Create partners for exchanging EDI and EDIFACT messages.
When you create a partner for EDI and EDIFACT messages, you configure general partner properties, select the types of messages to exchange with the partner, and define an inbound flow, an outbound flow, or both.
Before you create a partner, verify that you have completed the required prerequisites.
Before you begin
Before you create a partner for EDI and EDIFACT messages, complete the following prerequisites:
•For an inbound flow, if you plan to use process-to-backend custom mappings for the partner, you must create the mappings.
•For an outbound flow, you must create one or more process-from-backend custom mappings.
•If you plan to use an Advanced FTP V2, Advanced FTPS V2, Advanced SFTP V2, or AS2 Client connection, configure the connection in Administrator. For information about configuring the connection, see the respective connector guide.
•If you plan to use the File Servers connection, create a user account for each partner that sends files from an AS2, HTTPS, or SFTP server to your organization or receives files that you send to an HTTPS or SFTP server for the partner. For more information, see File server users.
•If you plan to run a flow based on a schedule, verify that the schedule has been created or create the schedule in Administrator.
•Verify that you have the appropriate asset privileges to create the partner and define the flows. For more information about privileges, see User roles.
Creating a partner for EDI and EDIFACT messages
Create a customer in the New Customer wizard, or create a supplier in the New Supplier wizard.
1Click New and select Partners > Customer or Partners > Supplier, as applicable.
The New Customer or New Supplier wizard appears.
2In the General page enter the partner name and number, select EDI X12 or EDIFACT from the File Type list, and then enter the message interchange details. Click Next.
The Messages page appears.
3Perform the following steps:
aClick Add Message to select a message type to exchange with the partner.
bIf required, edit the version, mode, or status of the message type.
cFor each message type, you can assign a custom process to process EDI messages of that type. To assign a custom process to a message type, perform the following tasks:
aCustomize a Library Data Transformation project in Informatica Developer.
bExport or deploy the transformation as a service. For more information, see the Data Transformation User Guide.
dIn the Custom Process field, select a transformation service from the list.
dFor each message type, you can attach a process-from-backend mapping. To attach a process-from-backend mapping to the message type, click the Actions button to the right of the line of the message type, click Add Process-from-Backend Mapping, select a mapping that is appropriate to the message type that you are adding, and then click Select.
Note: For both inbound and outbound flows, define each message type in one mapping only. If you define the same message type in both a message-specific backend processing mapping and in the flow's backend processing mapping, B2B Gateway might run messages of that message type twice. For example, if you define a process-from-backend mapping for the 810 Invoice message type for a customer, and 810 Invoice is also defined in the process-from-backend mapping that is defined for the outbound flow of the customer, B2B Gateway might run 810 Invoice messages twice.
eAdd as many message types as applicable for the partner.
fClick Next.
The Inbound page appears.
4To define an inbound flow, perform the following steps:
aSelect the connection type for the flow and configure connection details.
bIf you selected the Advanced FTP V2, Advanced FTPS V2, or Advanced SFTP V2 connection type, select the connection where B2B Gateway creates files for the partner and the action that B2B Gateway performs on the files after pickup.
cIf you selected the File Servers connection type, you can select a file transfer task in the Pre-Process area and define the task variables. You can select one of the following file transfer tasks:
Name
Description
Decrypt
Decrypts files that the partner uploads to the file server before the files are sent to B2B Gateway. For more information, see Decrypt.
Decompress
Decompresses files that the partner uploads to the file server before the files are sent to B2B Gateway. For more information, see Decompress.
dIf you selected the Local Folder/MFT, FTP Client, or SFTP Client connection type, select whether or not B2B Gateway deletes files after pickup.
eSelect a process-to-backend mapping if applicable and the location where B2B Gateway saves the mapping. This mapping is used for messages where a process-to-backend mapping is not associated with the message type.
fIf the mapping contains parameters, optionally enter parameter values in the Mapping Parameters list.
gFor EDI X12 messages, select whether to use element names or element reference numbers in the B2B Gateway XML interface files.
hDefine a schedule for the flow.
iClick Next.
The Outbound page appears.
Tip: If the outbound flow uses the same connection as the inbound flow, and the connection type is File Servers, Local Folder/MFT, FTP Client, or SFTP Client, click Copy Details from Inbound to populate the Outbound page with details that you entered in the Inbound page and then edit the outbound details, as required.
5To define an outbound flow, perform the following steps:
aSelect the connection type for the flow and configure connection details.
bIf you selected the Advanced FTP V2, Advanced FTPS V2, Advanced SFTP V2, or AS2 Client connection type, select the connection where B2B Gateway creates files for the partner.
cIf you selected the File Servers connection type, you can select a file transfer task in the Post-Process area and define the task variables. You can select one of the following file transfer tasks:
Name
Description
Encrypt
Encrypts files that you send to the partner before they are upload to the file server. For more information, see Encrypt.
Compress
Compresses files that you send to the partner before they are upload to the file server. For more information, see Compress.
dSelect one or both of the following mappings, and the locations where B2B Gateway saves the mappings:
▪ If you assigned process-from-backend mapping to specific messages on the Messages page, select a message discovery mapping.
▪ Select a process-from-backend mapping to use for messages where a process-from-backend mapping is not associated with the message type.
eIf the mappings contain parameters, optionally enter parameter values on the Mapping Parameters lists.
fOptionally configure message details.
gOptionally define a schedule for the flow.
hClick Save.
The partner shows on the Explore page.
Partner properties for EDI X12 and EDIFACT messages
Use the partner wizard to create or edit a partner. A partner can be either a customer or a supplier.
The partner wizard contains the following pages for EDI X12 and EDIFACT messages:
General page
Define partner details and message interchange details.
Messages page
Select the types of messages that you exchange with the partner and define general message details. For each message type that you select you can assign a custom process to process EDI messages of that type, and select process-to-backend and process-from-backend mappings for the message type, as applicable.
Inbound page
Define the connection to use for the inbound flow, select a file transfer task if applicable, select a custom process-to-backend mapping if applicable, and define the schedule by which the flow runs.
Outbound page
Define the connection to use for the outbound flow, select a file transfer task if applicable, select a message discovery mapping, a process-from-backend mapping, or both, configure message details, and define a schedule to run the flow.
Partner general properties for EDI and EDIFACT messages
Use the General page of the partner wizard to define partner details and message interchange details.
The General page includes the following properties for EDI and EDIFACT messages:
Customer or Supplier Details
Customer or Supplier Name
Name of the partner. The name can contain up to 30 characters and must be unique in the organization and can be used either for a customer or for a supplier, not for both. The name can contain alphanumeric characters, symbols, and special characters, and must not contain angled brackets (< or >).
Customer or Supplier Number
Number of the partner. The number can contain up to 15 characters and must be unique in the organization. The number can contain alphanumeric characters, symbols, and special characters, and must not contain angled brackets (< or >).
Tip: Use a number that identifies the partner in your organization.
File Type
Type of files to exchange with the partner. Select EDI X12 or EDIFACT.
Message Interchange Details
Customer or Supplier Interchange Qualifier
Partner interchange qualifier. Optional.
Customer or Supplier Interchange Production ID
Interchange identifier to use for messages of message types that are in production mode, as defined in the Messages tab. The identifier can contain up to 15 ASCII characters for X12 message and up to 30 characters for EDIFACT message.
To define multiple interchange production IDs for the partner, click Manage Multiple IDs, add the IDs, and click OK. You can define up to 50 interchange production IDs.
Customer or Supplier Interchange Test ID
Interchange identifier to use for messages of message types that are in test mode, as defined in the Messages tab. The identifier can contain up to 15 ASCII characters for X12 message and up to 30 characters for EDIFACT message.
To define multiple interchange test IDs for the partner, click Manage Multiple IDs, add the IDs, and click OK. You can define up to 50 interchange test IDs.
When you define interchange IDs for the partner, consider the following requirements:
▪ You must enter at least one partner Interchange ID. For more information, see Partner interchange IDs.
▪ If you define multiple interchange IDs of the same type for the partner, you must pass the interchange ID to use in outbound flows as a parameter in the process-from-backend mapping that you assign to the partner. For more information, see Creating a process-from-backend mapping for outbound EDI message flows.
Customer or Supplier Group ID
Partner group identifier to use in outbound messages as the Application Receiver's Code, GS-03. Applies to X12 messages.
You can use the group identifier to differentiate between groups in your organization, so that the receiver of the messages can redirect the EDI data to the appropriate recipients. For example, assign each department in the organization a unique group identifier.
Organization Interchange Qualifier
Organization interchange qualifier to use in outbound message to your partners. By default, the qualifier that is defined in the organization setup. If you want B2B Gateway to use a different qualifier in outbound messages for this partner, enter the qualifier here.
Organization Interchange ID
Organization interchange identifier to use in outbound message to your partners. By default, the identifier that is defined in the organization setup. If you want B2B Gateway to use a different identifier in outbound messages for this partner, enter the identifier here.
Partner messages properties for EDI and EDIFACT messages
Use the Messages page of the partner wizard to select the types of messages that you exchange with partners that you exchange EDI X12 and EDIFACT messages with and to define general message details.
Note: B2B Gateway rejects incoming messages of a type that is not selected or is disabled for the partner.
The Messages page can include the following properties for EDI and EDIFACT messages:
Messages
To select the types of messages that you exchange with the partner, click Add Message and then select the message type to add, or select Add all to add all supported message types. The list of message types includes the supported EDI X12 or EDIFACT message types, based on the file type you select for the partner on the General page.
For each message type, select the version number that you use and select whether to use this type of message in test mode or in production mode. After you select a message type you can disable and enable the use of the message type in exchanges with the partner, as required.
For each message type, you can assign a custom process to process EDI messages of that type. To assign a custom process to a message type, perform the following tasks:
1Customize a Library Data Transformation project in Informatica Developer.
2Export or deploy the transformation as a service. For more information, see the Data Transformation User Guide.
4In the Custom Process field, select a transformation service from the list.
For each message type, you can attach a process-from-backend mapping. To attach a process-from-backend mapping to the message type, click the Actions button to the right of the line of the message type, click Add Process-from-Backend Mapping, select a mapping that is appropriate to the message type that you are adding, and then click Select.
Security Information Qualifier
Applicable to the EDI X12 file type. Select the code to identify the type of information in Security Information. If you select the option 01 Password, enter the information in the Security Information field. Security information can contain up to 10 ASCII characters.
Authorization Information Qualifier
Applicable to the EDI X12 file type. Select the code to identify the type of information in Authorization Information. If you select an option other than 00 No Authorization Information Present, enter the information in the Authorization Information field. Authorization information can contain up to 10 ASCII characters.
Partner inbound properties for EDI and EDIFACT messages
Use the Inbound page of the partner wizard to define the inbound flow for the partner.
The Inbound page can include the following properties for EDI and EDIFACT messages:
Connection
The Connection area includes the following properties:
Connection Type
Select the type of the connection from where B2B Gateway picks up files. You can select the following connection types:
▪ Advanced FTP V2
▪ Advanced FTPS V2
▪ Advanced SFTP V2
▪ File Servers (AS2, HTTPS, SFTP)
▪ Local Folder/MFT
▪ FTP Client
▪ SFTP Client
Connection
Connection where B2B Gateway creates files for the partner. Applies to the Advanced FTP V2, Advanced FTPS V2, and Advanced SFTP V2 connection types.
You configure connections in Administrator. For information about configuring the connections, see the respective connector guides.
File Server User
The file server user name for the partner from whom you receive files. Applies to the file servers connection type.
You create file server users in Administrator. For information about creating file server users, see the Administrator help.
Host
Host where the files that B2B Gateway picks up are located. Applies to the Local Folder/MFT, FTP Client, and SFTP Client connection types.
Port
Port where the files that B2B Gateway picks up are located. Applies to the Local Folder/MFT, FTP Client, and SFTP Client connection types.
Source Directory
Path to the directory on the connection from where B2B Gateway picks up files. Applies to the Local Folder/MFT, FTP Client, and SFTP Client connection types.
File Pattern
Pattern that defines the names of the files that B2B Gateway picks up. The pattern must be a Java regular expression.
For example:
To pick up all files enter .*
To pick up only files that start with ab enter ab\S.*
Tip: After you configure the connection click Test Connection to test and validate the connection.
File Pattern
Select the file pattern type to pick up.
After File Pickup
Action that B2B Gateway performs on the files after pickup. Applies to the Advanced FTP V2, Advanced FTPS V2, and Advanced SFTP V2 connection types.
Choose one of the following options:
▪ Keep Files. Keep the files in the source location.
▪ Delete Files. Delete the files from the source location.
▪ Archive Files. Moves the files from the source location. Enter the target location in Archive Directory.
▪ Rename Files. Rename the files in the source location. Enter a suffix to add to the original file name in New File Name Suffix.
Delete files on source after pickup
Determines whether or not B2B Gateway deletes files after pickup. Selected by default. Applies to the Local Folder/MFT, FTP Client, and FTPS Client connection types.
Pre-Process
Optionally, select a file transfer task to run actions on files that you receive from the partner. Applies to the file servers connection type.
You can select one of the following file transfer tasks:
Name
Description
Decrypt
Decrypts files that the partner uploads to the file server before the files are sent to B2B Gateway. For more information, see Decrypt.
Decompress
Decompresses files that the partner uploads to the file server before the files are sent to B2B Gateway. For more information, see Decompress.
Processing
The Processing area includes the following properties:
- Process-to-Backend Mapping. Optionally, select a mapping to process files from B2B Gateway to the organization backend system. This mapping is used for messages where a process-to-backend mapping is not associated with the message type.
- Mapping Location. Location where B2B Gateway saves the mapping.
- Mapping Parameters. Lists the mapping parameters. You can enter parameter values in the Value fields.
- XML Interface Files. Determines whether to use element names or element reference numbers in the B2B Gateway XML interface files. Applies to EDI X12 messages.
Select whether or not to send acknowledgments to the partner. If you select to send acknowledgments, B2B Gateway generates and sends acknowledgments to the partner upon receiving and processing messages. Selected by default.
Schedule
Schedule by which to run the flow. Select one of the following options:
- Manually or by an external trigger. No schedule. You can run the flow from the Explore page or from a REST API. You can also run the flow from the Partner wizard.
- By schedule. Runs the flow according to the defined schedule. Select a schedule from the list.
Note: To run a flow by a schedule, users need Read and Run permissions for schedules. If permissions are not configured, users cannot see existing schedules. For more information about permissions, see User roles.
- By file listener. Runs the flow according to the defined file listener rules. Select a file listener from the list. You create file listeners in Data Integration. For information about creating file listeners, see Components in the Data Integration help.
Partner outbound properties for EDI X12 and EDIFACT messages
Use the Outbound page of the partner wizard to define the outbound flow for the partner.
The Outbound page can include the following properties for EDI X12 and EDIFACT messages:
Copy Details from Inbound
Populates the fields in the Outbound page with the details that you entered in the Inbound page. You then edit the fields in the Outbound page as required. Applies to the File Servers, Local Folder/MFT, FTP Client, and SFTP Client connection types.
Connection
The Connection area includes the following properties:
Connection Type
Select the type of the connection where B2B Gateway creates the files for the partner. You can select the following connection types:
▪ Advanced FTP V2
▪ Advanced FTPS V2
▪ Advanced SFTP V2
▪ AS2 Client
▪ File Servers (HTTPS, SFTP)
▪ Local Folder/MFT
Connection
Connection where B2B Gateway creates files for the partner. Applies to the Advanced FTP V2, Advanced FTPS V2, Advanced SFTP V2, and AS2 Client connection types.
You configure connections in Administrator. For information about configuring the connections, see the respective connector guides.
File Server User
The file server user name for the partner from whom you receive files. Applies to the File Servers connection type.
You create file server users in Administrator. For information about creating file server users, see the Administrator help.
Host
Host where B2B Gateway creates the files. Applies to the Local Folder/MFT, FTP Client, and SFTP Client connection types.
Port
Port where B2B Gateway creates the files. Applies to the Local Folder/MFT, FTP Client, and SFTP Client connection types.
Target Directory
Path to the directory on the connection where B2B Gateway creates the files.
Pattern Type
Select the file name pattern type to create.
Pattern Type
Select the file name pattern type to create.
File Pattern
Select the outbound acknowledgment file name pattern.
For example:
($eventId).edi
The patterns are not case sensitive. For more information about the file patterns that you can use in the outbound flow definition, see File Patterns.
Post-Process
Applies to the file servers connection type. Optionally, select a file transfer task to run actions on files that you send to the partner. You can select one of the following file transfer tasks:
Name
Description
Encrypt
Encrypts files that you send to the partner before they are upload to the file server. For more information, see Encrypt.
Compress
Compresses files that you send to the partner before they are upload to the file server. For more information, see Compress.
Processing
The Processing area includes the following properties:
- Message Discovery Mapping. Use if you assigned a process-from-backend mapping to specific messages on the Messages page.
- Process-from-Backend Mapping. Use for messages where a process-from-backend mapping is not associated with the message type.
- Mapping Location. Location where B2B Gateway saves the mapping.
- Mapping Parameters. Lists the parameters of the process-from-backend mapping. You can enter parameter values in the Value fields.
Tip: If required, you can temporarily override the values that you define here by defining different values in the Run Partner REST API and running the flow with the API. For more information, see Run Partner REST API.
Message Details
The Message Details area includes the following properties:
- Data Element Separator. Symbol used in the file as a data element separator.
- Repetition Separator. Symbol used in the file as a repetition separator.
- Component Element Separator. Symbol used in the file as a component element separator.
- Segment Terminator. Symbol used in the file as a segment terminator. Select Add new line to start a new line at the end of the segment.
- Decimal mark. Symbol used in the file as a decimal mark. Applies to the EDIFACT file type.
- Release Character. Symbol used in the file as a release character. Applies to the EDIFACT file type.
- Control Number. Determines the type of numbers to use as control numbers in outbound messages, including outgoing acknowledgments. You can choose one of the following options:
▪ Use event ID. B2B Gateway adds file event IDs as control numbers to outbound messages and acknowledgments. Selected by default.
▪ Use sequence numbers. B2B Gateway uses number sequences to determine the control numbers. The initial interchange control and group control numbers start the sequences. B2B Gateway adds the initial interchange control and group control numbers to the first outbound message or acknowledgement, and increments the numbers sequentially for subsequent messages.
To reset the sequence of a control number, click Edit Initial Number next to the number to reset, enter the new initial number, and click OK. Control numbers can include only numeric characters. The allowed number of digits in control numbers is nine digits for EDI X12 messages and 14 digits for EDIFACT messages.
- Request technical acknowledgment (TA1). Determines whether or not you receive a technical acknowledgment for the file you send. Selected by default. Applies to the EDI X12 file type.
- Request functional acknowledgment (997). Determines whether or not you receive a functional acknowledgment for a functional group in the file you send. Selected by default. Applies to the EDI X12 file type.
- Add UNG group header. Determines whether or not message type events show the functional groups that are sent in the file. By default, not selected. Applies to the EDIFACT file type.
- Request acknowledgment. Determines whether or not you receive an acknowledgment when you send the file. Selected by default. Applies to the EDIFACT file type.
Note: Separators and terminators must be unique. You cannot assign the same symbol to more than one separator or terminator.
Schedule
Schedule by which to run the flow. Select one of the following options:
- Manually or by an external trigger. No schedule. You can run the flow from the Explore page or from a REST API. You can also run the flow from the Partner wizard.
- By schedule. Runs the flow according to the defined schedule. Select a schedule from the list.
Note: To run a flow by a schedule, users need Read and Run permissions for schedules. If permissions are not configured, users cannot see existing schedules. For more information about permissions, see User roles.
- By file listener. Runs the flow according to the defined file listener rules. Select a file listener from the list. You create file listeners in Data Integration. For information about creating file listeners, see Components in the Data Integration help.