⚠ This article is new and still under construction so content can be changed at any time!
...
Technical field name | Neutral label | Description |
|---|---|---|
yuvsigsubject | Subject | The reason why the signing was requested . This subject is part of the email sent to a signer. |
yuvsigtype | Signature type | 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. |
yuvsigrequester | Signing requester | The ID of the requesting user |
yuvsigreqdate | Date of request | The Date and time the request was activated |
yuvsigdate | Date | The date the signing process wass finished |
yuvsigstatus | Status | Status of the signing process. The shown values are those of the catalog ‘yuvsigstatus’ described below. |
yuvsigerror | Error message | Error message writte by the client or the Signing-Service in case of an error. |
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. In the beginning only ‘docusign’ will be reported here. |
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 |
yuvsigneremail | Email address | Email address of a signer that is used by Docusign for sending the email. |
yuvsignerphone | Phone number | This number can be used for two-factor authentication |
yuvsignextern | external | The boolean shows whether the signer is not a user of the yuuvis® RAD based system. |
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 |
Warning: 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 |
cancelled | cancelled | Set when a users had cancelled 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 | inprocess | Set by the Signing-Service if the transfer to the signing platform was positiv. |
Warning: 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 |
Warning: don’t change the technical value names. They are used by the Signing-Service to request the configured signing platform correctly.
The use case
A user is offered the object action ‘Request signature’ ('Signatur anfordern') if
...