Mapping task list

The following task list outlines the steps involved in creating a map, including the steps you must take before and after creating a map. You can use this task list as a checklist each time you create a new map.

  1. From your trading partner agreement, identify the business documents that best fit your business needs using the industry-supplied, national, or international formats. You and your trading partners must agree on what documents to use, and the content and format of the documents to use.
  2. Obtain the business document implementation guide. The implementation guide contains specific information about the content and format of a business document that will be exchanged between you and your trading partner.
  3. Ensure that you understand your source and target data so that you can take the source data and put it into a target business document format.
  4. Create a mapping implementation guide. Determine the relationship of your data with the standard format. You should examine each source document element in your data and make a decision on a corresponding target document element. This enables you to identify mapping commands and additional mapping objects needed during the mapping process. A mapping implementation guide can be very useful during this step.
  5. Create source and target document definitions.
  6. Create additional mapping objects to use during the mapping process, such as translation tables or code lists. In addition, identify if a validation map and functional acknowledgment map are needed.
  7. Create a data transformation map. At this point, use the various available mapping techniques to create a map. This might include a "drag and drop" from a source field to target field, or the specification of an "assignment command" to set a target field to a specific value. Other mapping commands and mapping functions can be use to format data, convert data from one value to another, or qualify the movement of data based on the content of the source message. "Conditional statements" can be used to provide alternate courses of action for the translation engine.
  8. Compile the data transformation map control string.
  9. Export the data transformation map control string.
  10. Create a validation map (if needed).
  11. Compile the validation map control string.
  12. Export the validation map control string.
  13. Create a functional acknowledgment map (if needed).
  14. Compile the functional acknowledgment map control string.
  15. Export the functional acknowledgment map control string.

After the map control strings have been exported, the following tasks can be performed from WebSphere Partner Gateway.

  1. Import all mapping and mapping objects.
  2. Set up partner rules for mapping execution.

The final step is to test the mapping (in WebSphere Partner Gateway) and make any necessary adjustments (in Data Interchange Services client).

Creating database definitions

You create a new database definition whenever you have a database that Data Interchange Services client needs to access. Data Interchange Services client distributes Microsoft Access databases as the local database.

The following steps describe how to create a new database definition.

  1. Open the Databases list window by selecting Databases from the View menu.
  2. Click the New button on the toolbar.
  3. Type the name of the database definition. The name uniquely identifies the name of the database definition. This is a required field.
  4. Type a description of the database.
  5. Select the ODBC Data Source Name (DSN) from the list of defined data source names. This is a required field. The data source name must be defined to Windows before you can select it in a database definition.
  6. Specify the database qualifier if it is required by the database system to identify the database. The database qualifier is used when connecting to multi-user, or server, databases. For instance, on DB2 for Windows this corresponds to the database schema.
  7. Select the Database Type. The database type indicates whether the database is a Data Interchange Services Database or is a Document Manager database.
  8. Click on the Change button if you wish to change the color of the window background for this database. Clicking the Change button opens the Windows Color dialog. Select a color to use as the window background for this database and click the OK button. Click the Cancel button to close the dialog without changing the color for the database.
  9. .Click on the OK button. Data Interchange Services client saves the new database definition and closes the Database editor.

Note:
Data Interchange Services client uses ODBC to access databases. This means that an ODBC Data Source Name (DSN) is required to access each database. The Data Source Name can be any name of your choice. Use the Data Source Administrator tool found within the Control Panel of most Windows systems to define a Data Source Name. Some database tools can automatically establish an ODBC Data Source Name for when you identify the remote database to your system using the database tool. For instance, IBM's DB2 Configuration Assistant can be used to identify a remote DB2 database. It will define the ODBC Data Source Name if you select the appropriate option.

Creating dictionaries

Dictionaries must be created before document definitions can be created. Data Interchange Services client allows you to create three types of dictionaries: XML dictionaries for DTD or schema document definitions, EDI dictionaries for EDI document definitions, and ROD dictionaries for ROD document definitions.

