Skip to main content

EX Project

What is an EX Project​

The EX Project resource is the central access point from which you can access other resources contained within an EX Project such as a Survey, a Dashboard, or Message Templates. Note that an EX Project with a Survey is different from a Survey Project: an EX Project's Survey must be considered in the context of its associated EX Project, whereas a Survey Project's Survey can be edited and distributed on its own.

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.

Context​

The EX Project resource will generate the following fields:

  • exProjectId
  • surveyId
  • responseSetId

The exProjectId will be your EX Project's id (TS_***) and can be accessed with <step.id>.exProjectId or <step.id>.id.

The EX Project id will be necessary for linking resources to the project, as well as directing users to the page for that project in a location.

How to import an EX Project resource into an XM Solution​

Start by running the following command:

solution import

Then select EX Project to view all available EX Projects.

1. survey
2. CXDashboard
3. EXProject
please select a resource type to begin import [1]: 3

Then, select a project subtype to view all EX Projects of that subtype to import.

1. EmployeeAdHoc
2. EmployeeEngagement
3. EmployeeLifecycle
4. ThreeSixtyProject
Select the project you want to import [number / string] [1]:

Now, a list of all your EX Projects will show, and you can select one to import.

1. [EmployeeAdHoc] proj1
2. [EmployeeAdHoc] proj2
3. [EmployeeAdHoc] proj3
4. ...

Select the project you want to import [number / string] [1]:

Now you should have your EX Project and all of its dependencies downloaded into a src/Resources_**** folder of your solution plugin. This will include the EX Project associated with your selected project.

Solution Execution​

EX Project resources are created using a "Create" step and updated using an "Update" step.

{
  "id": "EXProject",
  "type": "Create",
  "config": {
    "apiVersion": "exproject.v1",
    "templateFilePath": "Resources/EXProject.json",
    "transformationFilePath": "Resources/interpolate.js"
  }
}

The current apiVersion for EX Project is "exproject.v1".