tHMap – Docs for ESB 5.x

Note

For further information about performing transformations using Talend Data Mapper, see Talend Data Mapper User
Guide.

Copying an editable version of the example files

1. In the Mapping perspective, in
   the Data Mapper view, expand the Hierarchical Mapper node and the Other Projects folder, right-click Examples and then select Copy in the contextual menu.

2. In the Data Mapper view, right-click at the
   root of the Hierarchical Mapper node, and then
   select Paste in the contextual menu.

   This copies an editable version of all the read-only example files to your
   local workspace.

Adding and linking the components

1. In the Integration perspective,
   create a new Job and call it tdm_to_tdm.

2. Click the point in the design workspace where you want to add the first
   component, start typing tFileInputRaw, and then
   click the name of the component when it appears in the list proposed in order to
   select it.

3. Do the same to add a tHMap component and a
   tFileOutputRaw component as well.

4. Connect the tFileInputRaw component to the
   tHMap component using a Row > Main link and rename it input, then connect the tHMap
   component to the tFileOutputRaw component using
   a Row > Main link and name it output. When you are asked if you want to get the
   schema of the target component, click Yes.

Defining the properties of tFileInputRaw

1. Select the tFileInputRaw component to define
   its properties.

   

2. In the Basic settings tab, click the
   […] button next to the Filename field then browse to the location on your
   file system where the input file is stored, or enter the path manually between
   double quotes. For this example, use <PATH_TO_WORKSPACE>/<PROJECT_NAME>/Sample
   Data/CSV/PurchaseOrderPayPal/PayPalPO.csv.

3. Set the Mode as Read
   the file as a string, and leave all the other parameters
   unchanged.

Defining the properties of tFileOutputRaw

1. Select the tFileOutputRaw component to define
   its properties.

   

2. In the Basic settings tab, click the
   […] button then browse to the location on
   your file system where the output file is to be stored, or enter the path
   manually between double quotes. Leave the other parameters unchanged.

Defining the properties of tHMap

1. Select the tHMap component to define its
   properties.

   

2. Click the […] button next to the Map Path field to open the picker and select the map
   to use, Maps/CSV/POPayPalCsv_PO2, then click
   OK. This map transforms a CSV file into an
   XML file.

3. Set Read Input As to Single Column.

4. Set Write Output As to String (single column).

Saving and executing the Job

1. Press Ctrl+S to save your Job.

2. In the Run tab, click Run to execute the Job.

3. Browse to the location on your file system where the output file is stored to
   check that an XML file has been created containing the same data as the input
   CSV file.

Copying an editable version of the example files

1. In the Mapping perspective,
   in the Data Mapper view, expand the
   Hierarchical Mapper node and the
   Other Projects folder, right-click
   Examples and then select Copy in the contextual menu.

2. In the Data Mapper view, right-click at
   the root of the Hierarchical Mapper node,
   and then select Paste in the contextual
   menu.

   This copies an editable version of all the read-only example files to your
   local workspace.

Adding and linking the components

1. In the Integration
   perspective, create a new Job and call it di_to_di.

2. Click the point in the design workspace where you want to add the first
   component, start typing tFileInputDelimited, and then click the name of the component
   when it appears in the list proposed in order to select it.

3. Do the same to add a tHMap component and
   a tFileOutputXML component as well.

4. Connect the tFileInputDelimited component
   to the tHMap component using a Row > Main link, then connect the tHMap component to the tFileOutputXML component using a Row >
   Main link.

Defining the properties of tFileInputDelimited

1. Select the tFileInputDelimited component
   to define its properties.

   

2. In the Basic settings tab, click the […] button next to the Filename field then browse to the location on your file system
   where the input Excel file is stored, or enter the path manually between
   double quotes. For this example, use <PATH_TO_WORKSPACE>/<PROJECT_NAME>/Sample
   Data/CSV/PurchaseOrderPayPal/PayPalPO.csv.

3. Select the CSV options check box.

4. Change the Field Separator to a comma,
   between double quotes (“,”).

5. Change the value of Header to 1.

6. Click the […] button next to Edit schema to define the schema.

7. Add three columns and rename them txn_id, payment_date and
   first_name (which correspond to the
   names of the first three columns in the input file, and is sufficient for
   the purposes of this example), and then click OK.

8. Leave all the other parameters unchanged.

Defining the properties of tFileOutputXML

1. Select the tFileOutputXML component to
   define its properties.

   

2. In the Basic settings tab, click the
   […] button next to the File Name field then browse to the location on
   your file system where the output file will be stored, or enter the path
   manually between double quotes.

