Generic Integration Framework to Support SFTP Interface - Revision history

WikiSysop at 15:04, 16 February 2022

2022-02-16T15:04:30Z

Show changes

IDT-1 at 08:06, 21 December 2021

2021-12-21T08:06:54Z

Show changes

IDT-1 at 12:54, 20 December 2021

2021-12-20T12:54:22Z

IDT-1 at 14:57, 19 December 2021

2021-12-19T14:57:51Z

IDT-1 at 13:14, 15 December 2021

2021-12-15T13:14:54Z

IDT-1 at 13:07, 15 December 2021

2021-12-15T13:07:12Z

IDT-1 at 13:04, 15 December 2021

2021-12-15T13:04:08Z

Show changes

IDT-1 at 18:05, 11 June 2021

2021-06-11T18:05:20Z

IDT-1 at 17:54, 11 June 2021

2021-06-11T17:54:39Z

IDT-1 at 12:28, 24 September 2020

2020-09-24T12:28:25Z

@@ Line 19: / Line 19: @@
 <div class="image-green-border">[[File:GIF1.png|500px|GIF1.png]]</div>
 .'''Select''' ''Masterdata''.
-<div class="image-green-border">[[File:GIF 2.png|500px|GIF 2.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">3.&nbsp;'''Click '''the ''Next ''button. The ''Create Contract Type Wizard'' page opens.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:GIF 3.png|600px|GIF 3.png]]</div>
+<div class="image-green-border">[[File:GIF 2.png|500px|GIF 2.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">3.&nbsp;'''Click '''the ''Next ''button. The ''Create Contract Type Wizard'' page opens.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:GIF 3.png|500px|GIF 3.png]]</div>
 The&nbsp;''Create Contract Type&nbsp;''page has the following sections:&nbsp;
@@ Line 82: / Line 82: @@
 #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:GIF 9A.png|600px]]</div> <ol start="3">
+<div class="image-green-border">[[File:GIF 9A.png|600px|GIF 9A.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>
@@ Line 148: / Line 148: @@
 To create a customized folder structure using GIF:
-. '''Click '''''Home > Configuration > Masterdata > Create Masterdata''. The ''Masterdata Details'' page opens.
+. '''Click '''''Home > Configure&nbsp;> Masterdata > Create Masterdata''. The ''Masterdata Details'' page opens.
 <div class="image-green-border"><br/> 2. Enter the relevant details:</div>
 *Category: '''Select '''''Default''
@@ Line 163: / Line 163: @@
 <div class="image-green-border">[[File:SFTP 7.png|500px|SFTP 7.png]]</div>
 . '''Click '''''Save''. The cross reference mapping will be created.
-<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">&nbsp;</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> <div class="image-green-border">&nbsp;</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">&nbsp;</div> <div class="image-green-border">[[File:7.14 GIF Folder Structure Management 08.png|650px|7.14 GIF Folder Structure Management 08.png]]</div> <div class="image-green-border">&nbsp;</div>
 == Support for user provisioning/deprovisioning from ASB/SFTP/BLOB ==
 <div class="image-green-border">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:</div> <div class="image-green-border">&nbsp;</div>
 === Configuring Client App Cross Reference Mapping &nbsp; ===
-<div class="image-green-border">&nbsp;</div> <div class="image-green-border">1. Create the master data for user information, similar to other integration client app cross reference mapping.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 8.png|500px|SFTP 8.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">2. Edit the JSON structure for “UserInformation”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 02.png|600px|7.16 GIF User provisioning 02.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 03.png|720px|7.16 GIF User provisioning 03.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 04.png|720px|7.16 GIF User provisioning 04.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">6. Update details on ASB.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">7. Send the payload on the inbound topic. Payload can be captured from any third-party application. For example, SAP.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">8. '''Click '''''User Administration > Users > Users'' in ICI. The users index page opens. The provisioned user will be displayed in the list of users.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Following is a list of all actions available that can be used in the same steps as described for the “Provision” above:</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 06.png|720px|7.16 GIF User provisioning 06.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''': All actions can be checked for success or failure through standard ICI notifications.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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:</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 07.png|720px|7.16 GIF User provisioning 07.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">The line items (such as organization, extended user entity, etc.) can be sent in other files.&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 08.png|720px|7.16 GIF User provisioning 08.png]]</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 09.png|720px|7.16 GIF User provisioning 09.png]]</div> <div class="image-green-border"><br/> 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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Similar to ASB, users can also be provisioned, deprovisioned and replaced using SFTP by passing the respective actions via CSV.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Unlike CSV, when using JSON based integrations, all actions can be passed using one file.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 10.png|600px|7.16 GIF User provisioning 10.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''':&nbsp;&nbsp; &nbsp;<br/> The Folder Structure Json attribute has been updated to Version 2.0, however earlier versions continue to be supported.<br/> Notifications to individual users and mass notification to functional users are not supported.<br/> Creating a new security group or user group is not supported.</div>
+<div class="image-green-border">&nbsp;</div> <div class="image-green-border">1. Create the master data for user information, similar to other integration client app cross reference mapping.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 8.png|500px|SFTP 8.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">2. Edit the JSON structure for “UserInformation”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 02.png|600px|7.16 GIF User provisioning 02.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 20.12.21.png|500px]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">6. Update details on ASB.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">7. Send the payload on the inbound topic. Payload can be captured from any third-party application. For example, SAP.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">8. '''Click '''''User Administration > Users > Users'' in ICI. The users index page opens. The provisioned user will be displayed in the list of users.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Following is a list of all actions available that can be used in the same steps as described for the “Provision” above:</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 06.png|720px|7.16 GIF User provisioning 06.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''': All actions can be checked for success or failure through standard ICI notifications.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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:</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 07.png|720px|7.16 GIF User provisioning 07.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">The line items (such as organization, extended user entity, etc.) can be sent in other files.&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 08.png|720px|7.16 GIF User provisioning 08.png]]</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 09.png|720px|7.16 GIF User provisioning 09.png]]</div> <div class="image-green-border"><br/> 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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Similar to ASB, users can also be provisioned, deprovisioned and replaced using SFTP by passing the respective actions via CSV.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Unlike CSV, when using JSON based integrations, all actions can be passed using one file.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 10.png|600px|7.16 GIF User provisioning 10.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''':&nbsp;&nbsp; &nbsp;<br/> The Folder Structure Json attribute has been updated to Version 2.0, however earlier versions continue to be supported.<br/> Notifications to individual users and mass notification to functional users are not supported.<br/> Creating a new security group or user group is not supported.</div>
 == Extending file-based inbound integration for agreements and associations ==

@@ Line 82: / Line 82: @@
 #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:GIF 9.png|600px|GIF 9.png]]</div> <ol start="3">
+<div class="image-green-border">[[File:GIF 9A.png|600px]]</div> <ol start="3">
 <li>'''Click''' the ''Download Payload'' button. The template for the Masterdata will be downloaded to your local drive.</li>
 </ol>
@@ Line 156: / Line 156: @@
 . '''Enter '''the relevant attribute values in the respective fields.&nbsp;
-<div class="image-green-border">5. '''Copy '''the Json format from the tool-tip of the ''Folder Structure Json'' attribute.</div> <div class="image-green-border">&nbsp;</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:SFTP 14.png|600px]]</div> <div class="image-green-border"><br/> '''Note''':&nbsp;</div>
+<div class="image-green-border">5. '''Copy '''the Json format from the tool-tip of the ''Folder Structure Json'' attribute.</div> <div class="image-green-border">&nbsp;</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:SFTP 14.png|600px|SFTP 14.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.
@@ Line 167: / Line 167: @@
 <div class="image-green-border">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:</div> <div class="image-green-border">&nbsp;</div>
 === Configuring Client App Cross Reference Mapping &nbsp; ===
-<div class="image-green-border">&nbsp;</div> <div class="image-green-border">1. Create the master data for user information, similar to other integration client app cross reference mapping.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 8.png|500px]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">2. Edit the JSON structure for “UserInformation”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 02.png|600px|7.16 GIF User provisioning 02.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 03.png|720px|7.16 GIF User provisioning 03.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 04.png|720px|7.16 GIF User provisioning 04.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">6. Update details on ASB.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">7. Send the payload on the inbound topic. Payload can be captured from any third-party application. For example, SAP.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">8. '''Click '''''User Administration > Users > Users'' in ICI. The users index page opens. The provisioned user will be displayed in the list of users.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Following is a list of all actions available that can be used in the same steps as described for the “Provision” above:</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 06.png|720px|7.16 GIF User provisioning 06.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''': All actions can be checked for success or failure through standard ICI notifications.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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:</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 07.png|720px|7.16 GIF User provisioning 07.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">The line items (such as organization, extended user entity, etc.) can be sent in other files.&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 08.png|720px|7.16 GIF User provisioning 08.png]]</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 09.png|720px|7.16 GIF User provisioning 09.png]]</div> <div class="image-green-border"><br/> 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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Similar to ASB, users can also be provisioned, deprovisioned and replaced using SFTP by passing the respective actions via CSV.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Unlike CSV, when using JSON based integrations, all actions can be passed using one file.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 10.png|600px|7.16 GIF User provisioning 10.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''':&nbsp;&nbsp; &nbsp;<br/> The Folder Structure Json attribute has been updated to Version 2.0, however earlier versions continue to be supported.<br/> Notifications to individual users and mass notification to functional users are not supported.<br/> Creating a new security group or user group is not supported.</div>
+<div class="image-green-border">&nbsp;</div> <div class="image-green-border">1. Create the master data for user information, similar to other integration client app cross reference mapping.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 8.png|500px|SFTP 8.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">2. Edit the JSON structure for “UserInformation”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 02.png|600px|7.16 GIF User provisioning 02.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 03.png|720px|7.16 GIF User provisioning 03.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 04.png|720px|7.16 GIF User provisioning 04.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">6. Update details on ASB.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">7. Send the payload on the inbound topic. Payload can be captured from any third-party application. For example, SAP.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">8. '''Click '''''User Administration > Users > Users'' in ICI. The users index page opens. The provisioned user will be displayed in the list of users.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Following is a list of all actions available that can be used in the same steps as described for the “Provision” above:</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 06.png|720px|7.16 GIF User provisioning 06.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''': All actions can be checked for success or failure through standard ICI notifications.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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:</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 07.png|720px|7.16 GIF User provisioning 07.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">The line items (such as organization, extended user entity, etc.) can be sent in other files.&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 08.png|720px|7.16 GIF User provisioning 08.png]]</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 09.png|720px|7.16 GIF User provisioning 09.png]]</div> <div class="image-green-border"><br/> 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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Similar to ASB, users can also be provisioned, deprovisioned and replaced using SFTP by passing the respective actions via CSV.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Unlike CSV, when using JSON based integrations, all actions can be passed using one file.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 10.png|600px|7.16 GIF User provisioning 10.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''':&nbsp;&nbsp; &nbsp;<br/> The Folder Structure Json attribute has been updated to Version 2.0, however earlier versions continue to be supported.<br/> Notifications to individual users and mass notification to functional users are not supported.<br/> Creating a new security group or user group is not supported.</div>
 == Extending file-based inbound integration for agreements and associations ==

@@ Line 156: / Line 156: @@
 . '''Enter '''the relevant attribute values in the respective fields.&nbsp;
-<div class="image-green-border">5. '''Copy '''the Json format from the tool-tip of the ''Folder Structure Json'' attribute.</div> <div class="image-green-border">&nbsp;</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>
+<div class="image-green-border">5. '''Copy '''the Json format from the tool-tip of the ''Folder Structure Json'' attribute.</div> <div class="image-green-border">&nbsp;</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:SFTP 14.png|600px]]</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:SFTP 7.png|600px|SFTP 7.png]]</div>
+<div class="image-green-border">[[File:SFTP 7.png|500px|SFTP 7.png]]</div>
 . '''Click '''''Save''. The cross reference mapping will be created.
 <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">&nbsp;</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> <div class="image-green-border">&nbsp;</div>
