August 16, 2023

tMSAXOutput – Docs for ESB 6.x

tMSAXOutput

Writes data in a MicrosoftAX server.

tMSAXOutput Standard properties

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

The Standard
tMSAXOutput component belongs to the Business family.

The component in this framework is generally available.

Basic settings

Property type

Either Built-in or Repository.

 

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.

Version

Select the type of the business connector to be used. The type may be:

  • Dynamics AX
    4.0

  • Dynamics AX
    2012

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

Global Variables

NB_LINE: the number of rows read by an input component or
transferred to an output component. This is an After variable and it returns an
integer.

NB_LINE_UPDATED: the number of rows updated. This is an
After variable and it returns an integer.

NB_LINE_INSERTED: the number of rows inserted. This is an
After variable and it returns an integer.

NB_LINE_DELETED: the number of rows deleted. This is an
After variable and it returns an integer.

NB_LINE_REJECTED: the number of rows rejected. This is an
After variable and it returns an integer.

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

Usage rule

This component is used as an output component. An Input component
is required.

Note:

Dynamics AX 2012 type
only.

.NET Business Connector Assembly
Path

 

Host

Note:

Dynamics AX 2012 type
only.

Port

Note:

Dynamics AX 2012 type
only.

AOS Server Instance

 

Domain

 

User and Password

Note:

Dynamics AX 2012 type
only.

Company

Note:

Dynamics AX 2012 type
only.

Language

Note:

Dynamics AX 2012 type
only.

Configuration File

 

Table Name

 

Action
on data

 

Schema and Edit
Schema

 

Die on error

 

Additional Columns

Scenario 1: Inserting data in a defined table in a MicrosoftAX server

Warning:

Before being able to use this component, make sure that you install and
launch the MicrosoftAX server correctly.

This Java scenario describes a two-component Job that uses tMSAXOutput to insert four columns in a defined table in a MicrosoftAX
server after it alters values in one of the inserted columns.

Use_Case_tMSAXOutput.png

Setting up the Job

  1. Drop tFixedFlowInput and tMSAXOutput from the Palette to the design workspace.
  2. Connect the two components together using a Row > Main
    connection.

Configuring tFixedFlowInput

  1. Double-click tFixedFlowInput to display
    its Basic settings view and define the
    component properties.

    Use_Case_tMSAXOutput1.png

  2. Set Schema type to Built-in and click the three-dot button next to Edit schema to display a dialog box where you can
    define the input schema.
  3. Click the plus button and add the input schema columns, three in this
    example: name, city and
    street.
  4. Click OK to close the dialog box and
    accept propagating the changes when prompted by the system.

    The three schema columns display automatically in the Values list.
  5. Click in the Value column and enter a
    value for each of the input columns.

Configuring tMSAXOutput

  1. Double-click tMSAXOutput to open its
    Basic settings view and define the
    component properties.

    Use_Case_tMSAXOutput2.png

  2. Set Property type to Built-in.
  3. In the Host field, type in the IP address
    of the MicrosoftAX server and type in the domain name on which the
    MicrosoftAX server is hosted in the Domain
    field.
  4. Enter your username and password for the server in the corresponding
    fields and enter the name of the table you want to write data in the
    Table Name field,
    ADDRESS in this example.
  5. In the Action on data list, select the
    action you want to carry on, Insert in this
    example.
  6. Click Sync columns to retrieve the schema
    from the preceding component.

    In this example, we want to retrieve the three input columns:
    name, city and street and
    write the data included in the three input columns in the MicrosoftAX server
    without any changes.
    If needed, click the three-dot button next to Edit
    Schema
    to verify the retrieved schema.
  7. In the Additional columns list, click the
    plus button to add one line where you can define parameters for the new
    column to add to the row you want to write in the
    ADDRESS table.
  8. Set a name, a data type, a position and a reference column in the
    corresponding columns for the line you added.

    In this example, we want to add a new column we call
    “address” after the street
    column.
  9. Click in the Local expression column and
    press Ctrl + space on your keyboard to open
    the context variable list and select:
    StringHandling.UPCASE(row2.city)+"-"+row2.street. This
    expression will write the city name initially capped followed by the street
    name to form the address of Bryant park. Thus the
    address column in this example will contain the string: New
    York-Midtown Manhattan
    .

