From ICIHelp8.2
| (14 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
= E-Sign Configurations = | = E-Sign Configurations = | ||
| − | == | + | == What is an E-Sign Configuration? == |
An E-Sign or electronic signature is an efficient, legally binding way to get approval on electronic documents. Secure and verifiable, it can replace a handwritten signature in virtually any process. This utility will support Adobe Sign and DocuSign as ESign providers. | An E-Sign or electronic signature is an efficient, legally binding way to get approval on electronic documents. Secure and verifiable, it can replace a handwritten signature in virtually any process. This utility will support Adobe Sign and DocuSign as ESign providers. | ||
| + | | ||
| − | == | + | == Performing E-Sign Configuration == |
<br/> 1. Click “Configure” tile and click “System Configuration”. The “System Configuration – Self-Service” tab will open. | <br/> 1. Click “Configure” tile and click “System Configuration”. The “System Configuration – Self-Service” tab will open. | ||
| Line 15: | Line 16: | ||
*User needs to have manage access for “Self Service” security group privilege to view “System Configuration” option under “Configure” tile. | *User needs to have manage access for “Self Service” security group privilege to view “System Configuration” option under “Configure” tile. | ||
*User needs to have the manage access for “Self Service E-sign Configuration” security group privilege to view the “E- Sign Configuration” option on the “System Configuration – Self Service” page. | *User needs to have the manage access for “Self Service E-sign Configuration” security group privilege to view the “E- Sign Configuration” option on the “System Configuration – Self Service” page. | ||
| − | </div> <div class="image-green-border">[[File:Configuring DocuSign-SecurityGroups.png|720px]]</div> | + | </div> <div class="image-green-border">[[File:Configuring DocuSign-SecurityGroups.png|720px|Configuring DocuSign-SecurityGroups.png]]</div> |
2. Click “E-Sign Configurations” index page will open. | 2. Click “E-Sign Configurations” index page will open. | ||
<div class="image-green-border">[[File:E sign 8.2 2.png|720px|E sign 8.2 2.png]]</div> <div class="image-green-border"> </div> <div class="image-green-border">'''Note: '''User need to have the E-sign admin user role assigned to make E-sign configuration changes</div> <div class="image-green-border"> </div> <div class="image-green-border">[[File:E-sign Admin.png|720px|E-sign Admin.png]]</div> | <div class="image-green-border">[[File:E sign 8.2 2.png|720px|E sign 8.2 2.png]]</div> <div class="image-green-border"> </div> <div class="image-green-border">'''Note: '''User need to have the E-sign admin user role assigned to make E-sign configuration changes</div> <div class="image-green-border"> </div> <div class="image-green-border">[[File:E-sign Admin.png|720px|E-sign Admin.png]]</div> | ||
3. Click “Create” button and from the dropdown select “Adobe Sign Account” or “DocuSig Account” as required. | 3. Click “Create” button and from the dropdown select “Adobe Sign Account” or “DocuSig Account” as required. | ||
<div class="image-green-border">[[File:E sign 8.2 3.png|720px|E sign 8.2 3.png]]</div> | <div class="image-green-border">[[File:E sign 8.2 3.png|720px|E sign 8.2 3.png]]</div> | ||
| − | === | + | |
| + | |||
| + | | ||
| + | |||
| + | | ||
| + | |||
| + | | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | === Setting up the Configuration === | ||
This facilitates you to configure Adobe Sign / DocuSign as the E-Sign provider on the instance. While creating the configuration, you need to perform the following steps: | This facilitates you to configure Adobe Sign / DocuSign as the E-Sign provider on the instance. While creating the configuration, you need to perform the following steps: | ||
| Line 28: | Line 41: | ||
*'''Validate and Deploy''' – Once the Authentication URL is integrated successfully, the next and final step is to validate the configuration and deploy on the instance. Once the validation is successful, it will be pushed to the instance and updated at the required locations. Please note - If during the configuration, the Bio Pharma is set to 'Yes' OR if the 'Send as Signature' is either 'Sender' or a specific Email ID then the configuration will be published to ICI without validations in step 3 (Validation) of the Configuration process. | *'''Validate and Deploy''' – Once the Authentication URL is integrated successfully, the next and final step is to validate the configuration and deploy on the instance. Once the validation is successful, it will be pushed to the instance and updated at the required locations. Please note - If during the configuration, the Bio Pharma is set to 'Yes' OR if the 'Send as Signature' is either 'Sender' or a specific Email ID then the configuration will be published to ICI without validations in step 3 (Validation) of the Configuration process. | ||
| − | + | '''Creating DocuSign Account ''' | |
| + | <div class="image-green-border">[[File:Configuring DocuSign-CreateAccount.png|720px|Configuring DocuSign-CreateAccount.png]]</div> <div class="image-green-border"> </div> <div class="image-green-border">Provide the following information. </div> | ||
| + | *Account Name: Enter the account name that is used during DocuSign configuration Same need to be added in E-Signature Provider attribute You can find same on below path <br/> setting-> Connect. | ||
| + | <div class="image-green-border">[[File:Configuring DocuSign-DocuSignSignature.png|720px|Configuring DocuSign-DocuSignSignature.png]]</div> | ||
| + | *Client ID: This is the user id in DocuSign, you can find same on below path <br/> Setting-> Apps and Keys. | ||
| + | <div class="image-green-border">[[File:Configuring DocuSign-Apps and Keys.png|720px|Configuring DocuSign-Apps and Keys.png]]</div> | ||
| + | | ||
| − | + | *Client Secret: It is the RSA private key in DocuSign. You can find the RSA key on below path Setting->Apps and Keys->Add Apps and Integration key-> Generate RSA. | |
| − | *Client | + | <div class="image-green-border">[[File:Configuring DocuSign-RSAKeyRepair.png|720px|Configuring DocuSign-RSAKeyRepair.png]]</div> |
| − | * | + | *API Key: It is the integration key in DocuSign. You can find it at this path: Settings-> Apps and Keys. |
| − | <div class="image-green-border">[[File: | + | <div class="image-green-border">[[File:Configuring DocuSign-Settings.png|720px|Configuring DocuSign-Settings.png]]</div> <div class="image-green-border"> </div> |
| − | + | *CALLBACK URL: https://<cname>/ESignCallBack/Initiate | |
| + | *SERVICE URI: [https://{server}.docusign.net/restapi/v2.1/ https://{server}.docusign.net/restapi/v2.1/] For example, [https://demo.docusign.net/restapi/v2.1/ https://demo.docusign.net/restapi/v2.1/] | ||
| − | + | OAUTH BASE PATH | |
| − | + | *For Dev: account-d.docusign.com | |
| + | *For Prod: account.docusign.com | ||
| + | *Bio-Pharma Account: Set '''Yes '''or '''No '''as per requirement. | ||
| + | *Access URL: This is the consent url, that must be copied from UI. Users ask DocuSign admin to allow access. | ||
| + | |||
| + | '''Adobe E-Sign ''' | ||
| + | |||
| + | 1. Enter “Account Name”, “Client ID” and “Client Secret” | ||
| + | |||
| + | *Account Name: A unique Account Name to identify the configuration. This is the name used in Adobe configuration and must be added in E-Signature provider attribute. You can find same on below path :Account->Acrobat Sign API / Adobe Sign API -> API Application. | ||
| + | <div class="image-green-border">[[File:E sign 8.2 4.png|500px|E sign 8.2 4.png]]</div> <div class="image-green-border"> </div> <div class="image-green-border">[[File:Configuring AdobeSign.PNG|720px|Configuring AdobeSign.PNG]]</div> | ||
| + | *Client ID: Identifies the Client that is making the request. This is the application ID in Adobe. It is available at the following location: Account ->Acrobat Sign API / Adobe Sign API-> API Application. | ||
| + | <div class="image-green-border">[[File:Configuring AdobeSign-ClientID.PNG|720px|Configuring AdobeSign-ClientID.PNG]]</div> | ||
| + | *Client Secret: Identifies the Client Secret that is making the request. This is the client secret in Adobe, you can find the same on below path <br/> Account->Acrobat Sign API / Adobe Sign API -> API Application. | ||
| + | <div class="image-green-border">[[File:Configuring AdobeSign-ClientSecret.PNG|720px|Configuring AdobeSign-ClientSecret.PNG]]</div> | ||
| + | 2. Enter “Service URL” and “Days Until Signing Deadline”. | ||
| + | |||
| + | *Service URL: URL used by ICI to send information to the provider. [https://api.{shard}.adobesign.com https://api.{shard}.adobesign.com]<br/> For example: [https://api.na2.echosign.com/ https://api.na2.echosign.com/] | ||
| + | *Bio-Pharma Account: Select '''Yes '''or '''No '''as per the requirement. | ||
| + | *Access URL: This is the consent URL that must be copied from the user interface and request DocuSign administrator to provide access. | ||
| + | |||
| + | 3. Enter the Callback URI as follows: | ||
| + | |||
| + | https://<cname>/ESignCallBack/AdobeSignCallback | ||
| + | |||
| + | 4. Toggle the “Bio Pharma Account” switch as required. | ||
| + | |||
| + | | ||
<div class="note-box">'''Note: '''If set to “Yes”, it will enforce additional authentication during the signature process.</div> | <div class="note-box">'''Note: '''If set to “Yes”, it will enforce additional authentication during the signature process.</div> | ||
| − | + | 5. Click “Save and Next” | |
| − | + | 6.''' '''In OAuth URL section, click “Generate URL”. | |
<div class="image-green-border">[[File:E sign 8.2 5.png|450px|E sign 8.2 5.png]]</div> | <div class="image-green-border">[[File:E sign 8.2 5.png|450px|E sign 8.2 5.png]]</div> | ||
| − | + | 7. Copy the generated URL and send it to the administrator for the setup. | |
<div class="image-green-border">[[File:E sign 8.2 6.png|720px|E sign 8.2 6.png]]</div> | <div class="image-green-border">[[File:E sign 8.2 6.png|720px|E sign 8.2 6.png]]</div> | ||
| − | + | 8. Once the Authentication URL setup is completed successfully, toggle the “OAuth URL Setup Complete” switch to “Yes” and click “Next”. | |
| − | + | 9. Click “Validate and Publish”. | |
<div class="image-green-border">[[File:E sign 8.2 7.png|720px|E sign 8.2 7.png]]</div> | <div class="image-green-border">[[File:E sign 8.2 7.png|720px|E sign 8.2 7.png]]</div> | ||
| − | === | + | |
| + | |||
| + | === Default Configuration === | ||
There will be atleast and atmost 1 default configuration on the instance. Only an active configuration can be made default. If another active configuration is made Default, it will replace the existing one. | There will be atleast and atmost 1 default configuration on the instance. Only an active configuration can be made default. If another active configuration is made Default, it will replace the existing one. | ||
| Line 56: | Line 105: | ||
'''To Make a configuration as default''' | '''To Make a configuration as default''' | ||
| − | + | 1. In E-sign Configuration index page click the three dots next to the E-sign Configuration name and click “Set as Default”. | |
| − | <div class="image-green-border">[[File:E sign 8.2 8.png|720px|E sign 8.2 8.png]]</div> <div class="note-box">'''Note: '''Only Non Active configurations can be edited. Active configurations will be in read-only mode.</div> | + | <div class="image-green-border">[[File:E sign 8.2 8.png|720px|E sign 8.2 8.png]]</div> <div class="image-green-border"> </div> <div class="note-box">'''Note: '''Only Non Active configurations can be edited. Active configurations will be in read-only mode.</div> |
| | ||
Latest revision as of 11:40, 19 December 2022
Contents
E-Sign Configurations
What is an E-Sign Configuration?
An E-Sign or electronic signature is an efficient, legally binding way to get approval on electronic documents. Secure and verifiable, it can replace a handwritten signature in virtually any process. This utility will support Adobe Sign and DocuSign as ESign providers.
Performing E-Sign Configuration
1. Click “Configure” tile and click “System Configuration”. The “System Configuration – Self-Service” tab will open.
Note
- User needs to have manage access for “Self Service” security group privilege to view “System Configuration” option under “Configure” tile.
- User needs to have the manage access for “Self Service E-sign Configuration” security group privilege to view the “E- Sign Configuration” option on the “System Configuration – Self Service” page.
2. Click “E-Sign Configurations” index page will open.
Note: User need to have the E-sign admin user role assigned to make E-sign configuration changes
3. Click “Create” button and from the dropdown select “Adobe Sign Account” or “DocuSig Account” as required.
Setting up the Configuration
This facilitates you to configure Adobe Sign / DocuSign as the E-Sign provider on the instance. While creating the configuration, you need to perform the following steps:
- Account Details - Fill in the form with the correct information as per the fields provided for Adobe Sign / DocuSign.
- Generating Authentication URL – Once the form is saved, this is the next step where you can generate and copy the Authentication URL. This URL is sent to the administrator for the setup.
- Validate and Deploy – Once the Authentication URL is integrated successfully, the next and final step is to validate the configuration and deploy on the instance. Once the validation is successful, it will be pushed to the instance and updated at the required locations. Please note - If during the configuration, the Bio Pharma is set to 'Yes' OR if the 'Send as Signature' is either 'Sender' or a specific Email ID then the configuration will be published to ICI without validations in step 3 (Validation) of the Configuration process.
Creating DocuSign Account
Provide the following information.
- Account Name: Enter the account name that is used during DocuSign configuration Same need to be added in E-Signature Provider attribute You can find same on below path
setting-> Connect.
- Client ID: This is the user id in DocuSign, you can find same on below path
Setting-> Apps and Keys.
- Client Secret: It is the RSA private key in DocuSign. You can find the RSA key on below path Setting->Apps and Keys->Add Apps and Integration key-> Generate RSA.
- API Key: It is the integration key in DocuSign. You can find it at this path: Settings-> Apps and Keys.
- CALLBACK URL: https://<cname>/ESignCallBack/Initiate
- SERVICE URI: https://{server}.docusign.net/restapi/v2.1/ For example, https://demo.docusign.net/restapi/v2.1/
OAUTH BASE PATH
- For Dev: account-d.docusign.com
- For Prod: account.docusign.com
- Bio-Pharma Account: Set Yes or No as per requirement.
- Access URL: This is the consent url, that must be copied from UI. Users ask DocuSign admin to allow access.
Adobe E-Sign
1. Enter “Account Name”, “Client ID” and “Client Secret”
- Account Name: A unique Account Name to identify the configuration. This is the name used in Adobe configuration and must be added in E-Signature provider attribute. You can find same on below path :Account->Acrobat Sign API / Adobe Sign API -> API Application.
- Client ID: Identifies the Client that is making the request. This is the application ID in Adobe. It is available at the following location: Account ->Acrobat Sign API / Adobe Sign API-> API Application.
- Client Secret: Identifies the Client Secret that is making the request. This is the client secret in Adobe, you can find the same on below path
Account->Acrobat Sign API / Adobe Sign API -> API Application.
2. Enter “Service URL” and “Days Until Signing Deadline”.
- Service URL: URL used by ICI to send information to the provider. https://api.{shard}.adobesign.com
For example: https://api.na2.echosign.com/ - Bio-Pharma Account: Select Yes or No as per the requirement.
- Access URL: This is the consent URL that must be copied from the user interface and request DocuSign administrator to provide access.
3. Enter the Callback URI as follows:
https://<cname>/ESignCallBack/AdobeSignCallback
4. Toggle the “Bio Pharma Account” switch as required.
Note: If set to “Yes”, it will enforce additional authentication during the signature process.
5. Click “Save and Next”
6. In OAuth URL section, click “Generate URL”.
7. Copy the generated URL and send it to the administrator for the setup.
8. Once the Authentication URL setup is completed successfully, toggle the “OAuth URL Setup Complete” switch to “Yes” and click “Next”.
9. Click “Validate and Publish”.
Default Configuration
There will be atleast and atmost 1 default configuration on the instance. Only an active configuration can be made default. If another active configuration is made Default, it will replace the existing one.
To Make a configuration as default
1. In E-sign Configuration index page click the three dots next to the E-sign Configuration name and click “Set as Default”.
Note: Only Non Active configurations can be edited. Active configurations will be in read-only mode.
