Documentation for Digital Signature Tool

Table of Contents Page 2 of 29

Table of Contents

Table of Contents 2
Digital Signature Tool 3
License 3
Digital Signature Tool 3.x compatibility 3
Digital Signature Tool 2.x compatibility 3
Digital Signature Tool 1.x compatibility 4
Download 4
Requirements 6
User guide version 3.x 7
Configuration 7
Sign and upload documents 8
Sign documents within OpenKM 10
Log 11
User guide version 2.x 13
Configuration 13
Sign and upload documents 14
Sign documents within OpenKM 16
Log 17
User guide version 1.x 19
Configuration 19
Sign and upload documents 20
Log 22
Change log of version 3.x 23
Digital Signature Tool 3.x 23
v3.6 23
v3.5 23
v3.4 23
v3.3 23
v3.2 23
v3.1 23
Change log of version 2.x 24
Digital Signature Tool 2.x 24
v 2.4.2 24
v 2.4.1 24
v 2.4 24
v 2.3 24
v 2.2 24
v 2.1 24
v 2.0 25
Change log of version 1.x 26
Digital Signature Tool 1.x 26
v 1.1.0 26
Language pack 27
Spanish translation 27
Create a new language 28
= 28

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 3 of 29

Digital Signature Tool

Digital Signature Clients allows to sign - digital signature - documents to OpenKM.

License

 Digital Signature Tool for WINDOWS is licensed under the terms of the EULA - OpenKM End User
License Agreement as published by OpenKM Knowledge Management System S.L.

This program is distributed WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the EULA - OpenKM End User
License Agreement for more details.

Digital Signature Tool 3.x compatibility

Digital Signature tool version OpenKM Compatibility Status

Professional Community

3.6 Version 7.1.11 and upper. Not compatible. Active.

3.5 Version 7.1.9 and upper. Not compatible. Deprecated.

3.4 Version 7.1.8 and upper. Not compatible. Deprecated.

3.3 Version 7.1.4 and upper. Not compatible. Deprecated.

3.2 Version 7.1.4 and upper. Not compatible. Deprecated.

3.1 Version 7.1.3 and upper. Not compatible. Deprecated.

3.0 Version 7.1.2 and upper. Not compatible. Deprecated.

Digital Signature Tool 2.x compatibility

Digital Signature tool version OpenKM Compatibility Status

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 4 of 29

Professional Community

2.4.2 Version 6.4.45 and upper. Not compatible. Active.

2.4.1 Version 6.4.45 and upper. Not compatible. Deprecated.

2.4 Version 6.4.45 and upper. Not compatible. Deprecated.

2.3 Version 6.4.31 to 6.4.44. Not compatible. Deprecated.

2.2 Version 6.4.31 to 6.4.44. Not compatible. Deprecated.

2.1 Version 6.4.31 to 6.4.44. Not compatible. Deprecated.

2.0 Version 6.4.26 to 6.4.44. Not compatible. Deprecated.

Digital Signature Tool 1.x compatibility

Digital Signature tool version OpenKM Compatibility Status

Professional Community

1.1.0 Not compatible. Version 6.3.7 and upper. Active.

1.0.2 Version 6.4.25 to 6.4.26. Version 6.3.2 and upper. Deprecated.

1.0.1 Version 6.4.1 to 6.4.25. Version 6.3.2 and upper. Deprecated

Download

OpenKM Digital Signature tool 3.6 available at OpenKM Download center.

OpenKM Digital Signature tool 3.5 available at OpenKM Download center.

OpenKM Digital Signature tool 3.4 available at OpenKM Download center.

OpenKM Digital Signature tool 3.3 available at OpenKM Download center.

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 5 of 29

OpenKM Digital Signature tool 3.2 available at OpenKM Download center.

OpenKM Digital Signature tool 3.1 available at OpenKM Download center.

OpenKM Digital Signature tool 3.0 available at OpenKM Download center.

OpenKM Digital Signature tool 2.4.2 available at OpenKM Download center.

OpenKM Digital Signature tool 2.4 available at OpenKM Download center.

OpenKM Digital Signature tool 2.3 available at OpenKM Download center.

OpenKM Digital Signature tool 2.2 available at OpenKM Download center.

OpenKM Digital Signature tool 2.1 available at OpenKM Download center.

OpenKM Digital Signature tool 2.0 available at OpenKM Download center.

OpenKM Digital Signature tool 1.1.0

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 6 of 29

Requirements

Before running the application be sure you get installed Visual C++ Redistributable for Visual Studio.

Windows installer 4.5.

NET Framework 4.5.2 (x86 or x64).

Visual C++ Redistributable for Visual Studio 2012 (x86 or x64) ( Recommended ).

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 7 of 29

