Get the PDF

Configure the Workday Sync Module for REST

Complete this task to configure the

BlackBerry AtHoc

Workday Sync Module to access Workday custom reports using REST.

Obtain Report-as-a-Service (RaaS) access

Set up security for a REST integration

Open the

WorkdayIWS.config

file.

Set the value of the <isEncrypted> attribute to

false

Update the value of the <ReportServiceType> attribute to

REST

Update the values for the following attributes in the

REST - Get report as REST service

section with the values generated by completing the tasks in the Set up security for a REST integration section:

TokenEndpoint

ClientId

ClientSecret

NonExpiringRefreshToken

<add key="TokenEndpoint" value="token-endpoint-url" />
<add key="ClientId" value="client-id" />
<add key="ClientSecret" value="client-secret" />
<add key="NonExpiringRefreshToken" value="non-expiring-refresh-token" />

Update the WDURL value in the

Report service URL

section with the value generated by completing the Obtain Report-as-a-Service (RaaS) access task.

<!--Report service URL-->
<add key="WDURL" value="web-service-URL" />

You should avoid including parameters in the WDURL. Parameters can be included, if required.

Example of a WDURL without parameters. This is the recommended format:

https://sharedgmspreview.workdaysuv.com/ccx/service/customreport2/gms/tserrano/TestCustomReport

Example of a WDURL with parameters:

https://sharedgmspreview.workdaysuv.com/ccx/service/customreport2/gms/tserrano/TestCustomReport*?Include_Subordinate_Organizations=0&Is_Active=0&format=json*

In the example with parameters, remove the bold portion of the URL for best results. If any escape characters (&, <, >,",') are present in the WDURL, they must be rewritten as follows:

Replace

(ampersand) with

Replace

(less than) with

Replace

(greater than) with

Replace

(quotes) with

&quots;

Replace

(apostrophe) with

In the

Web service credential

section, leave a blank space for the WDusername and values:

<!--Web service credential-->
<add key="WDusername" value=" " />
<add key="WDpassword" value=" " />

In the

CSV folder path

section, update the values of the CsvFilePath key with the location where you want to store the .csv file.

<!--CSV folder path-->
<add key="CsvFilePath" value="C:\tmp\"

The value of the CsvFilePath in the

Workday.exe.config

file must match the value in the <readFolder> attribute in the User Sync Client

AtHocDataIntegration.config

file.

In the

SET TriggerUserSyncTool Value...

section, update the value of the TriggerUserSyncTool key to

true

false

If the value is set to true, the Workday Sync Module imports data from Workday to a .csv file and then triggers the

BlackBerry AtHoc

User Sync Client to synchronize the data from the .csv file into

BlackBerry AtHoc

. If the value is set to "false" the Workday Sync Module imports the user data from Workday into a .csv file but does not trigger the

BlackBerry AtHoc

User Sync Client.

<!-- SET  TriggerUserSyncTool Value as "true" to trigger User Sync Tool -->
<!-- SET  TriggerUserSyncTool Value as "false" to disable automatic trigger and check if CSV is getting created -->
<add key="TriggerUserSyncTool" value="true" />

In the

Import only selected fields

section, update the value of the SyncConfiguredFields key with the Workday fields whose data you want to import into a .csv file. Separate each field with a comma.

<!--Import only selected fields-->
<add key="SyncConfiguredFields" value="PublicEmailAddresses,FirstName,LastName" />

In the

CSV "Username" column mapping with workday field

section, enter the name of a column in the .csv file that you want to map to a Workday data field. In the following example, the "PublicEmailAddresses" data field in Workday is mapped to the "username" column in the .csv file:

<!--CSV "Username" column mapping with workday field -->
<add key="UsernameMapping" value="PublicEmailAddresses" />

The .csv file must have a "username" column for the

BlackBerry AtHoc

User Sync Client to synchronize Workday user data to

BlackBerry AtHoc

The Username field must have a minimum of 4 characters for the

BlackBerry AtHoc

User Sync Client to synchronize user data to

BlackBerry AtHoc

Optionally, in the

Specify date fields and format workday field

section, update the values of the "DateTypeFields" line with all date attributes. Modify the "DateFormatSupported" value to match the format required by the

BlackBerry AtHoc

User Sync Client.

<!--Specify date fields and format workday field -->
<add key="DateTypeFields" value="Last_Hire_Date,Term_Date" />
<add key="DateFormatSupported" value="dd-MM-yyyy" />

Save and close the file.

Section:

Configure the Workday Sync Module