Creating and using a synonym file

You can use a synonym file to configure automatic mapping of input to output elements in the Auto map wizard (automap). You can use either a Tab delimited .txt file or a comma delimited .csv synonym file. You can create a synonym file manually or generate a synonym file from the information that is contained in a Microsoft Excel spreadsheet.

Procedure

Complete the following steps to configure Auto map to use a synonym file that is created from the information that is contained in a Microsoft Excel spreadsheet:

  1. Optional: Create a synonym file where the original mapping requirement is written in Microsoft Excel. The following set of instructions describe how to create a synonym file where the original mapping requirement is written in Microsoft Excel. If your original requirement is written in a table in Word, you must copy and paste the table into Microsoft Excel before you begin.
    1. Select the section of the Microsoft Excel spreadsheet that you require.
      For example, if you have a Product that you want to map to a Part number, select that section of the spreadsheet.
    2. Remove all columns from the spreadsheet, except the ones that contain the input field name and the output field name.
      You might have to edit some of the cells. For example, if your mapping instruction includes the phrase based on, remove this phrase.
    3. If the input or output fields contain paths, remove the paths to leave only the short names of the item.
      However, it is helpful to sort the column before you remove the paths. Sorted path names can indicate which is the best input or output to select when you start the action. If all the interested inputs or outputs start with the same path prefix, you might consider selecting the lowest input (or output) node in the tree, which has that common path prefix.
    4. Remove all rows that do not have an input field name and an output field name.
      For example, if you have an obsolete product that no longer has a part number and you have n/a in the input, remove that row.
    5. Select the Save As function in Microsoft Excel to save the spreadsheet into a format that is supported by IBM® App Connect Enterprise Toolkit.
      You can use either a Tab delimited .txt file or a comma delimited .csv file. A comma delimited file can be opened with Microsoft Excel. The file can also be opened in a text editor.
  2. Create the mappings by using the synonym file. Select the options in the Auto map wizard that match your requirements.
    For example, select the default options of Map all simple descendants of the selected elements and Alphanumeric characters (Letters and digits only).

    When you choose these options, select Create transforms when the input and output names are matched to synonyms defined in a file.

    If you want to map same-name inputs to outputs, and the synonym file does not contain rows with those names (for example a row with car,car), select the Create transforms when the names of inputs and outputs are the same option, in addition to the Create transforms when the input and output names are matched to synonyms defined in a file option.

    You can select both Create transforms when the names of inputs and outputs are the same and Create transforms when the names of inputs and outputs are more similar than, in addition to Create transforms when the input and output names are matched to synonyms defined in a file, if your synonym file does not contain a row color,color and you want to map between them.

  3. Click Finish.