Configuring VidSigner
VidSigner is a third-party product which can be integrated into OpenKM to allow digital signature of a document.
Some configuration properties are needed:
Field / Property | Type | Description |
---|---|---|
vidsigner.user | String |
Name of the user given for the subscription to VidSigner. |
vidsigner.password | Password |
Password of the user. |
vidsigner.device.name | String |
Name of the device provided by VidSigner to which we want to send the document for signing. Don't set this if you want to sign the document on any device associated with the subscription. In this case, you can find the document on the device by enabling search mode in the configuration and searching by OpenKM user. |
vidsigner.notification.url | String |
The URL where the notification will be sent: http://openkm.your-domain.com/openkm/rest/vidSigner |
vidsigner.preproduction.mode | Boolean |
Set to true to test VidSigner in pre-production mode. |
vidsigner.sign.page | String | The page on which to show the signature image. If it is set to zero, the signature will be invisible. |
vidsigner.sign.posX | String | The X position in millimeters at which to place the signature image. |
vidsigner.sign.posY | String | The Y position in millimeters at which to place the signature image. |
vidsigner.sign.sizeX | String | The X size in millimeters of the signature image. |
vidsigner.sign.sizeY | String | The Y size in millimeters of the signature image. |
vidsigner.generate.log | Boolean | Set to true to generate a detailed log with all the information about the call to the VidSigner service. |
In addition, you have to create a user in OpenKM with the name and password provided by VidSigner for your subscription.
Also, you have to create two new Automations on the event Set metadata group (at post) and associate the action VidSigner Document To Sign with the first one and the action VidSigner Document Signed with the second.
Finally, you have to register this group of metadata:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 3.10//EN"
"http://www.openkm.com/dtd/property-groups-3.10.dtd">
<property-groups>
<property-group label="ViDSigner" name="okg:vidsigner">
<checkbox label="Pending to sign" name="okp:vidsigner.pending" value="true" />
<input label="Document GUI" name="okp:vidsigner.docgui" readonly="true" />
</property-group>
</property-groups>