0% found this document useful (0 votes)
220 views14 pages

02 - User Guide DocuSign (v.168+)

This document provides a user guide for DocuSign V2 integration in Ivalua. Key updates include: - Moving to a fully EAI-based integration for easier configuration. - Enhancing the EAI stack with new integration capabilities. - Improving the UI/UX for electronic signature processes. - Including some DocuSign configuration options directly in Ivalua. - Transitioning the authorization mechanism to OAuth2.0 for improved security.

Uploaded by

arnault.scalabre
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
220 views14 pages

02 - User Guide DocuSign (v.168+)

This document provides a user guide for DocuSign V2 integration in Ivalua. Key updates include: - Moving to a fully EAI-based integration for easier configuration. - Enhancing the EAI stack with new integration capabilities. - Improving the UI/UX for electronic signature processes. - Including some DocuSign configuration options directly in Ivalua. - Transitioning the authorization mechanism to OAuth2.0 for improved security.

Uploaded by

arnault.scalabre
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 14

DocuSign V2: User guide

Version 168 +

updated 04.27.21

Contents

1. Introduction 2

2. Configuration 2

3. User Guide 2

4. Add signature proxy to any Business Object 7


Procedure to add an electronic signature for a new object 8

5. System definition and Oauth2.0 12


EAI Interfaces 13

Migration from Docusign V1 to Docusign V2 14


1. Introduction

Since Release 168, a new version for Docusign integration has been delivered named Docusign V2.
Any project that has configured Docusign V1 should upgrade since a big refactoring has been performed
and the new implementation is full EAI based, which grants the configurator to integrate it easily into any project
without specific code.
The V1 configuration can’t work anymore without an upgrade

- We’ve enriched the EAI stack with a lot of new possibilities to reach a full configurable integration
- We’ve removed almost all the specific code regarding this integration.
- We’ve improved the UI/ UX to bring more coherence with the other e-signature implementations.
- We've included some Docusign options directly in Ivalua to speed-up the signature transaction process setup.
- We’ve reworked the authorization mechanism moving to the OAUTH 2 standard to increase security.

OAuth2.0 instead of SOBO

From the version 168, we’ve replaced the SOBO mechanism with OAuth 2.0 “Act on
Behalf on “ which is strongly recommended by Docusign to improve security

2. Configuration
Please refer to the Docusign V2: Configuration to get deeper information about the setup of the third party system
and the Oauth 2.0 configuration

3. User Guide

When a user accesses the first time to the document tab of a contract or to any e-signature browse where the
signature proxy has been added, he should activate his authorizations to allow Ivalua to act on his behalf for the
Docusign platform.
Instead of the button “ sign'' he will then see a button called “Activate e-signatures”. Clicking on it brings the user
through the authorization process and sets the required access token and refresh token for that user.

© 2020 Ivalua, Inc. 2


This action is only needed once, The access token and the refresh token are then automatically renewed and the
validity period is also automatically extended.

A. if the user doesn’t yet have an account by Docusign, this action will automatically create one for him. The user
will then receive an Email from Docusign to fulfill the account creation.

B. Once the user has an active Docusign account, then he can activate his authorizations by clicking a second
time on the button “ Activate e-signatures”.

C. Important! The synchronization of the account creation might take a few minutes on the Docusign
platform. Please wait up to 5 minutes before trying to activate the authorizations to avoid frustration.
After completion, the user can see the button “Sign” again and can start to create signature transactions.

1. New signature setup page and new settings options:


When the user selects a document and hits the “sign” button, a new screen is displayed.
This screen helps configure a signature transaction before moving to docusign.
Before, the user had to set a lot of additional parameters on Docusign side before launching the signature,
through these new added options, the most required and important setup can be done directly in only one step
in Ivalua directly.

© 2020 Ivalua, Inc. 3


a. General information
- contains all the generic information about the transaction
- we can change the language to adapt to the signers contexts
b. Documents

- the already selected documents have been added to the document grid
- the original documents and the pdf that will be sent to Docusign are available and downloadable
- add new documents related to the objects or any other important files through the button “add
documents”

- reorder the documents in the Grid

© 2020 Ivalua, Inc. 4


- decide to “keep Documents order” will send the documents with the decided order to Docusign and
set this option on Docusign side.

c. Signatories

- One crucial enhancement that will really ease the process flow is that we can now select the signers directly
by Ivalua which used to be done manually on the Docusign platform

- we can reorder the signer in the grid through the drag&Drop column “order”

