User guide v5.x

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

Server configuration

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

The available configuration parameters are:

Property	Type	Description
Language	Select	User interface language.
User	String	User ID for accessing OpenKM. user1
Password	String	The user’s password. 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 parameter changes, click the Accept button.

Signature configuration

The available configuration parameters are:

Property	Type	Description
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. 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, which 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 X position.
Expr. Y	String	Expression to set the Y position.
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. 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.

Note

In the Expr. X and Expr. Y input fields, you can enter 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 the Digital Signature Client to sign documents.

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

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

When the Digital Signature Client detects an existing document with the same name in OpenKM, it displays a popup asking you to choose one of two options: update the file or skip it.

The Digital Signature Client’s 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.

Note

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.

Alternative configuration of the main file folder

To configure a custom path for storing key application files such as:

• The log file (openkm.log)
• The configuration file (openkm.xml)
• Temporary files generated during runtime

This configuration is done using the okm.folder.path property, located in the app.properties file within the installation directory.

Example:

okm.folder.path=C:\\New_folder_path

Note

When to Use This Configuration:

This option is especially useful when there are issues using the default file paths, such as:

• Insufficient file system permissions

• Limited disk space or access restrictions in the default location

• Need to separate system files from configuration and data

• IT infrastructure policies or organization requirements

After making the changes, you must restart the app.

Log

In My Documents/OpenKM there is a log file called DigitalSignature.log that contains a complete log trace.