tWorkdayOutput Standard properties - Cloud

These properties are used to configure tWorkdayOutput running in the Standard Job framework.

The Standard tWorkdayOutput component belongs to the Business and the Cloud families.

The component in this framework is available in all subscription-based Talend products.

Note: This component is available only when you have installed the 8.0.1-R2022-09 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.

Basic settings

Property Type	Select the way the properties will be set. Two options are provided: Built-In and Repository. Built-In: Use the properties set for the current component in the Basic settings and Advanced settings views. Repository: Use the properties stored in the repository.
Schema and Edit schema	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.
Guess schema	Click this button to generate the schema based on the Workday client credentials provided. Click this button after you have provided all the necessary information for connecting the Workday server.
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. Note: The OAuth JWT authentication option applies to the Workday web services mode only. You can select the Workday web services mode from the Mode drop-down list. The OAuth JWT authentication option is available only 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.
Client Identifier	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.
Client Secret	Click […] and enter the Client secret key of the API Client used to connect to Workday in double quotation marks. To enter the client secret, click the [...] button next to the Client secret field to bring out the Enter a new password dialog box, enter the client secret in the text field, and click OK. Note that you can enter the client secret either in a JSON string in the pure password mode or as a Java expression in the Java mode. You can toggle between the two modes by clicking switch to Java mode or switch to pure password mode on the top of the text field. This field is available when you select REST - Client ID authentication mode (deprecated) from the Authentication mode drop-down list.
User login	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.
User password	Click […] and enter the password for the SOAP login authentication mode. To enter the user password, click the [...] button next to the User password field to bring out the Enter a new password dialog box, enter the user password in the text field, and click OK. Note that you can enter the user password either in a JSON string in the pure password mode or as a Java expression in the Java mode. You can toggle between the two modes by clicking switch to Java mode or switch to pure password mode on the top of the text field. This field is available when you select SOAP - Login authentication mode from the Authentication mode drop-down list.
Tenant Alias	Enter the Tenant ID that allows you to connect to Workday. The tenant alias is provided by your Workday administrator.
Mode	Select the mode for writing 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, only the Workday web services mode takes 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. Note: In the OAuth JWT authentication mode, you need to set a specific endpoint in the Endpoint pattern field in the Advanced settings view for the mode selected in the Mode drop-down list. The Workday web services item is available only when you have installed the 8.0.1-R2022-08 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
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. Note: The WS Security with JWT authentication security type is implemented by the OAuth JWT authentication mode if you have installed the 8.0.1-R2022-12 Talend Studio Monthly update or a later one delivered by Talend. You can enable OAuth JWT authentication by selecting OAuth JWT authentication from the Authentication mode. For more information, check with your administrator.
Login and Password	Enter the username and password for the SOAP - WS-Security authentication mode. To enter the password, click the [...] button next to the Password field to bring out the Enter a new password dialog box, enter the password in the text field, and click OK. Note that you can enter the password either in a JSON string in the pure password mode or as a Java expression in the Java mode. You can toggle between the two modes by clicking switch to Java mode or switch to pure password mode on the top of the text field. 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. Note: This field is available when you select WS Security with certificate authentication from the WS -Security type drop-down list.
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. Note: This field is available when you select WS Security with certificate authentication from the WS-Security type drop-down list.
Private key	Enter the private key. To enter the private key, click the [...] button next to the Private key field to bring out the Enter a new password dialog box, enter the private key in the text field, and click OK. Note that you can enter the private key either in a JSON string in the pure password mode or as a Java expression in the Java mode. You can toggle between the two modes by clicking switch to Java mode or switch to pure password mode on the top of the text field. 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.
WQL Query	Enter Workday query language statements for writing client data. This field is available when Workday query language is selected from the Mode list.
Report Owner	Enter the report owner for the client data to be written. 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 to be written. This field is available when Report as a service is selected from the Mode list.
Service	Enter the names of the Workday services to write data to. 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. Note: This field is available when you select Workday web services from the Mode drop-down list.
Operation	Enter the names of the operations to be carried out to the data to be written. 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. Note: This field is available when you select Workday web services from the Mode drop-down list.

Advanced settings

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. In the OAuth JWT authentication mode, only the Workday web services mode is supported and the endpoint pattern needs to be `https://wd2-impl-services1.workday.com/ccx/service/${tenant}`. In the OAuth JWT authentication mode, the endpoint patterns are preset in a list box. So, in addition to entering the endpoint address manually in the Endpoint pattern field, you can also access the list box and select the preset endpoint pattern from the list box. You can access the list box by clicking [...] next to the field. Note: 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 pattern. 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.
Authentication endpoint	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.
Service endpoint	Enter the Web service endpoint. In the SOAP - WS-Security authentication mode, the component can work properly only when you set the service endpoint as the following. Set the service endpoint to `https://wd2-impl-services1.workday.com/ccx/service/customreport2/${tenant}` if you select Report as a service from the Mode drop-down list. Set the service endpoint to `https://wd2-impl-services1.workday.com/ccx/service/${tenant}` if you select Workday web services from the Mode drop-down list. In the SOAP - WS-Security authentication mode, the two endpoint addresses are preset in a list box. So, in addition to entering the endpoint address manually in the Service endpoint field, you can also access the list box and select a preset endpoint address from the list box. You can access the list box by clicking [...] next to the field. Note: The two preset endpoint addresses and the [...] button are available only when you select SOAP - WS-Security authentication mode from the Authentication mode drop-down list. This field defaults to `https://wd2-impl-services1.workday.com/ccx/service/customreport2/${tenant}`. You need to change it explicitly if you select Workday web services from the Mode drop-down list. The actual service endpoint needs to adapt to the customer endpoint based on the above two service endpoints. 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 service endpoint from `wd2-impl-services1` to `wd5-impl-services1` accordingly. You can modify the service endpoint manually in the Service endpoint field.
API version	Set the version of the API you want to use.
Request link	Click the [...] button next to this field to have the link to your request string displayed in this field. You can check your request string generated in a browser by copying the link and pasting it in the address bar of the browser. Note that the link can be generated only when you have entered your user account credentials and set the service and the operation properly in the Basic settings view. This field provides a way for users to check their requests and is not necessary for the component to work.

Global Variables

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

Usage rule	This component is usually used as an end component of a Job or subJob and it always needs an input link.