User guide version 3.x

Digital Signature Clients allows signing - electronic digital signature - documents to OpenKM.

Configuration

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

Configuration parameters available are:

User interface language.

User and password to connect.

The OpenKM server host.

To accept configuration parameters changes, click Accept button.

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 8 of 29

Sign and upload documents

To sign documents, select some files or folders with files into and drag to Digital Signature Client.

Will be shown a popup to choose the certificate what will be 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 Sign button.

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 9 of 29

When Digital Signature Client detects an existing document with the same name into OpenKM is prompt a popup to choose one

of these two options, updated the file or skip it.

Information about signing and uploading process is shown in Digital Signature Client main table.

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 10 of 29

Sign documents within OpenKM

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

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 11 of 29

Select the document and click Sign button.

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

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

Log

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

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 12 of 29

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 13 of 29

User guide version 2.x

Digital Signature Clients allows signing - electronic digital signature - documents to OpenKM.

Configuration

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

Configuration parameters available are:

User interface language.

User and password to connect.

The OpenKM server host.

To accept configuration parameters changes, click Accept button.

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 14 of 29

Sign and upload documents

To sign documents, select some files or folders with files into and drag to Digital Signature Client.

Will be shown a popup to choose the certificate what will be 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 Sign button.

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 15 of 29

When Digital Signature Client detects an existing document with the same name into OpenKM is prompt a popup to choose one

of these two options, updated the file or skip it.

Information about signing and uploading process is shown in Digital Signature Client main table.

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 16 of 29

Sign documents within OpenKM

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

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 17 of 29

Select the document and click Sign button.

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

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

Log

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

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 18 of 29

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 19 of 29

User guide version 1.x

Digital Signature Clients allows signing - electronic digital signature - documents to OpenKM.

Configuration

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

Configuration parameters available are:

OpenKM version which client connects to.

User interface language

User and password to connect

The OpenKM server host

To accept configuration parameters changes, click Accept button.

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 20 of 29

Sign and upload documents

To sign documents, select some files or folders with files into and drag to Digital Signature Client.

Will be shown a popup to choose the certificate what will be 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 Sign button.

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 21 of 29

When Digital Signature Client detects an existing document with the same name into OpenKM is prompt a popup to choose one

of these two options, updated the file or skip it.

Information about signing and uploading process is shown in Digital Signature Client main table.

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 22 of 29

Log

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

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 23 of 29

Change log of version 3.x

Digital Signature Tool 3.x

v3.6

Released 2020-04-17

Update OKMRest version 3.7.0 (compatible with OpenKM version 7.1.11 and upper)

v3.5

Released 2020-02-18

Update OKMRest version 3.6.0 (compatible with OpenKM version 7.1.9 and upper)

v3.4

Released 2019-11-25

Update OKMRest version 3.5.0.

v3.3

Released 2019-04-05

Bugs

Validation of the host URL for methods using System.Net.Http in the SDK to .net.

v3.2

Released 2019-02-11

Update OKMRest version 3.1:

Replacement of objects with the name "XXXList", by lists directly (List<T>).

v3.1

Released 2019-01-24

Allow select multiple in metadata fields.

Authentication by Token.

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 24 of 29

Change log of version 2.x

Digital Signature Tool 2.x

v 2.4.2

Released 2019-04-09

Bugs

Validation of the host URL for methods using System.Net.Http in the SDK to .net.

v 2.4.1

Released 2018-11-16

Updated tools:

Net Framework 4.5.2

Bug SDK:

Upload, download and update large files. Affected methods: createDocumetSimple, getContent and check-in.

v 2.4

Released 2018-09-14

Update:

OKMRest version 2.6.0

v 2.3

Released 2017-10-04

Explorer Form:

Add a signature icon to a new table column.

Bug:

Mark the document assigned when uploading or editing a document.

v 2.2

Released 2017-09-18

Server Configuration:

Improve the portion of how translations are loaded.

Main form:

Change of images and the main icon.

v 2.1

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 25 of 29

Released 2016-10-28

File Menu:

Add functionality to sign documents within OpenKM.

v 2.0

Released 2016-05-02.

Server Configuration:

Implements OKMRest (Remove field OpenKM Version)

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 26 of 29

Change log of version 1.x

Digital Signature Tool 1.x

v 1.1.0

Released 2018-11-15

Updated tools:

Net Framework 4.5.2

Use Rest Service

Bug SDK:

Upload, download and update large files. Affected methods: createDocumetSimple, getContent and check-in.

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 27 of 29

Language pack

The application can work with several languages, there are set the languages terms definitions.

 Sometimes translations are not fully completed and some terms are missing. The "en-GB" is used to identify
which are the missing terms and how many are.

