Navigation Guide for XM Solutions

In your XM Solution, you may want to redirect the user's browser to show them what the XM Solution has built.

If you would like to join the early access program for XM Solution Plugins, then please let us know by taking this survey.

Not generally available

This feature is in Early Access and is not yet generally available. Functionality, APIs, and documentation may change before general availability.

This document explains the details about Location configuration options for the Solution Execution file. Basic UI tasks have a location associated with them of the format seen in this example:

{
  "id": "preview_survey",
  "type": "BasicUI",
  "config": {
    "description": "Your survey is ready for review! If something's not right, you can make edits or start over.",
    "title": "PREVIEW",
    "setLocationOnReady": {
      "type": "Product",
      "section": "EditSurvey",
      "sectionData": {
        "surveyId": "survey.id"
      }
    },
    "primaryAction": {
      "location": {
        "type": "Product",
        "section": "PreviewSurvey",
        "sectionData": {
          "surveyId": "survey.id"
        },
        "completeOnClick": true
      },
      "text": "Preview Survey"
    }
  }
}

Navigation Types

Currently, there are two types of navigation types when configuring navigation: Product and URL.

URL Navigation

URL navigation is used when you want to leave the Qualtrics platform. The only configuration parameter allowed for these options is url. All navigation links of this type are opened in a new tab, so the user doesn't lose their spot in the Qualtrics product.

Field	Type	Description	Required
type	string	URL	Yes
url	string	The URL to navigate to	Yes
enableCompleteOnClick	boolean	On clicking navigate to that product section mark the task as complete	No

Example configuration

{
  "type": "URL",
  "url": "https://example.com"
}

Product Navigation

Product navigation is used when navigating to part of the Qualtrics product.

Field	Type	Description	Required
type	string	Product	Yes
section	string	Product section to navigate to	Yes
sectionData	object	Refer to Section Data subheading below	No
enableCompleteOnClick	boolean	On clicking navigate to that product section mark the task as complete	No
enableOpenInNewTab	boolean	Only used for product navigation, defaults to false. (Preview always opens in new tab)	No
productNavigationContext	string	Enable on clicking navigate to that product section mark the task as complete	No

Section Data

Section data can be used to refine redirection for locations on the workflow.json file. Each product section will expect certain data (listed below) to be provided here and workflow will transform these values to their respective values on the context before building the redirect URL. Note that the productId field refers to the Project ID of the project if this is part of a project.

Data and Analysis

Parameters

Field	Type	Validation	Description
surveyId	context path	required	id of the survey
productId	context path	optional	id of the DataAndAnalysis product

Example Configuration

{
  "type": "Product",
  "section": "DataAndAnalysis",
  "sectionData": {
    "surveyId": "survey.id",
    "productId": "mainEntityID.id"
  }
}

Distribution

Parameters

Field	Type	Validation	Description
surveyId	context path	required	id of the survey
productId	context path	optional	id of the distribution product

Example Configuration

{
  "type": "Product",
  "section": "Distributions",
  "sectionData": {
    "surveyId": "survey.id",
    "productId": "mainEntityID.id"
  }
}

Edit Survey

Parameters

Field	Type	Validation	Description
surveyId	context path	required	id of the survey
productId	context path	optional	id of the edit Survey product

Example Configuration

{
  "type": "Product",
  "section": "EditSurvey",
  "sectionData": {
    "surveyId": "survey.id",
    "productId": "mainEntityID.id"
  }
}

My Projects

Parameters

Parameters should be empty for this section.

Example Configuration

{
  "type": "Product",
  "section": "MyProjects",
  "sectionData": {}
}

Preview Survey

Parameters

Field	Type	Validation	Description
surveyId	context path	required	id of the survey

Example Configuration

{
  "type": "Product",
  "section": "PreviewSurvey",
  "sectionData": {
    "surveyId": "survey.id"
  }
}

Printed Report

Parameters

Field	Type	Validation	Description
surveyId	context path	required	id of the survey
reportId	context path	required	id of the report
productId	context path	optional	id of the product

Example Configuration

{
  "type": "Product",
  "section": "PrintedReports",
  "sectionData": {
    "surveyId": "survey.id",
    "reportId": "report.id",
    "productId": "product.id"
  }
}

View Results

Parameters

Field	Type	Validation	Description
surveyId	context path	required	id of the survey
productId	context path	optional	id of the product

Example Configuration

{
  "type": "Product",
  "section": "ViewResults",
  "sectionData": {
    "surveyId": "survey.id",
    "productId": "mainEntityID.id"
  }
}

CX Dashboard

FYI: "Vocalize" Dashboards === CX Dashboard

CX Dashboards is the new name for "Vocalize" Dashboards, but you may still see some references to the old "Vocalize", especially in JSON or code files. They are the same thing.

Parameters

Field	Type	Validation	Description
dashboardId	context path	required	id of the dashboard the user wants to display

Example Configuration

{
  "type": "Product",
  "section": "VocalizeDashboard",
  "sectionData": {
    "dashboardId": "dashboard1.id"
  }
}