Creating XML dictionaries

DTD or schema document definitions are assigned to an XML dictionary. The XML dictionary must be created before importing the DTD or schema into Data Interchange Services client.

The following steps describe how to create an XML dictionary.

  1. Open the XML Dictionary Definition editor. Do this by clicking the XML button on the main application window, then move to the XML Dictionaries tab and click the New button.
  2. In the General tab of the XML Dictionary Definition editor, type a name for the XML dictionary definition in the Dictionary Definition field.
  3. Continue entering information in the remaining fields, then click the Save button on the menu bar. The new XML dictionary appears at the bottom of the XML Dictionary list window until you re-open it, at which point it appears in alphabetical order.

Creating EDI dictionaries

EDI document definitions are assigned to an EDI dictionary. The EDI dictionary must be created before creating EDI document definitions using Data Interchange Services client.

The following steps describe how to create an EDI dictionary.

  1. Open the EDI Dictionary Definition editor. Do this by clicking the EDI button on the main application window, then move to the EDI Dictionaries tab and click the New button.
  2. In the General tab of the EDI Dictionary Definition editor, type a name for the EDI dictionary definition in the Dictionary Definition field.
  3. Continue entering information in the remaining fields, then click the Save button on the menu bar. The new EDI dictionary appears at the bottom of the EDI Dictionary list window until you re-open it, at which point it appears in alphabetical order.

Creating ROD dictionaries

ROD document definitions are assigned to an ROD dictionary. The ROD dictionary must be created before creating ROD document definitions using Data Interchange Services client.

The following steps describe how to create an ROD dictionary.

Note:
In addition to requiring a ROD dictionary, a ROD document definition also requires a Record ID information object to indicate whether the ROD document definition also uses the Record ID information object to ensure that all loops and records within the ROD document definition use the same Record ID information object.

  1. Open the ROD Dictionary Definition editor. Do this by clicking the ROD button on the main application window, then move to the ROD Dictionaries tab and click the New button.
  2. In the General tab of the ROD Dictionary Definition editor, type a name for the ROD dictionary definition in the Dictionary Definition field.
  3. Continue entering information in the remaining fields, then click the Save button on the menu bar. The new ROD dictionary appears at the bottom of the ROD Dictionary list window until you re-open it, at which point it appears in alphabetical order.

Creating ROD Record ID information objects

You create a new record ID information object when you set up your first ROD document definition or when you set up an ROD document definition whose record IDs are structured differently than your existing data formats. You can use the same record ID information object for any ROD document definition whose record IDs have the same structure or that are set up as C and D records.

The following steps describe how to create a data format record ID information profile.

  1. Open the Record ID Information Object editor. Do this by clicking the ROD button on the main application window, then move to the Record ID Information Objects tab and click the New icon.
  2. In the General tab of the Record ID Information Object editor, enter the following information:
  3. Click the Save button on the toolbar. The new Record ID information object appears at the bottom of the Record ID Information Object list window until you re-open it, at which point it appears in alphabetical order.

Creating document definitions

Data Interchange Services client allows you to create three types of document definitions: XML, EDI, and ROD.

Creating DTD document definitions

You create a new DTD or schema document definition when you plan to process an XML document defined by an XML DTD or schema which has not previously been imported into Data Interchange Services client.

The following steps describe how to create a new DTD or schema document definition.

Note:
DTD and schema document definitions are assigned to an XML dictionary. The XML dictionary must be created before importing the DTD into Data Interchange Services client.

  1. Select Open Import File from the File menu. This opens the Select Import File page.
  2. In the Files of Type drop-down list, select XML DTD File. The window changes so only files with a type of "dtd" are displayed.
  3. Enter the name of the file to select a directory and file name of the DTD to be imported. Click the Open button when you have selected your DTD file. The Select a Database page appears if you have more than one database defined to Data Interchange Services client. If you have only one database defined, the Import XML DTD page appears
  4. If the Select a Database page appears, select the Data Interchange Services client database you want to import the DTD into, then click OK. The Import XML DTD page appears.
  5. On the Import XML DTD page, enter the appropriate information and press the Import button.

