Instalación

Pasos para instalar y configurar la aplicación de intercambio electrónico de documentos en OpenKM v7.1:

Precaución

En caso de que quiera instalar EDX en un servidor distinto de OpenKM, necesita crear la base de datos:

CREATE USER 'edx'@'%' IDENTIFIED BY 'openkm';
CREATE DATABASE edx DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_bin;
GRANT ALL ON edx.* TO 'edx'@'%' WITH GRANT OPTION;

En caso contrario, debe usar la misma base de datos que usa OpenKM.

• Detenga Tomcat
• Descargue la aplicación desde el centro de descargas de OpenKM
• Coloque el fichero edx.war en $TOMCAT_HOME/webapps
• Coloque el fichero edx-plugins.jar en $TOMCAT_HOME/plugins
• Esta aplicación necesita compartir la base de datos con OpenKM, así que no necesita crear una nueva
• Cree el fichero de configuración $TOMCAT_HOME/edx.properties (esta es una configuración de ejemplo que debe adaptarse al entorno de destino)

# Database
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/okmdb?useUnicode=true&characterEncoding=UTF8&serverTimezone=CET
spring.datasource.username=openkm
spring.datasource.password=openkm

# JPA stuff
spring.jpa.hibernate.ddl-auto=create
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL57InnoDBDialect

# OpenKM
openkm.url=http://localhost:8080/openkm
openkm.url.preview=http://localhost:8080/openkm

# OpenKM admin user
admin.user=okmAdmin
admin.password=admin

# OpenKM edx user
edx.user=edxUsr
edx.password=s3cr3t0

# Available languages
languages=es-ES#Español,en-GB#English
default.language=en-GB

# Logging config
logging.level.com.openkm.edx=INFO

Nota

EDX se ha probado con estas bases de datos:

• MySQL
• MariaDB
• Oracle 12c
• PostgreSQL 9
• SQL Server 2012

Vea más abajo las configuraciones para otras bases de datos.

La familia de propiedades de configuración openkm.url también es importante porque EDX usará este usuario para interactuar con su instancia de OpenKM. Por tanto, configure un usuario con permisos suficientes. Este usuario ya debe existir en OpenKM.

• Inicie Tomcat
• Inicie sesión en OpenKM
• Vaya a Administration > Users y cree el usuario definido en la propiedad de configuración edx.user. Este usuario se usará para conectarse a la instancia de OpenKM, así que compruebe bien el nombre de usuario y la contraseña, y asegúrese de que este usuario tiene acceso a la carpeta base de EDX (la definida en la propiedad de configuración edx.base.uuid).
• Vaya a Administration > Utilities > Database query y ejecute estas sentencias SQL para crear algunas propiedades de configuración necesarias:

insert into OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) values ('edx.base.uuid', 'string', '');
insert into OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) values ('edx.inbox.name', 'string', 'Inbox');
insert into OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) values ('edx.public.name', 'string', 'Public');
insert into OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) values ('edx.template.folder.inbox.uuid', 'string', '');
insert into OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) values ('edx.template.folder.public.uuid', 'string', '');
insert into OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) values ('edx.email.body', 'string', '');
insert into OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) values ('edx.email.subject', 'string', '');insert into OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) values ('edx.url', 'string', 'http://localhost:8080/edx');

• Establezca las propiedades de configuración según su uso:
  • edx.base.uuid: El UUID de la carpeta base donde se crearán las demás carpetas.
  • edx.inbox.name: El nombre de la carpeta usada para almacenar los documentos entrantes. Solo se usa si la propiedad edx.template.folder.inbox.uuid no existe o está vacía.
  • edx.public.name: El nombre de la carpeta usada para almacenar documentos públicos. Solo se usa si la propiedad edx.template.folder.public.uuid no existe o está vacía.
  • edx.template.folder.inbox.uuid: UUID de la plantilla de carpeta que crea la estructura de la carpeta de entrada.
  • edx.template.folder.public.uuid: UUID de la plantilla de carpeta que crea la estructura de la carpeta pública.
  • edx.email.body: Cuerpo del correo de notificación.
  • edx.email.subject: Asunto del correo de notificación.
  • edx.url: Esta es la URL en la que EDX será accesible desde OpenKM.