@@ Line 167: / Line 167: @@
 <div class="image-green-border">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:</div> <div class="image-green-border">&nbsp;</div>
 === Configuring Client App Cross Reference Mapping &nbsp; ===
-<div class="image-green-border">&nbsp;</div> <div class="image-green-border">1. Create the master data for user information, similar to other integration client app cross reference mapping.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 01.png|720px|7.16 GIF User provisioning 01.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">2. Edit the JSON structure for “UserInformation”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 02.png|720px|7.16 GIF User provisioning 02.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 03.png|720px|7.16 GIF User provisioning 03.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 04.png|720px|7.16 GIF User provisioning 04.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">6. Update details on ASB.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">7. Send the payload on the inbound topic. Payload can be captured from any third-party application. For example, SAP.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">8. '''Click '''''User Administration > Users > Users'' in ICI. The users index page opens. The provisioned user will be displayed in the list of users.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Following is a list of all actions available that can be used in the same steps as described for the “Provision” above:</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 06.png|720px|7.16 GIF User provisioning 06.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''': All actions can be checked for success or failure through standard ICI notifications.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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:</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 07.png|720px|7.16 GIF User provisioning 07.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">The line items (such as organization, extended user entity, etc.) can be sent in other files.&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 08.png|720px|7.16 GIF User provisioning 08.png]]</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 09.png|720px|7.16 GIF User provisioning 09.png]]</div> <div class="image-green-border"><br/> 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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Similar to ASB, users can also be provisioned, deprovisioned and replaced using SFTP by passing the respective actions via CSV.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Unlike CSV, when using JSON based integrations, all actions can be passed using one file.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 10.png|720px|7.16 GIF User provisioning 10.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''':&nbsp;&nbsp; &nbsp;<br/> The Folder Structure Json attribute has been updated to Version 2.0, however earlier versions continue to be supported.<br/> Notifications to individual users and mass notification to functional users are not supported.<br/> Creating a new security group or user group is not supported.</div>
+<div class="image-green-border">&nbsp;</div> <div class="image-green-border">1. Create the master data for user information, similar to other integration client app cross reference mapping.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 8.png|500px]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">2. Edit the JSON structure for “UserInformation”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 02.png|600px|7.16 GIF User provisioning 02.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 03.png|720px|7.16 GIF User provisioning 03.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 04.png|720px|7.16 GIF User provisioning 04.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">6. Update details on ASB.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">7. Send the payload on the inbound topic. Payload can be captured from any third-party application. For example, SAP.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">8. '''Click '''''User Administration > Users > Users'' in ICI. The users index page opens. The provisioned user will be displayed in the list of users.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Following is a list of all actions available that can be used in the same steps as described for the “Provision” above:</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 06.png|720px|7.16 GIF User provisioning 06.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''': All actions can be checked for success or failure through standard ICI notifications.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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:</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 07.png|720px|7.16 GIF User provisioning 07.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">The line items (such as organization, extended user entity, etc.) can be sent in other files.&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 08.png|720px|7.16 GIF User provisioning 08.png]]</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 09.png|720px|7.16 GIF User provisioning 09.png]]</div> <div class="image-green-border"><br/> 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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Similar to ASB, users can also be provisioned, deprovisioned and replaced using SFTP by passing the respective actions via CSV.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Unlike CSV, when using JSON based integrations, all actions can be passed using one file.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 10.png|600px|7.16 GIF User provisioning 10.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''':&nbsp;&nbsp; &nbsp;<br/> The Folder Structure Json attribute has been updated to Version 2.0, however earlier versions continue to be supported.<br/> Notifications to individual users and mass notification to functional users are not supported.<br/> Creating a new security group or user group is not supported.</div>
 == Extending file-based inbound integration for agreements and associations ==
