From ICIHelp8.2
Revision as of 14:11, 16 February 2022 by WikiSysop (Talk | contribs)

(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 ICI-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 ICI support for generic integration provides the ability to synchronize ICI 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 ICI and ASB, a Masterdata Contract Type should first be configured in ICI, with specific attributes for the integration. To create a Masterdata Contract Type:

1. Click Contract Type  menu from the Configure tile. The Contract Type details page opens. Click the "Create" button.

Configure Contract Types.png

2. Select Masterdata radio button.

Contract Type MasterData.png

3. The Create Contract Type page opens.  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.
Create MasterData Contract Type Details.png
 

Client App Cross Reference

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

  1. Navigate to the Create Masterdata page in ICI. This page contains the following tabs:
GIF 4.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 ICI 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 ICI Entity Name as ICISupplierMaster 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.

2. Click Save to save the entity mapping.

GIF 5.png
 
GIF 6.png
 

Client App Entity Mapping

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

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

GIF 7.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 ICI attributes with attributes uploaded through ASB, Client App Entity Mapping must be selected from the drop-down.

3. Click Next. The Attributes page opens.

Attributes

1. Enter the relevant attribute values. For example, enter ICI Entity Name as ICISupplierMaster 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 ICI 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<ICI Attribute Name>. For example, in case of Supplier Master the ICI attribute name will be ICISupplierCountry and the Masterdata Contract Type for this attribute will be ICICountryMaster. Hence, relationship key will be ICICountryMaster__ICISupplierCountry.

2. Click  CREATE  to save the entity mapping.

GIF 8.png

Using ASB Adapter to load/publish Masterdata

Download Payload

1. Navigate to the Masterdata page in ICI.

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

GIF 9.png
 

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.
 
GIF 10.png

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:

Generic Integration Framework ASB 10.png

For EventBased updation:

Generic Integration Framework ASB 11.png

Publish Payload

5. 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.

GIF 11.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.

Using ASB Adapter to load/publish Transaction Data 

Updating Transaction Data 

To update transaction data from ICI using generic integration framework:

1. Edit the agreement in ICI with the desired values.

2. Click Update.

Note: For transaction data outbound, it is mandatory to select Data Flow Type as ICI 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.

7.12 ASB adapter.png

The updated values are displayed in the Message Text.

6. Check the Notifications Dashboard in ICI 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

Related Topics: Agreement Management | Integrations | Salesforce | Using Adobe Sign | Using DocuSign | Using Namirial eSignAnyWhere | Generic Integration Framework to Support SFTP Interface | Release_Notes |

Retrieved from "https://iciwikiapac.icertis.com:443/ICIHelp8.2/index.php?title=Generic_Integration_Framework_to_Support_ASB_Interface&oldid=23834"