tWorkdayInput Standard properties

Property Type

Select the way the properties will be set.

Two options are provided: Built-In and Repository.

A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. When you create a Spark Job, avoid the reserved word line when naming the fields.

• Built-In: You create and store the schema locally for this component only.

• Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs.

Click Edit schema to make changes to the schema. If you make changes, the schema automatically becomes built-in.

• View schema: choose this option to view the schema only.

• Change to built-in property: choose this option to change the schema to Built-in for local changes.

• Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion.

  If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the Repository Content window.

Click this button to generate the schema based on the client data retrieved or Workday client report.

Click this button after you have provided all the necessary information, such as information for connecting the Workday server, data to retrieved, operations to be carried out, and so on.

Authentication mode

Select an authentication mode among OAuth JWT authentication (the default), REST - Client ID authentication mode (deprecated), SOAP - Login authentication mode, and SOAP - WS-Security authentication mode.

Communications with Workday clients are carried out using the HTTPS protocol. For SOAP - WS-Security authentication mode, the authentication information is included in the messages. See WS Security for related information.

Enter the Client ID of the API Client used to connect to Workday.

This field is available when you select REST - Client id authentication mode (deprecated) from the Authentication mode drop-down list.

Click […] and enter the Client secret key of the API Client used to connect to Workday in double quotation marks.

This field is available when you select REST - Client ID authentication mode (deprecated) from the Authentication mode drop-down list.

Enter the username for the SOAP login authentication mode.

This field is available when you select SOAP - Login authentication mode from the Authentication mode drop-down list.

Click […] and enter the password for the SOAP login authentication mode.

This field is available when you select SOAP - Login authentication mode from the Authentication mode drop-down list.

Enter the Tenant ID that allows you to connect to Workday. The tenant alias is provided by your Workday administrator. The following gives an example: tenant_alias.

Select the mode for retrieving client data. You can select Workday query language, Report as a service, or Workday web services from the list.

Whether a mode can take effect is determined by the authentication mode you select from the Authentication mode drop-down list. The following gives the detail.

• If you select OAuth JWT authentication from the Authentication mode drop-down list, all the three modes take effect.
• If you select REST - Client ID authentication from the Authentication mode drop-down list, the Workday query language and Report as a service modes take effect.
• If you select SOAP - Login authentication mode from the Authentication mode drop-down list, the Report as a service mode takes effect.
• If you select SOAP - WS-Security authentication mode from the Authentication mode drop-down list, the Report as a service and Workday web services modes take effect.

WS-Security type

Select the WS Security type from the drop-down list: WS Security with basic authentication or WS Security with certificate authentication.

The WS-Security type drop-down list is available if you select SOAP - WS-Security authentication mode option from the Authentication mode drop-down list.

Login and Password

Enter the username and password for the SOAP - WS-Security authentication mode.

These two options are available when you select SOAP - WS-Security authentication mode from the Authentication mode drop-down list and select WS Security with basic authentication from the WS-Security type drop-down list.

Integration system user

Enter the integration system user.

Creating an integration system user is the first step to build an SOAP request with x509 certificate. You can create an integration system user by carrying out the Create Integration System User task in Workday.

X509 certificate

Enter your X.509 certificate content.

You can create an X.509 certificate by carrying out the Create x509 public key task in Workday.

Private key

Enter the private key.

This field is available when you select OAuth JWT authentication from the Authentication mode drop-down list or select SOAP - WS Security authentication mode from the Authentication mode drop-down list and select WS Security with certificate authentication from the WS-Security type drop-down list.

Enter Workday query language statements for retrieving client data.

This field is available when Workday query language is selected from the Mode list.

Enter the report owner for the client data retrieved.

This field is available when Report as a service is selected from the Mode list.

Report Name

Enter the report name for the client data retrieved.

This field is available when Report as a service is selected from the Mode list.

Service

Enter the names of the Workday services to retrieve data from.

You can also fill the service names in this field by clicking [...] next to this field and select a part or all of these five most frequently used services from the list box in the dialog box: Compensation, Financial_Management, Human_Resources, Payroll, and Staffing. To select services that are not in the list box, select the Use custom value option and enter the desired service names in the Custom value field.

Operation

Enter the names of the operations to be carried out to the retrieved data.

You can also enter the operation names by clicking the [...] next to this field and select the desired operations from the list box in the dialog box that appears. Note that operations appear in the list box only when all the information that is necessary to connect to the Workday server is provided.

Currently, only the operations with their names beginning with Get_ can be carried out.

Use references

Select this option to set filters for the retrieved data.

To set a filter, add a row in the References table by clicking the plus button on the bottom of the table, click the Reference name column and select a field from the drop-down list, click the Type column and select a type from the drop-down list, and then enter a value in the Value column. Note that the items appear in the drop-down lists in the Reference name column and the Type column only when all the information that is necessary to connect to the Workday server is provided.

Use criteria

Select this option to set criteria for the retrieved data.

To set a criterion, add a row in the Criteria table by clicking the plus button on the bottom of the table. Click the Name column and select a field from the drop-down list. Click the Compound type column and select a type from the drop-down list. Then, enter a value in the Value column and the Group ID column if needed. The Group ID column can be used if you need to group rows with the same name. Note that the items appear in the drop-down lists in the Name column and the Compound type column only when all the information that is necessary to connect to the Workday server is provided.

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the Job level as well as at each component level.

Endpoint pattern

Enter the endpoint pattern.

• This field is available only when you select OAuth JWT authentication from the Authentication mode drop-down list.
• The actual endpoint pattern needs to adapt to the customer endpoint based on the above endpoint patterns. For example, if you connect to Workday using https://wd5-impl-services1.workday.com/ccx/service/customreport2/{tenant_alias}/{report_owner}/{report_name}, you need to change the first part of the endpoint pattern from wd2-impl-services1.workday.com to wd5-impl-services1.workday.com accordingly. You can modify the endpoint pattern manually in the Endpoint pattern field.
• This field is available when you have installed the 8.0.1-R2022-12 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.

Enter the authentication endpoint.

This field is available when you select REST - Client ID authentication mode from the Authentication mode in the Basic settings view.

Enter the Web service endpoint.

API version

Set the version of the API you want to use.

This field is available when you select the Workday web services item from the Mode drop-down list in the Basic settings view.

ERROR_MESSAGE

The error message generated by the component when an error occurs. This is an After variable and it returns a string.

NB_LINE

The number of rows processed. This is an After variable and it returns an integer.

Usage rule

This component is usually used as a start component of a Job or subJob and it always needs an output link.