@@ Line 180: / Line 180: @@
 <div class="image-green-border">[[File:7.16 GIF File based 01.png|720px|7.16 GIF File based 01.png]]</div>
 . Enter the “Default Entity Team”.
-<div class="image-green-border">[[File:7.16 GIF File based 02.png|720px|7.16 GIF File based 02.png]]</div> <div class="image-green-border"><br/> 4. Enter the “Line Item Separator” as “#”.</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 9.PNG|600px|SFTP 9.PNG]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">5. Upload the files to the FTP server.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 11.png|600px|SFTP 11.png]]</div> <div class="image-green-border"><br/> The agreement gets created with all the uploaded details:</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 13.png|600px|SFTP 13.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">To create an agreement along with associations and team using JSON file-based integration:</div> <div class="image-green-border"><br/> Update the JSON file with the agreement and team details.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF File based 06.png|720px|7.16 GIF File based 06.png]]</div> <div class="image-green-border"><br/> 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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 12.png|600px|SFTP 12.png]]</div> <div class="image-green-border"><br/> Follow the same process to create contract requests.</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">
+<div class="image-green-border">4. Enter the “Line Item Separator” as “#”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 9.PNG|600px|SFTP 9.PNG]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">5. Upload the files to the FTP server.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 11.png|600px|SFTP 11.png]]</div> <div class="image-green-border"><br/> The agreement gets created with all the uploaded details:</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 13.png|600px|SFTP 13.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">To create an agreement along with associations and team using JSON file-based integration:</div> <div class="image-green-border"><br/> Update the JSON file with the agreement and team details.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF File based 06.png|720px|7.16 GIF File based 06.png]]</div> <div class="image-green-border"><br/> 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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 12.png|600px|SFTP 12.png]]</div> <div class="image-green-border"><br/> Follow the same process to create contract requests.</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">
 '''Note''':&nbsp;<br/> 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.

