E-5 2000 Adapter
The E-5 2000 adapter uses predefined business processes to assist communication with other E-5 servers or clients. These business processes provide client and server functions for delivering a document, obtaining a resultant document, and acknowledging receipt of a resultant document.
The E-5 2000 adapter enables business processes to interact with E-5 clients and servers. E-5 is a B2B standard developed by the Automotive Industry Action Group (AIAG). This adapter provides computer-to-computer delivery and receipt of EDI, XML, or other proprietary data agreed upon by the trading partners.
- Provide E-5 client-side services
- Provide E-5 server-side services
The following table provides an overview of the E5 Client Configuration adapter:
Category | Description |
---|---|
System name | None |
Graphical Process Modeler (GPM) categories | All Services, Internet B2B |
Description | The E5 Client Configuration adapter is a set of model business processes that allows a user to send and retrieve documents from an E-5 server. |
Preconfigured? | No |
Requires third-party files? | No |
Platform availability | All supported Sterling B2B Integrator platforms |
Related services | E5 Client Configuration service |
Application requirements | The adapter supports E-5 2000 or version 2.0 of the E-5 standard. Previous versions of E-5 are not supported. |
Initiates business processes? | No |
Invocation | The API Definition, Deliver Submit, Obtain Submit and Acknowledge Submit run by starting the E5Client_StartSubmit.bpml. The Loop Back Test runs by starting the E5Client_LoopBackTest.bpml |
Business process context considerations | Business process context considerations:
|
Returned status values | If a message code of Serious is returned from the E-5 server, the E5 Client Configuration adapter sends the business process an error. |
Restrictions | There can be multiple configurations of this service. |
Testing considerations | See Testing the E5 Client Configuration Adapter. |
The following table provides an overview of the E5 Server Configuration adapter:
Category | Description |
---|---|
System name | None |
Graphical Process Modeler (GPM) categories | All Services, Internet B2B |
Description | The E5 Server Configuration adapter is a set of model business processes that acts as a server by receiving and storing documents from an E-5 client. These documents can also be retrieved by E-5 clients. |
Preconfigured? | No |
Requires third-party files? | No |
Platform availability | All supported Sterling B2B Integrator platforms |
Related services | E5 Server Configuration service, E5 Obtain service |
Application requirements | For information on how to deploy the E5 Server Configuration adapter for Sterling B2B Integrator, see the User Manual. |
Business process context considerations | No |
Returned status values | When applicable error messages are returned to the E-5 client. |
Restrictions | There may be multiple configurations of this service. |
Testing considerations | See Testing the E-5 Server Configuration Adapter. |
Requirements
- The E-5 2000 specification (E-5 version 2.0 or AIAG Guideline for Electronic Commerce Message Routing).
- XML concepts
- How process data and documents are handled in Sterling B2B Integrator
- BPML concepts
- Trading partner setup
- Perimeter server configuration
For the E-5 2000 adapters to work correctly, verify that you have installed and configured a Perimeter server to work with the HTTP Server adapter.
How the E-5 2000 Adapter Works
The E5 Client Configuration adapter is a set of business processes that can be used within Sterling B2B Integrator to facilitate communication with an E-5 server. The E5 Client Configuration adapter uses Sterling B2B Integrator trading profiles and the HTTP Send adapter in conjunction with the custom developed E5 Client Configuration service and other internal Sterling B2B Integrator services to send documents and retrieve them from an outside E-5 server. The E-5 business processes are customizable examples of how a customer can use Sterling B2B Integrator services to communicate with an E-5 server.
The Sterling B2B Integrator E5 Client Configuration service enables you to specify parameters that are required to send E-5 requests. See Configuring the E5 Client Configuration and E5 Server Configuration Services for more detailed information.
The E5 Server Configuration adapter is a set of business processes used within Sterling B2B Integrator to facilitate communication with an E-5 client. The E5 Server Configuration adapter uses the Sterling B2B Integrator HTTP Server adapter in conjunction with the custom-developed E5 Server Configuration service, E5 Obtain service, and other internal Sterling B2B Integrator services to receive and store documents as well as retrieve documents requested by E-5 clients. The E-5 business processes are customizable examples of how a customer can use Sterling B2B Integrator services to communicate with an E-5 client.
The E5 Server Configuration service enables you to specify parameters that are required to respond to E-5 requests. See E5 Server Adapter Configuration for more detail.
The adapter will receive unsolicited messages in the proper format and start a BPML to process the incoming data. The adapter will also provide, through the services of the Correlation service and API, a repository of documents that can be searched by an E-5 client to obtain responses to delivered documents.
E-5 Client and Server Interactions
The following example shows standard client/server interactions that this adapter supports:
Message Formats
E-5 communication is a synchronous request/response model. Each API command has a DTD specification for the request and the response metadata that accompanies the actual data in the transfer. The response should be received in the same HTTP session.
The following figure shows a typical message format with metadata in the form of XML and the data being transferred. All messages are packaged in MIME formatting. The E-5 2000 adapter uses the HTTP Server adapter and the HTTP Send adapter or the new HTTP Client adapter. The transport mechanism to communicate with the far-end E-5 server is HTTP or HTTP/S. Communications are secure according to those standards.
Implementing the E-5 2000 Adapter
- Activate your license for the E5 Client Configuration and E5 Server Configuration adapters. See An Overview of Implementing Services.
- Configure trading profiles for E-5. The following sample trading
partner configurations are located in the install_dir\e5
samples\TradPartnerProfiles folder:
- E5TPP.xml – non-SSL trading partner configuration
- E5SSLTPP.xml – SSL trading partner configuration
Special configuration of the server transport is required if using SSL:
- Specify port 443 in URL. You might need to leave the URL as HTTP instead of HTTPS, to avoid potential issues sometimes experienced when using JAVA to decode HTTPS as a URL.
- On the Security page, select Must for SSL, STRONG for Cipher strength, and add the certificate you use
- Configure the DTDs using the Sterling B2B Integrator Map Editor:
- Load the DTDs from the si_install\e5 samples\dtds folder.
- Map the DTD corresponding to the desired request to your information.
Special instructions for mapping the Obtain Submit DTD:
- Go to withs->between->Attributes->name. Right click on name and select properties. Select the Type tab and in the default selection click the button for Implied, the default value should now be grayed out.
- Go to withs->equals->Attributes->name. Right click on name and select properties. Select the Type tab. Select CDATA for the Attribute Type. In the default selection click the button for Implied, the default value should now be grayed out.
- Go to bys->by->Attributes->name. Right click on name
and select properties. Select the Type tab. Select CDATA for the Attribute
Type. In the default selection click the button for Implied, the default
value should now be grayed out.
The E-5 2000 adapter is dependent on the DTDs that are packaged with the adapter. Changes to the DTDs loaded into Sterling B2B Integrator may cause adapter failure.
- Create configurations for the E5 Client Configuration and E5 Server Configuration services. See Creating a Service Configuration.
- Configure the E5 Client Configuration and E5 Server Configuration services. See Configuring the E5 Client Configuration and E5 Server Configuration Services.
- Edit the following preconfigured configurations:
- E5 HTTP Send adapter Note: Because of our continuing efforts to improve services and adapters to align with new technology and capabilities, the HTTP Send adapter has entered the retirement process in Sterling B2B Integrator and will be replaced with the HTTP Client adapter and its related services. See Retiring and Removed Services and Adapters.
- E5 Lightweight JDBC adapter: Define the following configuration
fields:
Start a new business process - select This Lightweight JDBC adapter will not start a new business process
Pool Name - select the pool name
- E5 HTTP Send adapter
- Use the E-5 adapter in a business process.
Configuring the E5 Client Configuration and E5 Server Configuration Services
To configure the E5 Client Configuration and E5 Server Configuration services, you must specify field settings in Sterling B2B Integrator.
E5 Client Adapter Configuration
- In Sterling B2B Integrator,
edit the following fields, as appropriate:
The field names in parentheses represent the corresponding field names in the GPM. This information is provided for your reference.
Note: Because of our continuing efforts to improve services and adapters to align with new technology and capabilities, the HTTP Send adapter has entered the retirement process in Sterling B2B Integrator and will be replaced with the HTTP Client adapter and its related services. See Retiring and Removed Services and Adapters.Field Description Name Unique and meaningful name for the service configuration. Required. Description Meaningful description for the service configuration, for reference purposes. Required. Select a Group Select one of the options: - None – You do not want to include this configuration in a group at this time.
- Create New Group – You can enter a name for a new group in this field, which will then be created along with this configuration.
- Select Group – If you have already created one or more groups for this service type, they are displayed in the list. Select a group from the list.
Note: See Using Service Groups.E5 Sending Contract Name (E5_CONTRACTID) Choose the trading profile contract name for sending to the remote E5 server. Required. E5 Remote Username (E5_USERNAME) Remote E5 server username. Required. This username was created as part of the E5 HTTP Send adapter configuration. E5 Authentication (E5_AUTHENTICATION) To use E5 server authentication, type TRUE; otherwise, type FALSE. Required. Certificate Name(s) (E5_CERTIFICATENAME) If SSL is being used, enter the certificate names. Required if using SSL. - Exchange certificates with the E-5 server if using SSL. Check in the E-5 certificates as a trusted certificate. If Sterling B2B Integrator uses a CA certificate, check in the E-5 certificate as a CA certificate.
E5 Server Adapter Configuration
- In Sterling B2B Integrator,
edit the following fields, as appropriate:Note: It is not recommended that you create more than one instance of this service.
Field Description Name Unique and meaningful name for the service configuration. Required. Description Meaningful description for the service configuration, for reference purposes. Required. Select a Group Select one of the options: - None – You do not want to include this configuration in a group at this time.
- Create New Group – You can enter a name for a new group in this field, which will then be created along with this configuration.
- Select Group – If you have already created one or more groups for this service type, they are displayed in the list. Select a group from the list.
Note: See Using Service Groups.E5 DTD Directory Path to where the E5 DTDs are stored. Required. Local E5 API URI URI where an outside E5 server may send an E5 API Request to Sterling B2B Integrator. Required. Local URI for the E5 API Result DTD URI where an outside E5 server may access the E5 API Result DTD on Sterling B2B Integrator. Required. Local E5 Deliver URI URI where an outside E5 server may send an E5 Deliver Request to Sterling B2B Integrator. Required. Local URI for the E5 Deliver Submit DTD URI where an outside E5 server may access the E5 Deliver Submit DTD on Sterling B2B Integrator. Required. Local URI for the E5 Deliver Result DTD URI where an outside E5 server may access the E5 Deliver Result DTD on Sterling B2B Integrator. Required. Local E5 Obtain URI URI where an outside E5 server may send an E5 Obtain Request to Sterling B2B Integrator. Required. Local URI for the E5 Obtain Submit DTD URI where an outside E5 server may access the E5 Obtain Submit DTD on Sterling B2B Integrator. Required. Local URI for the E5 Obtain Result DTD URI where an outside E5 server may access the E5 Obtain Result DTD on Sterling B2B Integrator. Required. Local E5 Acknowledge URI URI where an outside E5 server may send an E5 Acknowledge Request to Sterling B2B Integrator. Required. Local URI for the E5 Acknowledge Submit URI DTD URI where an outside E5 server may access the E5 Acknowledge Submit DTD on Sterling B2B Integrator. Required. Local URI for the E5 Acknowledge Result URI DTD URI where an outside E5 server may access the E5 Acknowledge Result DTD on Sterling B2B Integrator. Required. Local E5 Deliver Loop Back Test URI URI where an outside E5 server may send an E5 Deliver Loop Back Test Request to Sterling B2B Integrator. Required. E5 Template Path Path to the E5 server templates. Required. - Install and configure a Perimeter server for use with the E-5 adapter.
- Create a configuration of the HTTP Server adapter for use with
the E-5 adapter. See Creating a Service Configuration and HTTP
Server Adapter, using the following E-5 specific settings for
the fields indicated:
- User Authentication field: Yes
You must create the user on the server side, then give the username and password to the E-5 client.
- URIs field: The following table shows a sample configuration of
the URIs for the HTTP Server adapter to support the E-5 server business
processes. Set up your HTTP Server adapter in a similar fashion before
communicating with the far end E-5 client.
URI BPML To Run Raw Messages /b2bhttp/inbound/E5Server E5Server_Receive_All Yes /b2bhttp/inbound/E5ServerAPI E5Server_Receive_APIRequest No /b2bhttp/inbound/E5ServerLoopBackTest E5Server_LoopBackTest Yes /b2bhttp/E5_V20_APIs_Result.dtd E5Server_DTD_Response Yes /b2bhttp/E5_V20_Deliver_Submit.dtd E5Server_DTD_Response Yes /b2bhttp/E5_V20_Deliver_Result.dtd E5Server_DTD_Response Yes /b2bhttp/E5_V20_Obtain_Submit.dtd E5Server_DTD_Response Yes /b2bhttp/E5_V20_Obtain_Result.dtd E5Server_DTD_Response Yes /b2bhttp/E5_V20_Acknowledge_Submit.dtd E5Server_DTD_Response Yes /b2bhttp/E5_V20_Acknowledge_Result.dtd E5Server_DTD_Response Yes /b2bhttp/inbound/E5Server_Obtain E5Server_Receive_Obtain Yes
- User Authentication field: Yes
E5 Client Configuration Adapter Business Processes
The following table describes the predefined business processes associated with the E5 Client Configuration adapter:
BPML Name | Usage Description |
---|---|
E5Client_Acknowledge_Submit.bpml |
|
E5Client_Deliver_Submit.bpml |
|
E5Client_GetAPI.bpml |
|
E5Client_LoopBackTest.bpml |
|
E5Client_Obtain_Submit.bpml |
|
E5Client_Release_B2B.bpml |
|
E5Client_StartSubmit.bpml |
|
E5_MIME_Decode_Obtain.bpml |
|
E5_MIME_Encode.bpml |
|
Facade BPML
Use a facade BPML to run the predefined business processes listed in E5 Client Configuration Adapter Business Processes. The facade contains the environmental setup information that enables the business process to communicate successfully with E-5 servers. You should customize the facade to meet the specific needs of your company.
BPML | Description |
---|---|
API Definition |
|
Deliver Submit |
|
Obtain Submit |
|
Acknowledge Submit |
|
Loop Back Test |
|
E5 Server Configuration Adapter Business Processes
The following table describes the predefined business processes associated with the E5 Server Configuration adapter:
BPML Name | Usage Description |
---|---|
E5Server_Acknowledge.bpml |
|
E5Server_DTD_Response.bpml |
|
E5Server_Deliver.bpml |
|
E5Server_Deliver_ProcessAttachment.bpml |
|
E5Server_Deliver_ProcessDocument.bpml |
|
E5Server_Input_ErrorMsg.bpml |
|
E5Server_LoopBackTest.bpml |
|
E5Server_Obtain.bpml |
|
E5Server_Receive_APIRequest.bpml |
|
E5Server_Receive_All.bpml |
|
E5Server_StoreValues.bpml |
|
E5_MIME_Decode.bpml |
|
E5_MIME_Encode_Obtain.bpml |
|
E5Server_Receive_Obtain.bpml |
|
BPML Error Handling
- Service failures – Can be detected by on fault BPML constructs.
- Detectable errors – Must be checked for specifically.
Functionality Supported for Sterling B2B Integrator
- Support up to four “equals” search parameters
- Wildcard character searches are supported
- No support for “between” searching
- No support for “by” searching
Acknowledgement of Document(s) removes it from the list of possible documents to be returned in an Obtain search. This adapter follows the standard for not Obtaining Documents that have an Acknowledge DateTime set, due to contradictions in the E-5 specification.
Testing the E5 Client Configuration Adapter
- Configure the E5ClientConfig service instance.
- Using the following table, perform the steps for each E-5 operation,
and then verify the results:
E-5 Operation Steps Result API Definition - Invoke E5ClientConfig.
- Place no documents in ProcessData.
- Invoke E5Client_StartSubmit.bpml.
API Definition Results document should be the PrimaryDocument. Deliver Submit - Invoke E5ClientConfig.
- Place the Deliver Submit document as PrimaryDocument and attachment document as AttachmentDocument in ProcessData.
- Invoke E5Client_StartSubmit.bpml.
Deliver Results document should be the PrimaryDocument. Obtain Submit - Invoke E5ClientConfig.
- Place the Obtain Submit document as PrimaryDocument in ProcessData.
- Invoke E5Client_StartSubmit.bpml.
Obtain Results documents and attachment documents, named RoutingDocDecoded_1, AttachmentDocDecoded_1, RoutingDocDecoded_2, etc. Acknowledge Submit - Invoke E5ClientConfig.
- Place the Acknowledge Submit document as PrimaryDocument in ProcessData.
- Invoke E5Client_StartSubmit.bpml.
Acknowledge results document should be the PrimaryDocument. Loop Back Test - Invoke E5ClientConfig.
- Place the Deliver Submit document as PrimaryDocument and attachment document as AttachmentDocument in ProcessData.
- Invoke E5Client_LoopBackTest.bpml.
RoutingDocDecoded_1 and AttachmentDocDecoded_1
Testing the E-5 Server Configuration Adapter
- Configure service instances for the E-5 Server Configuration service, E-5 Obtain service, and HTTP Server adapter.
- Using the following table as a guide, test each of the E-5 operations
by verifying that the E-5 client submitted the correct document:
E-5 Operation Description API Definition - The client sends the request (configured per the specifications in the AIAG Guideline for Electronic Commerce Message Routing) to the URI that has been set up to handle API requests. This request is received through the HTTP Server adapter
- Invokes the E5Server_Receive_APIRequest.bpml.
- An API definition document is created using a template placed in a predefined location and the document is returned to the E-5 client.
Deliver Submit - The client sends the meta data and document according to the specifications in the AIAG Guideline for Electronic Commerce Message Routing. The request is sent to the URI that has been set up to handle general E-5 server requests and is received through the HTTP Server adapter
- Invokes the E5Server_Receive_All.bpml.
- The document is stored in the Correlation service along with name/value pairs based on the meta data and other parameters.
- A Deliver results document is created using a template placed in a pre-defined location and the document is returned to the E-5 client.
Obtain Submit - The client sends the request according to the specifications in
the AIAG Guideline for Electronic Commerce Message Routing.
Note: Bys and Betweens are not supported in this E5 server.
- The request is sent to the URI that has been set up to handle general E-5 server requests and is received through the HTTP Server adapter.
- Invokes the E5Server_Receive_All.bpml. The E5 Obtain service is used to search the Correlation service for the requested information.
- The Obtain results are returned to the E-5 client.
Acknowledge Submit - The client sends the request according to the specifications in the AIAG Guideline for Electronic Commerce Message Routing. The request is sent to the URI that has been set up to handle general E-5 server requests and is received through the HTTP Server adapter.
- Invokes the E5Server_Receive_All.bpml. The acknowledgeFlag and acknowledgeDateTime are updated in the Correlation service.
- The acknowledge results are returned to the E-5 client.