From ICIHelp8.1
| Line 6: | Line 6: | ||
== Configuring SFTP Adapter to load Masterdata == | == Configuring SFTP Adapter to load Masterdata == | ||
| − | The | + | 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 === | === Create Masterdata Contract Type === | ||
| − | To enable synchronization between | + | 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: | To create a Masterdata Contract Type: | ||
1. '''Click '''''Create Contract Type'' sub menu from the ''Configuration ''tile. The ''Select Contract Type'' page opens. | 1. '''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> | + | <div class="image-green-border">[[File:Generic Integration Framework SFTP 01.png|720px|Generic Integration Framework SFTP 01.png]]</div> |
2.'''Select''' ''Masterdata''. | 2.'''Select''' ''Masterdata''. | ||
| − | <div class="image-green-border">[[File:Generic Integration Framework SFTP 02.png|420px|Generic Integration Framework SFTP 02.png]]</div> | + | <div class="image-green-border">[[File:Generic Integration Framework SFTP 02.png|420px|Generic Integration Framework SFTP 02.png]]</div> |
3. '''Click '''the ''Next ''button. The ''Create Contract Type Wizard'' page opens. | 3. '''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> | + | <div class="image-green-border">[[File:Generic Integration Framework SFTP 03.png|520px|Generic Integration Framework SFTP 03.png]]</div> |
The ''Create Contract Type ''page has the following sections: | The ''Create Contract Type ''page has the following sections: | ||
| − | *Details: '''Enter '''the contract type name. | + | *Details: '''Enter '''the contract type name. |
| − | *Attributes: '''Select''' the Attributes for the Masterdata Contract Type. | + | *Attributes: '''Select''' the Attributes for the Masterdata Contract Type. |
| − | *Display Preference: '''Select''' Attributes to be displayed in the Agreement Tile View. | + | *Display Preference: '''Select''' Attributes to be displayed in the Agreement Tile View. |
| − | *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 === | ||
| − | The Client App Cross Reference mapping maps | + | 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 | + | 1. Navigate to the ''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> | <div class="image-green-border">[[File:Generic Integration Framework SFTP 04.png|520px|Generic Integration Framework SFTP 04.png]]</div> | ||
'''Masterdata Details ''' | '''Masterdata Details ''' | ||
| Line 40: | Line 41: | ||
2. '''Select''' the Masterdata Contract Type. | 2. '''Select''' the Masterdata Contract Type. | ||
| − | <div class="note-box">'''Note: '''In order to map | + | <div class="note-box">'''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.</div> |
3. '''Click '''''Next. ''The ''Attributes'' page opens. | 3. '''Click '''''Next. ''The ''Attributes'' page opens. | ||
'''Attributes ''' | '''Attributes ''' | ||
| − | #'''Enter''' the relevant attribute values. For example, enter '' | + | #'''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''. |
#'''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'', ''SSH ''or Blob.</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'', ''SSH ''or Blob.</div> | ||
4. '''Click '''''Save ''to save the entity mapping. | 4. '''Click '''''Save ''to save the entity mapping. | ||
| − | <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 === | === Client App Entity Mapping === | ||
| − | The Client App Entity Mapping maps | + | 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 | + | 1. Navigate to the''Create Masterdata'' page in ICI. 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> | + | <div class="image-green-border">[[File:Generic Integration Framework SFTP 06.png|620px|Generic Integration Framework SFTP 06.png]]</div> |
'''Masterdata Details ''' | '''Masterdata Details ''' | ||
| Line 63: | Line 63: | ||
2.'''Select''' the Masterdata Contract Type. | 2.'''Select''' the Masterdata Contract Type. | ||
| − | <div class="note-box">'''Note: '''In order to map | + | <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. '''Click '''''Next. ''The ''Attributes'' page opens. | 3. '''Click '''''Next. ''The ''Attributes'' page opens. | ||
'''Attributes''' | '''Attributes''' | ||
| − | 1. '''Enter''' the relevant attribute values. For example, enter '' | + | 1. '''Enter''' the relevant attribute values. For example, enter ''ICI 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''. | 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 | + | 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. '' |
2. '''Click '''''Save ''to save the entity mapping. | 2. '''Click '''''Save ''to save the entity mapping. | ||
| − | <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"> </div> | + | <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"> </div> |
== Using SFTP Adapter to load/publish Masterdata == | == Using SFTP Adapter to load/publish Masterdata == | ||
| − | |||
=== Download Payload === | === Download Payload === | ||
| − | #Navigate to the ''Masterdata'' page in | + | #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 ''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"> | <div class="image-green-border">[[File:Generic Integration Framework SFTP 08.png|720px|Generic Integration Framework SFTP 08.png]]</div> <ol start="3"> | ||
| Line 91: | Line 90: | ||
<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> | <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> | </ol> | ||
| − | <div class="image-green-border">[[File:Generic Integration Framework SFTP 10.png|520px|Generic Integration Framework SFTP 10.png]]</div> | + | <div class="image-green-border">[[File:Generic Integration Framework SFTP 10.png|520px|Generic Integration Framework SFTP 10.png]]</div> |
| − | + | ||
=== Publish Payload === | === Publish Payload === | ||
'''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 Masterdata == | == Using SFTP adapter to load/publish Masterdata == | ||
=== Download Payload === | === Download Payload === | ||
| − | 1. Navigate to the ''Masterdata'' page in | + | 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. '''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. | 3. '''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. 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. | ||
| Line 112: | Line 110: | ||
'''Click''' ''Publish Payload.'' The empty payload will be published. | '''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> | + | <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. | 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> |
| | ||
Revision as of 12:33, 12 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.
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
- 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.
- 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 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.
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 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 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.
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.
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.
- 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.
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 ICI.
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.
