Creating an extended integration for Workday users (OAuth)

Sync Workday with Oomnitza to gain visibility of user and SaaS user information.

Contents

1. Before you start
2. Get required information
3. Creating an integration user
4. Adding credentials
5. Creating the integration
6. Mappable fields

Before you start

Workday's Report-as-a-Service (RaaS), which exposes reports as web services, is used to sync data with Oomnitza. When you create the integration in Oomnitza, you add the Workday Report URL to sync the data that is generated by the report with Oomnitza.

Get required information

To learn more and get more detailed information, see the documentation that is provided by Workday. Go to Workday documentation and search for Register API Client for Integrations, Manage OAuth 2.0 Clients, and 
OAuth 2.0 Authentication for Integrations. You will require a Workday account to access the articles.

To create the integration and add credentials, you will need to complete the following tasks and retrieve the following information:

Workday report URL

The format of the report URL is as follows:

https://[subdomain].workday.com/ccx/service/customreport2/[your_company]/[your_report]?format=json 

You must append format=json to the report URL. To parse and use the data, the output must be in JSON format.

Subdomain

The format of the base tenant URL is https://{subdomain}.workday.com. If your base tenant URL is https://mycompanyname.workday.com, you enter mycompanyname as the subdomain.

Client ID and secret

An active Workday tenant with administrator access is required to Register an API Client. 

1. Log into Workday and search for register an API client.
2. Open the register an API client form.
3. Select Authorization Code Grant as Client Grant Type and Bearer as Access Token Type.
4. Enter the following redirection URL: https://generic-oauth2-proxy.oomnitza.com/oauth2/redirect_url.
5. Configure token settings and functional scopes. 
6. Save your changes. 

Make sure you copy your client ID and secret.

Scopes

When you create credentials in Oomnitza, you must also enter a separated-list of scopes such as Integration Report as a Service and the scopes required to retrieve the type of data in the report such as Staffing.

Adding a global variable

Adding global variables

Save time when you create integrations and run workflows by adding connection information as global variables.

1. Click Configuration > General > Global Settings.
2. Click Add new variable.
3. Add the key value, which is the name of the variable.
4. Enter the value.
5. Save your changes.

The name of the global variable is Workday.Report Url. The value is your Workday report URL. 

Creating an integration user

To easily find the records that are uploaded to Oomnitza, it's best practice to create a dedicated user account for each integration. This will make it easier for you to retrieve the records that are uploaded to Oomnitza from the vendor application. 

Creating integration users 

Adding credentials

Make life easier and add your credentials to Oomnitza before you create the integration.  

1. In Oomnitza, click Configuration > Security > Credentials.
2. Click Add new credential (+).
3. Search for the integration, and then click the forward arrow > to select the integration.
4. Enter your client credentials and any other additional information.
5. Click Authenticate. You are prompted to log in to authorize your request.
6. Click CREATE.

Creating the integration

1. In Oomnitza, click Configuration > Integrations > Overview.
2. Click Block view .
3. On the Integrations page, scroll down to the Extended section for user integrations.
4. Click NEW INTEGRATION.
5. In the sidebar, search for the integration.
6. Click ADD.

Integration details overview

More information is provided about the following fields to help you complete the integration:

• User only. Add user records.
• User plus SaaS user. Add user and SaaS user records. 

The benefit of adding SaaS user records is that you can run a workflow to validate the status and activity of SaaS users and retrieve information such as the role of the SaaS user. The information that can be retrieved depends on whether SaaS user workflows are available for the integration. 

Installation types

• Cloud. Store credentials in the Oomnitza cloud.
• Local. Store credentials locally. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select cloud as the type of installation. Local installations don't support AWS and OAuth authentication. 

Integration preferences

• Create & Update. Add and update records.
• Create only. Add records.
• Update only. Update records.

Editing the integration details

When you edit the Integration details section, you can select the name or names of integration contacts.  Integration contacts will receive an in-app notification and an email, when the integration fails, when the integration fails to complete within 24 hours, or when the scheduled integration fails to run.

1. Click Edit .
2. Make your changes.

Editing the credential details

If you selected Cloud as the installation type, choose one of the following options:

• Select the credentials that were created for the integration.
• Edit the credentials that were created for the integration.
• Create new credentials

Scheduling the integration

By default, data is synced once every day. Change the interval or the time so that the data is streamed when your system isn't busy.

1. Click Edit .
2. Make and save your changes.

Mapping fields to Oomnitza

To map the fields to Oomnitza, click Edit .

  Select Edit integration to add rules for syncing data. Filtering integration results.  
 

You can add new fields to your integration by selecting Add new field   on the mapping page. 
Creating custom API fields. 

Mappable fields

Company
Connector Sync Time
Cost Center
Country
First Name
ID
Last Name
LDAP
Location
Location WID
Manager
Manager ID
Primary Address
Start Date
Time Zone
Type
Work Email

Creating custom mappings

Map the Workday fields to Oomnitza fields and create custom mappings to get the user information that you need.

1. Click Smart Mapping to automatically detect map fields to Oomnitza. Values from the integration can also be dragged to the appropriate field on the Oomnitza side, or selected from the integration field dropdown.
2. Required. Map the Work Email field to the Email field and the Username field.
3. Required. Select the Role field on the Oomnitza mapping side and select a role from the list.
4. Map other fields or create custom mappings to map any other field that you want to add to Oomnitza. To create  a custom mapping, complete the following steps:
   1. Click the down arrow on the field that you want to map.
   2. Select Add new Oomnitza field.
   3. Change the name of the field.
   4. Click CREATE. 
5. Assign a sync key to a unique field, such as Email.
6. Click UPDATE.

Selecting sync keys

You must select at least one field as the sync key field. To ensure that the sync runs successfully, the field must contain unique values such as the serial number of an asset record or the email address of a user record. Records that do not contain a value for the sync key are skipped.   

See Configuring multiple sync keys.

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration. 

If you selected Cloud as the installation type when creating the integration, see Running an extended integration

If you selected Local as the installation type when creating the integration, see Running an extended integration locally.

Viewing data ingested by Oomnitza

Viewing ingested asset data

For asset integrations, click Hardware. If the asset integration also ingests software data, click Software.

Viewing ingested user data

For user integrations, click People. If you chose the option to ingest User and SaaS user data, click Software > SaaS, click the SaaS app, and then click the Users tab. 

Related Links

• Running an extended integration
• Troubleshooting integrations
• Mapping extended integrations