Workday
General information
Workday connector provides an ability to get user data from Workday HR system. The operations that could be performed by using OpenIAM are - search.
Installing the connector
Based on the nature of your deployment, follow the procedures below to deploy the connector.
Docker swarm
To start this connector in a Docker Swarm deployment, follow the steps described below:
- Uncomment the following line in
setup.sh
file
setup.sh - #docker pull "openiamdocker/workday-rest-connector-rabbitmq:debian-${OPENIAM_VERSION_NUMBER}-${BUILD_ENVIRONMENT}"
- Uncomment the following line in
startup.sh
file
#docker stack deploy --compose-file connectors/workday-rest/docker-compose.yaml --with-registry-auth workday-rest-connector
For the changes to take effect you will need to stop your OpenIAM containers and then run:
./setup.sh./startup.sh
General usage
During Managed System configuration you should provide service account username (Login filed), password, tenant name (Host URL field) and URL for APIs in Attributes section.
- Navigate to Provisioning>>Managed System
- Create a new Managed System by clicking on “Create Managed System”
- Select the Connector as Workday Connector
- Enter the Managed System Name
- Provide the Host URL as provided for eg. https://example.workday.com
- Define the Port as 9999
- Specify Workday service account credentials in Login Id and Password field.
- In Attributes section add WORKERS - https://example.workday.com/xyz?format=json
Synchronization
Instruction how to set up synchronization is provided in a separate document. OpenIAM provides out of the box sync configurations and groovy scripts. Connector allows pulling user personal and employee data.
- Navigate to Provisioning>> Synchronization
- Create a new Synchronization by clicking on “Create Synchronization”
- Enter the Synchronization System Name
- Enter the number of threads as 1
- Select is Active
- Select Synchronization Source as Connector (Since 4.2.1.2)
- Select Managed System type as Workday Rest Connector as defined in Managed System Section
- Select Synchronize Object as User
- Select Sync Type as Complete
- Select Validation Rule as “/sync/user/workday/WorkdayUserSampleValidationScript.groovy”
- Select a specific Transformation Rule as per your requirements
- Select OpenIAM Field Name: EMPLOYEE ID
- Enter Source Attribute Name: EMPLOYEE_ID
- Enter SQL Query / Directory Filter as *. Note: This will fetch all the users
- Define the Source attribute names script as per the attributes coming from source.
- For syncing only certain number of records say 5; we need to enter SQL Query / Directory Filter: count=5
Example of query to get limited number of users count=5
Connector Troubleshooting and Tips
Connector troubleshooting could be done by raising logging level to DEBUG mode (-Dlogging.level.org.openiam=DEBUG)