| Line 1: | Line 1: | ||
| + | |||
= Generic Integration Framework to Support SFTP Interface = | = Generic Integration Framework to Support SFTP Interface = | ||
The Secure File Transfer Protocol (SFTP) adapter will be built as an automated solution to load Masterdata once extracted from source of truth via SFTP. SFTP, a secure version of File Transfer Protocol (FTP), is a network protocol which facilitates file access, file transfer and file management over a Secure Shell (SSH) data stream. | The Secure File Transfer Protocol (SFTP) adapter will be built as an automated solution to load Masterdata once extracted from source of truth via SFTP. SFTP, a secure version of File Transfer Protocol (FTP), is a network protocol which facilitates file access, file transfer and file management over a Secure Shell (SSH) data stream. | ||
| + | |||
== Configuring SFTP Adapter to load Masterdata == | == Configuring SFTP Adapter to load Masterdata == | ||
| Line 95: | Line 97: | ||
'''Click''' ''Publish Payload.'' The empty payload will be published. | '''Click''' ''Publish Payload.'' The empty payload will be published. | ||
<div class="image-green-border">[[File:Generic Integration Framework SFTP 11.png|720px|Generic Integration Framework SFTP 11.png]]</div> <div class="image-green-border"> </div> <div class="note-box">'''Note''': For any subsequent ''Masterdata'' changes, the user needs to click ''Publish Payload'' button again to update the empty payload.</div> | <div class="image-green-border">[[File:Generic Integration Framework SFTP 11.png|720px|Generic Integration Framework SFTP 11.png]]</div> <div class="image-green-border"> </div> <div class="note-box">'''Note''': For any subsequent ''Masterdata'' changes, the user needs to click ''Publish Payload'' button again to update the empty payload.</div> | ||
| − | |||
== Using SFTP adapter to load/publish Transaction Data == | == Using SFTP adapter to load/publish Transaction Data == | ||
| Line 108: | Line 109: | ||
4. Open the downloaded CSV file. This file will be used by third-party systems to push data to the SFTP adapter. | 4. Open the downloaded CSV file. This file will be used by third-party systems to push data to the SFTP adapter. | ||
| + | | ||
=== Publish Payload === | === Publish Payload === | ||
| Line 115: | Line 117: | ||
A notification is displayed once the Payload is published successfully. | A notification is displayed once the Payload is published successfully. | ||
<div class="note-box">'''Note''': The user can create a subscription to the job status updates by using the standard in ''Notification Setting'' in the ''User Administration'' menu.</div> | <div class="note-box">'''Note''': The user can create a subscription to the job status updates by using the standard in ''Notification Setting'' in the ''User Administration'' menu.</div> | ||
| + | == Support for pre/post processing == | ||
| + | |||
| + | With this release, support is being provided for custom pre- and post-processing hooks to the Generic Integration Framework in order to considerably reduce implementation time. These hooks are now provided to: | ||
| + | |||
| + | *Pre-process inbound data through file-based integrations. | ||
| + | *Pre-process inbound and outbound data through ASB-based integrations. | ||
| + | |||
| + | ICI administrators will now be able to: | ||
| + | |||
| + | *Enable or disable the hook as part of file-based integration. | ||
| + | *Pass parameters to the hook for executing a custom logic. | ||
| + | *Enable or disable the hook at file or record level. When hook is enabled at file level, the system will process all records in the file before handing off control to the hook. When hook is enabled at record level, system will wait for hook to complete processing at record level before processing the next record. | ||
| + | *Execute any custom logic in the system for a file or record when hook is configured. | ||
| + | *Complete GIF process even when custom logic encounters any error while processing a record or file. | ||
| + | |||
| | ||
Revision as of 11:56, 24 September 2020
Contents
Generic Integration Framework to Support SFTP Interface
The Secure File Transfer Protocol (SFTP) adapter will be built as an automated solution to load Masterdata once extracted from source of truth via SFTP. SFTP, a secure version of File Transfer Protocol (FTP), is a network protocol which facilitates file access, file transfer and file management over a Secure Shell (SSH) data stream.
Configuring SFTP Adapter to load Masterdata
The ICI support for generic integration provides the ability to synchronize ICI Masterdata tables using the input file from SFTP server. 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 SFTP, a Masterdata Contract Type should first be configured in ICI, 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.
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 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:
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
- 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 CSV or Json.
- Select the Text Delimiter. Supported options are pipe, colon and comma.
- Select the Text Qualifier. Supported options are Single Quote, Double Quote, No Quote.
4. Click Save to save the entity mapping.
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 SFTP.
1. Navigate to theCreate Masterdata page in ICI. 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 ICI Entity Name as ICISupplierMaster and Client Entity Name as SupplierMaster.
To create mapping using SFTP, select FileBased 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 Save to save the entity mapping.
Using SFTP Adapter to load/publish Masterdata
Download Payload
- Navigate to the Masterdata page in ICI.
- Click the View Record icon next to the Client App Cross Reference entity you have created. The Masterdata Details page opens.
- Click the Download Payload button. The template for the Masterdata will be downloaded to your local drive.
- Open the downloaded CSV or Json file. This file will be used by third-party systems to push data to the SFTP adapter.
Publish Payload
Click Publish Payload. The empty payload will be published.
Using SFTP adapter to load/publish Transaction Data
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.
3. Click the Download Payload button. The template for the Masterdata will be downloaded to your local drive.
4. Open the downloaded CSV file. This file will be used by third-party systems to push data to the SFTP adapter.
Publish Payload
Click Publish Payload. The empty payload will be published.
A notification is displayed once the Payload is published successfully.
Support for pre/post processing
With this release, support is being provided for custom pre- and post-processing hooks to the Generic Integration Framework in order to considerably reduce implementation time. These hooks are now provided to:
- Pre-process inbound data through file-based integrations.
- Pre-process inbound and outbound data through ASB-based integrations.
ICI administrators will now be able to:
- Enable or disable the hook as part of file-based integration.
- Pass parameters to the hook for executing a custom logic.
- Enable or disable the hook at file or record level. When hook is enabled at file level, the system will process all records in the file before handing off control to the hook. When hook is enabled at record level, system will wait for hook to complete processing at record level before processing the next record.
- Execute any custom logic in the system for a file or record when hook is configured.
- Complete GIF process even when custom logic encounters any error while processing a record or file.
Related Topics: Agreement Management | Integrations | Salesforce | Using Adobe Sign | Using DocuSign | Using Namirial eSignAnyWhere | Generic Integration Framework to Support ASB Interface | Release_Notes |
