Create, Configure, and Embed Touchpoints
- Applies to:
- MindTouch (current)
- Role required:
- Admin
Create and configure your Touchpoints through the new Touchpoints management dashboard.
Create an Individual Touchpoint
- Access the Touchpoint management dashboard and select "Touchpoints management" in the Integrations panel.
- Select your Touchpoint. Each Touchpoint is designed to perform a specific function. Select the Touchpoint that fits your use case. Keep in mind that Touchpoints can be used concurrently to achieve greater functionality in your integrations.
Generate and Embed Your Touchpoint
- When you have filled out all necessary fields for your Touchpoint, click Add this Touchpoint
- When prompted, click Copy code to clipboard to copy the embed code of your Touchpoint. The embed code will look like this:
<!-- Touchpoint name, Type = touchpoint-type --> <!-- Generated on [DATE] by MindTouch --> <script async="async" src="https://yourdomain.com/@embed/{AUTOGENERATED-GUID}.js"></script> <script type="mindtouch/embed" id="mindtouch-embed-{AUTOGENERATED-GUID}"></script> <!-- End Touchpoint name --> - You can now embed that code into the HTML of any web property or application for which that Touchpoint is configured (the website hostname that was included when creating the Touchpoint)
The development environments for different platforms will vary. Please be sure to research your platform and understand all that is required to successfully embed a Touchpoint.
Touchpoint Options
| Touchpoint type | Description |
|---|---|
| Search | A self-contained search field that can be embedded into any web page or web application to allow customers to search your product documentation and help content. The user will be redirected to the Expert search results page. |
| Search-In-Place | A self-contained search field that can be embedded into any of your web pages or web applications for your customers to access your product documentation and help content. Results will be populated within the same window on your site or application. |
| Contextual Help | An embeddable link your customers can click to access your Expert product documentation from any of your web properties or web applications. |
| Contextual Help Button | A help button you can embed on any of your web pages or web applications for customers to access your product documentation or help content (as long as you have rights of authorship). |
| Customer Insights | An embeddable intelligence tool that allows you to gain insight into your customers' view and search history with your Expert site. |
| Sign-In | An embeddable sign-in dialog your customers can use to log into your Expert site to access your product documentation and help content from any of your web properties or applications. |
| Embedded Contextual Help | Extend an Expert page into a third-party website or application for embedded access without a pop-up needed to view the content. |
| Analytics Connector | A utility to connect web sites and applications to Expert Analytics tracking. |
Touchpoint Fields
Each Touchpoint requires a set of unique configuration information. Due to the different functionalities of each Touchpoint, configuration fields will vary.
General Touchpoint Fields
| Field name | Description |
|---|---|
| Name | A unique name to easily identify the Touchpoint |
| Host Name | Host name or domain where the Touchpoint will be embedded (comma-separated host names and wildcards are allowed) |
Contextual Help and Contextual Help Button Fields
| Field name | Description |
|---|---|
| Custom CSS selector (contextual help only) | CSS class name that identifies your contextual help links that trigger your contextual help dialog (the default CSS selector is .F1) |
| Button label (help button only) | Host name or domain where the Touchpoint will be embedded (comma-separated host names and wildcards are allowed) |
| Display button | Display various buttons within the contextual help window (Back, Forward, Home, Open Article) |
| Label | Text label for the specific link (the default labels are Back, Forward, Home, and Open Article or localized equivalent) |
| Tooltip | Title attribute for the link (the default is the same as the label name) |
| Display search box | Display the search bar in the contextual help window |
| Search location | Option to automatically facet search results within the search bar |
| Search input hint | Text shown in the search text box (default is Search or localized equivalent) |
Customer Insights Fields
| Field name | Description |
|---|---|
| Input hint | Text displayed in the search bar field (default is Customer Insights Token or localized equivalent) |
| Customer insights token | Default token for which results are automatically populated |
| Height | Height of Touchpoint as a CSS property (%, em, px, etc.) |
| Width | Width of Touchpoint as a CSS property (%, em, px, etc.) |
Search Fields
| Field name | Description |
|---|---|
| Search location | The page URL of the Expert hierarchy you want your users to search (default is Homepage) |
| Input hint | The text displayed in the search bar field (default is Search) |
| Open search results in a new browser tab | Option to open the search results page in a new browser tab or on the same page |
Search-In-Place Fields
| Field name | Description |
|---|---|
| Search location | The page URL of the Expert hierarchy you want your users to search (default is Homepage) |
| Input hint | The text displayed in the search bar field (default is Search) |
| Search query | Search terms to auto-populate your search results |
| Search input CSS Selector | The class name of the search input field of your ticket submission form |
| Search query filter | Defines an advanced search filter that is appended with the AND operator for all searches done through the Touchpoint (use type:wiki to exclude page attachments from search scope) |
| Height | Height of Touchpoint as a CSS property (%, em, px, etc.) |
| Width | Width of Touchpoint as a CSS property (%, em, px, etc.) |
| Include recommended search results | Display search recommendations when populating search results |
| Allow search refinement filtering | Display drop-down search filters to refine search queries |
Sign-In Fields
| Field name | Description |
|---|---|
| Sign in redirect path | The URL of the page users will be sent to after signing in |
| Sign in label | The text label displayed prompting users to sign in |
| Authenticated user label | The text label displayed when the users have authenticated (default is Signed into Expert as {{username}}) |