- we can set the option “ sequential signing” available in docusign after deciding of the signatories order: this
correspond to the Docusign recipient setup : “set signing Order”

- we can also define a User Role for each of the selected contacts like “Needs to Sign” or “Needs to view”

- There are several roles available in Docusign and each project can add them by simply adding the
other values in the config table (Admin → DataBrowse → t_fil_sign_rol) if needed.

- We have a new option that allows us to attach the signature placeholder for each selected signer. These
placeholders are then generated automatically and added at the end of each document that should be
signed.

- The content of the signature placeholder can be of course configured by changing the provided
template.

- There will be as many signature blocks as signers defined.

- The signature blocks set a placeholder for: Full name, Place, Date, Function, Signature
⇒ This is a huge time saving since the configurator doesn’t need anymore to set these fields manually
for each signer on the Docusign page.

© 2020 Ivalua, Inc. 5


After launching the signature, the user is redirected to Docusign, there the user can set more parameters for
more configuration but the project can also decide to keep the redirection away if no further tuning is needed
before launching the signature.

Certificate

Once all the signers have signed the documents, the signature transaction is automatically updated and the
signed documents are available in Ivalua.
These can be reached either in the signature browse or in the signature transaction page.
For each document that has been signed. will find the original document, the fully signed document and the
certificate of termination generated by docusign.

© 2020 Ivalua, Inc. 6


4. Add signature proxy to any Business Object

Connect E-Signature to any business object simply by design Mode

The electronic signature is a feature that has been implemented in the past with deep integration to the Contract
Module, but some customers have expressed the need of using the e-signature for documents attached to other
business objects.

In this release, we’ve made a vast refactoring and separated the strong connection between the e-signature and the
Contract module to enable our customer to embed the e-signature feature into any business object simply with 2
configuration steps.

E-signature is now easy to configure and not linked to particular objects

© 2020 Ivalua, Inc. 7


Procedure to add an electronic signature for a new object

As an example, we will try to add electronic signatures to the invoice.

1 - Global parameter: declare the objects types that should use the e-signature

●Goto Menu Settings => Parameter,


● Search for "fil_sign_file_otypes",
● In this parameter value, add "invoice" with a semicolon before (ex:
basket;contract;order;supplier;delivery;invoice),
● Clear the server cache with the button "$" in the admin action bar.
2 - Manage page: add the signature proxy by Design Mode

● Go to Invoicing => Browse Invoices,


● Enter in any existing invoice manage,
● Switch to design mode,
● Add a proxy at the right position,
● Select your proxy to configure it,
● In the second tab:
○ fill the field "Proxy" with the page "Signatures (/fil/sign_browse)",
○ fill the field "PathInfo" by "invoice/{invoice_id}", the first one is the object type code and the second
one is the object id to plug-in.
● Leave the design mode,

● At this time, the proxy show the signature browse with a

button "Sign"

○ Or a button “Activate e-signature” which is only displayed when the e-signature third party system is
configured with the OAuth 2.0 authorization standard.
■ this button appears until the user gets his Oauth tokens set.
■ Clicking on it lets the user go through the authorization steps.
■ Once done this button is replaced with the “Sign” button and the tokens are automatically
updated during the lifetime of the application
● Click on the button "Sign" and check that the signature creation is shown in a modal with object type & a
selector set to your invoice as selected.

© 2020 Ivalua, Inc. 8


3 - Custom data source for file selector (optional)

On the page of electronic signature creation ( /sign_manage), a file selector is available to select the documents
related to the object itself.

This selector is filled by default by all files found in the table "t_fil_file_x" filter on the target object type code
(otype_code) and the target object ID (frel_x_id).

© 2020 Ivalua, Inc. 9


If the selector is empty because the documents attached to that object are stored in specific tables, he can customize
this selector by creating a query in the module query.

This query should respect the following rules:

● the query code must be in this format: "sign_file_filter_<otype_code>",

● the query must return one field called "file_guid",

● the query can use parameter "@otype_code" (object type code) and "@object_id" (object ID),

● the file selector will filter & display only files GUIDs returned by the query.

EXAMPLE
SELECT file_guid
FROM t_fil_file_x AS filx
WHERE filx.otype_code = @otype_code
AND filx.frel_x_id = @object_id
AND filx.frel_type = 'us_invoice'
⇒ This query will return only documents attached to the object of type "us_invoice".

© 2020 Ivalua, Inc. 10


