From ICIHelp8.1
Jump to: navigation, search
(Created page with " = 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 e...")
 
Line 27: Line 27:
 
*Team: '''Select '''the team.
 
*Team: '''Select '''the team.
 
*Verify: Verify the details in preview mode and '''click '''''Create.''
 
*Verify: Verify the details in preview mode and '''click '''''Create.''
 +
  
 
=== Client App Cross Reference ===
 
=== Client App Cross Reference ===
Line 33: Line 34:
  
 
1. Navigate to the ''Create Masterdata'' page in ICM. This page contains the following tabs:
 
1. Navigate to the ''Create Masterdata'' page in ICM. 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>
+
<div class="image-green-border">[[File:Generic Integration Framework SFTP 04.png|520px|Generic Integration Framework SFTP 04.png]]</div>  
 
'''Masterdata Details&nbsp;'''
 
'''Masterdata Details&nbsp;'''
  
Line 39: Line 40:
  
 
2.&nbsp;'''Select'''&nbsp;the Masterdata Contract Type.
 
2.&nbsp;'''Select'''&nbsp;the Masterdata Contract Type.
−
<div class="note-box">'''Note: '''In order to map ICM entities with entities in the file uploaded through SFTP''', '''you must select&nbsp;''Client App Cross Reference ''from the drop-down.</div>
+
<div class="note-box">'''Note: '''In order to map ICM 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.
 
3.&nbsp;'''Click&nbsp;'''''Next. ''The ''Attributes''&nbsp;page opens.
  
 
'''Attributes&nbsp;'''
 
'''Attributes&nbsp;'''
  
−
#'''Enter''' the relevant attribute values. For example, enter ''ICM Entity Name'' as ''ICMSupplierMaster'' and ''Client Entity Name'' as ''SupplierMaster''. The ''Payload Type ''can be selected as&nbsp;''CSV''.
+
#'''Enter''' the relevant attribute values. For example, enter ''ICM Entity Name'' as ''ICMSupplierMaster'' 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 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''.  
−
<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'' or ''SSH''.</div>
+
<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;
 
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>
 
<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; ===
 
=== Client App Entity Mapping&nbsp; ===
  

Revision as of 04:26, 14 July 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 ICM support for generic integration provides the ability to synchronize ICM 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 ICM and SFTP, a Masterdata Contract Type should first be configured in ICM, 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 ICM entities (for example, ICM attributes) to client app entities.

1. Navigate to the Create Masterdata page in ICM. 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 ICM 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 ICM Entity Name as ICMSupplierMaster 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 ICM attributes (for example, attribute names used in Supplier Master) to attributes in the file uploaded through SFTP.

1. Navigate to theCreate Masterdata page in ICM. 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 ICM 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 ICM Entity Name as ICMSupplierMaster 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 ICM 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<ICM Attribute Name>. For example, in case of Supplier Master the ICM attribute name will be ICMSupplierCountry and the Masterdata Contract Type for this attribute will be ICMCountryMaster. Hence, relationship key will be ICMCountryMaster__ICMSupplierCountry. 

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

Download Payload 

1. Navigate to the Masterdata page in ICM.

2. C'lick' 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.

 

Retrieved from "https://iciwikiapac.icertis.com:443/ICIHelp8.1/index.php?title=Generic_Integration_Framework_to_Support_SFTP_Interface&oldid=13248"