Nav

Document Types

Configuring a document type for a partner means specifying a Name and

Get Started

  1. Start APM. The Transaction Monitoring Page appears.

  2. In the left-hand navigation pane, click Partner Configuration. The Partner Configuration Page appears.

    To edit or add settings for your company, in the Name table, click the name of your company.

    To edit or add settings for an existing trading partner, in the Name table, click the name of the partner.

  3. In the CONFIGURATION section of the left-hand navigation pane on the Company Information Page, click Document Types.

    The Documents Page appears.

img-documents
Figure 1. Documents Page

Edit an Existing Document

  1. On the Documents Page, click the document you want to edit.

    The Existing Document Page appears.

img-document-edit
Figure 2. Existing Document Page
  1. Edit settings as appropriate.
    For information about editing specific settings, see Add a New Document.

Changing the values for Name or Message Type may disrupt existing processes that refer to the existing values.

Add a New Document

  1. Click New. The Document page appears. The Document Page appears.

img-document
Figure 3. Document Page
  1. Enter settings as appropriate.

  2. To add a new property, see Document Properties.

Setting Description

Name

Name for this document type

Required

Yes

Default

Auto-populates based on the following values:

If you choose to change the default, then subsequently want to revert to it, click Auto Fill.

Format

Valid values for Format fields depend on the choice you make for Standard.

Setting Description

Standard

Select a standard from the dropdown listbox. Based on the standard you select, the appropriate settings options appear. For guidance on these settings, click the link that corresponds to the standard you choose in Valid values.

Required?

No

Valid values
Default

None

Format (X12)

Setting Description

Version

Select a value from the dropdown listbox, or enter a different value.

Required?

Yes

Valid values

See listbox

Default

None

Message Types

Select a value from the dropdown listbox, or enter a different value.

Required?

Yes

Valid values

See listbox

Default

None

Default Checkboxes

Select either of these checkboxes in order to use the values selected in the corresponding sections of x12-Settings.

Deselect either of these boxes if you want to choose different values than those chosen as defaults.

Default

Selected

Schema

Click Choose File, then choose a file from the selection window.

In the file type box of the selection window, select All Files.
Required?

No

Default

None

Document Properties

This section enables you to select a standard-specific label and specify a path for a given document. For more information, see Document Properties.

Format (EDIFACT)

Setting Description

Version

Select a value from the dropdown listbox, or enter a different value.

Required?

Yes

Valid values

Alphanumeric

Default

None

Message Type

Select a value from the dropdown listbox, or enter a different value.

Required?

Yes

Valid values

See listbox

Default

None

Default Checkboxes

Select either of these checkboxes in order to use the values selected in the corresponding sections of EDIFACT.

Deselect either of these boxes if you want to choose different values than those chosen as defaults.

Default

Selected

Schema

Click Choose File, then choose a file from the selection window.

In the file type box of the selection window, select All Files.
Required?

No

Default

None

Document Properties

This section enables you to select a standard-specific label and specify a path for a given document. For more information, see Document Properties.

Format (CSV)

Setting Description

Version

Select a value from the dropdown listbox, or enter a different value.

Required?

No

Valid values
  • 4010

  • 5010

Default

None

Message Type

Select a value from the dropdown listbox, or enter a different value.

Required?

Yes

Valid values

See listbox

Default

None

Use default Outbound CSV for partner

Select this checkbox in order to use the values selected in the corresponding sections of CSV-Settings.

Deselect this checkbox if you want to choose different values than those chosen as defaults.

Default

Selected

If you deselect the Use default Outbound CSV for partner checkbox, the following fields appear.

Outbound (Write)

Setting Description

Delimiter

Separates data in a document or message

Valid values

Standard APM field format

It is common to use a comma or pipe character (|) as a delimiter.

Has Header Row

Select this checkbox to include a header row for CSV Inbound documents

Deselect the checkbox to omit header rows.

Setting Description

Use default Inbound CSV for partner

Select this checkbox in order to use the values selected in the corresponding sections of CSV-Settings.

Deselect this checkbox if you want to choose different values than those chosen as defaults.

Default

Selected

If you deselect the Use default Inbound CSV for partner checkbox, the following fields appear.

Inbound (Read)

Setting Description

Delimiter

Separates data in a document or message

Valid values

Standard APM field format

It is common to use a comma or pipe character (|) as a delimiter.

Has Header Row

Select this checkbox to include a header row for CSV Inbound documents

Deselect the checkbox to omit header rows.

Setting Description

Schema

Click Choose File, then choose a file from the selection window.

In the file type box of the selection window, select All Files.
Required?

No

Default

None

Document Properties

This section enables you to select a standard-specific label and specify a path for a given document. For more information, see Document Properties.

Format (XML)

Setting Description

Namespace

Type a value in the box.

Required?

No

Valid values

Standard APM field format

Default

None

Root Node

Type a value in the box.

Required?

Yes

Valid values

Must conform to XML naming rules (see http://www.w3schools.com/xml/xml_elements.asp)

Default

None

Schema

Click Choose File, then choose a file from the selection window. A NOTE: In the file type box of the selection window, select All Files.

Required?

No

Default

None

Document Properties

This section enables you to select a standard-specific label and specify a path for a given document. For more information, see Document Properties.

Format (JSON)

Setting Description

Message Type

Required?

Yes

Valid values

Standard APM field format

Default

None

Schema

Click Choose File, then choose a file from the selection window.

In the file type box of the selection window, select All Files.
Required?

No

Default

None

Document Properties

This section enables you to select a standard-specific label and specify a path for a given document. For more information, see Document Properties.

Format (RosettaNet)

Setting Description

Message Type

Required?

Yes

Valid values

Standard APM field format

Default

None

Version

Select a value from the dropdown listbox.

Required?

Yes

Default

None

Schema

Click Choose File, then choose a file from the selection window.

In the file type box of the selection window, select All Files.
Required?

No

Default

None

Document Properties

This section enables you to select a standard-specific label and specify a path for a given document. For more information, see Document Properties.

Document Properties

These settings, which must be configured independently for each format, enable you to select a standard-specific label and specify a path for a given document.

Add New Document Properties

On the Documents Page, click New Property. The Add Property box appears.

Setting Description

Property

Choose an appropriate label for this document from the listbox.

Required?

No

Valid values

See listbox.

Default

Property Source Type

Choose an appropriate label for this document from the listbox.

Required?

No

Valid values

See listbox

Default

None

Path

Type the path for the location of this document.

Required?

No

Valid Values

XPath for XML Documents, JsonPath for others

Default

None