XM Extension Getting Started

Summary

By following this guide you will create and modify a Qualtrics XM Extension!

Prerequisites

Before continuing with this guide ensure you have already:

• Reviewed the Extension SDK Overview
• Completed the Extension SDK Quickstart
• Set up the Extension SDK tooling

Steps

Step 1: Create an XM Extension

1.1: Organize

Keep your XM Extensions organized by creating a new directory specifically for them in your file system and then navigate to it, see the example below:

mkdir ~/path/to/my/qualtrics/extensions/directory
cd ~/path/to/my/qualtrics/extensions/directory

1.2: Create

Using the XMT CLI, create an XM Extension named Hello World by running the create extension command with the -n (name) flag:

xmt create extension -n "Hello World"

The -n flag allows you to provide a name for the Extension, in this case Hello World

Extension Name Directory Transformation

The create extension command transforms the Extension name you provide into a directory by:

1. Stripping out special characters
2. Converting all letters to lowercase
3. Replacing spaces with underscores

So the Extension name Hello World becomes the directory hello_world.

When creating your extension, you will be prompted to create your first plugin. Decline for now and the process to create a plugin will be explained later in this guide.

1.3: Review

Navigate to the newly created hello_world directory which contains your Extension:

cd hello_world

At this point your hello_world Extension directory should look like this:

├── assets
│   ├── images
│   │   └── logo.svg
│   └── translations
│       └── EN.json
└── manifest.json

Customize Your Logo

You should replace the default Qualtrics XM logo with your own, see this section for details.

Recap

Congratulations on creating your first XM Extension with the XM Extension SDK! You are one step closer to seeing your Extension show up in Qualtrics.

Recommended Content

Each functional XM Extension consists of one or more XM Plugins, which are a code and configuration bundle that integrates code you write into underlying Qualtrics functionality. Check out this list of XM Plugins to see what's available.