From ICIHelp8.2
Revision as of 15:04, 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 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.

Configure Contract Types.png

2.Select Masterdata radio button.

Contract Type MasterData.png

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.
GIF 3.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 Configure > Create Masterdata page in ICI.

Configure MasterData.png

Masterdata Details 

1. Select the Category from the drop-down. For example, Default.

2. Select the Masterdata Contract Type.

MasterData ClientAppCorssRef.png
Note: In order to map ICI entities with entities in the file uploaded through SFTP, you must select Client App Cross Reference from the drop-down.

3. Click Next. The Attributes page opens. Input the details as required:

  • 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.
Note: The Client Name GenericIntegration must be selected. To create mapping using SFTP, select FileBased in the Integration Mode drop-down. The Transport Protocol can be FTP, SFTP, SSH or Blob.

4. Click Create to crate  the entity mapping. Or Click Update to update existing entity mapping. 

SFTP 1.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 SFTP.

1. Navigate to the Create 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 SFTP, 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 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

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 9A.png

3. Click the Download Payload button. The template for the Masterdata will be downloaded to your local drive.

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 CSV or Json file. This file will be used by third-party systems to push data to the SFTP adapter.

Generic Integration Framework SFTP 10.png

Publish Payload

Click Publish Payload. The empty payload will be published.

GIF 11.png
 
 
Note: For any subsequent Masterdata changes, the user needs to click Publish Payload button again to update the empty payload.

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.

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

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.

Note: The user can create a subscription to the job status updates by using the standard in Notification Setting in the User Administration menu.

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.

Support for defining folder structure in Generic Integration Framework

Previously, the generic integration framework provided a fixed folder structure for file-based inbound master data integration. 
Now, support is being extended so that users will be able to define and configure the folder structure and file names depending on their business requirement. This helps in reducing effort during implementation while aiding better adoption of changes on the client's system.
With this release users have:

  • Support for single or multiple folders in the folder structure. 
  • A folder and file naming convention which is flexible, and configurable via masterdata (in JSON format).
  • Support for folder structure based on ICI entities, with separate folders for each ICI entity.
  • Folders which are easy to configure and flexible to modify via JSON structure, whenever business needs change.
  • A choice to use standard folders as per requirement. If JSON structure is not added, then the ICI default folder structure will automatically be used.

Creating a Customized Folder Structure

To create a customized folder structure using GIF:

1. Click Home > Configure > Masterdata > Create Masterdata. The Masterdata Details page opens.

2. Enter the relevant details:

  • Category: Select Default
  • Masterdata: Select Client App Cross Reference 
GIF 4.png
 

3. Click Next. The Attributes page opens.

4. Enter the relevant attribute values in the respective fields. 

5. Copy the Json format from the tool-tip of the Folder Structure Json attribute.
 
7.14 GIF Folder Structure Management 04.png

6. Edit the Json format text to customize the folder structure.  
SFTP 14.png

Note: 
  • The folders Inbox and Processing are mandatory whereas Archive, Error and Passed are not mandatory and can be removed. For example, if the Passed folder is removed, no Pass file will be created after the files are processed. However, if the Inbox or Processing folder(s) is/are removed, then the GIF will use the default folder structure.
  • Folder structures using only one folder will also have a separate folder for processing.
  • Users can configure different folder structures per entity.
  • If no customization is needed, then leave the Folder Structure Json attribute blank and Update the existing Client App Cross Reference. In this case, the default folder structure will be created on the FTP folder structure.
SFTP 7.png

7. Click Save. The cross reference mapping will be created.

8. Click Publish Payload on the Masterdata Summary page. The folder structure will be created in the FTP.

7.14 GIF Folder Structure Management 08.png

Support for user provisioning/deprovisioning from ASB/SFTP/BLOB

Configurators can now provision, deprovision, reprovision and replace users in ICI through ASB and SFTP based integrations. For example, to provision a user using ASB:
 

Configuring Client App Cross Reference Mapping  

 
1. Create the master data for user information, similar to other integration client app cross reference mapping.
 
