Custom XML documents
This section describe how to create custom XML documents.
Overview
XML (Extensible Markup Language) is the universal format
for structured documents and data on the Web. Using the Manage XML
Protocols page, you can create and manage custom XML formats that
can be added to the list of available document flow definitions.
An XML
format defines the paths within a set of XML documents. This enables
the Document Manager to retrieve the values that uniquely identify
an incoming document and access information within the document
necessary for proper routing and processing.
Creating
an XML format is a multi-step process. You must:
- Create a protocol for the format and associate it with a package
or packages
- Create a document flow for the format and associate it with
the newly created protocol
- Create the format
You then create a valid interaction for the newly created format.
These steps are described in the sections that follow. You can
also find an example of these steps in Setting up the hub for custom XML documents.
Creating a protocol definition format
The following steps describe how to create a custom XML protocol definition format:
- Click Hub Admin > Hub Configuration > Document Flow Definition > Create Document Flow Definition.
- For Document flow type, select Protocol.
- For Code, enter the value for the type
of object you selected in the previous step. For example, you might
want to enter XML.
- For Name, enter an identifier for the
document flow definition. For example, for a custom XML protocol,
you might enter Custom_XML. This field is required.
- For Version, enter 1.0.
- Enter an optional description of the protocol.
- Set Document level to No,
because you are defining a protocol, rather than a document flow
(which you will define in the next section).
- Set Status to Enabled.
- Set Visibility for this protocol. You
will probably want it to be visible to all participants.
-
Select the packages in which this new protocol
will be wrapped. For example, if you want this protocol to be associated
with the AS, None, and Backend Integration packages, select Package: AS, Package: None, Package: Backend Integration.
- Click Save.
Creating a document definition flow
Next, use the Create
Document Flow Definition page again to create a document flow.
- Click Hub Admin > Hub Configuration > Document Flow Definition > Create Document Flow Definition.
- For Document flow type, select Document Flow.
- For Code, enter the value for the type
of object (document flow) you selected in the previous step.
- For Name, enter an identifier for the
document flow definition. For example, you might enter XML_Tester
as a name for the document flow. This field is required.
- For Version, enter 1.0.
- Enter an optional description of the protocol.
- Set Document level to Yes (because
you are defining a document level).
- Set Status to Enabled.
- Set Visibility for this flow. You will
probably want it to be visible to all participants.
- Click the Expand icon to expand each package
you selected in step 10.
Expand the folder and select the name of the protocol you created
in the previous section (for example, Protocol: CustomXML.).
- Click Save.
The Manage Document Flow Definitions page now contains a document
flow of XML_Tester and a protocol of CustomXML under the AS, None,
and Backend Integration packages.
Creating an XML format
After you create a custom XML protocol (and associate
it with a package or set of packages) and create an associated document
flow, you are ready to create the XML format.
To create an XML format, use the following procedure.
- Click Hub Admin > Hub Configuration > XML Formats.
- Click Create XML Format.
- For Routing Format, select the document
flow definition with which this format will be associated.
- For File Type, select XML.
Note: XML is the only option available for file type.
- For Identifier Type, select the element
used to identify the incoming document type. The choices are DTD, Name Space,
or Root Tag.
- For each field for which a choice of types is offered, select
either Element Path, which is the path to
the value in the document, or Constant, which
is the actual value in the document. Then provide a value.
- For Source/Target Business ID, enter the
path of the business ID. This field is required.
- For Source Document Flow & Version,
enter an expression that defines the path to the Document Flow and
Version value within the XML document. This field is required.
- For Document Identifier, enter the path
for the document ID number.
- For Document Timestamp, enter the path
for the document creation time stamp.
- For Duplicate Check Key 1-5, enter paths
used to identify the routing of a duplicate document.
- Click Save.