3. Click the […] button next to Edit schema to define the schema.

4. Add three columns to the input schema on the left and rename them
   id, date and name, copy them
   to the output schema on the right, and then click OK.

5. Leave the other elements unchanged.

Defining the properties of tHMap

1. Select the tHMap component to define its
   properties.

   

2. Click the […] button next to the
   Open Map Editor field to create a new
   map based on the input and output of tHMap.

3. In the tHMap Structure Generate/Select
   dialog box that opens, select Generate hierarchical
   mapper structure based on the schema and then click Next to generate the input structure.

4. Do the same for the output structure.

5. In the Mapping perspective
   that opens, drag the txn_id element of
   Input (map) to the id element of Output
   (map). Do the same to map payment_date to date and
   first_name to name, and then save your changes.

   

6. In the Integration
   perspective, in the Job, check that Read Input
   As is set to Data Integration
   columns.

Saving and executing the Job

1. Press Ctrl+S to save your Job.

2. In the Run tab, click Run to execute the Job.

3. Browse to the location on your file system where the output file is stored
   to check that an XML file has been created containing the same data as the
   input CSV file.

Creating a new structure in the Mapping perspective

1. In the Mapping perspective, in
   the Data Mapper view, expand the Hierarchical Mapper node, right-click Structures and then select New > Structure.

2. In the [New Structure] dialog box that opens,
   select Create a new structure where you manually enter
   elements, and then click Next.

3. Name your structure JSON_structure, and
   then click Next.

4. In the [Select Representation] dialog box,
   select JSON from the list of available
   representations, and then click Next.

5. Select Don’t select a sample document for
   now, and then click Finish.

Entering the elements for your new structure

1. In the Mapping perspective, in
   the Data Mapper view, expand the Hierarchical Mapper node and the Structures node, and then open the JSON_structure structure you created
   earlier.

2. In the JSON_structure, right-click to add a
   new element, click New element and name the new
   element Root.

3. Follow the same steps to create a new element called people under the Root
   element, a person element under people, and four new elements under the person element: firstname, lastname,
   address and city.

4. For the person element, change the
   Occurs Max value to -1 (unlimited).

   

5. Press Ctrl + S to save your changes.

Adding and linking the components

1. In the Integration perspective, in the
   Repository, right-click Job Designs, and then click Create Job to create a Job named di_to_json. Add a Purpose and
   Description if you wish, and then click
   Finish.

2. Click the point in the design workspace where you want to add the first
   component, start typing tRowGenerator, and then
   click the name of the component when it is displayed in the list proposed in
   order to select it.

3. Do the same to add a tHMap component, and a
   tFileOutputRaw component as well.

4. Connect the tRowGenerator component to the
   tHMap component using a Row > Main link, then connect the tHMap component to the tFileOutputRaw component using a Row >
   Main link. When you are asked if you want to get the schema of
   the target component, click Yes.

Defining the properties of tRowGenerator

1. Select the tRowGenerator component to define
   its properties.

2. In the Basic settings tab, click the
   […] button next to RowGenerator Editor to define the rows to be generated.

3. In the dialog box that opens, click four times the [+] button to add four new columns to the schema, and name them
   firstname, lastname, address and
   city.

4. For each of the columns you just added, change the function to match what is
   shown in the table below by clicking in the Functions column and scrolling through the list of available
   functions until you find the one you want, and then click OK when you’re done.

   firstname	TalendDataGenerator.getFirstName
   lastname	TalendDataGenerator.getFirstName
   address	TalendDataGenerator.getUsStreet
   city	TalendDataGenerator.getUsCity

Defining the properties of tFileOutputRaw

1. Select the tFileOutputRaw component to define
   its properties.

2. In the Basic settings tab, click the
   […] button then browse to the location on
   your file system where the output file is to be stored, or enter the path
   manually between double quotes, and call the output file output.json

   Leave the other parameters unchanged.

Defining the properties of tHMap

1. Select the tHMap component to define its
   properties.

   

2. Click the […] button next to the Open Map Editor field to create a new map.

3. In the [tHMap Structure Generate/Select]
   dialog box that opens, select Generate hierarchical mapper
   structure based on the schema for the input structure, and then
   click Next and then Finish. This means that Talend Data Mapper will
   automatically generate a structure for you, based on the schema of the input
   component (tRowGenerator in this case).

4. For the output structure, select Select an existing
   hierarchical mapper structure, and then click Next.

5. Select the JSON_structure structure that
   you created earlier, and then click Next and
   then Finish.

