Adopt advanced use cases

This page provides additional tips and guidance to help you navigate edge cases within Adopt. It covers advanced concepts, configuration options and other information you may find useful depending on your organizational needs.

Configuring multiple tenants in the Nexthink browser extension

You can integrate the Nexthink browser extension with multiple Nexthink tenants. This allows you to develop guide content associated with different Nexthink environments using Adopt Editor.

This capability is useful, for example, when you need to create Adopt guides for the same web application and link them to different Nexthink environments, ensuring they do not interfere or overlap.

This page contains the steps to configure and switch between multiple tenants from the Nexthink browser extension and open tenant-specific guide content in Adopt Editor.

To configure a new tenant for the Nexthink browser extension:

1. Open your browser—Google Chrome or Microsoft Edge—select the Extensions icon from the browser toolbar, and locate Nexthink.

2. Click the pin icon to add the extension to your browser toolbar.

3. Right-click on the pinned extension (the Nexthink icon) and select Tenants Configuration. This will open the extension configuration page, where you should see the default tenant.

   
4. Click on Add tenant and fill in the Name and URL fields from the Add tenant pop-up.

   • Add the URL of your Nexthink instance. For example: https://nexthink.tet.nexthink.saas

   • The URL cannot include a / slash at the end of the URL—also known as trailing slash.

   
5. Open the action menu for the new tenant and select Authenticate. This opens the authentication page in a new window. Once the authentication is complete, you can select this tenant and open associated guides in Adopt Editor.

Switching tenants to open instance-specific guides in Adopt Editor

Authenticating to a Nexthink tenant

To access guides associated with a particular Nexthink Infinity environment in Adopt Editor you must first authenticate to that Nexthink environment.

• Access the Tenants Configuration page in the Nexthink browser extension and select Authenticate from the action menu.

• Alternatively, to authenticate to the default Nexthink tenant, right-click on the Nexthink icon on the browser toolbar and select Sign in as admin.

Switching tenants in Adopt Editor

1. Once authenticated, click on the Nexthink icon from the browser toolbar.

2. From the drop-down menu, choose the Tenant of interest, and select the target web Application.

3. Click the guide of interest to open Adopt Editor directly on the web application URL.

   • The Nexthink browser extension lists only those guides that were created in the associated Nexthink Infinity environment and have not been published.

   • Refer to the Guide content development from in-app Adopt Editor documentation for more information on creating and editing guide content.

Selecting the default tenant

In a multi-tenant architecture, to view guides associated with a specific environment as they appear in the web application (e.g., for testing purposes), you must set that tenant as the default.

To do this:

1. Go to the Tenants Configuration page in the Nexthink browser extension.

2. Open the action menu for the desired tenant.

3. Select Set as default.

In standard cases, organizations operate under a single Nexthink instance. However, if your organization uses development environments, you may need multiple tenants to test adoption guides in separate environments.

Adopt NQL capabilities

Certain adoption guide events can be queried via investigation for the purposes of data collection, measuring guide engagement or analytics.

Adopt-specific NQL tables

Adopt mainly uses the following NQL tables:

• application.guide: This table represents the guide object, which is any type of guidance provided to end-users, such as walkthroughs, tooltips, or media documents.

• application.guide_step: This table represents an individual-step object within a Walkthrough-type guide.

• web.context_help_executions: This table tracks employee interactions with Context Help elements from the web application (e.g., clicking the question mark icon, searching guides).

• web.guide_executions: This table records the execution event of a guide, which can occur multiple times for each employee using the target web application.

• web.guide_step_executions: This table captures employee interactions with individual steps within a guide.

These tables track user interactions with guides, steps within guides, and Context help executions. The data can be leveraged to understand employee behavior and guide engagement within Nexthink Adopt.

These metrics offer the following benefits:

• Querying guide engagement: Use the new fields to track guide targeting, engagement, execution duration, and other user interaction metrics.

• Increasing guide-related data granularity: By adjusting the data granularity, you can gain precise insights into how employees interact with guides, such as the exact timing of when an end-user engages with specific steps or elements.

Adopt-related configuration objects in the application NQL namespace

guide table fields

