Workday Scope

UiPath.Workday.Activities.WorkdayScopeActivity

The Workday Scope activity uses your Workday credentials (Username and Password) to establish a connection to your Workday Web Service (Tenant and TenantURL).

How it works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

1. Complete the Setup steps.

2. Add a activity.

   • For more information, see Credential Management in this guide.
3. Add the Workday Scope activity to your project.
4. Enter values for the Authentication and Connection input properties.
5. Create and enter a WorkdayConnection variable for output property.

   • You can use this variable in subsequent uses of the Workday Scope activity.

     
     

     

     
     

In the Body of the Activity

To build your project and enable the Object Wizard in other activities, you must use the Connection Wizard by clicking the Configure button.

To learn more about the Connection Wizard, see the Business Activity Frameworks page.

Note: Configuring the fields in the Connection Wizard does not populate the Workday Scope properties. The wizard establishes a connection to your Workday application during design time only; enabling the Object Wizards in the other Workday activities.

Properties

Authentication

• Password - The password (associated with the Username) to your Workday application. Enter a SecureString variable.
  • To create a SecureString variable, see the Create Credential Asset section of the Setup guide.
  • To enter your SecureString variable, use a activity that outputs your Credential Asset (see example below).
• Username - The user that you want to use to authenticate. Enter a SecureString variable. The Username is associated with the Password. Because of this relationship, it's recommended that you create a String variable for this property by following the Create Credential Asset section of the Setup guide.
  • To create and enter your String variable for this property, use a activity to output your Credential Asset (see example below).

Common

• DisplayName - The display name of the activity. This field supports only strings or String variables.

Connection

• Tenant - The name of the Workday tenant that you want to connect to. Enter a String or String variable.
• Tenant URL - The URL of the Workday tenant that you want to connect to. Enter a string or String variable. The URL syntax: https:// workdayhostname.workday.com/ccx/service/tenantname (e.g., https://wd2-impl-services1.workday.com/ccx/service/uipath_dpt1).

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Options

• ReportApiErrorAsException - When selected, API error responses are reported in BusinessActivityExecutionException by all child activities that use this application scope. When cleared, the child activity populates the API error message in the ResponseStatus output property and workflow execution continues. Check the ResponseStatus property to confirm successful execution.

Output

• Workday Connection - A record of your established connection that you can use in other Workday Scope activities that are included in this scope activity. Enter a WorkdayConnection variable. You can pass this variable to a scope activity in a workflow that is from within the parent scope activity.
  • For example, you may have 3 workflows. The first includes the parent scope activity that establishes the connection to your registered application (i.e., parent workflow). The second workflow gets a report and the third launches an EIB; both are included in the parent scope activity.
  • When the workflows run, the parent scope activity passes the WorkdayConnection variable to the ExistingConnection property in the second and third workflows (see image below).

UseExistingConnection

• ExistingConnection - A connection record from a parent Workday Scope activity that you can use instead of establishing a new connection. Enter a WorkdayConnect variable.
  • The WorkdayConnection variable must be from a previously run Workday Scope activity (parent) that still has an active connection.

  • If you're unable to establish a connection using this property, try re-running your parent Workday Scope activity.