Importing custom XML and non-XML documents

Custom documents can be transformed in the application through the use of code lists. To enable the implementation of custom document processing, these code lists are available in the Master Data area of the application:

CustomMessageTypes
CustomMessageFormats
CustomMessageIDs

Prerequisites

These are the prerequisite steps before configuring this functionality:

Create a custom style sheet with an associated XML document.
Determine the desired values for the trading partner, if it is not a standard trading partner.

Setup

These are the setup requirements in the Master Data area:

Create a code for the CustomTradingPartner code list that is used in the process.
Create a code for the CustomMessageTypes code list that is used in the process. This value is used for drop-down boxes for the selection of standard message types. In the Code List Properties table, create a code with the identifier that matches the document type defined in the custom XML document.
Create a code for the CustomMessageFormats code list that is used in the process.
- For XML documents, this code is used to determine the document type.
  Note: The process runs through all the custom message formats to find a document type. It uses the first custom message format where a value is found at the specified element.
  - In the Manage Code Properties dialog box, you must set a unique value in the Identifier field.
  - Set the Message Type Element field on the Values 1 tab to the element in the custom XML document that determines the XML document type. Only the first instance of this element is used in the process. XML elements are supported; however, attributes are not supported.
- For custom documents that are not XML, this code is used to identify these properties:
  - Message Starts With - The first six characters to identify the message
  - Message Standard - The message standard to associate with the message
  - Message Type - The message type to associate with the message
Create a code for the CustomMessageIDs code list that is used in the process.
- For an XML document, this code is used to determine the sender and receiver of the document.
  - Specify an Identifier that matches the CustomMessageTypes code created.
  - On the Values 1 tab, you must specify, at minimum, the Sender ID Position 1 and Receiver ID Position 1. These values are XML elements. The process starts at the location of the first instance of Position 1. If Position 2 is specified, it proceeds to Position 2. If Position 3 is specified, it proceeds to Position 3. When a position is specified, it must exist in the document; otherwise, the processing cannot succeed.
    Note: The first position is not required to be the document element.
- Similarly, for non-XML files, you can create a code for the CustomMessageTypes code list to determine the sender and receiver of the file.
  - Specify an Identifier that matches the CustomMessageTypes code created.
  - On the Values 1 tab, specify the position 1 values for both the sender and receiver. When the process starts, the position 1 scans the beginning of the non-XML file to ensure the characters match the text entered in the code list. Next, it uses one-based numbering to find the start index, which is position 2, and the end index, which is position 3, to identify the sender or receiver.
Create a code for the CustomStyleSheetRules code list that is used in the process. This code is used to determine the style sheet used to transform the custom document.
- This is the required setup for custom XML documents:
  - In the Manage Code Properties dialog box, specify an identifier that is used during processing and shown in lookups and drop-down lists. This value is typically the style sheet file name without file extension.
  - On the Values 1 tab, specify these field values:
    - Specify the file name in the Style Sheet File Name field that is used for the transformation. The file name must include the file extension.
    - In the Source Format File Description field, specify *none.
    - In the Target Format File Description field, specify *none.
    - In the Message Standard field, select XML.
- This is the required setup for custom non-XML documents:
  - In the Manage Code Properties dialog box, specify an identifier that is used during processing and shown in lookups and drop-down lists. This value is typically the style sheet file name without file extension.
  - On the Values 1 tab, specify these field values:
    - Specify the file name in the Style Sheet File Name field that is used for the transformation. The file name must include the file extension.
    - In the Source Format File Description field, specify the name of the format file.
    - In the Target Format File Description field, specify *none.
    - In the Message Standard field, select the appropriate non-XML standard from the drop-down list (for example, select Comma-separated Valuesfor a text file).

Transformation setup

These are the steps for setting up the Partner ID:

Select Transformation > Configuration > Partner IDs.
Click Create
On the Partner ID page, select the custom message type from the Message Type drop-down list.
Select the trading partner from the Trading Partner drop-down list.
In the Sender/Receiver IDs section, specify a sender ID and receiver ID in the respective fields.
In the Internal/External Partner Mapping section, specify the values in the mapping fields.

These are the steps for setting up the transformation rule:

Select Transformation > Configuration > Transformation Rules.
Click Create to create the transformation rule.
On the Transformation Rules page, select the custom trading partner, custom message type and custom style sheet rule from the corresponding fields.

These are the steps for setting up the custom style sheet:

Select Transformation > Configuration > Style Sheets.
Click Create to create the custom style sheet record.
On the Style Sheets page, use the custom trading partner and style sheet name including the file extension that have been created for the custom style sheet rule.

Processing custom XML documents

These are the steps for processing custom XML documents:

Select Transformation > Import Messages to import the XML document. Or, if the On-premises Client Configuration has been implemented in the Communications area, import the XML document through Exchange Services.
Note: At this time, ION Connector is not supported.
Select Transformation > Manage Messages.
On the Manage Messages page, check results. Fix any values required for processing.