6. In the Mapping perspective that opens, drag
   row from Input
   (Map) to person in Output (JSON) to map each of the input elements to
   its corresponding output element.

   

7. Double click SimpleLoop in Loop tab and, in the properties box that opens, check
   Stream Input and then click OK.

8. Press Ctrl+S to save your changes to the
   map.

9. Switch back to the Integration perspective to
   complete the settings for the tHMap component
   in your Job.

10. Set Read Input As to Data Integration columns.

11. Set Write Output As to InputStream (single column).

Saving and executing the Job

1. Press Ctrl+S to save your Job.

2. In the Run tab, click Run to execute the Job.

3. Browse to the location on your file system where the output file is stored to
   check that a JSON file showing the expected data has been successfully
   created.

Adding and linking the components

1. In the Integration perspective,
   create a new Job and call it error_handling.

2. Click the point in the design workspace where you want to add the first
   component, start typing tFixedFlowInput, and
   then click the name of the component when it appears in the list proposed in
   order to select it.

3. Do the same to add a tHMap component, a
   tJavaRow component, and three tJava components as well.

4. Connect the tFixedFlowInput component to the
   tHMap component using a Row > Main link, then connect the tHMap component to the tJavaRow component using a Row >
   Main link and rename the link out. When you are asked if you want to get the schema of the
   target component, click Yes.

5. Connect the tFixedFlowInput component to the
   first tJava component using an OnSubjobError trigger and to the second tJava component using an OnSubjobOk trigger, then connect the tHMap component to the third tJava component using a RunIf
   trigger.

Defining the properties of the RunIf trigger

1. Select the RunIf trigger to define its
   properties.

2. Add the following code in the Condition
   section.

   !((org.talend.transform.runtime.api.ExecutionStatus) globalMap.get("tHMap_1_EXECUTION_STATUS")).isOK()

   1	!((org.talend.transform.runtime.api.ExecutionStatus) globalMap.get("tHMap_1_EXECUTION_STATUS")).isOK()

Defining the properties of tFixedFlowInput

1. Select the tFixedFlowInput component to
   define its properties.

2. In the Basic settings tab, click the
   […] button next to Edit schema to define the schema.

3. Add one column, of type String, rename it inputKey, and then click OK.

4. In the Mode area. select the Use Inline Table radio button, then add three values
   to the inputKey column by clicking the
   [+]  button and then entering the value
   between double quotes in each case. In this example, the values used are
   value1, value2 and value3.

Defining the properties of tJavaRow

1. Select the tJavaRow component to define its
   properties.

2. In the Basic settings tab, click the
   […] button next to Edit schema to define the schema.

3. Click the [+]  button to add a column to the
   input schema on the left, of type String, rename it outputKey, copy it to the output schema on the
   right, and then click OK.

4. Add the following code in the Code
   section.

   String actualOutput = out.outputKey; System.out.println("======" + actualOutput + "======");

   1 2 3

   String actualOutput = out.outputKey;   System.out.println("======" + actualOutput + "======");

Defining the properties of tHMap

1. Select the tHMap component to define its
   properties.

2. Click the […] button next to the Open Map Editor field to create a new map based on
   the input and output of tHMap.

3. In the tHMap Structure Generate/Select dialog
   box that opens, select Generate hierarchical mapper
   structure based on the schema and then click Next to generate the input structure.

4. Do the same for the output structure.

5. In the Mapping perspective that
   opens, drag the inputKey element of Input (map) to the outputKey element of Output
   (map), and then save your changes.

   

6. Back in the Integration perspective, in
   the tHMap component in your Job, leave the
   value of the Exception Threshold drop-down list
   as Fatal.

7. In the Read Input As area, select the
   Data Integration columns radio
   button.

8. In the Write Output As area, select the
   Data Integration columns radio
   button.

Defining the properties of the first tJava component (OnSubjobError)

1. Select the first tJava component to define
   its properties. This component displays information in the console when the Job
   contains an error.

2. Add the following code in the Code
   section.

   System.out.println("tJava_1: Subjob ERROR"); org.talend.transform.runtime.api.ExecutionStatus es = (org.talend.transform.runtime.api.ExecutionStatus)globalMap.get("tHMap_1_EXECUTION_STATUS"); System.out.println("Execution result:" + es.getOverallSeverity()); // ExecutionStatus object System.out.println(es.toString()); // XML version of ExecutionStatus object java.io.StringWriter sw = new java.io.StringWriter(); es.exportToXml(sw); System.out.println("ExecutionStatus as XML"); System.out.println(sw.toString());

   1 2 3 4 5 6 7 8 9 10 11 12 13 14

   System.out.println("tJava_1: Subjob ERROR");   org.talend.transform.runtime.api.ExecutionStatus es = (org.talend.transform.runtime.api.ExecutionStatus)globalMap.get("tHMap_1_EXECUTION_STATUS");   System.out.println("Execution result:" + es.getOverallSeverity());   // ExecutionStatus object System.out.println(es.toString());   // XML version of ExecutionStatus object java.io.StringWriter sw = new java.io.StringWriter(); es.exportToXml(sw); System.out.println("ExecutionStatus as XML"); System.out.println(sw.toString());

