This article is written for administrators who want to support the users of the yuuvis® RAD client to sign their PDF documents via DocuSign or Adobe Sign. It describes how to set up the service as well as the schema so that the users can request others to sign a specific document file.
...
simple signature (only email address needed)
advanced signature (e-mail address and telephone number (SMS) needed)
qualified signature (e-mail address and Identity Provider with 2FA and previous registration needed) - only available with DocuSign at the moment (in Germany the Identity Provider is SignMe).
| Info |
|---|
The Signing-Service is planned to add further custom connectors for other signing platforms. This feature is not yet implemented. |
Installation and Update
After the installation, the Signing-Service is part of the infrastructure so the following configuration is in place.
...
| Code Block |
|---|
- name: signingservice type: microservice profiles: prod,cloud,red instances: 1 memory: 256M port: 72557381 path: ${appBase}/signingservice/signingservice-app.jar |
...
| Code Block |
|---|
signingplatform: "docusign"
#signingplatform: "adobesign"
max-signers: 6
# configuration for accessing DocuSign
docusign-config:
pathToPrivateKey: 'C:\yuuvis\service-manager\certificates\private.key'
# see documentation
secretkey: ENC(xxxxxxxx)
integrationKey: ENC(xxxxxxxx)
oAuthBasePath: account-d.docusign.com
apiUsername: ????????-????-????-????-????????????
signatureTypes:
simple: universalsignaturepen_imageonly
advanced: universalsignaturepen_opentrust_hash_tsp
#qualified:
# configuration for accessing Adobe Sign
adobesign-config:
#The integration key must be created for the permissions "user_read", "agreement_read", "agreement_write", "agreement_send"
#integrationKey: ENC(xxxxxxxx)
#signatureTypes:
#simple: true
#advanced: false
#qualified: false
## default values for e-mails
email:
subject: Please sign.
body: Please sign the document.
## Scheduler
## Minimum of fixedRate is 1200000 (20 mins)
fixedRate: 1800000 |
| Note |
|---|
With a service-manager update there might be new parameters for the signing-service that are not automatically added to the <service-manager>\config\signing-prod.yml. You will need to add those manually afterwards as described in the Release Information |
To encrypt the keys from the signing platform, use the batch-tool <service-manager>\tools\encode.bat:
...
Technical field name | English label | Description | Default size |
|---|---|---|---|
yuvsigemailsubject | Email subject | Used as the subject of the email which is sent to a signer. A default is configured in the configuration signing-prod.yml | 100 |
yuvsigemailbody | Email message | Used as an additional part of the email message which is sent to a signer. A default is configured in the configuration signing-prod.yml | 2000 |
yuvsigtype | Signature type | Prepared for a later version: This is a catalog field with the values ‘simple’, ‘advanced’, and ‘qualified’. The values control which type of signature will be used on the signing platform. A default is configured in the configuration signing-prod.yml | |
yuvsigrequester | Requested by | The ID of the requesting user. | |
yuvsigreqdate | Requested on | The Date and time the signatures were requested. | |
yuvsigdate | Changed on | The date the status value was changed. | |
yuvsigstatus | Status | Status of the signing process. The shown values are those of the catalog ‘yuvsigstatus’ described below. | |
yuvsigerror | Notice | Error message written by the Signing-Service in case of an error. This information is in the apsect ‘Signatures’ only shown to an administrator (role: System-Admin-Role). | 500 |
yuvsigcanceledby | Canceled by | The field gets the userid of the one who had canceled the signing process. The client show the user name if given. | |
yuvsigreason | Reason | This fields get a reason that a user was requested to give, for e.g. if he canceles the signing process. | 500 |
yuvsigplatform | Signing platform | The technical name of the signing platform that is configured in the signing-prod.yml file and that was used for the signing process. Currently, only ‘docusign’ is supported. | |
yuvsigplatformid | ID of the signing platform | The ID of the signing process on the external signing platform. In case of the signing platform ‘docusign’ this will be the envelopId. It is used by the Signing-Service to ask the signing platform for its status. | |
yuvsigners | Signers | The table listing the signers data. | |
yuvsignerorder | Signing order | Signer 2 gets an email after signer 1 has signed and so forth. | |
yuvsignername | Name | The name of the signer as offered on the Docusign platform. | 100 |
yuvsigneremail | Email address | Email address of a signer that is used by Docusign for sending the email. | 100 |
yuvsignerphone | Phone number | Prepared for a later version: | 100 |
yuvsignextern | external | Prepared for a later version: | |
yuvsignerdate | Date | The date and time the signer has signed or revised. | |
yuvsignerstatus | Status | The status of the single signing step. This status is set by the Signing-Service. The status ‘inprocess’ is the indicator for the signing service to ask the signing platfrom for the status. | |
yuvsigcomment | Comment | This field is used to show the comment that the signers has given on the signing platform | 500 |
| Note |
|---|
Don’t change the technical field names. They are used by the client to handle the signing features correctly. |
The catalog ‘yuvsigstatus’ offers the processing status values:
Technical value name | Neutral label | Description |
|---|---|---|
signed | signed | Set by the Signing-Service after successful transfer to the external signing platform An audit entry is written to the object history. |
revised | revised | Set by the Signing-Service if one of the signers has revised the signing on the external signing plaform An audit entry is written to the object history. |
expired | expired | Set by the Signing-Service if the signing process was timed out on the external signing platform. An audit entry is written to the object history. |
canceled | canceled | Set by the Signing-Service when a user had cancelled the signing process or an DocuSign administrator has das voided the signing process An audit entry is written to the object history. |
error | Error | Set by the Signing-Service in any case of error. An audit entry is written to the object history. |
inprocess | in process | Set by the Signing-Service if the transfer to the signing platform was positiv. An audit entry is written to the object history. |
| Note |
|---|
Don’t change the technical value names. They are used by the client to show different colors for each label. |
The catalog ‘yuvsigtype’ offers the list of signature types. The values are:
Technical value name | Neutral label | Description |
|---|---|---|
simple | simple | This signature is not based on a certificate. |
advanced | advanced | This signature is based on a selfsigned certificate. |
qualified | qualified | This signature is based on a certified certificate. |
| Note |
|---|
Don’t change the technical value names. They are used by the Signing-Service to request the configured signing platform correctly. |
Changing the labels in the object details aspect ‘Signatures’
...