Workday connection

Introduction

A Workday connection is configured via the Workday connector to establish access to an account on the Workday server. Once a connection is established, you can configure one or more Workday activities associated with that connection to use as a source or target within an operation.

To connect with the Workday server, contact the Workday administrator for the required credentials.

Create or edit a Workday connection

A new Workday connection is created using the Workday connector from one of these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The Global Connections page (see Create a global endpoint in Global Connections).

An existing Workday connection can be edited from these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).
• The Global Connections page (see Edit a global endpoint in Global Connections).

Configure a Workday connection

Each user interface element of the Workday connection configuration screen is described below.

The interface used in the Workday connection configuration depends on the Authentication type selected:

• Basic Auth: For this option, the connection is authenticated using a username and password.

• JWT Bearer OAuth: For this option, the connection is authenticated with a 2-legged OAuth 2.0. For information on obtaining the required credentials, see Prerequisites.

Basic Auth

When Basic Auth is selected as the Authentication type, this interface is presented:

• Connection name: Enter a name to use to identify the connection. The name must be unique for each Workday connection and must not contain forward slashes / or colons :. This name is also used to identify the Workday endpoint, which refers to both a specific connection and its activities.

• Workday Host: Enter the Workday host.

• Tenant: Enter the tenant for the Workday instance.

• Authentication type: Select Basic Auth to authenticate using a username and password.

• Username: Enter the username for the Workday instance.

• Password: Enter the password for the Workday instance.

• Version: Select the version of the Workday Web Services. Versions 32.0 through 43.0 are supported.

  Caution

  Versions v42.0 and v42.1 return errors when trying to fetch data for certain services. See limitations for more information.

• Optional Settings: Click the disclosure triangle to see this optional setting:

  • WSDL Download Timeout (in Milliseconds): Enter the timeout value for downloading the Workday WSDL. The default timeout value is 15 seconds (15000 milliseconds).

• Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.

• Test: Click this button to verify the connection. The server will check only that the specified user can make a connection. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click this button to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click Discard Changes to close the configuration without saving. A message will ask you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click Delete to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal).

JWT Bearer OAuth

When JWT Bearer OAuth is selected as the Authentication type, this interface is presented:

• Connection name: Enter a name to use to identify the connection. The name must be unique for each Workday connection and must not contain forward slashes / or colons :. This name is also used to identify the Workday endpoint, which refers to both a specific connection and its activities.

• Workday Host: Enter the Workday host.

• Tenant: Enter the tenant for the Workday instance.

• Authentication type: Select JWT Bearer OAuth to authenticate with a 2-legged OAuth 2.0 JWT bearer token.

• Client ID: Enter the client ID for the Workday OAuth 2.0 client, as described in Prerequisites.

• ISU username: Enter the Integration System User User Name, as described in Prerequisites.

• Private key: Enter the private key provided by the private.key file (as described in Prerequisites) in this format:

  -----BEGIN PRIVATE KEY-----
  
  <private key>
  
  -----END PRIVATE KEY-----
  

  Replace <private key> (including the angle brackets < >) with the appropriate value.

• Version: Select the version of the Workday Web Services. Versions 32.0 through 42.0 are supported.

  Caution

  There is a limitation when using the Human_resources or resource_management services with v42.0. See limitations for more information.

• Optional Settings: Click the disclosure triangle to see this optional setting:

  • WSDL Download Timeout (in Milliseconds): Enter the timeout value for downloading the Workday WSDL. The default timeout value is 15 seconds (15000 milliseconds).

• Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.

• Test: Click this button to verify the connection. The server will check only that the specified user can make a connection. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click this button to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click Discard Changes to close the configuration without saving. A message will ask you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click Delete to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal).

Next steps

After a Workday connection has been created, menu actions for that connection are accessible from the project pane's Components tab. See Connection actions menu for details.

After configuring a Workday connection, you can configure one or more Workday activities associated with that connection to use as a source or target within an operation. For more information, see:

• Workday activity: A Workday activity retrieves data from and/or sends data to a selected Workday web service and is used as a source or target in an operation.