tSageX3Input - 6.3

Talend Open Studio for Big Data Components Reference Guide

EnrichVersion
6.3
EnrichProdName
Talend Open Studio for Big Data
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Function

This component leverages the Web service provided by a given Sage X3 Web server to extract data from the Sage X3 system (the X3 server).

Purpose

This component extracts data from a given Sage X3 system.

tSageX3Input Properties

Component family

Business/Sage X3

 

Basic settings

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. The schema is either Built-In or stored remotely in the Repository.

Since version 5.6, both the Built-In mode and the Repository mode are available in any of the Talend solutions.

Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:

  • 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.

 

 

Built-in: No property data stored centrally.

 

 

Repository: Select the repository file where properties are stored. The fields that come after are pre-filled in using the fetched data.

 

Endpoint address

Type in the address of the Web service provided by the given Sage X3 Web server.

 

Username and Password

Type in the Web service user authentication data that you have defined for configuring the Sage X3 Web server.

To enter the password, click the [...] button next to the password field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

 

Language

Type in the name of the X3 language code used to start a connection group.

 

Pool alias

Type in the name of the connection pool that distributes the received requests to available connections. This name was given from the Sage X3 configuration console.

 

Request config

Type in the configuration string if you want to retrieve the debug or trace information. For example, the string could be:

RequestConfigDebug="adxwss.trace.on=on";

If you need to use several strings, separate them with a &, for example,

RequestConfigDebug="adxwss.trace.on=on&adxwss.trace.size=16384";

Warning

A third party tool is needed to retrieve this kind of information.

 

Publication name

Type in the publication name of the published object, list or sub-program you want your Studio to access.

 

Action

Select in the list the action to be carried on.

  • getAllDetails: returns the details of all the records.

  • getSummary: returns the summary of each record.

  • getDetail: returns the details of the records that meet the conditions configured in the Query condition table.

 

Mapping

Complete this table to map the variable elements of the object, the sub-program or the list set in the given Sage X3 Web server. The columns to be completed include:

Column: the columns defined in the schema editor for this component.Group ID: the identifier of each variable element group. For example, a variable element group could represent one of attributes of an object.Field name: the field name of each variable element.

 

Conditions

Complete this table to set up the query condition(s). The columns to be completed include:

Key: the names of the variable elements used as the key for data extraction.

Value: the value of the given key field used to extract the corresponding data.

Available when getDetail is selected in the Action list.

 

Query condition

Select this check box to set up the query condition(s). The columns to be completed include:

Key: the names of the variable elements used as the key for data extraction.

Value: the value of the given key field used to extract the corresponding data.

Not available when getDetail is selected in the Action list.

 

Limit

Type in a number to indicate the maximum row count of the data to be extracted.

Not available when getDetail is selected in the Action list.

Advanced settings

tStatCatcher Statistics

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

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. This variable functions only if the Die on error check box is cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl + Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio User Guide.

Usage

Usually used as a Start component. An output component is required.

Limitation

n/a

Scenario: Using query key to extract data from a given Sage X3 system

This scenario describes a two-component Job used to extract one row of data from a given Sage X3 system. The object method is to be called, that means the variable elements of this object thus are attributes. The data used in this scenario can be found in the example provided by Sage X3.

Setting up the Job

  1. Drop the tSageX3Input component and the tLogRow components onto the workspace from Palette.

  2. Connect the tSageX3Input component to the tLogRow component using a Row > Main link.

Configuring the schema of tSageX3Input

  1. Double-click tSageX3Input to set its properties in the Basic Settings view.

  2. In the Schema field, select Built-In and click the three-dot button next to Edit schema to open the schema editor.

  3. In this editor, click the plus button 12 times beneath the schema table to add 12 rows into this table.

  4. Type in the names you want to use for each row. In this example, these rows are named after the publication names of the object attributes set in the Sage X3 Web server. These columns are used to map the corresponding attribute fields in the Sage X3 system.

  5. In the Type column, click the IMG row to display its drop-down list.

  6. From the drop-down list, select List as this attribute appears twice or even more and do the same to switch the types of the TIT2NBLIG row, the ITMLNK row and the ZITMLNK row to List as well for the same reason.

  7. Click OK to validate this change and accept the propagation prompted by a pop-up dialog box.

Configuring the connection to the Sage X3 Web server

  1. In the Endpoint address field, type in the URL address of the Web service provided by the Sage X3 Web server. In this example, it is http://10.42.20.168:28880/adxwsvc/services/CAdxWebServiceXmlCC

  2. In the User field, type in the user name of the given Sage X3. In this example, it is ERP.

  3. In the Language field, type in the name of the X3 language code used to start a connection group. In this example, it is FRA.

  4. In the Pool alias field, type in the name of connection pool to be used. In this example, this connection pool is called TALEND.

  5. In the Publication name field, type in the publication name of the object to be called. In this scenario, the publication name is ITMDET.

Setting up the mapping and configuring the query condition

  1. In the Group ID column and the Field name column of the Mapping table, type in values corresponding to the attribute group IDs and the attribute publication names defined in the Sage X3 Web server. In this example, the values are presented in the figure below.

    Note

    In the Mapping table, the Column column has been filled automatically with the columns you created in the schema editor.

  2. Select the Query condition check box to activate the Conditions table.

  3. Under the Conditions table, click the plus button to add one row into the table.

  4. In the Key column, type in the publication name associated with the object attribute you need to extract data from.

  5. In the Value column, type in the value of the attribute you have selected as the key of the data extraction. In this scenario, it is CONTS00059, one of the product references.

Job execution

  1. Press Ctrl+S to save your Job.

  2. Press F6 or click Run on the Run tab to execute the Job.

    The results are displayed on the Run console: