Revision as of 04:07, 22 July 2020

Generic Integration Framework to Support ASB Interface

Azure Service Bus (ASB) is a fully managed enterprise integration message broker. Data is transferred between different applications and services using messages. The ICM-ASB adapter considers the approach based on REST and OData principles that exposes a uniform, stateless interface which communicates using HTTP(S) and JSON payloads.

Configuring ASB adapter to load Masterdata 

The ICM support for generic integration provides the ability to synchronize ICM Masterdata tables using the input from ASB. Through a technical configuration, you can specify the attributes to be used for this generic integration.

Create Masterdata Contract Type

To enable synchronization between ICM and ASB, a Masterdata Contract Type should first be configured in ICM, with specific attributes for the integration. To create a Masterdata Contract Type:

1. Click Create Contract Type sub menu from the Configuration tile. The Select Contract Type page opens.

2. Select Masterdata.

3. Click the Next button. The Create Contract Type Wizard page opens.

3. The Create Contract Type page has the following sections:

• Details: Enter the Contract Type Name
• Attributes: Select the Attributes for the Masterdata Contract Type
• Display Preference: Select Attributes to be displayed in the Agreement Tile View
• Team: Select the Team
• Verify: Verify the details in preview mode and click Create.

Client App Cross Reference

The Client App Cross Reference mapping maps ICM entities (for example, ICM attributes) to client app entities.

1. Navigate to the Create Masterdata page in ICM. This page contains the following tabs:

Masterdata Details

1.    Select the Category from the drop-down. For example, Default.
2.    Select the Masterdata Contract Type.

3.    Click Next. The Attributes page opens.

Attributes

1. Enter the relevant attribute values. For example, enter ICM Entity Name as ICMSupplierMaster and Client Entity Name as SupplierMaster. The Payload Type can be selected as JSON.

2. Click Save to save the entity mapping.

Client App Entity Mapping

The Client App Entity Mapping maps ICM attributes (for example, attribute names used in Supplier Master) to attributes in the file uploaded through ASB.

1. Navigate to theCreate Masterdata page in ICM. This page contains the following tabs:

Masterdata Details

1. Select the Category from the drop-down. For example, Default.
2. Select the Masterdata Contract Type.

3. Click Next. The Attributes page opens.

Attributes

1. Enter the relevant attribute values. For example, enter ICM Entity Name as ICMSupplierMaster and Client Entity Name as SupplierMaster. 

To create mapping using ASB, select Messaging in the Integration Mode drop-down. The Client Name selected must be GenericIntegration.

In case of lookup and non-lookup attributes: The ICM Relationship Key should be set for lookup attributes and kept blank for non-lookup attributes. The Relationship Key framing should be <Master Contract Type Name> Double Underscore<ICM Attribute Name>. For example, in case of Supplier Master the ICM attribute name will be ICMSupplierCountry and the Masterdata Contract Type for this attribute will be ICMCountryMaster. Hence, relationship key will be ICMCountryMaster__ICMSupplierCountry.

2. Click Save to save the entity mapping.

Using ASB Adapter to load/publish Masterdata

Download Payload

1. Navigate to the Masterdata page in ICM.
2. Click the View Record icon next to the Client App Cross Reference entity you have created. The Masterdata Details page opens.

3. Click the Download Payload button to download a template for the Masterdata.

Note: The file format of the template will be according to the Payload Type selected in the attributes of the Client App Cross Reference entity.

4. Open the downloaded JSON file. This file will be used by third-party systems to push data to the ASB adapter.

For Scheduled updation:

For EventBased updation:

Publish Payload

5. Click Publish Payload. The file will be published.

A notification is displayed once the Payload is published successfully.

Using ASB Adapter to load/publish Transaction Data 

Updating Transaction Data 

To update transaction data from ICM using generic integration framework:

1. Edit the agreement in ICM with the desired values.
2. Click Update.

Note: For transaction data outbound, it is mandatory to select Data Flow Type as ICM to Client in the Client App Entity Mapping. The workflow action selected in Publish Transaction Data in Client App Cross Reference Mapping is the event at which transaction data will be updated. For example, if the values selected in this field are Approved and Updated, then the transaction data will be updated when these actions are taken on the agreement.

Checking Data in Service Bus Explorer

To validate the data in the Service Bus Explorer:

1. Open Service Bus Explorer and go to the Service Bus Namespace.
2. Go to the genericintegrationoutbound topic. Right-click and select Refresh Subscription from the drop-down.
3. Click Messages. The Retrieve messages from subscription window opens.
4. Select Peek radio button in the Receive Mode section.
5. Click Ok.

The updated values are displayed in the Message Text.

6. Check the Notifications Dashboard in ICM to view the success, failure and update notifications for outbound transaction data.

The same steps can be followed to create:  

• Contract Requests with Associations - Inbound
• Associations for Agreements - Inbound
• Amendments with Associations - Outbound