Managing guides

To manage existing guides follow one of the options below:

Managing guides from the Adoption guides table

The Adoption guides table action menu is context-sensitive and depends on the guide Published or Draft status.

From Applications > Manage Adoption guides:

  1. Review the Adoption guides table with all existing guides—regardless of the application.

  2. Hover over a guide to reveal the action menu on the right side of the table-item row:

    • Edit is only available for guides in Draft mode. Therefore, you must Unpublish active guides before editing their configuration settings.

      • To unpublish an active guide, go to Applications > Manage Applications and open the application of interest. From the Guides tab, use the action menu to Unpublish any guide tied to the application.

      • You can always see the configuration Details of a published guide.

    • Manage tags to create, assign, and edit the investigation tags.

      • Optionally, open the Tags panel by clicking the tags icon in the right-side menu.

        • Search for tags of interest from the displayed list of guides.

        • Select one or more tags to filter the Adopt guides table.

    • Attach to an application guides that are currently not tied to any web application.

      • The system undergoes key-page comparison between the target application and the attached guide.

    • Delete a guide from the system.

If needed, sort the table items by clicking on the column header or using the search bar at the top-right corner of the table to find a guide.

Understanding the column fields in the Adoption guides table

Find below the description of each of the column fields in the Adoption guide table:

  • Name: displays the guide name. The hyperlinked guide name on the table takes you directly to the Edit guide configuration page.

  • Origin: indicates if a Custom guide was created using Nexthink, or imported from Nexthink Library. Refer to Library pack documentation.

  • Tags: see tags associated with a guide.

  • Description: contains the guide description defined during its configuration.

  • Application: indicates the application tied to the guide.

  • Type: indicates the guide type: Walkthrough, Tooltip, or Media. The guide type is not editable after creation.

    • Walkthrough: step-by-step guidance of a task flow. The walkthrough provides in-line support throughout the process till completion.

    • Tooltip: contextual information that organically unfolds to end-users while hovering or using specific elements on the application site. Unlike walkthroughs, tooltips are independent, user-discoverable, and quickly built.

    • Media: embedded existing media or articles within the application site. This way, end-users can access media content from the Context help pop-up—based on the Context help configuration and conditions.

  • Published: shows if a guide is published (date since active) or in Draft mode. Published guides cannot be edited. Refer to the Action menu section below for more information.

    • Published guides cannot be edited. Refer to the Action menu section below for more information.

Managing guides from the application-specific Guides tab

The Guides table action menu is context-sensitive and depends on the guide Type and Published status

From Applications > Manage applications:

  1. Select the web application of interest with guides.

  2. Open the Guides tab listing application-specific guides.

    • The columns in the Guides tab table match the table fields covered in the Manage adoption guides section on this page.

  3. Hover over a guide to reveal the action menu on the right side of the table-item row:

    • Edit Walkthrough/Tooltip/Media is only available for guides in Draft mode. Therefore, you must Unpublish active guides before editing their configuration settings.

      • You can always see the configuration Details of a published guide.

      • The Edit page of an existing guide contains the same configuration fields as those used when creating a guide.

    • See analytics takes you to guide-specific details dashboard.

    • Update translation of guides due to changes in the localization configuration.

      • You can only update translations for unpublished guides in Draft mode.

    • Duplicate an existing guide within the same application site.

    • Copy to another application any of the existing guides listed on the table.

    • Delete a guide from the system.

    • Export guides you can later import in different web applications or Nexthink instances.

Managing guides from the application-specific Guides tab

Importing guides

You can Import guides previously exported—in JSON format—from the same or a different Nexthink instance, saved on your local device.

From Nexthink Applications > Manage Applications:

  1. Select the web application of interest with guides.

  2. Open the Guides tab listing application-specific guides.

  3. Click the Import button in the top-right corner of the page.

  4. Choose or drag the JSON file from your hard drive to import the guide into the system.

  5. Define Target URL which is the same Open editor on URL configured when creating new guides.

    • When launching Adopt Editor from the Nexthink browser extension for the imported guide, the browser automatically loads the defined Target URL path.

  6. Check Unidentified key pages missing from the target web application configuration.

    • The imported guide configuration retains matching key pages between the guide and the target web application.

The system also applies key-page comparison when attaching or copying existing guides to different applications.


RELATED TOPICS

Last updated

Was this helpful?