From ICIHelp7.15
Jump to: navigation, search
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
 +
  
 
= Generic Integration Framework to Support SFTP Interface =
 
= Generic Integration Framework to Support SFTP Interface =
Line 46: Line 48:
 
'''Attributes '''
 
'''Attributes '''
  
−
#'''Enter''' the relevant attribute values. For example, enter ''ICI Entity Name'' as ''ICMSupplierMaster'' and ''Client Entity Name'' as ''SupplierMaster''. The ''Payload Type ''can be selected as ''CSV or Json''.  
+
#'''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 Delimiter''. Supported options are ''pipe'', ''colon'' and ''comma''.  
 
#'''Select''' the ''Text Qualifier''. Supported options are ''Single Quote'', ''Double Quote'', ''No Quote''.  
 
#'''Select''' the ''Text Qualifier''. Supported options are ''Single Quote'', ''Double Quote'', ''No Quote''.  
Line 68: Line 70:
 
'''Attributes'''
 
'''Attributes'''
  
−
1. '''Enter''' the relevant attribute values. For example, enter ''ICI Entity Name'' as ''ICMSupplierMaster'' and ''Client Entity Name'' as ''SupplierMaster''.
+
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''.
 
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 ''ICMSupplierCountry'' and the Masterdata Contract Type for this attribute will be ''ICMCountryMaster''. Hence, relationship key will be ''ICMCountryMaster__ICMSupplierCountry.&nbsp;''
+
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.&nbsp;''
  
 
2.&nbsp;'''Click&nbsp;'''''Save&nbsp;''to save the entity mapping.&nbsp;
 
2.&nbsp;'''Click&nbsp;'''''Save&nbsp;''to save the entity mapping.&nbsp;
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">&nbsp;</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">&nbsp;</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 Masterdata&nbsp; ==
+
== Using SFTP adapter to load/publish Transaction Data&nbsp; ==
  
 
=== Download Payload&nbsp; ===
 
=== Download Payload&nbsp; ===
Line 101: Line 103:
 
1. Navigate to the ''Masterdata'' page in ICI.
 
1. Navigate to the ''Masterdata'' page in ICI.
  
−
2. '''C''''''lick''' the ''View Record'' icon next to the ''Client App Cross Reference'' entity you have created. The ''Masterdata Details'' page opens.
+
2. '''Click'''&nbsp;the ''View Record'' icon next to the ''Client App Cross Reference'' entity you have created. The ''Masterdata Details'' page opens.
  
 
3.&nbsp;'''Click''' the ''Download Payload'' button. The template for the Masterdata will be downloaded to your local drive.
 
3.&nbsp;'''Click''' the ''Download Payload'' button. The template for the Masterdata will be downloaded to your local drive.
 
<div class="note-box">'''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.</div>  
 
<div class="note-box">'''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.</div>  
 
4.&nbsp;Open the downloaded CSV file. This file will be used by third-party systems to push data to the SFTP adapter.
 
4.&nbsp;Open the downloaded CSV file. This file will be used by third-party systems to push data to the SFTP adapter.
 +
 +
&nbsp;
  
 
=== Publish Payload&nbsp; ===
 
=== Publish Payload&nbsp; ===
Line 113: 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''':&nbsp;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''':&nbsp;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.
 +
 +
 +
 +
== 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.&nbsp;<br/> 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.<br/> With this release users have:
 +
 +
*Support for single or multiple folders in the folder structure.&nbsp;
 +
*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.
 +
 
&nbsp;
 
&nbsp;
 +
 +
=== Creating a Customized Folder Structure ===
 +
 +
To create a customized folder structure using GIF:
 +
 +
1. '''Click '''''Home > Configuration > Masterdata > Create Masterdata''. The ''Masterdata Details'' page opens.
 +
<div class="image-green-border">[[File:7.14 GIF Folder Structure Management 01.png|720px|7.14 GIF Folder Structure Management 01.png]]</div> <div class="image-green-border"><br/> 2. Enter the relevant details:</div>
 +
*Category: '''Select '''''Default''
 +
*Masterdata: '''Select '''''Client App Cross Reference''&nbsp;
 +
