How to export data from Workday to Pigment

  • 21 December 2021
  • 2 replies
  • 380 views
How to export data from Workday to Pigment
Userlevel 4
Badge +2

 

This article details the process of transferring data from Workday directly into Pigment and configuring an automatic data update based on a desired schedule. 

 

Building a Set Up

 

Transferring data from Workday into Pigment is a 3-step process:

  1. Build a Custom Report in Workday with that includes the data you want to send to Pigment
  2. Build an Enterprise Interface Builder (EIB) in Workday which will connect the Workday report to a Pigment Block
  3. (Optional) Create an Integration System User (ISU) 

 

 

Build a Custom Report in Workday

 

Custom reports are built with the Workday Report Writer tool.

There are two ways of creating one:

  1. From scratch by using the Create Custom Report task
  2. From a copy of an existing Standard report by using the Copy Standard Report to Custom Report task

Make sure to activate the option "Enable as web service" to use the report in an EIB later. Go to the report’s Advanced settings to do it.

 

Click on the image to expand the view

 

 

Build an Enterprise Interface Builder (EIB) in Workday

 

To create an EIB, use the Task Create EIB and select "Outbound”

 

Click on the image to expand the view

 

In the "Get Data" step, select "Custom Report" then select the report you want to integrate (note that if you forgot to enable the "Web service option" on your report you won't be able to find it). In Details > "Alternate Output format", please select "CSV"

 

Click on the image to expand the view

 

In the "Transform" step, do nothing and click next.

In the "Deliver step", this is the configuration required:

  • Delivery method: HTTP/SSL
  • HTTP Address: put Pigment API URL with the API token as query parameter.
    • API URL template: https://pigment.app/api/importservice/Csv/ApiPush/{pipeline-Id}?api_key={API_key} .  (Note: don’t put the { and } in url)
    • Please ask your API_key to your Customer Success Manager
    • Follow this tutorial to create the pipeline-Id
  • Web service Invocation Type: "Basic Auth" instead.
  • User Id / Password: Enter anything there. The authentication to Pigment is actually done based on the API_key in your API URL.
  • File Name: leave blank

 

Click on the image to expand the view

 

Once your EIB integration is created you can launch it to see if it works. Open the EIB you just created and click on "Action">"Integration" > "Launch / Schedule"

 

Click on the image to expand the view
 
Click on the image to expand the view

 

Select "Run Now" and launch the EIB.

Your data should now appear in Pigment! 

 

Note

If your data doesn't appear in Pigment, check the History Update panel:

  • If you see a failed import, it means that the data has been correctly sent to Pigment. You may need to adjust your import Pipeline configuration.
  • If you don't see any import: it means that Pigment didn't receive the data. Double-check on the Workday side if the "API URL" is correct and if the EIB has ran correctly.

 

 

Schedule an automated export

 

Open the EIB you just created and click on "Action">"Integration" > "Launch / Schedule".

Then in "Run Frequency" select the desired frequency. For this example, we will take "Monthly Recurrence".  

 

Click on the image to expand the view

 

Fill in the different information requested and Save.

Thanks to this configuration, now Workday will automatically send this report to Pigment at the frequency chosen. 

 

 

(Optional) Create an Integration System User (ISU)

 

We also recommend using an Integration System User (ISU) to run your Custom report. This way you can run it with different security profiles.

Here are the steps to follow: 

  1. Create an Integration System User using the Create Integration System User task. Add this ISU to an existing Integration System Security Group (ISSG) or create a new one.
  2. Using the Maintain Password Rules task, add this ISU account to the System Users exempt from the password expiration list
  3. Update the relevant domain security policies so that the security group gets access to integration permissions
  4. Activate pending security policy changes
  5. Share the report with authorized users including the ISSG/ISU

 

 


2 replies

Userlevel 4
Badge +4

Quick note: remove the {} from the URL once you’ve filled the ID and Key, like this: 

https://pigment.app/api/importservice/Csv/ApiPush/qsjfqknkl2152?api_key=dsmlfksdmfkmsqdfk243578

Userlevel 4
Badge +2

Quick note: remove the {} from the URL once you’ve filled the ID and Key, like this: 

https://pigment.app/api/importservice/Csv/ApiPush/qsjfqknkl2152?api_key=dsmlfksdmfkmsqdfk243578

Added to the doc! Thanks for the feedback!

Reply