The example below uses nql_idfield object from the guide table of the application NQL namespace.

application.guides 
| list nql_id 

guide_step table fields

The example below uses rankfield object from the guide_step table of the application NQL namespace.

application.guide_steps 
| sort rank asc 
| limit 10 

Adopt-related events in the web NQL namespace

context_help_executions table fields

The example below uses browser_languagefield event from the context_help_executions table of the web NQL namespace.

web.context_help_executions during past 24h
| sort browser_language desc

guide_executions table fields

The example below uses statusfield event from the guide_executions table of the web NQL namespace.

web.guide_executions from 2025-02-03 11:00:00 to Feb 4, 2025, 11 AM
| list status

guide_step_executions table fields

The example below uses number_of_executionsfield event from the guide_step_executions table of the web NQL namespace.

web.guide_step_executions on 2025-02-04
| list number_of_executions
| limit 100

Adopt Editor use cases

The following use cases apply to the Adopt Editor. Apply them to configure and manage guides in a sustainable way.

Hidden steps

Hidden steps are used to perform actions or wait for user interactions without displaying any overlay to the user. They handle background logic within a guide, such as navigating to a specific page, waiting for a page to load, scrolling to an element, showing a border around an element, or pausing until a user interaction occurs.

To add a hidden step:

1. Add a new step and label it appropriately without adding content.

2. Open the step configuration. In Appearance, set Step overlay to Hidden. This ensures the user will not see an empty overlay. Set Shadow to Off to prevent brief visual flickers.

3. Configure the step as necessary. The following use cases utilize hidden steps, providing insight into their utility.

1. Save your settings.

Triggering steps when hovering a button

Validate step conditions by triggering a step when the user hovers over a specific element, such as a button. This approach helps confirm that required fields or conditions are met before the user continues, ensuring that each action occurs at the right time.

1. Open the guide in the Adopt editor.

2. Add a new step for detecting the hover action.

   • You can make this a hidden step. If you do, you must set the Step is completed when trigger to complete step immediately.

3. Use the selector tool to capture the target element.

4. Open the step configuration. In Triggers, set Step is started when to Mouse over.

1. In Appearance, set Step overlay to Hidden. Set Shadow to Off.

1. Once the hover event is detected, the step completes automatically and the guide continues to the next visible step.

2. Save and test to confirm that the step waits correctly until the user hovers over the element, then proceeds as expected.

Automatically completing steps after elapsed time without user interaction

Use step automation to streamline your guide and reduce unnecessary clicks. This can be achieved through timers and actions, allowing the guide to progress independently and reducing manual interaction for the end user.

1. Open the guide in the Adopt editor.

2. Select the step that interacts with the intended element.

3. Open the step configuration. In Triggers, under Step is completed when, set a timer to automatically end the step after a few seconds (for example, 3 seconds).

   • Keep the Action type set to Mouse click for redundancy so the user can still advance the guide manually.

1. Save your settings.

2. Publish and test the guide to confirm that steps complete automatically and clicks occur in the correct order.

Language-dependent selectors

Ensure guide reliability across different interface languages by choosing selectors that are not affected by localized text. XPath selectors hold a language-specific text value that can change when the UI is translated, which may cause steps to fail. CSS selectors are generally more stable and language-independent. As a general rule, ensure that steps which utilize XPaths are multilingual to increase overall stability.

1. Open the guide in the Adopt editor.

2. Select the step that is causing language-related instabilities.

3. Open the step properties. In Position, review the Selector field:

   • If the selector uses XPath and references text (for example, button labels), it will only work in that language.

4. To support multiple languages, use one of the following options:

   • Option 1: Reselect the element for each language version so that each locale has its own XPath.

     • You can switch languages through the toolbar or in the step configuration.

     • If not localized, the XPath for a specific language will be empty.

   • Option 2: Use a CSS selector (instead of XPath selector) that targets structural or class-based attributes instead of text.

5. Use broad and stable selectors when possible. The best practice is to avoid dynamic IDs or any elements that change as a page loads.

6. Test the guide in each supported language to ensure all elements are correctly detected and the steps trigger as expected.

RELATED TOPICS

• Configuring Adoption settings

• Guide insights and analytics