Defining the properties of the second tJava component (OnSubjobOk)

1. Select the second tJava component to define
   its properties. This component displays information in the console when the Job
   runs successfully.

2. Add the following code in the Code
   section.

   System.out.println("tJava_2: Subjob OK"); org.talend.transform.runtime.api.ExecutionStatus es = (org.talend.transform.runtime.api.ExecutionStatus)globalMap.get("tHMap_1_EXECUTION_STATUS"); System.out.println("Execution result:" + es.getOverallSeverity()); // ExecutionStatus object System.out.println(es.toString()); // XML version of ExecutionStatus object java.io.StringWriter sw = new java.io.StringWriter(); es.exportToXml(sw); System.out.println("ExecutionStatus as XML"); System.out.println(sw.toString());

   1 2 3 4 5 6 7 8 9 10 11 12 13 14

   System.out.println("tJava_2: Subjob OK");   org.talend.transform.runtime.api.ExecutionStatus es = (org.talend.transform.runtime.api.ExecutionStatus)globalMap.get("tHMap_1_EXECUTION_STATUS");   System.out.println("Execution result:" + es.getOverallSeverity());   // ExecutionStatus object System.out.println(es.toString());   // XML version of ExecutionStatus object java.io.StringWriter sw = new java.io.StringWriter(); es.exportToXml(sw); System.out.println("ExecutionStatus as XML"); System.out.println(sw.toString());

Defining the properties of the third tJava component (RunIf)

1. Select the third tJava component to define
   its properties. This component runs if any errors occur within the map itself
   (higher than informational status).

2. Add the following code in the Code
   section.

   System.out.println("tJava_3: Run If"); org.talend.transform.runtime.api.ExecutionStatus es = (org.talend.transform.runtime.api.ExecutionStatus)globalMap.get("tHMap_1_EXECUTION_STATUS"); System.out.println("Execution result:" + es.getOverallSeverity()); // ExecutionStatus object System.out.println(es.toString()); // XML version of ExecutionStatus object java.io.StringWriter sw = new java.io.StringWriter(); es.exportToXml(sw); System.out.println("ExecutionStatus as XML"); System.out.println(sw.toString());

   1 2 3 4 5 6 7 8 9 10 11 12 13 14

   System.out.println("tJava_3: Run If");   org.talend.transform.runtime.api.ExecutionStatus es = (org.talend.transform.runtime.api.ExecutionStatus)globalMap.get("tHMap_1_EXECUTION_STATUS");   System.out.println("Execution result:" + es.getOverallSeverity());   // ExecutionStatus object System.out.println(es.toString());   // XML version of ExecutionStatus object java.io.StringWriter sw = new java.io.StringWriter(); es.exportToXml(sw); System.out.println("ExecutionStatus as XML"); System.out.println(sw.toString());

Running the Job under different conditions

1. Press Ctrl+S to save your Job.

2. In the Run tab, click Run to execute the Job.

   In this case, no errors occur, so the Job triggers the second tJava component only.

   

3. Double-click the tHMap component to open the
   Mapping
   perspective.

4. Right-click the outputKey element and click
   Go to Structure Element.

5. Change the tHMap_1_output structure that
   opens from Read Only to Editable and then change the Data
   Type for outputkey to
   Integer (32). This means that this element
   can only be an Integer, and since this does not match the input, an
   error will occur.

   

6. In the Run tab, click Run to execute the Job again.

   In this case, the Job still triggers the second tJava component even though there is an error, because the
   threshold above which an exception should be thrown (thus enabling the
   downstream components to detect the error) is set as Fatal. However, the third tJava
   component is also triggered since there is an error in the execution of the
   map.

   

7. In the tHMap component, change the value of
   the Exception Threshold drop-down list to
   Error. This causes an exception to be
   thrown when the map has a severity of Error
   or higher.

8. In the Run tab, click Run to execute the Job for a third time.

   In this case, the Job detects the error and triggers the first tJava component (OnSubjobError).