Migrating Automations to XM Directory Workflows
About Migrating Automations to XM Directory Workflows
Workflows are the new and improved way to automate tasks in XM Directory, and will eventually fully replace automations. To get ahead of this change, we recommend following the instructions on this page to recreate common automations as workflows.
Workflows in XM Directory
The Workflows tab of XM Directory is where you can create, edit, and manage directory-related workflows. When replacing your legacy automations, this can be an easy, one-stop location to find all of your XM Directory workflows.
For more information, see Workflows in XM Directory.
Workflow Schedules
All XM Directory automations are scheduled at regular intervals. Thus, the first step to replacing your automation is to create a scheduled workflow.
- Navigate to XM Directory.
- Go to the Workflows tab.
- Select Create a workflow.
- Select Started at a specific time (scheduled).
- Select the Frequency from the dropdown menu.
- Enter the Start days, Start times, Time zone, Start, and End fields. For more information, see Scheduled Workflows.
- Select Save.
- Next, determine if you want to import contacts on a regular schedule or send a distribution.
Contact Import Automations
Contact import automations allow you to automatically upload files of contacts from a source of your choice to XM Directory. In legacy automations, contacts can come from a Secure File Transfer Protocol (SFTP) server, the Qualtrics File Service, or Google Drive. Workflows achieve this same functionality using ETL workflows, while also supporting several more sources, such as Amazon S3, Snowflake, and Salesforce.
- Create an ETL workflow.
- Set up your schedule.
- Select Data source (ETL extractor).
- Depending on where your data’s stored, select a data extraction task. The most common include:
- Extract data from Google Drive
- Extract data from Qualtrics File Service
- Extract data from SFTP files (supports SSH key)
Qtip: Workflows also supports other import sources, like Amazon S3, Snowflake, and Salesforce. For more information, see Building ETL Workflows.Qtip: Workflows do not support Gigya or Dropbox as data sources. - Click Add a data destination.
- Select the Add contacts and transactions to XMD task.
- Choose the directory to map data to.
- Select a mailing list to map data to. You can also choose to create a new mailing list for this directory each time this workflow runs.
- Select a data source. This should be the data extractor task you set up in step 4.
- Many of your XM Directory fields will be mapped automatically. Double-check the results and make adjustments as needed.
Qtip: If you want to make changes to field mappings, you can make individual edits or upload a file. See Mapping Field Values. - Use the Field type column to indicate whether each column is basic contact data, embedded data, or transaction data.
Qtip: See Setting Up an Add Contacts and Transactions to XMD Task for more details, including differences between field types, and proper transaction date formats.Qtip: If you don’t map a transaction date field, the system will automatically map the workflow’s execution date as the transaction date.
- Click Save.
Survey Distribution Automations
Survey distribution automations allow you to set a scheduled survey distribution to a mailing list or a sample of a mailing list. This same functionality can be achieved with the Email task or Send Survey via Text Message (SMS) task.
- Set up a scheduled workflow.
- Click the plus ( + ) sign.
- Select Add a task.
- Select a distribution task:
- Follow the steps from the pages linked above.
Linking Contact Import and Survey Distribution Automations
In legacy automations, users can link contact import and survey distribution automations together to send survey distributions to the contacts that were most recently imported. In Workflows, users can perform the import and distribution tasks in a single unified job.
It is also possible to add multiple survey distribution tasks to the same workflow, so you can have multiple distributions sent after a single contact import task.
- Follow the steps from the Tasks to create Contact Import Automation section.
- Click the plus sign ( + ).
- Select Add a task.
- Select a distribution task:
- Follow the steps from the pages linked above.
- When you choose who to invite, instead of choosing a directory or mailing list, click Source, then select the Add contacts and transactions to XM Directory task you created earlier, for your contact automation.
- Under Type, select whether to send to the mailing list created, or to that specific transaction group.
Qtip: If you select List, the entire mailing list will be invited. If you select Transaction Group, only the newly added contacts in this workflow execution will be invited. If you don’t create a new mailing list every time the contact import runs, you should select Transaction Group.
Qtip: If you schedule your workflow to run on a frequent basis, but there isn’t a new file to extract from your chosen source, the workflow will not send the distribution, and mark it as failed. This is intended behavior, since if there isn’t a group of contacts to message, the message can’t go out. If you have workflow failed notifications turned on and want to avoid receiving too many, add a condition to your workflow between your contact import and the distribution. As seen below, you can set a condition so the distribution’s only sent if the file is not empty, thus eliminating the failures described.
Run Summary Reports
Email tasks allow you to send a general email message with no survey link included. Because of this, email tasks are a great options if you want to create run reports, keeping your stakeholders updated on how many contacts were processed in each run. However, if you’re using an email task, you must add specific IDs to ensure that the survey is sent to the correct mailing list.
If you’re using a contact import automation, with or without a linked distribution, follow the steps below.
- Click the piped text button ( {a} ) next to the “To” (recipient) field.
- Hover over the Add contacts and transactions to XM Directory task you created earlier.
- Select the Transaction batch ID.
- Complete your email. In the body, you can generate piped text from either the contact extraction or the contact upload.
- Extract data from (source): You can show email recipients the number of files or rows in all files imported. Number of rows can be a great way to show the number of contacts generated.
- Add contacts and transactions to XMD: Display information such as the directory where the new contacts were uploaded, the list ID, or the transaction ID.
People Import Automations (EX)
In this section, we’ll discuss an automation that’s only available for Employee Experience customers, and is disconnected from XM Directory.
People import automations allow you to automatically pull lists of employees from a source of your choice to your employee directory. In legacy automations, employees can come from a Secure File Transfer Protocol (SFTP) server, the Qualtrics File Service, or Google Drive. Workflows achieve this same functionality using ETL workflows, while also supporting several more sources, such as SuccessFactors, Workday, and more.
- Set up a scheduled workflow.
- Click the plus ( + ) sign.
- Select Add a task.
- Create one of the following data extraction tasks:
- Extract Employee Data from SuccessFactors
- Extract data from Google Drive
- Extract data from Qualtrics File Service
- Extract data from SFTP files (supports SSH key)
Qtip: Workflows also supports other import sources, like Amazon S3, Snowflake, and Salesforce. For more information, see Building ETL Workflows. - Click Add a data destination.
- Select the Load Users into EX Directory task.
- Follow the steps on Load Users into EX Directory Task.