SFTP 8.png
 
2. Edit the JSON structure for “UserInformation”.
 
7.16 GIF User provisioning 02.png
 
3. In the “Default Groups” attribute on the Create Masterdata page, enter the JSON structure. The default security groups can be configured for each payload. The security groups will get added into that payload as a default.
 
SFTP 20.12.21.png
 
4. In the “Default Entity Team” attribute, enter the JSON structure array of the team. You can add details such as user’s email Id here.
 
5. Set the “Auto Detect User” flag to Yes. The user’s action will be auto-detected, even if the user does not pass any action from JSON structure/payload.
 
6. Update details on ASB.
 
7. Send the payload on the inbound topic. Payload can be captured from any third-party application. For example, SAP.
 
8. Click User Administration > Users > Users in ICI. The users index page opens. The provisioned user will be displayed in the list of users.
 
If the entity team includes an approver, the user gets created with Status “Created”. If the team does not include an approver, the user gets created with status “Provisioned”.
 
Following is a list of all actions available that can be used in the same steps as described for the “Provision” above:
 
7.16 GIF User provisioning 06.png
 
Note: All actions can be checked for success or failure through standard ICI notifications.
 
The same actions are available when using SFTP based integrations. However, in case of CSV multiple data cannot be sent in one line item. The first file contains the main payload. For example, see screenshot below:
7.16 GIF User provisioning 07.png
 
The line items (such as organization, extended user entity, etc.) can be sent in other files. 
 
7.16 GIF User provisioning 08.png
 
7.16 GIF User provisioning 09.png

When the files are uploaded and the job is triggered at the backend, the line items and main payload will be picked up for processing. The user will get added and the team will get updated in ICI.
 
Similar to ASB, users can also be provisioned, deprovisioned and replaced using SFTP by passing the respective actions via CSV.
 
Unlike CSV, when using JSON based integrations, all actions can be passed using one file.
 
7.16 GIF User provisioning 10.png
 
Note:    
The Folder Structure Json attribute has been updated to Version 2.0, however earlier versions continue to be supported.
Notifications to individual users and mass notification to functional users are not supported.
Creating a new security group or user group is not supported.

Extending file-based inbound integration for agreements and associations

To create an agreement along with associations and team using CSV file-based integration:

1. Update the Client App Cross Reference mapping as usual for file-based inbound integrations.

2. For CSV-based agreement creation:

  • Select “Integration Mode” as “FileBased”
  • Select “Payload Type” as “Csv”
  • Select “Transport Protocol” as “FTP”
  • Enter the folder structure in “Folder Structure Json”
7.16 GIF File based 01.png

3. Enter the “Default Entity Team”.

4. Enter the “Line Item Separator” as “#”.
 
The “Line Item Name Separator” entered here must be used in the Client App Entity Mapping. For example, it must be used while mapping, associations to agreements or roles to a distribution group.
 
SFTP 9.PNG
 
5. Upload the files to the FTP server.
 
Once the background task is triggered the files will be processed, the agreement gets created and it will be displayed on the agreement index page.
 
SFTP 11.png

The agreement gets created with all the uploaded details:
 
SFTP 13.png

To create an agreement along with associations and team using JSON file-based integration:

Update the JSON file with the agreement and team details.

7.16 GIF File based 06.png

Once the JSON is uploaded to the FTP server and the task is triggered, the files will be processed, the agreement gets created, and it will be displayed on the agreement index page.
 
SFTP 12.png

Follow the same process to create contract requests.
 

Note: 
To set a user other than service user or the user configured in cross reference mapping as the Primary Owner, the CSV payload must contain the details of the desired primary owner.

Adding the parent agreement code is mandatory in each association CSV file.

Inbound amendment management is currently not supported.

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

Retrieved from "https://ici-us-wiki01.icertis.com:443/ICIHelp8.2/index.php?title=Generic_Integration_Framework_to_Support_SFTP_Interface&oldid=23837"