Ektron 9.00
Setting Up the Digital Experience Hub
The Digital Experience Hub (DxH) lets users of SharePoint®, HubSpot®, Salesforce®, Marketo® Lead Management, Microsoft Dynamics® CRM seamlessly interact with your Ektron-powered website.
You also can manually import SharePoint content from the Ektron Workarea.
Connections and mappings are key concepts in DxH configuration.
DxH architecture connects Ektron to external systems, and shares data and content with third-party applications. DxH includes these components:
The following figure shows the relationship among DxH components, Ektron, and external applications.
You want to let customers alert you about an issue on your website and use that information to create a Salesforce case and subsequent customer contact.
For details about the using Salesforce with DxH, see Mapping Form Data to an External Application.
You want to capture site visitor information, create a lead based on it, then display targeted content when that visitor revisits the site.
The Targeted Content widget lets you personalize your site visitors' experience by providing content that matches their interests, thereby placing your site information in the context of your users. For example, the search keywords used to find your site might determine the best offer to show a prospect. Or, site members might explicitly state their interests by adding to their user profile or filling out a survey. For information about the Targeted Content widget, see Creating and Using Widgets.
For details about the DxH > Targeted Content connection, see Using DxH with the Targeted Content Widget.
You want to display SharePoint content on your website. The content is updated when changes are made in SharePoint.
For details on the DxH > SharePoint connection, see Importing SharePoint Content to Ektron.
- Ektron 8.6 or higher
- DxH version 2.0
- Server—Same as Installing Ektron
- Network—By default, DxH uses port 808 to communicate between Ektron and external applications. Whichever port you use, ensure it is open on your firewall.
- You must enable the Microsoft Windows Net.TCP Port Sharing Service (see How to: Enable the Net.TCP Port Sharing Service).
- External applications
- SharePoint®
- SharePoint 2010: Foundation, Standard, or Enterprise Editions
- SharePoint 2007: Windows SharePoint Services 3.0, MOSS 2007
- Salesforce®—Group, Professional, Enterprise, and Unlimited Editions
- Marketo—Spark, Professional, and Enterprise Editions
- Microsoft Dynamics® CRM—Microsoft Dynamics CRM 2011, Workgroup, Professional, Enterprise, and Service Provider Editions
- HubSpot®—Enterprise
- You have administrator privileges or privileges to install DxH and create database
You can install DxH on the Ektron server or on its own server.
NOTE: If you previously installed DxH, you can upgrade to the current version. To upgrade to DxH version 2.0 from Ektron Version 8.7, click DxHInstaller.exe
and follow the onscreen instructions.
DxHInstaller.exe
to the server to which you will install it.DxHInstaller.exe
. Port 808 is the default value. If you want to use a different port, change it on this screen then follow Step 14.
(local)
. If you are using SQLExpress, use machine_name\SQLExpress
.You can use either a domain or SQL Server account when creating the DB. For Ektron, we typically create a dedicated domain or SQL Server account for the database.
The finish screen appears, displaying the URL for connecting to DxH from Ektron. Save this information for later use.
NOTE: You can access this information at any time via the Windows Start button > All Programs > Ektron > Dxh > Dxh Connection URL.
siteroot/web.config
file and find this tag:<endpoint address="net.tcp://localhost:808/EktronConnector/tcp/EktronFormService" binding="netTcpBinding"
bindingConfiguration="ContextBusNetTcpBinding" contract="IEktronFormService" name="NetTcpBinding_IEktronFormService" />
localhost
to the site domain where DxH is installed. For example, if DxH is installed to the domain myDxhService
, the endpoint address would be net.tcp://myDxhService:808/ContextBus/EktronConnector/tcpEktronFormService
. web.config
.<endpoint
address=”net.tcp://localhost:808/EktronConnector/tcpEktronFormService”
binding=”netTcpBindding”
contract=”IEktronFormService”
name=”NetTcpBinding_IEktronFormService” />
After installing DxH, set up a connection between DxH and Ektron.
NOTE: If you are setting up a SharePoint connection, and your SharePoint version contains multiple sites, create a connection for each SharePoint site with which you want to connect.
NOTE: You can access this information from Windows Start menu > All Programs > Ektron > DxH > DxH Connection URL.
IMPORTANT: Editing a DxH connection may change the relationship between Ektron and DxH, which may interrupt data transfer between external applications and Ektron.
IMPORTANT: Deleting a connection stops data transfer between Ektron and an external application.
After installing and connecting DxH to Ektron, you can establish an inbound connectionA special DxH connection type that updates Ektron content in response to content changes made in an external application., which lets you transfer information between Ektron and DxH. From DxH, the information can be sent to external applications. See Also: Setting Up the Digital Experience Hub
IMPORTANT: Enter an Ektron Administrators group member. Many DxH features use the Inbound Connector user, not the logged-in user, to perform DxH functions. Administrative privileges are required to complete many DxH tasks.
Prerequisites
- You are a member of the Ektron Administrators group or assigned a DxH Administrator role.
- The following components are installed and configured: DxH, DxH connection, and inbound connectionA special DxH connection type that updates Ektron content in response to content changes made in an external application.. See Setting Up the Digital Experience Hub.
- You have access information for external applications that will connect with Ektron via DxH. Obtain this information from the external application administrator before adding a connection.
IMPORTANT: After you create a connection, you cannot change its name. This restriction prevents you from accidentally overwriting a connection. To rename a connection, delete it then add it again with a new name, as described in Deleting a Connection to an External Application.
To set up an external application connection:
IMPORTANT: If you rename a SharePoint Connection, the associated Workarea folder is also renamed.
IMPORTANT: Deleting a connection removes the relationship between the instance of the external application and DxH.This action stops all data transfer.
The SharePoint Receiver automatically transfers updated SharePoint content to Ektron. Any edit to a SharePoint document/file or its properties triggers an update.
After you import SharePoint content to Ektron (as described in Mapping Imported SharePoint Content into Ektron), the receiver monitors that content, and transfers updated files from SharePoint to Ektron with no intervention. The imported file overwrites the current version, if one exists.
IMPORTANT: Do not confuse the SharePoint Receiver (described above) with a SharePoint connection. A connection specifies an endpoint (URL or API path) and authentication credentials that allows communication between 2 software instances.
Prerequisites
- The SharePoint Receiver installation file. Contact your Ektron account manager to obtain a link to download this file.
- Permission to install and edit files on the SharePoint server.
ektronsharepointreceiver.wsp
is Deployed.web.config
file (which resides within the content root folder). Insert bindings within the <system.servicemodel>
section.<bindings> <netTcpBinding> <binding name="SharePointConnectorNetTcpBinding" portSharingEnabled="true" closeTimeout="00:02:00" openTimeout="00:02:00" receiveTimeout="00:10:00" sendTimeout="00:02:00" maxBufferSize="2147483647" maxConnections="10" maxReceivedMessageSize="2147483647"> <readerQuotas maxStringContentLength="2147483647" maxArrayLength="2147483647" maxBytesPerRead="2147483647" maxNameTableCharCount="2147483647"/> <security mode="None"> </security> </binding> </netTcpBinding> </bindings> <client> <endpoint name="SharePointAdapter_ISharePointEventReceiver" address="net.tcp://localhost:9002/SharePointConnector/tcp/SharePointEventReceiver" binding="netTcpBinding" bindingConfiguration="SharePointConnectorNetTcpBinding" contract="Ektron.DxH.SharePointConnector.Common.ISharePointEventReceiver"> </endpoint> </client>
endpoint>
address
property, update the text following net.tcp://
(in red above) to indicate the path and port to which DxH is installed.Select Site Features.
web.config
file (which resides within the content root folder). <system.servicemodel>
section.<bindings> <netTcpBinding> <binding name="SharePointConnectorNetTcpBinding" portSharingEnabled="true" closeTimeout="00:02:00" openTimeout="00:02:00" receiveTimeout="00:10:00" sendTimeout="00:02:00" maxBufferSize="2147483647" maxConnections="10" maxReceivedMessageSize="2147483647"> <readerQuotas maxStringContentLength="2147483647" maxArrayLength="2147483647" maxBytesPerRead="2147483647" maxNameTableCharCount="2147483647"/> <security mode="None"> </security> </binding> </netTcpBinding> </bindings> <client> <endpoint name="SharePointAdapter_ISharePointEventReceiver" address="net.tcp://localhost:9002/SharePointConnector/tcp/SharePointEventReceiver" binding="netTcpBinding" bindingConfiguration="SharePointConnectorNetTcpBinding" contract="Ektron.DxH.SharePointConnector.Common.ISharePointEventReceiver"> </endpoint> </client>
endpoint>
address
property, update the text following net.tcp://
(in red above) to indicate the path and port to which DxH is installed.To suspend automatic updating of SharePoint content in Ektron:
NOTE: For background about how DxH can import SharePoint content, see Example: Importing SharePoint Content.
Prerequisites
Before importing SharePoint content, you should do the following:
- Install DxH—see Installing DxH
- Set up an inbound connectionA special DxH connection type that updates Ektron content in response to content changes made in an external application. then a SharePoint connection—see Setting Up an Inbound Connection
- Install the SharePoint Receivera software module that automatically transfers updated SharePoint content to Ektron., which handles the automatic update of content imported from SharePoint to Ektron—see Setting Up a SharePoint Receiver
- Prepare Ektron metadata definitions to match SharePoint metadata—see Preparing Ektron Metadata to Support SharePoint Import
- Enable languages for which you want to import SharePoint content. See Also: Determining Which Languages are Available
After completing these tasks, you select SharePoint lists, libraries or individual files and then map Ektron metadata fields to SharePoint metadata fields. When the import process is set up, the SharePoint Receivera software module that automatically transfers updated SharePoint content to Ektron. automatically transfers the following changes to the Ektron import folder.
NOTE: While setting up the import,users determine if deletes to SharePoint content affect the Ektron version of that content.
NOTE: If you are not familiar with Ektron metadata, please read Working with Metadata.
While setting up the import of SharePoint files to Ektron, you may map SharePoint metadata to Ektron metadata. (In SharePoint, extra information about files is stored in columns, which are equivalent to metadata.) If you map, as SharePoint content is imported to Ektron, SharePoint metadata values are applied to corresponding Ektron metadata fields.
NOTE: To complete step 1, you must either have access SharePoint, or ask your SharePoint administrator for the information that is collected.
To prepare Ektron metadata to map to SharePoint fields:
IMPORTANT: You can only choose SharePoint column types that correspond to these Ektron metadata types:
* Byte
* Date
* Double
* Float
* Integer
* Long
* Multiple selections
* Number (generic)
* Select from a list
* Short
* Text
* Yes or no
For example, you cannot choose the SharePoint column type Person or Group, because there is no corresponding Ektron metadata type.
NOTE: You can only map Searchable Property metadata types to SharePoint files.
NOTE: If you add a new metadata definition but do not see it on the DxH Map Metadata to Ektron Folder screen, reset IIS on the Ektron server.
After you verify that the SharePoint fields are properly mapped to Ektron metadata fields, proceed with the other aspects of importing SharePoint content to Ektron.
Mapping SharePoint lists, libraries, or individual files to an Ektron folder, accomplishes 2 tasks:
NOTE: Only files types listed in the Asset Management Configuration screen's File Types field may be imported. See Also: Configuring Document Management
CustomList
.To set up the SharePoint-to-Ektron mapping:
NOTE: Deletions depend on your choice in the next field.
NOTE: Deletions depend on your choice in the next field.
NOTE: This field only appears if more than one language is enabled in the Ektron Workarea.
Delete it from Ektron—If the file is deleted from SharePoint, delete it from Ektron.
You may map as many Ektron metadata fields to SharePoint metadata fields as you wish.
Required Ektron fields have an asterisk (*). If you do not map required metadata fields, you may proceed but when the content is imported to Ektron, its status is Checked-In. The content can only be published after required metadata values are entered.
Also, you can manually update any imported file at any time. See Also: Updating SharePoint Content Manually
NOTE: Files attached to a custom list are not imported.
For example, SharePoint Document A includes a hyperlink to SharePoint Document B. When Document A is copied to Ektron, Document B is not. If Document B is not copied to Ektron, the link in Document A does not resolve correctly.
(no title)
as the title. If several items are imported to the same folder with no title, an integer is appended. For example: (no title)(1)
.<add key="ek_dxh_sharepoint_cache" value="900" />
. You may disable caching by changing this value to zero (0). If you do, the import screen's performance may be a bit slower.However, if the user selected Items from SharePoint® Lists or Libraries during import, content restored from the SharePoint recycle bin does not return to Ektron.
Typically, the SharePoint Receivera software module that automatically transfers updated SharePoint content to Ektron. handles this task for you. You only need the manual import if the SharePoint receiver is not installed or is inactive. See Also: Setting Up a SharePoint Receiver
Prerequisite
You have 1 of the following Ektron designations:
- Administrators group member
- DxH Connection User RoleA limited or specific administrator privilege that you can assign to users who do not require full administrator privileges.
- Folder-Admin role
- Edit permissionPermissions determine which actions users and user group members can perform on content, library items, and content folders. You can set permissions for a folder and content.s for the folder containing SharePoint content
Use the manual update feature to transfer a file to Ektron immediately. You also can manually transfer an updated image file that is embedded within SharePoint content. Without a manual update, that image only transfers to Ektron when the related SharePoint content is updated.
NOTE: When a user imports a SharePoint content item to an Ektron folder that already contains the item, that action also updates the Ektron content.
DxH's HubSpot connectors help marketers customize and personalize the site visitor experience. These visitors benefit from a consistent message, as marketers can access customer data available from HubSpot, resulting in more meaningful conversations and enhanced customer experience.
When a prospect submits a form on an Ektron-powered website, a HubSpot lead is automatically created, and campaign information is updated. This process can trigger a HubSpot business rule, which sends an email response to the customer, and routes the lead to the appropriate sales representative.
This section explains how to implement the Ektron DxH to HubSpot connection.
The Targeted Content widget can determine page content based on information transferred to HubSpot via DxH, such as:
Use HubSpot's website to learn how to maximize the information collected above. See Also: HubSpot Academy
You can also use Ektron's HubSpot/Aloha plug-in to bring HubSpot keywords into the editor experience. The plug-in enables content authors to see how well they are targeting keywords as they create content. See Also: Using Hubspot with the editor
This topic explains how to map an Ektron HTML form to an external application. For example, you create a form that prompts a site visitor for contact information (name, mailing address, physical address, and phone number) to create a sales lead. After completing the mapping, you publish the form on your Ektron website. As site visitors complete the form, its information is sent to the external application. For background on using DxH to transfer Ektron form data to an external application, see Example: Adding a case to Salesforce and Example: Targeting content based on a lead.
This topic also explains how to use information collected through Ektron forms and stored in an external application in a Targeted Content widget. See Also: Creating and Using Widgets
Prerequisites
- DxH and inbound connectionA special DxH connection type that updates Ektron content in response to content changes made in an external application.s are established See Also: Setting Up the Digital Experience Hub
- A connection to an external application is established (Salesforce, HubSpot, Marketo, or Microsoft Dynamics) See Also: Setting Up a Connection to an External Application
- Either you have permission to publish the form, or it was already published
NOTE: Only these forms are supported:
* Marketo Lead Management—Lead
* Salesforce—Lead, Contact, Account
* Microsoft Dynamics CRM—Lead, Contact, Account
* HubSpot—Contacts
IMPORTANT: Coordination is critical when mapping form fields to external applications. Before creating a form, contact your business partner for the application and determine which fields are required to complete the desired action.
NOTE: You obtained the form name in Step 1.
IMPORTANT: The external application field's data type must match the Ektron form field .
IMPORTANT: The Form Mapping Complete dialog indicates that mapping between form fields and the external application object has been established, but does not indicate that the mapping is valid. You should perform end-to-end system testing to ensure that form fields pass successfully between systems.
When a site visitor submits a mapped form, the external application creates a record (Lead, Account, or Contact). You may edit the record in the external application.
NOTE: You obtained the form name in Step 1.
IMPORTANT: The external application field's data type must match the Ektron form field .
After a form is mapped to an external application, you can edit the map properties.
You can use data collected through Ektron forms and stored in an external application in a Targeted Content widget. When a user submits a mapped form, the external application connector writes a user ID for that login back to Ektron. This enables the delivery of targeted content based on the user's identity.
You can use the Targeted Content widget to personalize a Web page by displaying content based on information from a user-completed form. For example, if the Salesforce lead's industry is healthcare, the page may display content of interest to healthcare professionals. See Also: Creating and Using Widgets
To use DxH with a Targeted Content widget:
siteroot/dxhTargetingRules.config
file. The following sample shows a portion of this file (which are in the file by default).<dxhRules> <Adapter name="Salesforce"> <AdapterObject name="Lead"> <add name="Company Name" value="Company"/> <add name="Industry" value="Industry"/> <add name="Number of Employees" value="NumberOfEmployees"/> <add name="Revenue" value="AnnualRevenue"/> <add name="Products Owned" value="Products Owned"/> <add name="Product Interest" value="ProductInterest"/> <add name="Score" value="Rating"/> </AdapterObject> </Adapter>
dxhRules
—The file's root tag.Adapter
—The adapter for which to display object rules, such as Salesforce or MSDynamics. It is not the connection name (for example, marketingSF
).AdapterObject
—The system name of the object within the specified adapter. For example, to enter a Salesforce lead, insert the system name Lead (case-sensitive).add
—The field. The name
attribute contains text that the end user sees (as shown in the following image). The value
attribute contains the system name of the field.NOTE: The field's datatype is recognized and automatically surfaced into the correct rule type; numeric rule for an integer or decimal, string rule for a string, a multi-select rule for a pick list, and so on.
Use the DxH Error Log to monitor transactions related to DxH connections and troubleshoot problems. For example, connection failures involving multiple connector types may correspond to network outages, or a specific connector failure may correspond to an event such as an application upgrade in progress.
more...
You can sort and filter the DxH log as required.
After creating connections to external applications and mapping forms to those applications, you should test the mappings before exposing the forms on a production site. The following errors can occur:
Network or server issues may cause a DxH connection to become unavailable. If this happens, a message displays on the View All Digital Experience Hub Connections screen, and the connections are shown as disabled.
Access to SharePoint content is dependent on the following connections:
To address the problem, choose from these options:
An external application or SharePoint connection can become unavailable due to network issues, user account changes, or issues with the server hosting the application.
Use the DxH log to display recent information, warning, and error messages about DxH, inbound, and external application connections, as described in Monitoring DxH Transactions.
Webinars and Articles
API Reference
Ektron Dev Center Articles