1. Home
  2. Digital Signature Tool
  3. User guide v4.x
  1.  

User guide v4.x

 The Digital Signature Client allows electronic digital signatures to documents in OpenKM.

Server configuration

Choose the File / Configuration menu option to show the configuration popup.

The available configuration parameters are:

PropertyTypeDescription

Language

Select

User interface language.

User

String

User id for accessing OpenKM.

user1

Password

String

The password of the user.

pass1

Host

String

OpenKM URL.

http://localhost:8080/openkm/

Use personal  token

Bool

The authentication will be done with the access token.
Personal token String

The personal access token

okmpat-Ky1t16O2Rwx4ttPmOK0R

To accept configuration parameters changes, click Accept button.

Signature configuration

The available configuration parameters are:

PropertyTypeDescription

Show document preview

Bool

When enabled, it allows you to preview documents.

Show signature

Bool

When activated, it makes the signature visible on the document.

And the following fields will be enabled:

Page

Select

This option determines which page will be signed, it can be the first, the last or dynamically that allows you to select the page and the place where the signature will be inserted in real-time.

Expr. X

String

Expression to set the position in X coordinates.

Expr. Y

String

Expression to set the position in Y coordinates.
Width String

Defines the width of the signature, for example:

200

Height

String

Defines the height of the signature, for example:

100

Add watermark to signature

Bool

When activated, it allows you to add an image as a watermark to your signature.

And the following fields will be enabled:

Select an image

String

 Select the image for the watermark.

Opacity

Float

The watermark opacity. The range of values allowed is from 0 to 1.

Scale

Float

The scale of the image. The allowed range of values is 0 to 1.

In Expr. X and Expr. Y input fields, you can put more than a simple number. Currently, the following macros are defined:

  • SIGN_WIDTH
  • SIGN_HEIGHT
  • PAGE_WIDTH
  • PAGE_HEIGHT
  • PAGE_CENTER
  • PAGE_MIDDLE

So to center a signature on the page, you can use:

Expr. X

PAGE_CENTER - SIGN_WIDTH / 2
Expr. Y

PAGE_MIDDLE - SIGN_HEIGHT / 2
 

Sign and upload documents

Select some files or folders with files and drag them to Digital Signature Client to sign documents.

Will be shown a popup to choose the certificate used to sign documents. Choose a certificate and click Accept button.

Finally, will be shown a navigator popup to select documents folder destination. Select a folder with write access ( for your user ) and click the Sign button.

When Digital Signature Client detects an existing document with the same name into OpenKM, it prompts a popup to choose one of these two options, update the file or skip it.

The Digital Signature Client main table shows information about the signing and uploading process.

Sign documents within OpenKM

Choose the File / Search menu option to show the search popup.

Select the document and click the Sign button.

If you want to change the signature certificate, click the Yes button.

Information about the signing process is shown in the Digital Signature Client table.

Log

In My Documents/OpenKM there's a file log called DigitalSignature.log with a complete log trace.

 

 

13/05/22