<div class="image-green-border">[[File:7.14 GIF Folder Structure Management 02.png|720px|7.14 GIF Folder Structure Management 02.png]]</div>
 +
3. '''Click '''''Next''. The ''Attributes ''page opens.
 +
 +
4. '''Enter '''the relevant attribute values in the respective fields.&nbsp;
 +
<div class="image-green-border">[[File:7.14 GIF Folder Structure Management 03.png|720px|7.14 GIF Folder Structure Management 03.png]]</div> <div class="image-green-border"><br/> 5. '''Copy '''the Json format from the tool-tip of the ''Folder Structure Json'' attribute.</div> <div class="image-green-border">[[File:7.14 GIF Folder Structure Management 04.png|720px|7.14 GIF Folder Structure Management 04.png]]</div> <div class="image-green-border"><br/> 6. '''Edit '''the Json format text to customize the folder structure. &nbsp;</div> <div class="image-green-border">[[File:7.14 GIF Folder Structure Management 05.png|720px|7.14 GIF Folder Structure Management 05.png]]</div> <div class="image-green-border"><br/> '''Note''':&nbsp;</div>
 +
*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.
 +
<div class="image-green-border">[[File:7.14 GIF Folder Structure Management 06.png|720px|7.14 GIF Folder Structure Management 06.png]]</div>
 +
7. '''Click '''''Save''. The cross reference mapping will be created.
 +
<div class="image-green-border">[[File:7.14 GIF Folder Structure Management 07.png|720px|7.14 GIF Folder Structure Management 07.png]]</div> <div class="image-green-border"><br/> 8. '''Click '''''Publish Payload ''on the ''Masterdata Summary ''page. The folder structure will be created in the FTP.</div> <div class="image-green-border">[[File:7.14 GIF Folder Structure Management 08.png|720px|7.14 GIF Folder Structure Management 08.png]]</div>
 +
&nbsp;
 +
 +
&nbsp;
 +
 +
&nbsp;
 +
 +
'''Related Topics:'''&nbsp;[[Agreement_Management|Agreement Management]]&nbsp;|&nbsp;[[Integrations|Integrations]]&nbsp;|&nbsp;[[Legal_and_Compliance|Salesforce]]&nbsp;| [[Using_Adobe_Sign|Using Adobe Sign]] | [[Using_DocuSign|Using DocuSign]] | [[Using_Namirial_eSignAnywhere|Using Namirial eSignAnyWhere]]&nbsp;| [[Generic_Integration_Framework_to_Support_ASB_Interface|Generic Integration Framework to Support ASB Interface]]&nbsp;|&nbsp;[[Release_Notes|Release_Notes]]&nbsp;|

Latest revision as of 12:28, 24 September 2020


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.

Generic Integration Framework SFTP 01.png

2.Select Masterdata.

Generic Integration Framework SFTP 02.png

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

Generic Integration Framework SFTP 03.png

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:

Generic Integration Framework SFTP 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 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.

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 CSV or Json.
  2. Select the Text Delimiter. Supported options are pipe, colon and comma.
  3. 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 Save to save the entity mapping. 

Generic Integration Framework SFTP 05.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 theCreate Masterdata page in ICI. This page contains the following tabs:

Generic Integration Framework SFTP 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 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. 

Generic Integration Framework SFTP 07.png
 

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

 

Generic Integration Framework SFTP 09.png
  1. 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.

Generic Integration Framework SFTP 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 > Configuration > Masterdata > Create Masterdata. The Masterdata Details page opens.

7.14 GIF Folder Structure Management 01.png

2. Enter the relevant details:
  • Category: Select Default
  • Masterdata: Select Client App Cross Reference 
7.14 GIF Folder Structure Management 02.png

3. Click Next. The Attributes page opens.

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

7.14 GIF Folder Structure Management 03.png

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.  
7.14 GIF Folder Structure Management 05.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.
7.14 GIF Folder Structure Management 06.png

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

7.14 GIF Folder Structure Management 07.png

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

 

 

 

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://iciwikiapac.icertis.com:15443/ICIHelp7.15/index.php?title=Generic_Integration_Framework_to_Support_SFTP_Interface&oldid=15147"