Working with a Use Case Scenario
Demonstrate the usage of receiving messages over AS2 Protocol from Remote Partner.
To do this, below activities need to be performed:
- Configure Host Trading Party in B2B Dashboard (to receive data from Remote Partner) by
- Adding Host, Contact details and Host Channel, and then Configuring Host Protocol Channel
- Adding Receive Agreements
- Adding Message Type and Message Type Bindings
- Create two Event Processes in Fiorano eStudio using
- B2BConnector to receive messages over AS2 from an external entity
- AS2Connector to represent Remote Partner, the external entity
- Run the Event Processes and validate the result
Above steps are explained in detail in the sections below.
In Fiorano B2B Dashboard you need to configure Host Party to receive data and configure Trading Party to send data. The Trading Parties section captures the information about the entities within the organization as well as the partners.
Configuring Host Trading Parties
After the database gets loaded, configure the Host Party and specify the protocol used for the connection between them and also the Message Type. In the below illustration, AS2 protocol is being used to explain the configuration.
Add Host Trading Party
The Host Trading Party needs to be added to configure FioranoB2B to receive data from a remote partner.
To add Host, perform the following actions:
- Click the Add button present on the Trading Parties tab in the Navigation Panel.
Figure 1: JMS Configuration screen
- In the Add Trading Party dialog box, provide preferred data in the fields: Unique ID and Name, and select 'Host' from Type drop-down.
Figure 2: Entering Host Trading Party details
- Click OK to navigate to Contacts page.
Add Host Contact details
In the Contacts page, the Name and Type fields will be auto-populated as entered while adding Host. Fill-in rest of the the contact details in General Info section under the Basic tab.
Figure 3: Contacts section
After the contact details, click Save button present in the Contacts page and then click OK in the Save pop-up that appears as a confirmation of the Host trading party details added.
Figure 4: Confirmation message saying that Trading Party details are saved
Add Host channel
- Click Channels tab and click the Add button in Channels section.
In the Add Channel dialog box, add a unique ID in Channel ID field and select the desired protocol from the Protocol drop-down.
- Click OK to configure AS2 channel.
Figure 5: Adding host channel
Configuring Host Protocol Channel
Fill-in the mandatory fields in the Protocol Parameters section, that is, under Connection Configuration.
- Provide IP address of the host in Host field and an available port which is not in use in Port field and a name in Context Name.
Figure 6: Configuring AS2 channel
- Click Save button in the Contacts page to save both the basic and channel details in the database to save the channel protocol details.
Add Receive Agreements for receiving documents
Business Agreements define the contract between the host and the remote trading party to send or receive documents using a specific channel (protocol). They can be used to monitor and manage the interactions with partners and also define a time period for the interaction after which the agreement will become inactive.
Add Receive Agreement
- Click the Add button present on the Agreements tab in Navigation Panel.
Figure 7: Adding Receive Agreement
- In Agreement ID dialog box, provide a unique ID and click OK.
Figure 8: Providing Agreement ID
Configure Receive Agreement
Perform the following actions in the Business Agreements page:
- Select host and host channel, which were added earlier, pre-populated in the Host and Channel drop-downs respectively.
- Provide Start Date and End Date of the agreement to create a timeline for the agreement.
Figure 9: Configuring ReceiveAgreement
Add Message Type and Message Type Bindings
Message Configurations enable to configure different messages which are communicated by the organization.
Add Message Type
You need to specify the type of the message that is transmitted. 'XML' and 'Plain Text' messages are the Message Types that is presently supported by Fiorano B2B. To configure Message Type, perform the following actions:
- In the Navigation Panel, click Message Configuration tab, and then click Message Type.
- Click Add Message Type button to add Message Type configuration and define the format of the message exchanged between the parties.
Provide a unique Message Type ID and Description and then choose the Message type from the following options: Plain Text and XML.
Figure 10: Message Type page
If the message type is 'XML', then click Load Schema button that appear and click Browse to select the Schema file or paste the content in the Add Schema text editor. Select the root element from the Root Element drop-down. Note: If the Message Type is 'Plain Text', no further entry is required.
Figure 11: Message Type Configuration
External Schemas can be added, if necessary, by clicking on the Add button and then click Save button in the Message Type page to save the Message Type configuration.
Add Receive Message Type Binding
Message Type Bindings has to be defined to associate a particular message type with a business agreement. To add Receive Message Type Binding, perform the following actions:
- Under Message Configurations in the Navigation Panel, click Message Type Binding present below Message Type.
- Click Add New Binding button in Message Type page. For a binding used by the host to receive messages, select Agreement ID 'HostReceiveAgreement' (this will be pre-populated as it was created previously).
Figure 12: Message Type Binding ID screen