Job execution

Save your Job and press F6 to execute
it.

tMSAXOutput inserts in the
ADDRESS table in the MicrosoftAX server a row that
holds the three input columns, name,
city and street in addition to
the new address column that combines the city name and
the street name.

Scenario 2: Deleting data from a defined table in a MicrosoftAX server

Warning:

Before being able to use this component, make sure that you install and
launch the MicrosoftAX server correctly.

This Java scenario describes a two-component Job that uses tMSAXOutput to delete from a defined table in a MicrosoftAX server all
rows that do not match the data included in a key column.

In this example, the input schema we use is an address column
that holds the following data: New York-Midtown Manhattan. We want
to delete from the MicrosoftAX server all addresses that are not identical with this
one.

Use_Case_tMSAXOutput3.png

Setting up the Job

  1. Drop tFixedFlowInput and tMSAXOutput from the Palette to the design workspace.
  2. Connect the two components together using a Row > Main
    connection.

Configuring tFixedFlowInput

  1. Double-click tFixedFlowInput to display
    its Basic settings view and define the
    component properties.

    Use_Case_tMSAXOutput4.png

  2. Set Schema type to Built-in and click the three-dot button next to Edit schema to display a dialog box where you can
    define the input schema.
  3. Click the plus button and add the input schema columns,
    address in this example.
  4. Click OK to close the dialog box. The
    schema column displays automatically in the Values list.
  5. Click in the Value column and enter a
    value for the input column.

Setting up the connection to the MicrosoftAX server

  1. Double-click tMSAXOutput to open its
    Basic settings view and define the
    component properties.

    Use_Case_tMSAXOutput5.png

  2. Set Property type to Built-in.
  3. In the Host field, type in the IP address
    of the MicrosoftAX server.
  4. In the Domain field, type in the domain
    name on which the MicrosoftAX server is hosted.
  5. Enter your username and password for the server in the corresponding
    fields.
  6. In the Table Name field, enter the name
    of the table you want to delete data from, ADDRESS in
    this example.

Defining the action on data

  1. In the Action on data list, select the
    action you want to carry on, Delete in this
    example.
  2. Click Sync columns to retrieve the schema
    from the preceding component. In this example, we want to retrieve the input
    column: address.
  3. Click the three-dot button next to Edit
    Schema
    to open a dialog box where you can verify the
    retrieved schema.

    Use_Case_tMSAXOutput6.png

  4. In the output schema, select the Key
    check box next to the column name you want to define as a key column, and
    then click OK to validate your changes and
    close the dialog box.

    Note:

    When you select Delete as an action
    on data, you must always define the Reference
    column
    as a key column in order for tMSAXOutput to delete rows based on this key
    column.

  5. In the Additional columns list, click the
    plus button to add one line and define the parameters the component will use
    as basis for the delete operation.
  6. Set a name, an operator, a data type, a local expression, a position and a
    reference column in the corresponding columns for the line you added.

    In this example, we want to delete from the ADDRESS
    table in the MicrosoftAX server all rows in which the address column is not
    equal to the address in the key address column and that
    reads as the following: New York-Midtown Manhattan.
    Note:

    When you select Delete as an action
    on data, you must always set Position
    to Replace. Otherwise, all settings in
    the Additional columns will not be
    taken into account when executing your Job.

Job execution

Save your Job and press F6 to execute
it.

tMSAXOutput deletes from the
ADDRESS table in the MicrosoftAX server all rows
where the address string is not equal to the address in the key column.


Document get from Talend https://help.talend.com
Thank you for watching.
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x