Connect your Workday recipients to Axios HQ
Axios HQ can connect with your Workday directory in two ways, via a single Group/User report or an SFTP connection.
⭐ Directory Sync requires an upgrade from the Essential Package.
Why it matters
- Setting up directory sync allows you to connect your current Workday email distribution lists and sync them to Axios HQ.
- As your email lists change you won’t have to worry about updating your audience to match in Axios HQ. Updates will sync automatically!
Table of contents:
- Overview
- Step 1: Generate key pair in Workday
- Step 2: Enter the public key
- Step 3: Generate custom reports
- Step 4: Create Enterprise Interface Builders
- Step 5: Finalize your setup
- What your users can expect
An overview of both setups
When you're ready to configure your Workday directory in Axios HQ, navigate to Settings > Integrations > Directory Sync. You will see two options for this directory provider: "Workday" and "Workday SFTP."
- The first option (Workday) is a singular sync. The Workday sync uses a single Group and User report to connect your directory for a quick and easy integration! Each user (ie: recipient) is expected to be available in only one group.
- Because only one group report can sync, your Segments in Axios HQ will be limited to that group report. We've seen clients leverage location or department, for example, to capture their audience groups.
- If you'd like to learn more about the Workday sync, review the instructions here.
- The second option (Workday SFTP) utilizes an SFTP connection, which will allow your recipients to exist in multiple groups within your synced directory. The Workday SFTP connection is more flexible, and is the most common connection type for Workday directories. Below are the steps you'll follow to configure a Workday SFTP connection.
We partner with a vendor, WorkOS, to facilitate both of these connection types. You will access these setup instructions via a portal provided by WorkOS.
1. Generate key pair in Workday
Workday will need to generate a public/private key pair to connect to the SFTP server. Log into Workday, search for and click the task "Create x509 Private Key Pair." Give the key pair a name and click "OK."
Create a file on your local computer in a text editor with the copied "RSA-SSH" formatted key and name it rsa.pub
. Then run ssh-keygen -i -f rsa.pub
to generate a SSH key that uses the OpenSSH format and is more secure. That command will output a new SSH key that you can use in the next step.
2. Enter the public key
Enter the public key you generated in the previous step.
The SSH public key format should include the key type (e.g. 'ssh-rsa', 'ssh-ed25519'), base64 encoded body, and an optional comment, with spaces between each element. For example: ssh-rsa AAAABB1 keycomment
3. Generate custom reports
You will need to create the following Custom Reports on Workday:
users.csv
-- a file that contains all of the user-specific informationuser_groups.csv
-- a file where each user is mapped to their group
We partner with a vendor, WorkOS, to facilitate this directory connection. WorkOS offers the ability to connect an optional groups.csv
, but it is not leveraged in Axios HQ. Feel free to ignore this file.
When creating the reports, make sure to select the Advanced report type and to have the Enable as Web Service box checked.
Create a users.csv
file with the following columns:
Note that WorkOS requires more headers than Axios HQ can ingest at this time. We recommend mapping the following to the required headers:
WorkOS-required header (above) | Axios HQ recommended mapping |
user_id | user id |
username | email address |
email address | |
first_name | recipient first name |
last_name | recipient last name |
job_title* | N/A* |
*job_title can be mapped to a true attribute or placeholder. Information will need to be passed into this attribute to facilitate the sync, but will not be applied to your recipients within HQ.
Your user_groups.csv file should contain the following columns:
Create an XSLT transformation to make the custom report in CSV format.
- You can can create an XSLT transformation to make the custom reports for this connection in CSV format.
- An XSLT transformation will also enable you to convert multiple data sources (Location, Department, etc.) into one CSV file (this is especially helpful for the required
user_groups.csv
file.)
4. Create Enterprise Interface Builders
You will need to create an Enterprise Interface Builder (EIB) once for each report you want to sync. Within Workday, search "Create EIB," fill out the "Name," and select "Outbound EIB."
On the following page, select "Get Data" and enter the Custom Report you created in the previous step.
Under the "Transformation" tab, choose the correct file name for that report:
Click "Deliver" and select "SFTP" as the "Delivery Method." Copy the following username and address and add those.
Select the x509 Key Pair that was created in Step 1.
Select "OK" and launch the integration.
5. Finalize your setup
Verify that the configuration is correct by clicking Start sync! A full sync usually takes a few minutes, but may be longer depending on the directory size.
What your users can expect
Your sync is now complete
Your recipients and groups are available after the first initial sync.
- Once the sync is complete, you will be able to view your groups by navigating to Audience > Segments.
- Updates occur at whatever cadence was set within the script; whomever configured the sync can determine how often updates are triggered.
Learn more about how your users can apply directory groups to their HQ audience here.