From ICIHelp8.1
Revision as of 17:00, 26 March 2020 by WikiSysop (Talk | contribs) (Created page with " = Generic Integration Framework to Support ASB Interface = Azure Service Bus (ASB) is a fully managed enterprise integration message broker. Data is transferred between diff...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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.
Generic Integration Framework ASB 01.png
  1. Select Masterdata.
Generic Integration Framework ASB 02.png
  1. Click the Next button. The Create Contract Type Wizard page opens.
Generic Integration Framework SFTP 03.png
  1. 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:
Generic Integration Framework ASB 04.png

Masterdata Details

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

Note: In order to map ICM entities with entities in the file uploaded through ASB, you must select Client App Cross Reference from the drop-down.

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.
Note: The Client Name GenericIntegration must be selected. To create mapping using ASB, select Messaging in the Integration Mode drop-down. You need to select a Task Category for Messaging, either Scheduled or EventBased as required.
  1. Click Save to save the entity mapping.
Generic Integration Framework ASB 05.png

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:
Generic Integration Framework ASB 06.png

Masterdata Details

  1. Select the Category from the drop-down. For example, Default.
  2. Select the Masterdata Contract Type.
Note: In order to map ICM attributes with attributes uploaded through ASB, Client App Entity Mapping must be selected from the drop-down.
  1. 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.

  1. Click Save to save the entity mapping.
Generic Integration Framework ASB 07.png

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.
Generic Integration Framework ASB 08.png
  1. 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.

Generic Integration Framework ASB 09.png
  1. Open the downloaded JSON file. This file will be used by third-party systems to push data to the ASB adapter.

For Scheduled updation:

Generic Integration Framework ASB 10.png


For EventBased updation:

Generic Integration Framework ASB 11.png

Publish Payload

  1. Click Publish Payload. The file will be published.
Note: For any subsequent Masterdata changes, the user needs to click Publish Payload button again to update the empty payload.

A notification is displayed once the Payload is published successfully.

Generic Integration Framework ASB 12.png
 
Note: The user can create a subscription to the job status updates by using the standard in Notification Setting in the User Administration menu.
Retrieved from "https://iciwikiapac.icertis.com:443/ICIHelp8.1/index.php?title=Generic_Integration_Framework_to_Support_ASB_Interface&oldid=12472"