@@ Line 17: / Line 17: @@
 .&nbsp;'''Click '''''Create Contract Type'' sub menu from the ''Configuration ''tile. The ''Select Contract Type'' page opens.
-<div class="image-green-border">[[File:GIF1.png|500px]]</div>
+<div class="image-green-border">[[File:GIF1.png|500px|GIF1.png]]</div>
 .'''Select''' ''Masterdata''.
-<div class="image-green-border">[[File:GIF 2.png|500px]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">3.&nbsp;'''Click '''the ''Next ''button. The ''Create Contract Type Wizard'' page opens.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:GIF 3.png|600px]]</div>
+<div class="image-green-border">[[File:GIF 2.png|500px|GIF 2.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">3.&nbsp;'''Click '''the ''Next ''button. The ''Create Contract Type Wizard'' page opens.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:GIF 3.png|600px|GIF 3.png]]</div>
 The&nbsp;''Create Contract Type&nbsp;''page has the following sections:&nbsp;
@@ Line 35: / Line 35: @@
 .&nbsp;Navigate to the&nbsp;''Create Masterdata'' page in ICI. This page contains the following tabs:
-<div class="image-green-border">[[File:GIF 4.png|600px]]</div>
+<div class="image-green-border">[[File:GIF 4.png|600px|GIF 4.png]]</div>
 '''Masterdata Details&nbsp;'''
@@ Line 51: / Line 51: @@
 <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>
 .&nbsp;'''Click&nbsp;'''''Crate&nbsp;''to crate&nbsp; the entity mapping. Or Click UPDATE to update existing entity mapping.&nbsp;
-<div class="image-green-border">[[File:SFTP 1.png|600px]]</div>
+<div class="image-green-border">[[File:SFTP 1.png|600px|SFTP 1.png]]</div>
 === Client App Entity Mapping&nbsp; ===
@@ Line 57: / Line 57: @@
 .&nbsp;Navigate to the''Create Masterdata'' page in ICI.&nbsp;This page contains the following tabs:
-<div class="image-green-border">[[File:GIF 7.png|600px]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div>
+<div class="image-green-border">[[File:GIF 7.png|600px|GIF 7.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div>
 '''Masterdata Details&nbsp;'''
@@ Line 82: / Line 82: @@
 #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:GIF 9.png|600px]]</div> <ol start="3">
+<div class="image-green-border">[[File:GIF 9.png|600px|GIF 9.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> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:GIF 10.png|600px]]</div> <ol start="4">
+<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="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:GIF 10.png|600px|GIF 10.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>
@@ Line 92: / Line 92: @@
 '''Click''' ''Publish Payload.'' The empty payload will be published.
-<div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:GIF 11.png|600px]]</div> <div class="image-green-border">&nbsp;</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">&nbsp;</div> <div class="image-green-border">[[File:GIF 11.png|600px|GIF 11.png]]</div> <div class="image-green-border">&nbsp;</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; ==
@@ Line 152: / Line 152: @@
 *Category: '''Select '''''Default''
 *Masterdata: '''Select '''''Client App Cross Reference''&nbsp;
-<div class="image-green-border">[[File:GIF 4.png|600px]]</div> <div class="image-green-border">&nbsp;</div>
+<div class="image-green-border">[[File:GIF 4.png|600px|GIF 4.png]]</div> <div class="image-green-border">&nbsp;</div>
 . '''Click '''''Next''. The ''Attributes ''page opens.
@@ Line 161: / Line 161: @@
 *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:SFTP 7.png|600px]]</div>
+<div class="image-green-border">[[File:SFTP 7.png|600px|SFTP 7.png]]</div>
 . '''Click '''''Save''. The cross reference mapping will be created.
 <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">&nbsp;</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> <div class="image-green-border">&nbsp;</div>
@@ Line 180: / Line 180: @@
 <div class="image-green-border">[[File:7.16 GIF File based 01.png|720px|7.16 GIF File based 01.png]]</div>
 . Enter the “Default Entity Team”.
-<div class="image-green-border">[[File:7.16 GIF File based 02.png|720px|7.16 GIF File based 02.png]]</div> <div class="image-green-border"><br/> 4. Enter the “Line Item Separator” as “#”.</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 9.PNG|600px]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">5. Upload the files to the FTP server.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 11.png|600px]]</div> <div class="image-green-border"><br/> The agreement gets created with all the uploaded details:</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 13.png|600px]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">To create an agreement along with associations and team using JSON file-based integration:</div> <div class="image-green-border"><br/> Update the JSON file with the agreement and team details.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF File based 06.png|720px|7.16 GIF File based 06.png]]</div> <div class="image-green-border"><br/> 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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 12.png|600px]]</div> <div class="image-green-border"><br/> Follow the same process to create contract requests.</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">
+<div class="image-green-border">[[File:7.16 GIF File based 02.png|720px|7.16 GIF File based 02.png]]</div> <div class="image-green-border"><br/> 4. Enter the “Line Item Separator” as “#”.</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 9.PNG|600px|SFTP 9.PNG]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">5. Upload the files to the FTP server.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 11.png|600px|SFTP 11.png]]</div> <div class="image-green-border"><br/> The agreement gets created with all the uploaded details:</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 13.png|600px|SFTP 13.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">To create an agreement along with associations and team using JSON file-based integration:</div> <div class="image-green-border"><br/> Update the JSON file with the agreement and team details.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF File based 06.png|720px|7.16 GIF File based 06.png]]</div> <div class="image-green-border"><br/> 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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:SFTP 12.png|600px|SFTP 12.png]]</div> <div class="image-green-border"><br/> Follow the same process to create contract requests.</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">
 '''Note''':&nbsp;<br/> 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.

@@ Line 170: / Line 170: @@
 == Support for user provisioning/deprovisioning from ASB/SFTP/BLOB ==
 <div class="image-green-border">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:</div> <div class="image-green-border">&nbsp;</div>
 === Configuring Client App Cross Reference Mapping &nbsp; ===
-<div class="image-green-border">&nbsp;</div> <div class="image-green-border">1. Create the master data for user information, similar to other integration client app cross reference mapping.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 01.png|720px]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">2. Edit the JSON structure for “UserInformation”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 02.png|720px]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 03.png|720px]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 04.png|720px]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">6. Update details on ASB.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">7. Send the payload on the inbound topic. Payload can be captured from any third-party application. For example, SAP.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">8. '''Click '''''User Administration > Users > Users'' in ICI. The users index page opens. The provisioned user will be displayed in the list of users.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 05.png|720px]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Following is a list of all actions available that can be used in the same steps as described for the “Provision” above:</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 06.png|720px]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''': All actions can be checked for success or failure through standard ICI notifications.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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:</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 07.png|720px]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">The line items (such as organization, extended user entity, etc.) can be sent in other files.&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 08.png|720px]]</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 09.png|720px]]</div> <div class="image-green-border"><br/> 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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Similar to ASB, users can also be provisioned, deprovisioned and replaced using SFTP by passing the respective actions via CSV.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Unlike CSV, when using JSON based integrations, all actions can be passed using one file.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 10.png|720px]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''':&nbsp;&nbsp; &nbsp;<br/> The Folder Structure Json attribute has been updated to Version 2.0, however earlier versions continue to be supported.<br/> Notifications to individual users and mass notification to functional users are not supported.<br/> Creating a new security group or user group is not supported.</div>
+<div class="image-green-border">&nbsp;</div> <div class="image-green-border">1. Create the master data for user information, similar to other integration client app cross reference mapping.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 01.png|720px|7.16 GIF User provisioning 01.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">2. Edit the JSON structure for “UserInformation”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 02.png|720px|7.16 GIF User provisioning 02.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 03.png|720px|7.16 GIF User provisioning 03.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 04.png|720px|7.16 GIF User provisioning 04.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">6. Update details on ASB.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">7. Send the payload on the inbound topic. Payload can be captured from any third-party application. For example, SAP.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">8. '''Click '''''User Administration > Users > Users'' in ICI. The users index page opens. The provisioned user will be displayed in the list of users.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 05.png|720px|7.16 GIF User provisioning 05.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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”.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Following is a list of all actions available that can be used in the same steps as described for the “Provision” above:</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 06.png|720px|7.16 GIF User provisioning 06.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''': All actions can be checked for success or failure through standard ICI notifications.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">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:</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 07.png|720px|7.16 GIF User provisioning 07.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">The line items (such as organization, extended user entity, etc.) can be sent in other files.&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 08.png|720px|7.16 GIF User provisioning 08.png]]</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 09.png|720px|7.16 GIF User provisioning 09.png]]</div> <div class="image-green-border"><br/> 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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Similar to ASB, users can also be provisioned, deprovisioned and replaced using SFTP by passing the respective actions via CSV.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">Unlike CSV, when using JSON based integrations, all actions can be passed using one file.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.16 GIF User provisioning 10.png|720px|7.16 GIF User provisioning 10.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''':&nbsp;&nbsp; &nbsp;<br/> The Folder Structure Json attribute has been updated to Version 2.0, however earlier versions continue to be supported.<br/> Notifications to individual users and mass notification to functional users are not supported.<br/> Creating a new security group or user group is not supported.</div>
 &nbsp;

