How to configure a Workday Custom Reports (also known as RaaS) Data Source in One Model to extract custom data from Workday.
Why Custom Reports/RaaS?
We recommend using Workday Custom Reports (also known as RaaS) to pull data out of Workday that can't be easily pulled from the main Workday API. However, for ease of setup, or performance reasons, we recommend using the Workday API where possible.
Configure Custom Reports in Workday
Prerequisites
To connect Workday RaaS to One Model, you will need:
- An active Workday report URL.
- The username and password to access that Workday report URL.
- To configure the reports as Advanced type reports to enable web service access.
To connect Workday HCM to One Model, you need a Workday Integration System User account that has read permissions for human resources domain objects in Workday.
For guidance on configuring security policies in Workday, please refer to this guide.
Create custom report
1. On the Create Custom Report page, enter the Report Name.
2. In the Report Type drop-down menu, select Advanced.
3. Add Data Source. Add the fields you want to sync.
4. Configure the report to meet your business requirements for the data you wish to extract
Finish custom report configuration
In each custom report's Advanced tab, share each report to Report-as-a-WebService.
For each report, go to Actions --> Web Service --> View URLs. If you have parameters that are being supplied, you will see a dialog that gives you the list of defaults. Hit OK to take you to the next screen. Right click and copy the REST URL, you will use this when setting up the data source in One Model.
Test each report by pasting it into a new browser session and log in using the One Model ELT web service user. If the Report XML does not display, check your user security settings.
Transfer Ownership of the Report
To ensure that there aren’t problems in the future with the integration it is recommended that you transfer the ownership of the custom report to your ISU. You can then transfer the ownership of the report via this menu in the view custom report screen:
The first step of this process is to configure the Custom Reports that you'd like to extract in Workday. A Workday user that will be used to extract the data will then need to be given access to that data. We recommend using the same user as the main Workday API for the sake of simplicity
Configure Custom Reports in One Model
Create a new Workday Custom Reports Connector
In your One Model instance, navigate to Data -> Data Sources, and then select Add Data Source -> Workday Custom Report:
You'll then need to configure the following:
- Schema: The schema in One Model that the Workday Custom Report data will be stored in.
- Company: Your Workday Company ID.
- Username: The name for the user who was given access to the Workday Custom Report.
- Password: The password associated with the above Username.
- Endpoint base URI: The URI for your Workday instance.
Once you've configured the base details, it should look like this:
Add a Report
Now that the connector is configured, we should be able to start adding reports. To do this, simply add the username of the Report Owner, and the name of the report into the respective fields, and hit the + button:
You should then see your Report underneath:
This includes any filters that were configured in the Report (such as Time Filters). It also includes a Table Prefix that can be used if the same report is configured multiple times using different filters.
Running the Report
You're now ready to run the report! This can be done from the Data Sources page, either using the Play button for a manual run, or configuring a schedule.
General notes for Workday Custom Reports
- The default maximum runtime for a custom report in Workday is 1 hour. If your report takes longer than this to run, it will return an error at the hour, and the extraction will fail.
- Parameters can be used to get different segments of data from the same report. When doing this you will need to configure a prefix to use as a part of the report definition on the One Model side, so that we don’t overwrite the data from the first report with the data from the second.
Comments
0 comments
Please sign in to leave a comment.