When a term is missing in other languages the "en-GB" term is used in its place.

 en-GB translation cannot be removed.

Spanish translation

# Main menu
mainmenu.file=Fichero
mainmenu.configuration=Configuración
mainmenu.exit=Salir
mainmenu.help=Ayuda
mainmenu.about=Sobre OpenKM Cliente de firma electrónica

# Drag & drop table

table.file=Nombre
table.date=Hora
table.file.adding=Añadiendo
table.file.added=añadido
table.file.error=Error
table.file.skip=Omitido
table.file.update=Actualizado

# Button
button.accept=Aceptar
button.cancel=Cancelar
button.close=Cerrar
button.search=Buscar
button.refresh=Refrescar

# Application forms
form.main.title=OpenKM Cliente de firma electrónica
form.main.queue.status={0} documentos en la cola
form.certificate.title=Seleccionar certificado
form.certificate=Certificado

# Application messages
message.alert.message=En proceso, por favor espere...
message.change.certificate=Cambiar el certificado
message.change.certificate.question=¿ Desea cambiar el certificado seleccionado {0} ?
message.change.path=Cambiar la ruta de destino
message.change.path.question=¿ Desea cambiar la ruta de destino {0}?
message.change.existing.document= ¿ El documento {0} ya existe, desea actualizarlo ?
message.wait.until.finish=No puede añadir más fichero mientras el proceso de firma no haya termi
message.warning.title=Aviso
message.required=Obligatorio
message.required.field=Faltan llenar campos.

# Form configuration
form.configuration.name=Configuracion
form.configuration.language=Idioma

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 28 of 29

form.configuration.version=Versión de OpenKM
form.configuration.userName=Usuario
form.configuration.password=Clave
form.configuration.host=Host
form.configuration.error.msg=El campo {0} no puede ser vacio
form.configuration.button.accept=Aceptar
form.configuration.button.cancel=Cancelar
form.configuration.button.test=Prueba
form.configuration.test.ok=Conexión establecida con éxito
form.configuration.test.error=La prueba de conexión ha fallado!!!

# Form tree
form.tree.title=Navegador
form.tree.context.root=Taxonomía
form.tree.context.templates=Plantillas
form.tree.context.personal=Personal
form.tree.contextmenu.newfolder=Nueva carpeta
form.tree.contextmenu.renamefolder=Renombrar carpeta
form.tree.contextmenu.deletefolder=Eliminar carpeta
form.tree.button.accept=Firmar
form.tree.input.title=Gestión de carpetas
form.tree.button.refresh=Refrescar
form.tree.button.search=Buscar
form.tree.button.cancel=Cancelar
form.tree.msg.foldername.empty=Error, el nombre de la carpeta esta vacio

# Form search
form.search.title=Buscar
form.search.msg.min.char=Como mínimo debe escribir 3 carácteres
form.search.msg.empty=La consulta no ha devuelto ningún resultado
form.search.button.search=Buscar
form.search.button.cancel=Cancelar

# Explorer form
form.explorer.form.name=Editor de documentos
form.explorer.context.taxonomia=Taxonomía
form.explorer.context.plantilla=Templarios
form.explorer.context.usuario=Personal
form.explorer.button.edit=Editar
form.explorer.button.searchFolder=Buscar directorio
form.explorer.button.searchDoc=Buscar documento
form.explorer.button.exit=Salir
form.explorer.button.select=Firmar
form.explorer.dataGrid.column.name=Nombre
form.explorer.dataGrid.column.author=Autor
form.explorer.dataGrid.column.version=Versión
form.explorer.dataGrid.column.date=Fecha

Create a new language

Language translations are displayed with the following structure.

Key property = Translation value

To create a file with a new language, follow these steps:

1. Creates a new text document named OKMDigitalSignature-xxXX with the .properties extension, where xxXX refers

to the language identifier (ISO 639).

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.
Digital Signature Tool Page 29 of 29

For example in the case of the Spanish language, it would be esES ( in English is enGB ), that means the file must be

named OKMDigitalSignature-esES.properties.

 More information about ISO 639.

2. Copy into the file created the example of the top of the Spanish translation. Each line of text it has sections, the " Key

property" and "Translation value". The first one should not be changed and the second it refers to translated text and

is what you should change.

For example:

# Configuration form
form.configuration.name=Configuration
form.configuration.language=Language
form.configuration.version=OpenKM Version
...

Replace by:

# Configuration form
form.configuration.name=Configuración
form.configuration.language=Idioma
form.configuration.version=OpenKM Versión
...

3. Save the file into the installation folder, located in: "C:\Program Files (x86)\OpenKM\OpenKM Digital Signature

Client\" or the path you selected for installation.

Created in 2016 by OpenKM. OpenKM documentation is provided under OpenKM documentation license.