@@ Line 146: / Line 146: @@
 &nbsp;
 === Creating a Customized Folder Structure ===
@@ Line 166: / Line 167: @@
 <div class="image-green-border">[[File:7.14 GIF Folder Structure Management 06.png|720px|7.14 GIF Folder Structure Management 06.png]]</div>
 . '''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>
+<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> <div class="image-green-border">&nbsp;</div>
 &nbsp;

@@ Line 132: / Line 132: @@
 *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.
@@ Line 144: / Line 145: @@
 *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 ===
@@ Line 150: / Line 152: @@
 . '''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]]</div> <div class="image-green-border"><br/> 2. Enter the relevant details:</div>
+<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]]</div>
+<div class="image-green-border">[[File:7.14 GIF Folder Structure Management 02.png|720px|7.14 GIF Folder Structure Management 02.png]]</div>
-. '''Click '''''Next''. The ''Attributes ''page opens.<br/> 4. '''Enter '''the relevant attribute values in the respective fields.&nbsp;
+. '''Click '''''Next''. The ''Attributes ''page opens.
 <div class="image-green-border">[[File:7.14 GIF Folder Structure Management 03.png|720px]]</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]]</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]]</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]]</div>
+<div class="image-green-border">[[File:7.14 GIF Folder Structure Management 06.png|720px|7.14 GIF Folder Structure Management 06.png]]</div>
 . '''Click '''''Save''. The cross reference mapping will be created.
-<div class="image-green-border">[[File:7.14 GIF Folder Structure Management 07.png|720px]]</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]]</div>
+<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;