Generic Integration Framework to Support SFTP Interface[edit]




= 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.&nbsp;

== 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&nbsp; ===

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:&nbsp;

1.&nbsp;'''Click '''''Create Contract Type'' sub menu from the ''Configuration ''tile. The ''Select Contract Type'' page opens.
<div class="image-green-border">[[File:Generic Integration Framework SFTP 01.png|720px|Generic Integration Framework SFTP 01.png]]</div> 
2.'''Select''' ''Masterdata''.
<div class="image-green-border">[[File:Generic Integration Framework SFTP 02.png|420px|Generic Integration Framework SFTP 02.png]]</div> 
3.&nbsp;'''Click '''the ''Next ''button. The ''Create Contract Type Wizard'' page opens.
<div class="image-green-border">[[File:Generic Integration Framework SFTP 03.png|520px|Generic Integration Framework SFTP 03.png]]</div> 
The&nbsp;''Create Contract Type&nbsp;''page has the following sections:&nbsp;

*Details:&nbsp;'''Enter&nbsp;'''the contract type name.&nbsp; 
*Attributes:&nbsp;'''Select''' the Attributes for the Masterdata Contract Type. 
*Display Preference: '''Select''' Attributes to be displayed in the Agreement Tile View. 
*Team:&nbsp;'''Select&nbsp;'''the team. 
*Verify: Verify the details in preview mode and&nbsp;'''click&nbsp;'''''Create.'' 

&nbsp;

=== Client App Cross Reference ===

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

1.&nbsp;Navigate to the&nbsp;''Create Masterdata'' page in ICI. This page contains the following tabs:
<div class="image-green-border">[[File:Generic Integration Framework SFTP 04.png|520px|Generic Integration Framework SFTP 04.png]]</div> 
'''Masterdata Details&nbsp;'''

1.&nbsp;'''Select&nbsp;'''the ''Category'' from the drop-down. For example, ''Default''.

2.&nbsp;'''Select'''&nbsp;the Masterdata Contract Type.
<div class="note-box">'''Note: '''In order to map ICI entities with entities in the file uploaded through SFTP''', '''you must select&nbsp;''Client App Cross Reference ''from the drop-down.</div> 
3.&nbsp;'''Click&nbsp;'''''Next. ''The ''Attributes''&nbsp;page opens.

'''Attributes&nbsp;'''

#'''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&nbsp;''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''. 
<div class="note-box">'''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'',&nbsp;''SSH&nbsp;''or Blob.</div> 
4.&nbsp;'''Click&nbsp;'''''Save&nbsp;''to save the entity mapping.&nbsp;
<div class="image-green-border">[[File:Generic Integration Framework SFTP 05.png|420px|Generic Integration Framework SFTP 05.png]]</div> 
=== Client App Entity Mapping&nbsp; ===

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.&nbsp;Navigate to the''Create Masterdata'' page in ICI.&nbsp;This page contains the following tabs:
<div class="image-green-border">[[File:Generic Integration Framework SFTP 06.png|620px|Generic Integration Framework SFTP 06.png]]</div> 
'''Masterdata Details&nbsp;'''

1.&nbsp;'''Select&nbsp;'''the ''Category'' from the drop-down. For example, ''Default''.

2.'''Select'''&nbsp;the Masterdata Contract Type.
<div class="note-box">'''Note: '''In order to map ICI attributes with attributes uploaded through SFTP''', '''''Client App Entity Mapping ''must be selected from the drop-down.</div> 
3.&nbsp;'''Click&nbsp;'''''Next. ''The ''Attributes''&nbsp;page opens.

'''Attributes'''

1.&nbsp;'''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.&nbsp;''

2.&nbsp;'''Click&nbsp;'''''Save&nbsp;''to save the entity mapping.&nbsp;
<div class="image-green-border">[[File:Generic Integration Framework SFTP 07.png|520px|Generic Integration Framework SFTP 07.png]]</div> <div class="image-green-border">&nbsp;</div> 
== 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. 
<div class="image-green-border">[[File:Generic Integration Framework SFTP 08.png|720px|Generic Integration Framework SFTP 08.png]]</div> <ol start="3">
<li>'''Click''' the ''Download Payload'' button. The template for the Masterdata will be downloaded to your local drive.</li>
</ol>
<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> 
&nbsp;
<div class="image-green-border">[[File:Generic Integration Framework SFTP 09.png|720px|Generic Integration Framework SFTP 09.png]]</div> <ol start="4">
<li>Open the downloaded CSV or Json file. This file will be used by third-party systems to push data to the SFTP adapter.</li>
</ol>
<div class="image-green-border">[[File:Generic Integration Framework SFTP 10.png|520px|Generic Integration Framework SFTP 10.png]]</div> 
=== Publish Payload ===

'''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> 
== Using SFTP adapter to load/publish Transaction Data&nbsp; ==

=== Download Payload&nbsp; ===

1. Navigate to the ''Masterdata'' page in ICI.

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

&nbsp;

=== Publish Payload&nbsp; ===

'''Click''' ''Publish Payload.'' The empty payload will be published.
<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> 
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> 

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

== Creating a Customized Folder Structure ==

1. '''Click '''''Home > Configuration > Masterdata > Create Masterdata''. The ''Masterdata Details'' page opens.<br/> 2. Enter the relevant details:

*Category: '''Select '''''Default'' 
*Masterdata: '''Select '''''Client App Cross Reference''&nbsp; 

3. '''Click '''''Next''. The ''Attributes ''page opens.<br/> 4. '''Enter '''the relevant attribute values in the respective fields.&nbsp;<br/> 5. '''Copy '''the Json format from the tool-tip of the ''Folder Structure Json'' attribute.<br/> 6. '''Edit '''the Json format text to customize the folder structure. &nbsp;<br/> '''Note''':&nbsp;

*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. '''Click '''''Save''. The cross reference mapping will be created.<br/> 8. '''Click '''''Publish Payload ''on the ''Masterdata Summary ''page. The folder structure will be created in the FTP.

&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;|