At this point the DTD is imported into a DTD document definition, which is created as part of the import.

Important:
The name of the DTD document definition must be unique amongst DTD document definitions and schema document definitions within the same dictionary. An imported DTD replaces any existing DTD document definition or schema document definition that has the same name.

You can now use the DTD Document Definition Editor to view or update the DTD document definition.

Creating EDI document definitions

The EDI Document Definition editor allows you to define and structure the items that make up an EDI document definition. From the EDI Document Definition editor, you can create and edit EDI segments that are a part of this EDI document definition.

The following steps describe how to create a new EDI document definition.

Important:
Typically, EDI document definitions can be downloaded from the Web and imported, and therefore do not need to be created.
Note:
EDI document definitions are assigned to an EDI dictionary. The EDI dictionary must be created before creating EDI document definitions using Data Interchange Services client.

  1. Open the EDI Document Definition editor. Do this by clicking the EDI button on the main application window, then clicking the New icon.
  2. In the EDI Document Definition editor, General tab, enter a name for EDI document definition.
  3. You may optionally enter a more complete description of the EDI document definition in the Description field, and a brief summary of the EDI document definition's purpose in the Purpose field.
  4. Select the EDI dictionary in which you want the EDI document definition to appear through the Dictionary Name drop-down list. This is a required field.
  5. You may optionally enter a functional group, such as IN for invoice.
  6. Click on the Details tab. The Details tab contains a grid that is used to identify the list of EDI segments that make up the EDI document definition. Each row in the grid represents an EDI segment. Use the information in the table below to create the EDI segments needed to create the EDI document definition.
  7. Click on the Comments tab. You may optionally type a comment.
  8. When you have completed entering information, click the Save button on the toolbar to save the EDI document definition. Your new EDI document definition appears at the bottom of the EDI Document Definitions list window until you reopen it, at which point it appears in alphabetical order.

EDI segment values contained in Details tab