Precaución

La propiedad edx.url normalmente debería ser “http://localhost:8080/edx” a menos que la aplicación esté instalada en un servidor distinto del servidor de OpenKM. Esta URL será usada por OpenKM para comunicarse con EDX al ejecutar automatizaciones y tareas de cron.

Nota

Una configuración mínima de ejemplo sería:

• edx.base.uuid: 688d3712-c12a-4140-be06-aefd098fe705 (use un UUID de carpeta existente)
• edx.inbox.name: Inbox
• edx.public.name: Public
• edx.url: http://localhost:8080/edx

• Cree estas automatizaciones:

| Name | Event | At | **Validation** | **Action** |

| --- | --- | --- | --- | --- |
| EDX Doc Create | Document create | Post | PathContains = /okm:root | EDX Catalog |
| EDX Doc Move Pre | Document move | Pre | PathContains = /okm:root | EDX Catalog |
| EDX Doc Move Post | Document move | Post | PathContains = /okm:root | EDX Catalog |
| EDX Doc Delete | Document delete | Pre | PathContains = /okm:root | EDX Catalog |
| EDX Doc Update | Document update | Post | PathContains = /okm:root | EDX Catalog |

Nota

En caso de problemas, revise $TOMCAT_HOME/logs/edx.log y tenga en cuenta que se puede obtener un registro más detallado usando la configuración en edx.properties:

# Logging config
logging.level.com.openkm.edx=DEBUG

No olvide reiniciar el servicio para aplicar estos cambios.

• Una vez configurada la aplicación, puede iniciar sesión en http://server.ip:8080/edx con el administrador por defecto:
  • User: admin
  • Password: admin
• ¡Recuerde cambiar esta contraseña por defecto!

Configuración para otras bases de datos

Oracle 12c

# Database
spring.datasource.driver-class-name=oracle.jdbc.OracleDriver
spring.datasource.url=jdbc:oracle:thin:@oracle:1521:XE
spring.datasource.username=openkm
spring.datasource.password=openkm

# JPA stuff
spring.jpa.hibernate.ddl-auto=create
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.Oracle12cDialect

# OpenKM
openkm.url=http://localhost:8080/openkm
openkm.url.preview=http://localhost:8080/openkm

# OpenKM admin user
admin.user=okmAdmin
admin.password=admin

# OpenKM edx user
edx.user=edxUsr
edx.password=s3cr3t0

# Available languages
languages=es-ES#Español,en-GB#English
default.language=en-GB

# Logging config
logging.level.com.openkm.edx=INFO

PostgreSQL 9

# Database
spring.datasource.driver-class-name=org.postgresql.Driver
spring.datasource.url=jdbc:postgresql://postgres:5432/okmdb
spring.datasource.username=openkm
spring.datasource.password=openkm

# JPA stuff
spring.jpa.hibernate.ddl-auto=create
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQL9Dialect

# OpenKM
openkm.url=http://localhost:8080/openkm
openkm.url.preview=http://localhost:8080/openkm

# OpenKM admin user
admin.user=okmAdmin
admin.password=admin

# OpenKM edx user
edx.user=edxUsr
edx.password=s3cr3t0

# Available languages
languages=es-ES#Español,en-GB#English
default.language=en-GB

SQL Server 2012

# Database
spring.datasource.driver-class-name=com.microsoft.sqlserver.jdbc.SQLServerDriver
spring.datasource.url=jdbc:sqlserver://sqlserver:1433;databaseName=okmdb
spring.datasource.username=openkm
spring.datasource.password=openkm

# JPA stuff
spring.jpa.hibernate.ddl-auto=create
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.SQLServer2012Dialect

# OpenKM
openkm.url=http://localhost:8080/openkm
openkm.url.preview=http://localhost:8080/openkm

# OpenKM admin user
admin.user=okmAdmin
admin.password=admin

# OpenKM edx user
edx.user=edxUsr
edx.password=s3cr3t0

# Available languages
languages=es-ES#Español,en-GB#English
default.language=en-GB