4 - Custom data source for contact selector (optional)

On the page of electronic signature creation ( sign_manage), the configurator can add signers in an open grid.

In this grid, he can select a contact. By default, this selector displays all contacts of the application.

If the need is to restrict the list of the contacts that could be chosen to the object team for example, then the
configurator can customize this selector by creating a query in the module query.

This query should respect the following rules:

● the query code must be in this format: "sign_contact_filter_<otype_code>",

● the query must return one field called "contact_id",

● the query can use parameter "@otype_code" (object type code) and "@object_id" (object ID),

● the file selector will filter & display only contact IDs returned by the query.

EXAMPLE
SELECT DISTINCT inv.contact_id
FROM
(
SELECT inv.contact_id
FROM t_ord_invoice inv
WHERE inv.invoice_id = @object_id

UNION

SELECT lg.contact_id
FROM t_ord_invoice inv
INNER JOIN t_usr_login lg ON lg.login_name = inv.login_name_created
WHERE inv.invoice_id = @object_id

UNION

SELECT lg.contact_id
FROM t_ord_invoice inv
INNER JOIN t_usr_login lg ON lg.login_name = inv.login_name_modified
WHERE inv.invoice_id = @object_id
) AS inv
WHERE inv.contact_id IS NOT NULL
⇒ This query will return the main contacts of a purchase requisition (creator, billing contact & delivery contact).

© 2020 Ivalua, Inc. 11


Always think of:

Adding a view authorization for the newly added proxy:


- Should an external user see the signature proxy and be able to create e-signature if
the page is visible for externals?
- In the standard version, there is no authorization set by default.

5. System definition and Oauth2.0


An example of Docusign configuration can be found in the REF-env under Menu Configuration → Systems →
Docusign_admin

Please refer to for detailed configuration information: System and OAuth2.0 Configuration Settings

- to see the new architecture and new screens to configure all connection settings to any third-party system.
- to get concrete step by step OAuth 2.0 configuration for Docusign

These 2 components simplify the configuration and the administration of any system Ivalua has to connect with.

Implemented OAuth 2.0 in version 168:

- ✅ Ability to connect Ivalua to 3rd party APIs via OAuth2.0


- ⬜ Ability to offer an OAuth mechanism to allow 3rd party services connect to Ivalua API
- This will be implemented in a future Release

© 2020 Ivalua, Inc. 12


EAI Interfaces

Go to Menu Integration → Configure EAI → filter on Docusign V2 to see all the interfaces that have been created to enable
full configurable connectivity between the both systems.

Interface Name Request Description

DocuSign V2: Create a user account 496582 initiate the user creation in Docusign when a user start a
signature transaction in Ivalua and doesn’t have a Docusign user
count for that ClientID

DocuSign V2: Signature create 448539 Create the signature transaction and initiate it in Docusign
- Only internal users can create transaction

DocuSign V2: Cancel Signature 448546 Cancel signature transaction as long as it’s not already send
- Button available for the transaction creator and the
admin account

DocuSign V2: Update Signature 448540 Update the signature status:


- Manual through a button available in the manage and
the browse
- automatic as long the signature is not in status=
“finished”when displaying the manage or the browse

DocuSign V2: Signature access 448607 the redirection URL can be set to redirect to:
- edit Document page
- main page of the envelope

DocuSign V2: Get the unsupported file types should be executed at least once at the project begin to update
the list of supported files. In the standard only pdf and word are
supported

Helper Interface
DocuSign V2: Get global informations 393976 to get general information from the external server:
Base URL
customerID
permission profiles

Helper interface
1. DocuSign V2: Get connect logs 448859 Get connection logs for all users that have been
connected to Docusign

Helper interface
2. DocuSign V2: Get connect log details when a deep lookup is needed for one particular user,

© 2020 Ivalua, Inc. 13


then get the is from the interface one and launch the second one
to get more detailed specific information for one user id

DocuSign V2: Create a user account 496582 initiate the user creation in Docusign when a user start a
signature transaction in Ivalua and doesn’t have a Docusign user
count for that ClientID

1. DocuSign V2: Signature create 448539 Create the signature transaction and initiate it in Docusign
- Only internal users can create transaction

6. Migration from Docusign V1 to Docusign V2

Please find the Migration documentation : Extranet/Documentation/04 Interfaces/03 Interface Definitions/


Docusign/ V2- Migration: Docusign V1 to Docusign V2

© 2020 Ivalua, Inc. 14

You might also like