Skip to end of metadata
Go to start of metadata

Introduction

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. After configuring a Workday connection, you can configure as many Workday activities as you like for each Workday connection.

Creating a Workday Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Within the Endpoints filter, click the Workday connection block to display activities that are available to be used with a Workday connection:

Connectivity tab

To create an activity that can be configured, the activity must first be added to an operation on the design canvas. To add an activity to an operation, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Accessing Menu Actions

After a Workday activity has been added to an operation, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an activity name and click the actions menu icon to open the actions menu.

  • Design Canvas: Within the operation, click an existing activity block to open the actions menu.

Each of these menu actions is available:

  • View/Edit: This opens the activity configuration screen for you to configure the activity. For details, see Configuring a Workday Activity later on this page.

  • Delete: This is used to permanently delete the activity.

  • Rename: This positions the cursor on the activity name in the project pane for you to make edits.

  • View Dependencies: This changes the view in the project pane to display any other parts of the project that the activity is dependent on.

  • Remove: Available only from the actions menu on the design canvas, this removes the activity as a step in the operation without deleting it from the project. When you remove an activity that is adjacent to a transformation, if schemas are provided within that activity, they will no longer be referenced by the transformation. Removed components can be accessed or permanently deleted from the project pane.

  • Deploy: This deploys the activity and any components it is dependent on.

  • Configurable Deploy: This opens the deployment screen, where you can select project components to deploy.

  • Add to group: This opens a prompt to create a new custom group or to add the component to an existing group.

  • Duplicate: This creates a copy of the activity as a new, unreferenced component. Upon creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

Configuring a Workday Activity

Follow these steps to configure a Workday activity:

  • Step 1: Select a Workday Web Service
  • Step 2: Select a Workday Operation
  • Step 3: Specify Settings
  • Step 4: Review Data Schema

In the example shown, a Workday get activity is being configured. Other Workday activities follow a similar pattern.

Step 1: Select a Workday Web Service

Connectivity tab

  • Name: Enter a name to use to identify the Workday activity. The name must be unique for each activity (of the same type) and must not contain forward slashes (/) or colons (:).

  • Select a Service: This section displays web services available in the Workday endpoint. When reopening an existing activity configuration, only the selected web service is displayed instead of reloading the entire web service list.

    • Selected Workday Service: After a web service is selected, it will be listed here.
    • Search: Enter any part of the web service name into the search box to filter the list of web services. The search is not case-sensitive. If web services are already displayed within the table, the table results will be filtered in real time with each keystroke. To reload web services from the endpoint when searching, enter search criteria and then refresh, as described below.
    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload web services from the Workday endpoint. This may be useful if you have recently added web services to the Workday instance. This action refreshes all metadata used to build the table of web services displayed in the configuration.
    • Select a Service: Within the table, click anywhere on a row to select a web service. Only one web service can be selected. The information available for each web service is fetched from the Workday endpoint:
      • Name: The web service name from Workday.
      • Description: The web service description from Workday.

    TIP: If the table does not populate with available web services, the Workday connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Step 2: Select a Workday Operation

Connectivity tab

  • Select an Operation: This section displays operations available for the selected web service in the Workday endpoint. When reopening an existing activity configuration, only the selected operation is displayed instead of reloading the entire operation list.

    • Selected Workday Service: The web service selected in the previous step will be listed here.
    • Selected Workday Operation: After an operation is selected, it will be listed here.
    • Search: Enter any part of the operation name into the search box to filter the list of operations. The search is not case-sensitive. If operations are already displayed within the table, the table results will be filtered in real time with each keystroke. To reload operations from the endpoint when searching, enter search criteria and then refresh, as described below.
    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload operations from the Workday endpoint. This may be useful if you have recently added operations to the Workday instance. This action refreshes all metadata used to build the table of operations displayed in the configuration.
    • Select an Operation: Within the table, click anywhere on a row to select an operation. Only one operation can be selected. The information available for each operation is fetched from the Workday endpoint:
      • Name: The operation name from Workday.
      • Description: The operation description from Workday.

    TIP: If the table does not populate with available operations, the Workday connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Step 3: Specify Settings

Connectivity tab

  • Continue on Error: Select to continue the operation if an error is encountered. If any errors are encountered, they are written to the operation log.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Step 4 - Review Data Schema

Connectivity tab

  • Data Schema: The request and response data schemas from Workday will be displayed. If the operation uses a transformation, the data schemas will be displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    The Workday connector uses the Workday Web Services (WWS) API, versions 32.0 or 32.1, 32.2, 33.0, or 33.1. Refer to the API documentation for information on the schema fields.

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the endpoint. This action also regenerates the schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Next Steps

After configuring a Workday activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

Workday activities that are used as a source can be used with these operation patterns:

Other patterns are not valid using Workday activities that are used as a source.

Workday activities that are used as a target can be used with these operation patterns:

Other patterns are not valid using Workday activities that are used as a target.

See the validation patterns on the Operation Validity page.

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

Operations that use Workday activities can also have operation actions configured to trigger upon a SOAP fault — an error resulting from an incorrect message format, header processing, or incompatibility. Operation actions can be configured to run an operation or send an email after a SOAP fault occurs. For instructions on triggering an action upon SOAP fault, refer to Operation Actions.

When ready, deploy and run the operation and validate behavior by checking the operation logs.

On This Page

Last updated:  Jul 25, 2019

  • No labels