Value Description
Table The value in this field indicates the table in which the EDI Segment belongs. A table is a section of the EDI document definition. Many EDI document definition have only a single table (numbered "1". Some EDI document definitions have a grouping that uses the value "1" to represent header information in the document, the value "2" to represent the details of the document, and the value "3" to represent the trailer information of the document. The valid values for the field are 1 to 32,767.
Position The value in this field indicates the relative position of the EDI segment within the specific table of the EDI document definition. Each value must be unique within the table. The values do not have to be sequential. When the EDI document definition is saved, the list of EDI segments will be sorted based on the table and position number. The valid values for this field are 1 to 32,000.
Segment This column is used to identify the name of the EDI segment. Select a name from the list of available EDI segments.
Requirement Designator Use this column to indicate whether the EDI segment is optional, mandatory, conditional, or floating. The conditional value indicates that the EDI segment may or may not be present depending on semantic conditions. Use the EDI Notes action to see a list of Notes or to maintain Notes for the EDI document definition.
Maximum Repeat This value indicates the maximum number of times the EDI segment can occur at this position. The value can be from 1 to 9,998. This column will be disabled if the Unlimited Repeat column is set. The first EDI segment within a Loop should have the Maximum Repeat column set to 1.
Unlimited Repeat This checkbox is used to indicate that the EDI segment can repeat infinitely. A set checkbox indicates the EDI segment can repeat infinitely. A reset checkbox indicates the EDI segment can not repeat infinitely. When the checkbox is set, the Maximum Repeat column will be disabled. The first EDI segment within a Loop should not repeat infinitely.
Loop ID The ID of the group of related EDI segments if the EDI segment is part of a Loop. By convention, a Loop is the same as a segment group in UN/EDIFACT, ODETTE, or TRADACOMS EDI Standards.The Loop Level and Loop ID columns are used together to determine the EDI Segments that are part of a specific Loop.
Maximum Loop Repeat This value indicates the maximum number of times the Loop can repeat. The value can be from 0 to 999,998. This column will be disabled if the Unlimited Loop Repeat column is set. A value should be entered only for the first EDI Segment within a Loop. The first EDI Segment within a Loop should have the Maximum Repeat column set to 1. A value of zero in this column is treated as one.
Unlimited Loop Repeat This checkbox is used to indicate that the Loop can repeat infinitely. A set checkbox indicates the Loop can repeat infinitely. A reset checkbox indicates the Loop can not repeat infinitely. When the checkbox is set, the Maximum Loop Repeat column will be disabled.
Loop Level The Loop Level indicates the current nesting level of a Loop. EDI Segments that are not within a Loop should have a value of zero in this column. When a Loop starts, the Loop Level for each EDI Segment at that level of the Loop should have a value of "1". If a Loop is nested within that first Loop, then that nested Loop Level should be "2" to indicate the second level of looping. All EDI segments that are part of nested Loop should have the Loop Level of "2". Nested Loops can be up to 16 levels deep. The Loop Level and Loop ID columns are used together to determine the EDI segments that are part of a specific Loop.
Description This column describes the EDI segment. This value in this column can not be changed.

Creating ROD document definitions

You create a new ROD document definition when you need to define the layout of a proprietary document that will be processed by Data Interchange Services client.

The following steps describe how to create a new ROD document definition.

Note:
ROD document definitions are assigned to an ROD dictionary. The ROD dictionary must be created before creating ROD document definitions using Data Interchange Services client. A ROD document definition also requires a Record ID information object to indicate whether the ROD document definition also uses the Record ID information object to ensure that all loops and records within the ROD document definition use the same Record ID information object.

  1. Open the ROD Document Definition editor. The following steps describe how to open the ROD Document Definition editor.
    1. Click the Record Oriented Data button on the main application window. The Record Oriented Data list window opens.
    2. Click the New button on the Record Oriented Data list window's toolbar. The Record Oriented Data editor opens.
  2. On the General tab page, type in the name of the ROD document definition. The name can be up to sixteen characters long and can contain alphanumeric characters and any of the special characters "!@#$%&*()_-+=':;<,>.?". It is suggested that the name not start with an ampersand ("&") or dollar sign ("$"). ROD document definitions provided by Data Interchange Services client may begin with either of these two characters. Also, the name of a ROD document definition must be unique against the names of all ROD document definitions regardless of the ROD dictionary.
  3. From the Dictionary Name drop-down list, select the name of the ROD dictionary that will contain the ROD document definition. The ROD document definition is able to utilize all Loops, Records, Structures, and Fields defined in the dictionary. Using a dictionary is a convenient way to reuse Loop definitions, Record definitions, Structure definitions, and Field definitions.
  4. You can optionally type a description of the ROD document definition in the Description field.
  5. From the Record ID Information drop-down list, select the name of the Record ID Information object to associate with the ROD document definition. The Record ID Information object indicates whether the ROD document definition will be C and D records format or Raw Data format, and it indicates the position and length of the field that contains the record identifier.
  6. In the Records Delimiter drop-down field, select the type of delimiter that will terminate Records. If no delimiter is required, select No Delimiter.
  7. If each Record is delimited, then field delimited records are supported. Checking the Delimited Fields checkbox indicates that fields in a Record are not fixed in position, but instead are separated by a delimiter. Enter the delimiter into the Field Delimiter field.
  8. From the Character Set drop-down list, select the character set used in the document defined by this ROD document definition, if it uses a code page other than the system default code page.
    Note:
    In WebSphere Partner Gateway, the selected character set is used as a default if no character encoding is specified for the document definition.
  9. In the Byte Order group box, select the byte order as needed. The Byte Order options are: Native Order, Big Endian, and Little Endian.
  10. Click on the Details tab to display the Details tab page. Use this tab page to identify the first level of Loops and Records that are contained in the ROD document definition. Refer to the help topic on that tab page for additional information.Important: Complete the General tab page before working on the Details tab page when creating a new ROD document definition. This is necessary because some information needed to fill the Details tab page is obtained from the General tab page. Changing the name of the ROD document definition, which dictionary the ROD document definition belongs to, or the Record ID Information object used by the ROD document definition on the General tab page causes all information on the Details tab page to be reset. This is not an issue with existing ROD document definitions since those field can not be changed on existing ROD document definition. There are two ways to approach providing information for the Details tab. One method is to create the Loops and Records that are part of the first level of the ROD document definition by typing the new loops and records into the Details tab page. After the ROD document definition has been saved, you will need to go open the ROD Loop editor and ROD Record editor for each loop and record created. In the editor you will have to complete the definition for each loop and record. This in turn will require you to create structures and fields that are a part of your ROD document definition. Another method for creating a ROD document definition is to first create all of the fields that are a part of the ROD document definition. Then create all of the structures that are a part of the ROD document definition. Follow this up by creating all of the records that are a part of the ROD document definition. Create the loops that are a part of the ROD document definition. Finally, create the ROD document definition. In this scenario, you use the Details tab page of the ROD Document Definition editor to select the existing loops and records that are a part of the first level of the ROD document definition.
  11. If you are using Raw Data format (as opposed to C and D records format) you must click the Raw Data tab to display the Raw Data page. On this page, identify either the first or last record within the ROD document definition. Records you have defined in a ROD document definition do not have be in the order they are defined to the ROD document definition, so one of these fields must be filled in when using raw data format so Data Interchange Services client can determine where each document begins and ends. The following list describes all of the available fields.Note for Beginning Records and Ending Records: The drop-down list will be empty if you have not created any records for the ROD dictionary. You must create the record using the ROD Record Editor first, and then return to this field to select the name of the record.Caution for Beginning Records and Ending Records: The records in the list are all of the records that qualify for use with the ROD dictionary. You will get a warning message when you save the ROD document definition if you select a record that is not currently used in the ROD document definition. You must make sure that the record is used as the first record (for Beginning Record field) or as the last record (for the Ending Record field) within the ROD document definition.Note for ROD fields: The drop-down list will be empty if you have not created any ROD fields for this ROD dictionary. You must create the field using the ROD Field editor first, and then return to this field to select the name of the ROD field.Caution for ROD fields: The fields in the list are all of the fields defined within the ROD Dictionary. You will get a warning message upon saving if you select a field that is not currently used in the ROD document definition. You must make sure that the field is used within the ROD document definition. Although reuse is allowed with other ROD fields, this field must occur in your ROD document definition only once.
  12. Click the Comments tab and add any comments you have about the ROD document definition.
  13. Click the Save button on the toolbar. Data Interchange Services client saves the new ROD document definition to the database.
  14. Click on the Overview tab to display the Overview tab page. This tab page displays a graphical representation of your ROD document definition. The information on this tab page is refreshed each time the ROD document definition is saved.
  15. Close the editor when you are done.
Importing COBOL copybooks

Importing allows you to take a COBOL source file and use it to create WebSphere Partner Gateway fields, structures, and records, and then save them in a Record Oriented Data dictionary.

The following steps describe how to import a COBOL copybook.

  1. From the main application window, click Record Oriented Data button.
  2. From the ROD Dictionaries tab, double-click the dictionary in which you want to store the new records and fields from the COBOL copybook.
  3. Click Import COBOL Copybook. The Select COBOL Copybook File dialog box appears.
  4. Enter the correct path and file name, and click Open.
  5. Click Close when the status dialog box indicates the import is complete. The path and file name of the copybook file display in the Copybook File field, and the Record ID info drop-down list and New button are enabled.

Copyright IBM Corp. 2003, 2005