August 17, 2023

tSageX3Output – Docs for ESB 5.x



tSageX3Output Properties

Component family

Business/Sage X3



This component connects to the Web service provided by a given
Sage X3 Web server and therefrom insert, update or delete data in
the Sage X3 system (the X3 server).


This component writes data into a given Sage X3 system.

Basic settings

Schema and Edit

A schema is a row description. It defines the number of fields 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

  • 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

  • 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

Click Sync columns to retrieve the schema from the
previous component connected in the Job.



Built-in: No property data stored



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

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.



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:

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




A third party tool is needed to retrieve this kind of


Publication name

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



You can do any of the following operations on the data in a Sage
X3 system:

Insert: insert data

Update: update data

Delete: delete data



Complete this table to map the variable elements of the object,
the list or the sub-program your Studio access. Only the elements
you need to conduct the data action of your interest on are selected
and typed in for the purpose of mapping. The columns to be completed

Column: the columns defined in the
schema editor for this component.

Key: the variable element used as
key for data insertion, update or deletion. Select the corresponding
check box if a variable element is the key. 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 selected variable element.

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 +
to access the variable list and choose the variable to use from it.

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


Usually used as an output component. An input component is



Scenario: Using a Sage X3 Web service to insert data into a given Sage X3

This scenario describes a two-component Job used to generate one row of data and
insert the data into a given Sage X3 system. You can find the data used in this scenario
in the example provided by Sage X3. The Sage X3 Web service is used to access an


Setting up the Job

  1. Drop the tFixedFlowInput and the
    tSageX3Output components onto the
    workspace from Palette.

  2. Connect the tFixedFlowInput component to
    the tSageX3Output component using a
    Row > Main connection.

Configuring the schema for the input data

  1. Double-click the tFixedFlowInput
    component to set its Basic Settings in the
    Component view

  2. Click the three-dot button next to Edit
    to open the schema editor.

  3. In the schema editor and then under the schema table, click the plus
    button four times to add four rows.

  4. Click OK to validate this changes and
    then accept the propagation prompted by the pop-up dialog box. The four rows
    appear automatically in the Values table of
    the Component view.

  5. In the Values table within the Mode area, type in the values for each of the
    four rows in the Value column. In this
    scenario, the values downward are:



    These values in the Value column must be put between quotation

Setting up the connection to the Sage X3 Web server

  1. Double-click tSageX3Output to set its
    properties from the Basic Settings view.

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

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

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

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

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

  7. In the Action field, select insert from the drop-down list.

Setting up the mapping

  1. In the Field name column of the Mapping table, type in the field names of the
    attributes the selected data action is exercised on.

  2. In the Group ID column of the Mapping table, type in values corresponding to
    group IDs of the selected attributes. These IDs are defined in the Sage X3
    Web server



    In the Mapping table, the Column column has been filled automatically
    with the columns retrieved from the schema of the preceding

Job execution

Press CTRL+S to save your Job and press F6 to
execute it.

To verify the data that you inserted in this scenario, you can use the tSageX3Input component to read the concerned data from
the Sage X3 server.

For further information about how to use the tSageX3Input component to read data, see Scenario: Using query key to extract data from a given Sage X3 system.

Document get from Talend
Thank you for watching.
Notify of
Inline Feedbacks
View all comments
Would love your thoughts, please comment.x