Contact Free trial Login

Use Studio to Configure Workday Connector 13.0 - Mule 4

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files.

To add and configure a connector in Studio:

  1. Create a Mule project.

  2. Add the connector to your Mule project.

  3. Configure a source for the connector’s flow.

  4. Add a connector operation to the flow.

  5. Configure a global element for the connector.

When you run the connector, you can view the app log to check for problems, as described in View the App Log.

If you are new to configuring connectors in Studio, see Use Studio to Configure a Connector. If, after reading this topic, you need additional information about the connector fields, see the Workday Connector Reference.

Create a Mule Project

In Studio, create a new Mule project in which to add and configure the connector:

  1. In Studio, select File > New > Mule Project.

  2. Enter a name for your Mule project and click Finish.

Add the Connector to Your Mule Project

Add Workday Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and to add the required dependencies to the project’s pom.xml file:

  1. In the Mule Palette view, click (X) Search in Exchange.

  2. In Add Dependencies to Project, type workday in the search field.

  3. Click Workday Connector in Available modules.

  4. Click Add.

  5. Click Finish.

Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace.

Configure a Source

A source (listener) initiates a flow when a specified condition is met.

You can configure one of these sources to use with Workday Connector:

  • On Modified Objects
    Start your app when an object is created in Workday.

  • HTTP Listener
    Initiates a flow each time it receives a request on the configured host and port

  • Scheduler
    Initiates a flow when a time-based condition is met

To configure the On Modified Objects source:

  1. In the Mule Palette view, select Workday > On Modified Objects.

  2. Drag On Modified Objects source to the Studio canvas.

  3. On the On Modified Objects configuration screen, optionally change the value of the Display Name field.

  4. Enter the required information for the following fields:

    Studio Field Description

    Connector configuration

    Global Element Properties configuration name

    Object type

    Type of the Workday object

    Scheduling Strategy

    Tells the source how it can poll the data. This field accepts two options:

    • Fixed Frequency
      Polls for data at a specified number of milliseconds, seconds, minutes, hours, or days. The default is 1000 milliseconds.

    • Cron
      Accepts an expression that polls for data based on a filter, such as every Monday in a month at a given time. See Cron Expressions for examples.

  5. Click the plus sign (+) next to the Connector configuration field to configure a global element that can be used by all instances of the On Modified Objects operation in the app.

Add a Connector Operation to the Flow

When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform.

To add an operation for Workday Connector, follow these steps:

  1. In the Mule Palette view, select Workday and then select the desired operation.

  2. Drag the operation onto the Studio canvas to the right of the source.

Each Workday operation has its own required fields in Anypoint Studio. For more information, see the Workday Reference.

Configure a Global Element

When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Workday system. Workday Connector supports basic authentication and x.509 authentication.

To configure the global element for Workday Connector, follow these steps:

  1. Select the operation in the Studio canvas.

  2. In the configuration screen for the operation, click the plus sign (+) next to the Connector configuration field to access the global element configuration fields.

  3. On the General tab, configure the authentication for the connection as described in the Basic Authentication or X.509 Authentication section.

    You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see Anypoint Connector Configuration.

  4. On the Advanced tab, optionally specify reconnection information, including a reconnection strategy.

  5. Click Test Connection to confirm that Mule can connect with the specified server.
    To validate connectivity using the Test Connection button, Workday Connector uses an Identity_Management WSDL service with the Get_Workday_Account_Signons_Request operation. You must ensure that your service account has the required permissions to operate on that service.

  6. Click OK.

Basic Authentication

Enter the following information on the General tab of the Global Element Properties screen to configure Basic authentication:

Field Description

Connection

Select Basic authentication.

Password

Enter the password with which to log in.

Host Name

Enter the host name of one of Workday’s Cloud Servers.

Tenant Name

Enter the Workday Tenant ID, which usually has the suffix pt1 appended to it, such as acme_pt1. This parameter supports expressions, which allow the value of this parameter to change dynamically. For example, you can use an expression to create a multi-tenant connection.

User Name

Enter the username with which to log in.

x.509 Authentication

Enter the following information on the General tab of the Global Element Properties screen to configure X.509 authentication:

Field Description

Connection

Select x.509 Authentication.

Host name

Enter the host name of a Workday cloud server.

Tenant name

Enter the Workday Tenant ID, which usually has the suffix pt1 appended to it, such as acme_pt1. This parameter supports expressions, which allow the value of this parameter to change dynamically. For example, you can use an expression to create a multi-tenant connection.

User Name

Enter the username with which to log in.

Key store path

Enter the location of the keystore file.

Type

Select the keystore type.

Password

Enter the password to access the keystore.

Alias

Enter the alias of the private key.

Signature Algorithm

Enter the signature algorithm.

Digest Algorithm

Enter the digest algorithm.

Canonicalization algorithm

Enter the c14n (canonicalization) algorithm.

Configure Additional Connector Fields

After you configure a global element for Workday Connector, configure the the other required fields for the connector, as described in Workday Reference.

View the App Log

To check for problems, you can view the app log as follows:

  • If you’re running the app from Anypoint Platform, the output is visible in the Anypoint Studio console window.

  • If you’re running the app using Mule from the command line, the app log is visible in your OS console.

Unless the log file path is customized in the app’s log file (log4j2.xml), you can also view the app log in the default location MULE_HOME/logs/<app-name>.log.

Next Step

After configuring Workday Connector in Studio, see the Examples text for financial management use cases that demonstrate how to use this connector.