Anypoint Partner Manager User’s Guide
Anypoint Partner Manager (APM) provides configuration and monitoring for AnyPoint B2B messaging flows. This page identifies the APM features you use to configure and monitor trading partner relationships and B2B documents.
To configure a trading partnership using APM, you must:
Set up a home organization
The Home Organization, or Home Org, is you - that is, the company licensing Anypoint B2B. To use Anypoint Partner Manager to manage your B2B transmissions, first create this Home Org in APM. After Getting Started, you can configure the following:
Getting Started
- Start APM. The Anypoint Platform home page appears, with B2B Transmissions selected.
- Click Trading Partners.
- In the top right of the Trading Partners page, click the name of your company. The Company page appears.
Company information
Enter Company information
- On the Company page, the Company Name box auto-populates based on your account provisioning process. If appropriate, you can change it. This name appears in the upper right of the Trading Partners page.
- In the API Key box, click Create an API key. The API Application Program Interface (API) Key is a 32-bit alphanumeric universal unique identifier (UUID) string that APM generates for you; you use it to access the Anypoint B2B API.
Store your API key in a secure location. If you lose it, you will need to create a new API key. APM does not store your API key. |
Company contact information
Use this section to add contact information for your company.
Adding contact information is optional. |
Enter Company contact information
- On the company page, in the Contact type dropdown list, select the type of contact you want to add. A contact may be technical, business, or both.
- After you enter a contact type, you can enter the following contact-specific information:
- First Name
- Last Name
- Title
- E-mail
- Office Phone
- Mobile Phone
- Fax
- Address Line 1
- Address Line 2
- City
- State
- Postal Code
- Country
- Click Save to save the values you entered in the previous steps.
- Click Next.The AS/2 Settings page appears.
Transport - Home Org
You can configure default options for B2B-enabled Home Org transport connectors; currently, this includes AS2.
AS2
AS2 is a secure transport protocol that enables files to be signed, encrypted and sent between a company and its trading partners. You can configure both inbound and outbound settings.
AS2 Identity Settings - Home Org
- In the AS2 Identity box, enter the name you want to use for your company’s AS2 ID.
- Click Choose File to select and upload this trading partner’s AS2 Certificate.The Certificate Name, Expiration and Thumbprint fields automatically populate when an AS2 certificate is uploaded.
Format - Home Org
You can configure default options for supported B2B format standards (currently X12 and EDIFACT).
X12
X12 standards define the structure, format, and content of business transactions conducted through Electronic Data Interchange (EDI) and are used in conjunction with AS2 or FTPS as transport for configured transaction sets.
X12 Identity Settings - Home Org
Interchange ID qualifier - ISA - Home Org
This is the qualifier your company will use as a default X12 Qualifier. If you have exceptions, you can change them at the transaction level for an individual trading partner.
Interchange ID - ISA - Home Org
This is the X12 EDI identifier your company will be using as a default EDI ID. If you have exceptions, you can change them at the transaction level for the individual trading partner.
EDIFACT Identity Settings - Home Org
Interchange ID Qualifier - UNB - Home Org
Qualifier your company uses as a default EDIFACT Qualifier.
Interchange ID - UNB - Home Org
EDIFACT ID your Company uses as a default ID.
Set up a trading partner
To use Anypoint Partner Manager to manage the exchange of B2B messages with another company, first create a Trading Partner in APM. You can configure trading partner information for:
Company - Partner
In this section you can configure the name that is displayed for a trading partner, and, optionally, technical and business contacts for the partner.
Enter contact information
- On the Anypoint Platform page, click Trading Partners. The Trading Partnerspage appears.
- Click Create. The Partnership page appears.
- In the Contacts section of the Partnership page, enter the following:
- Company Name
- Contact type
(In the dropdown listbox, select Technical, Business, or Both)
- After you enter a contact type, you can enter the following contact-specific information:
- First Name
- Last Name
- Title
- E-mail
- Office Phone
- Mobile Phone
- Fax
- Address Line 1
- Address Line 2
- City
- State
- Postal Code
- Country
- Click Save to save the values you entered in the previous steps.
- Click Next.The AS/2 Settings page appears.
Transport - Partner
In this section, you can configure) default options for any B2B-enabled transport connectors (currently AS2 and FTPS).
AS2 - Partner
AS2 is a secure transport protocol that enables files to be signed, encrypted and sent between your organization and your trading partners. You can configure both inbound and outbound settings.
Enter AS2 Identity Settings
- In the AS2 Identity box, enter the trading partner-assigned name associated with this trading partner’s Production AS2 ID.
- Click Choose File to select and upload this trading partner’s AS2 Certificate.The Certificate Name, Expiration and Thumbprint fields populate when an AS2 certificate is uploaded.
Enter AS2 Settings - Inbound
URL
URL you expose in MuleSoft to receive messages from a trading partner. Enter the URL, including the port.
- Required?
- Yes, if AS2 is the transport protocol.
- Example
www.midsizesupplier.com:8080
MDN Subject
Subject of the MDN (Message Disposition Notification) sent
- Required?
- Yes
- Valid values
- Alphanumeric
- Default
Message Disposition Notification
Preferred Digest Algorithm
MIC algorithm for use in signing the returned receipt.
- Required?
- Yes
- Valid values
None
SHA1
MD5
- Default
None
Checkbox options
- Compress
- Compresses message-size
- Message Encrypted
- Adds an encryption wrapper around the document, signature, and compression payloads
- Message Signed
- Adds a signature wrapper around the document payload
Enter AS2 Settings - Outbound
The AS2 Outbound Settings are for your trading partner’s specific AS2 settings such as certificate and URL.
URL
URL to which you will send AS2 transmissions for this partner, including port
- Required?
- Yes, if AS2 is the transport protocol
- Example
www.midsizesupplier.com:8080
Content Type
Content type for messages sent over AS2.
If you choose Custom , a Custom content type box appears that accepts an alphanumeric string. Be sure that the string is known to your trading partner. |
- Valid Values
Application/edi-consent
Custom
application/edi-x12
- Default
application/edi-x12
Digest Algorithm
MIC algorithm for use in signing the returned receipt
- Valid values
SHA1
MD5
- Default
SHA1
Fallback Digest Algorithm
Digest algorithm the receiver uses to create the MIC and signature
- Required?
- No
- Valid values
None
SHA1
MD5
- Default
None
Subject
Subject of the message being sent
- Required?
- No
- Valid values
- Alphanumeric
- Default
AS2 Message
Filename
Name of file to send
- Required
- No
- Valid values
- Alphanumeric
- Default
- None
Encoding
Type of encoding to use when sending a message with AS2
- Required
- Yes
- Default
- Binary
- Valid values
- Binary
A method of encoding in which a message is represented using a combination of 0s and 1s. - 7-bitData that is all represented as relatively short lines with 998 bytes or less between CRLF line separation sequences. No bytes with decimal values greater than 127 are allowed and neither are NULLs (bytes with decimal value 0). CR (decimal value 13) and LF (decimal value 10) bytes only occur as part of CRLF line separation sequences.
- 8-bitData that is all represented as relatively short lines with 998 bytes or less between CRLF line separation sequences, but bytes with decimal values greater than 127 may be used. As with "7bit data" CR and LF bytes only occur as part of CRLF line separation sequences and no NULLs are allowed.
- Quoted-PrintableIntended to represent data that largely consists of bytes that correspond to printable characters in the US-ASCII character set. It encodes the data in such a way that the resulting bytes are unlikely to be modified by mail transport. If the data being encoded are mostly US-ASCII text, the encoded form of the data remains largely recognizable by humans. A body which is entirely US-ASCII may also be encoded in Quoted-Printable to ensure the integrity of the data should the message pass through a character-translating, and/or line-wrapping gateway.
Encryption Algorithm
3DES is an encryption that uses 3 different keys, or encryptions, to encrypt the messages. No other choices are available at this time.
Checkbox Options
- Compress
- Compresses message-size
- Message Encrypted
- Adds an encryption wrapper around the document, signature, and compression payloads
- Message Signed
- Adds a signature wrapper around the document payload
MDN Signed
Ensures trading partner validation and security
MDN Async
Allows AS2 MDNs to be returned to the AS2 message sender’s server at a later time. Typically used when large files are involved, or when a trading partner’s AS2 server has poor Internet service. If this checkbox is selected the MDN Async URL box appears.
MDN Async URL
An Async Message Disposal Notification (MDN) returns the MDN to this URL at a later time for files sent if an MDN is required. If you are using Async MDN, enter the URL and port to which it should be sent.
- Required
- No
- Valid values
- Alphanumeric
- Default
None
- MDN Required
- An Async MDN will return the MDN to the URL at a later time for files sent if an MDN is required. If you are using Async MDN, enter the URL and port to which it should be sent.
If this checkbox is selected, the Require Receipt for Unsupported Digest Algorithm and Require Receipt for Unsupported Signature Format checkboxes appear. --- |
FTPS - Partner
FTPS is an extension to the commonly used File Transfer Protocol (FTP) that adds support for the Transport Layer Security (TLS) and Secure Sockets Layer (SSL) cryptographic protocols.
Enter FTPS Settings - Inbound
Server Address
Server address to which inbound B2B documents are delivered.
- Required?
- Yes
- Valid values
- Alphanumeric
- Default
localhost
Port
Specific inbound port to be used with this trading partner. Set the host of your FTP server, this can be an IP address or a host name.
- Required?
- Yes
- Valid values
- Numeric
- Default
990
User Name
The user name you specify for this FTPS instance.
- Required?
- Yes
- Valid values
- Alphanumeric
- Default
- None
Password
The password you are using with this trading partner.
- Required?
- Yes
- Valid values
- Alphanumeric
- Default
- None
Transfer Mode
For ease of client use, use passive mode when possible.
- Required?
- Yes
- Valid values
- Active|Passive
- Default
Passive
SSL Mode
Method of invoking client security
- Required?
- Yes
- Valid values
Explicit
- Uses standard FTPS commands and replies.
Implicit
- Requires a Transport Layer Security to be established at the beginning of the connection.
- Default
Implicit
Enable Server Validation (Checkbox)
Selecting this checkbox validates the servers identity; only JKS format is supported at this time.
- Default
- Not selected
Path
Specific FTPS file location where inbound documents will reside.
- Required?
- No
- Valid values
- Alphanumeric
- Default
/
Filename
- Required?
- No
- Valid values
- Numeric
- Default
None
Move to directory
Places the files in the specified directory until they complete uploading.
- Required?
- No
- Valid values
- Alphanumeric
- Default
None
Polling frequency
- Required?
- No
- Valid values
- Alphanumeric
- Default
1000
Maximum Number of Download Threads
Controls the concurrency level at a given time.
- Required?
- No
- Valid values
- Numeric
- Default
None
Enter FTPS Settings - Outbound
Server Address
Address to which outbound documents are sent.
- Required?
- Yes
- Valid values
- Alphanumeric
- Default
localhost
Port
Specific outbound port to be used with this trading partner. Set the host of the partner’s FTP server; this can be an IP address or a host name.
- Required?
- Yes
- Valid values
- Numeric
- Default
990
User Name
- Required?
- Yes
- Valid values
- Alphanumeric
- Default
- None
Password
- Required?
- Yes
- Valid values
- Alphanumeric
- Default
- None
Transfer Mode
For ease of client use, use passive mode when possible.
- Required?
- Yes
- Valid values
- Active|Passive
- Default
Passive
SSL Mode
- Required?
- Yes
- Valid values
- Explicit|Implicit
- Default
Implicit
Enable Server Validation (Checkbox)
Selecting this checkbox validate the servers identity; only JKS format is supported at this time.
- Default
- Not selected
Path
- Required?
- No
- Valid values
- Alphanumeric
- Default
/
Filename
- Required?
- No
- Valid values
- Numeric
- Default
None
Upload Temporary Directory
- Required?
- No
- Valid values
- Alphanumeric
- Default
None
Format - Partner
In the Format Settings section you can configure the default options for supported B2B format standards (currently EDI X12 and EDIFACT).
X12 - Partner
X12 standards define the structure, format, and content of business transactions conducted through Electronic Data Interchange (EDI) and are used in conjunction with AS2 or FTPS as transport for these documents.
Enter X12 Identity Settings
Interchange ID qualifier - ISA - Partner
Value of the EDI ID Qualifier for your trading partner. Some of the most common values are listed below. If you choose Custom, you can define the trading partner’s EDI X12 qualifier.
- Required?
- Yes
- Valid values
01 (DUNS Number)
08 (UCC EDI Number)
12 (Phone Number)
14 (DUNS Number plus Suffix Number)
ZZ (Mutually Defined)
Custom
- Default
- No default provided
Interchange ID - ISA - Partner
EDI X12 ISA ID for your trading partner; can be up to 15 characters. Your trading partner will supply you with the proper EDI X12 Interchange ID.
- Required?
- Yes
- Valid values
- Alphanumeric
- Default
- No default provided
Enter X12 Settings Inbound (Read)
Envelope Headers (ISA)
Auth. Info. Qualifier (ISA 01)
Most common value is 00; rarely is another used.
- Required?
- No
- Valid values
00
01
02
03
04
05
06
- Default
00
Authorization Information (ISA 02)
Enter a value if appropriate for your organization.
If the value in the previous box (ISA 01) is 00 (the default), then this box is disabled. |
- Required?
- No
- Valid values
- Alphanumeric
- Default
- Defaults to ten blank spaces
Security Inf. Qualifier (ISA 03)
Select a value from the dropdown listbox (if appropriate for your organization).
- Required?
- No
- Valid values
00
01
- Default
00
If the value in (ISA 03) is 01, then a valid password value is required in ISA 04. |
Security Information (ISA 04)
Enter a value if appropriate for your organization.
If the value in the previous box (ISA 03) is 00 (the default), then this box is disabled |
- Required?
- No
- Valid values
- Alphanumeric
- Default
- Defaults to ten blank spaces
Interchange sender ID qualifier (ISA 05)
This value populates based on the value saved in Interchange ID qualifier - ISA - Partner
- Required?
- Yes (must be entered and saved in Interchange ID qualifier - ISA - Partner)
Interchange sender ID (ISA 06)
This value populates based on the value entered and saved in Interchange ID - ISA - Partner
- Required?
- Yes (must be entered and saved in Interchange ID - ISA - Partner)
Interchange receiver ID qualifier (ISA 07)
This value populates based on the value entered and saved in Interchange ID qualifier - ISA - Home Org
- Required?
- Yes (must be entered and saved in Interchange ID qualifier - ISA - Home Org)
Interchange receiver ID (ISA 08)
This value populates based on the value entered and saved in Interchange ID - ISA - Home Org
- Required?
- Yes (must be entered and saved in Interchange ID - ISA - Home Org)
Interchange Control Version (ISA 12)
Identifies the X12 version this partner uses.
- Required?
- No
- Valid values
00401 (4010)
00501 (5010)
- Default
00401 (4010)
Parser Settings (Failure conditions)
Fail document when value length outside allowed range
Fail document when invalid character in value
Fail document if value is repeated too many times
Fail document if unknown segments are used
Fail document when segments are out of order
Fail document when unused segments are included
Fail document when too many repeats of a segment
Fail document when unused segments are included
Each of these options identifies a condition for which APM can fail an inbound document from a trading partner. If any of these options selected, and an X12 document meets the condition in a selected option, a 997 message stating a failure will be sent.
Parser Settings (Other options)
- Require 997
- If selected, a 997 message will be sent regardless of whether or not an error condition is met.
- Generate 999
- If a 999 acknowledgement is needed check this box. The default X12 acknowledgement will be 997.
Character Set and Encoding
Drop-down listbox enabling choice of three character sets.
- Valid values
- Basic
This character set includes:- Uppercase letters
A
throughZ
- Digits
0
through9
- Special characters
! “ & ’ ( ) * + , - . / : ; ? =
- The character created by pressing the space bar.
- Extended
This character set includes:- All characters in the Basic character set
- Lowercase letters
a
throughz
- Select language characters
- Other special characters:
% @ [ ] _ { } \ | < > ~ # $
- Unrestricted character set - includes all characters.
- Default
Basic
Control Number Settings
These settings, when selected, require unique inbound ISA 13, GS 06 and ST 02control numbers on all inbound documents for a trading partner.
Require unique ISA control numbers (ISA 13)
Require unique GS control numbers (GS 06)
Require unique transaction set control numbers (ST 02)
Enter X12 Settings - Outbound (Write)
Envelope Headers (ISA)
The fields in this section enable you to set envelope header options.
Auth Info. Qualifier (ISA 01)
The most common value is
00
; rarely is another used.- Required?
- No
- Valid values
00
01
02
03
04
05
06
- Default
00
Authorization Information (ISA 02)
If the value in the previous box (ISA 01) is 00 (the default), then this box is disabled. |
- Required?
- No
- Valid values
- Alphanumeric
- Default
- Ten blanks
Security Inf. Qualifier (ISA 03)
In the dropdown listbox, enter a value for this trading partner.
- Required?
- Yes
- Valid values
00
01
- Default
00
If the value in (ISA 03) is 01, then a valid password value is required in ISA 04. |
Security Information (ISA 04)
If the value in the previous box (ISA 03) is 00 (the default), then this box is disabled. |
- Required?
- No
- Valid values
- Alphanumeric
- Default
- None
Interchange sender ID qualifier (ISA 05)
This value populates based on the value saved in Interchange ID qualifier - ISA - Home Org
- Required?
- Yes (must be entered and saved in Interchange ID qualifier - ISA - Home Org)
Interchange sender ID (ISA 06)
This value populates based on the value entered and saved in Interchange ID - ISA - Home Org
- Required?
- Yes (must be entered and saved in Interchange ID - ISA - Home Org)
Interchange receiver ID qualifier (ISA 07)
This value populates based on the value entered and saved in Interchange ID qualifier - ISA - Partner
- Required?
- Yes (must be entered and saved in Interchange ID qualifier - ISA - Partner)
Interchange receiver ID (ISA 08)
This value populates based on the value entered and saved in Interchange ID - ISA - Partner
- Required?
- Yes (must be entered and saved in Interchange ID - ISA - Partner)
- Repetition separator character (ISA 11)
- Drop-down listbox that enables you to choose a repetition character.
- Required?
- No
- Valid values
U
^
+
- Default
^
Interchange Control Version (ISA 12)
Drop-down listbox that enables you to choose which X12 version you use. If you choose
Custom
, another box appears in which you can enter an numeric value of your choice. Currently 004010
and 005010
are the supported X12 versions.- Required?
- No
- Valid values
004010 (4010)
005010 (5010)`
Custom
- Default
004010 (4010)
Request Interchange Acknowledgements (ISA 14)
Drop-down list that enables you to choose whether or not a 997 message is required.
- Required?
- Yes
- Valid values
0 (997 not required)
1 (997 required)
- Default
1 (997 required)
Default Interchange usage indicator (ISA 15)
Indicates whether you are in Test or Production with this trading partner.
- Required?
- Yes
- Valid values
Production
Test
- Default
Production
Component element separator character (ISA 16)
Indicates the character used to separate data. ">" is a commonly used character.
- Required?
- No
- Valid values
- Most special characters excluding numbers; must be a single character.
Alphanumeric
- Default
>
Group Headers (GS)
Version identifier code suffix (GS 08)
Enables you to identify the X12 version being used in the outbound message.
- Required?
- Yes
- Valid values
- 12 characters, alphanumeric
- Default
004010
Terminator/Delimiter
Segment terminator character
Identifies the end of X12 segment. "~" is a commonly used terminator character.
- Required?
- No
- Valid values
- Most special characters; must only be a single character only.
- Default
~
Data Element Delimiter
Separates data elements from each other. One of the most common values used in this field is “*”
- Required?
- No
- Valid values
- Most special characters except whole numbers; must be a single character only.
- Default
*
String substitution character
Character to be used to replace invalid characters in string values. Sends
null
to the server if has no value- Required?
- No
- Valid values
- Most special characters except whole numbers; must be a single character only.
- Default
- None provided
Character Set and Encoding
Character Set
Drop-down listbox enabling choice of three character sets.
- Valid values
- Basic
This character set includes:- Uppercase letters
A
throughZ
- Digits
0
through9
- Special characters
! “ & ’ ( ) * + , - . / : ; ? =
- The character created by pressing the space bar.
- Extended
This character set includes:- All characters in the Basic character set
- Lowercase letters
a
throughz
- Select language characters
- Other special characters:
% @ [ ] _ { } \ | < > ~ # $
- Unrestricted character set - includes all characters.
- Default
Basic
Character Encoding
Drop-down listbox enabling you to select character encoding.
- Required?
- Yes
- Valid values
ASCII
ISO-8859-1
IBM 1047
- Default
ASCII
Line ending between segment
Drop-down listbox that enables you to specify the type of line-ending you want on your outbound data Options include Carriage return (
CR
), Line feed (LF
), Line feed carriage return (LFCR
) or none.- Required?
- Yes
- Valid values
None
CR
LF
LFCR
- Default
None
Control Number Settings
Initial Interchange control number (ISA 13)
You can use this box to specify a whole number to appear in the ISA control number that begins your outbound documents with a Trading Partner. If a single digit is specified it will be padded with leading zeros.
- Required?
- No
- Valid values
- Alphanumeric
- Default
1
Initial GS control number (GS 06)
You can use this box to specify a whole number to appear in the GS control number that begins your outbound documents with a Trading Partner. If a single digit is specified it will be padded with leading zeros.
- Required?
- No
- Valid values
- Alphanumeric
- Default
1
Initial transaction set control numbers (ST 02)
You can use this box to specify a whole number to appear in the ST control number that begins your outbound documents with a Trading Partner. If a single digit is specified it will be padded with leading zeros.
- Required?
- No
- Valid values
- Alphanumeric
- Default
1
Implementation Convention reference (ST 03)
Used in the Healthcare space in X12 versions 5010 and above.
- Required?
- No
- Valid values
- Alphanumeric
- Default
- None provided
Require unique GS control numbers (GS06)
Select this checkbox to require unique GS control numbers.
Require unique transaction set control numbers (ST02)
Select this checkbox to require unique transaction set control numbers.
EDIFACT - Partner
EDIFACT (Electronic Data Interchange For Administration, Commerce and Transport) provides a set of standard messages which allow multi-country and multi-industry business document exchanges. EDIFACT is widely used across Europe.
Enter EDIFACT Identity Settings
Interchange ID qualifier - UNB
Enter your trading partners EDIFACT Interchange ID qualifier here. Choose from commonly used EDIFACT qualifiers or enter a custom qualifier.
- Required?
- No
- Valid values
8
9
12
14
16
ZZZ
Custom
- Default
- None provided
Interchange ID - UNB
Enter your trading partners EDIFACT Interchange ID here.
- Required?
- No
- Valid values
- Alphanumeric, 35 character maximum
- Default
- None provided
Enter EDIFACT Settings - Inbound (Read)
Header Settings (UNB)
Request Acknowledgements - UNB 9
This drop-down setting correlates to the EDIFACT document CONTRL. This document acts as a functional acknowledgement accepting or rejecting the documents sent.
- Required?
- Yes
- Valid values
1 (Acknowledgement requested)
2 (Confirmation of receipt only)
- Default
- None provided
Interchange Sender ID (UNB 2.1)
EDIFACT Interchange ID for your EDIFACT trading partner; auto-populated with the value entered in Interchange ID - UNB. If no value appears in this box, you must enter a value in Interchange ID - UNB.
Interchange sender ID qualifier (UNB 2.2)
Trading partners EDIFACT qualifier, auto-populated from Interchange ID qualifier - UNB. If no value appears in the box, you must enter a value in Interchange ID qualifier - UNB.
Interchange Receiver ID (UNB 3.1)
Your company’s EDIFACT Interchange Receiver ID; auto-populated from EDIFACT Identity Settings - Home Org. If no value appears in the box, you must enter a value in EDIFACT Identity Settings - Home Org.
Interchange receiver ID qualifier (UNB 3.2)
Auto-populated from EDIFACT Identity Settings - Home Org. If no value appears in the box, you must enter a value in EDIFACT Identity Settings - Home Org.
Parser Settings
There are eight optional parser settings that can be chosen for your trading partners inbound documents. The fields are listed below. The expected behavior if these options are checked is a CONTRL stating a failure will be sent for the condition.
- Fail document when value length outside allowed range
- Fail document when invalid character in value
- Fail document if value is repeated too many times
- Fail document if unknown segments are used
- Fail document when segments are out of order
- Fail document when unused segments are included
- Fail document when too many repeats of a segment
Terminator/Delimiter settings
These settings specify which special characters a trading partner wants to use as separators and terminators in the EDIFACT data. The min/max for this field is 1. All these fields are editable.
- Data element separator character
- The default value is “+”
- Component element separator character
- The default value is “:”
- Repetition separator character
- The default value is “*”
- Segment terminator character
- The default value is “ ‘ “
- Release character
- The default value is “? “
- String substitution character
- Character to be used to replace invalid characters in string values; no default given.
Control Number settings
These settings if checked will require unique inbound control numbers on all inbound documents for this trading partner.
- Require unique Message Reference Numbers
- Require unique Interchange Control Numbers
- Require unique Group Numbers
Enter EDIFACT Settings - Outbound (Write)
Header Settings (UNB)
Interchange Sender ID (UNB 2.1)
This field is the EDI Interchange ID for your Company. This is auto populated fromEDIFACT Identity Settings - Home Org.
Interchange sender ID qualifier (UNB 2.2)
This is a field for your EDIFACT Interchange sender ID qualifier. This is auto populated from EDIFACT Identity Settings - Home Org.
Interchange Receiver ID (UNB 3.1)
This field is your trading partners EDIFACT Interchange Receiver ID. This is auto populated from Interchange ID - UNB.
Interchange receiver ID qualifier (UNB 3.2)
This field is your trading partners EDIFACT Interchange Receiver ID qualifier. This is auto populated from Interchange ID qualifier - UNB.
Request Acknowledgements (UNB 9)
Indicates if your trading partner requires EDIFACT document acknowledgements; correlates to the EDIFACT document CONTRL.
- Required?
- No
- Valid values
1 (Acknowledgement requested)
2 (Confirmation of receipt only)
- Default
- None provided
Default test indicator (UNB 11)
Checkbox; select if you are testing EDIFACT documents (Outbound) with this trading partner.
- Required?
- No
- Default
- Not selected
Syntax version (UNB 1.2)
- Required?
- No
- Valid values
2
3
4
- Default
4
Parser Settings (checkboxes)
- Always send UNA
- Fail document when invalid character in value
Terminator/Delimiter
These settings specify which special characters your Company wants to use with a trading partner to separate and use as terminators in the EDIFACT data. The min/max for this field is 1. All these fields are editable.
- Data element separator character
- The default value is “+”
- Component element separator character
- The default value is “:”
- Repetition separator character
- The default value is “*”
- Segment terminator character
- The default value is “ ‘ “
- Release character
- The default value is “? “
- Line ending between segments
- Drop-down box that enables you to specify on your outbound data you would like CR (Carriage return) or Line feed (LF) or Line feed carriage return (LFCR) or none.
- String substitution character
- Character to be used to replace invalid characters in string values; no default given.
Character Set and Encoding
Message character encoding
- Required?
- No
- Valid values
ONOA (ISO 646)
UNOB (ISO 646)
UNOC (ISO 8859-1)
UNOD (ISO 8859-2)
UNOE (ISO 8859-5)
UNOF (ISO 8859-7)
UNOG (ISO 8859-3)
UNOH (ISO 8859-4)
UNOI (ISO 8859-6)
UNOJ (ISO 8859-8)
UNOK (ISO 8859-9)
UTF8
- Default
UNOA (ISO 646)
Control Number Settings
Initial Interchange Control Reference
A whole number can be specified in the Initial Interchange Control Reference number to begin on your outbound documents with this Trading Partner. If a single digit is specified it will be padded with leading zeros.
- Required?
- No
- Valid values
- Alphanumeric
- Default
None
Initial Message Reference Number
A whole number can be specified to begin on your outbound documents with this Trading Partner. If a single digit is specified it will be padded with leading zeros.
- Required?
- No
- Valid values
- Alphanumeric
- Default
None
Initial Group Reference
A whole number can be specified to begin on your outbound documents with this Trading Partner. If a single digit is specified it will be padded with leading zeros.
- Required?
- No
- Valid values
- Alphanumeric
- Default
None
Checkbox options:
- Use groups
- Use unique Message Reference Numbers
- Use unique Group Reference Numbers
Transactions - Partner
In the Transactions section you can configure specific transaction sets that you expect to process with this trading partner. Transactions can be inbound or outbound and each is defined by a transport protocol and format protocol. For example, if you expect to receive X12 850 messages and to respond with X12 856 messages, you would set those transactions up as inbound and outbound respectively.
To enter transaction information
- In left-hand pane of the Partnership page, click Transactions.
- In the upper right of the page, click New.
- In the Direction listbox, select Inbound or Outbound.
The default is Inbound.
Direction
- Inbound/Outbound
- Select the direction this transaction will be going. Outbound is from your Company to your Trading Partner’s. Inbound is from your Trading Partner to your Company.
Inbound
is the default.
Format - Partner
- Standard
- Select X12 or EDIFACT. If you check the “Use default for Inbound X12 for partner” This will use the settings already set up in X12 or EDIFACT as defaults. If you wish to configure a different format leave the check box unselected and enter the information pertaining to this specific transaction.
- Required?
- Yes
- Valid values
X12
EDIFACT
Alphanumeric
- Default
None
- Version
- Select the version of the standard you will be using for this specific transaction.
- Required?
- No
- Valid values
- X12
- 4010
- 5010
- EDIFACT
- D01B
- D02A
- D93A
- D96A
- D98B
- D95B
- D99A
- D99B
- D00A
- D03A
- Default
None
- Message Type
- Pick one of the Message Types in the dropdown. For X12 it is the numeric number of the transaction. with the friendly name appended (for example, 850Purchase Order).
For EDIFACT. the formal name of the document precedes the friendly name, as in ORDERS(Purchase Order). - Required?
- No
- Valid values
- Alphanumeric
- Default
None
Transport - Partner
Pick the method of transport you are going to use for this transaction.
If you have not defined the parameters for the transport chosen, go back to the AS2 or FTPS areas by clicking on the appropriate one in the left navigation bar to enter your default transport information. If you check the “Use default for Inbound AS2 for partner” this will use the settings already set up in AS2 or FTPS as defaults (once you have saved them).
You will then be able to click on the Transaction Type (In blue) and see your parameters and make any changes needed. If you make changes be sure and click the Update button. If you need to delete a Transaction the Blue “X” on the far right should be selected and a warning about are you sure you want to delete will appear.
Monitoring B2B Transmissions
APM supports monitoring tracking data for B2B transmissions.
You can use the settings in the following areas to filter for the specific data for which you are looking as well as to review and monitor errors and acknowledgements.
You can also search for metadata.
Partner
Leave unselected to search all trading partners, or select a specific partner by name.
Type
Select “All” to search all types of B2B messages. Select X12, EDIFACT, AS2, or FTPS to filter for messages by a specific format or transport. The Type selection also adjusts the fields that are displayed.
Select “All” to search all types of B2B messages. Select X12, EDIFACT, AS2, or FTPS to filter for messages by a specific format or transport.
Direction
Select the direction to view inbound messages only, outbound messages only, or both.
Date
Set the time window for the messages searched. You can quickly set all messages in the past day, week, or month, or set a custom date range.
File Name
Search for a specific file by its specific filename, or for all files that start with the same text.
Control #
Search for a message by Control# (only enabled when the Type is X12 or EDIFACT).
Metadata search
The fields are defined by name value pairs in the Anypoint work flow, which need to be done prior to using this specific search function (By your Developer) The meta data search will allow you to search for frequently used data queries inside your B2B transactions. An example would be if container was defined (in the Anypoint work flow) and you enter that defined value for Container (In what specific field in X12 or EDIFACT) and then the agreed upon name in the MetaData field and then in the value field the value you are searching for, say Container# CSQU3054383. If there are any matching documents, they will show in the results field.
Không có nhận xét nào:
Đăng nhận xét