Configurando la expiración de documentos

La expiración de documentos es un sistema de alerta por notificación que puede usarse para avisar a los usuarios sobre la expiración de documentos y los documentos ya expirados.

Configuración

Descargue los ficheros de expiración document_expiration_8.zip.

Registrar parámetros

Ejecute el SQL desde Administration > Tools > Database query.

-- NOTIFICATION PARAMETERS
DELETE FROM OKM_CONFIG WHERE CFG_KEY LIKE '%expiration.%';
INSERT INTO OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) VALUES ('expiration.date.pattern','string','dd-MM-yyyy HH:mm:ss');
INSERT INTO OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) VALUES ('expiration.expiration.alert.days','string','15');
INSERT INTO OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) VALUES ('expiration.notification.subject','string','New uploaded document with expiration');
INSERT INTO OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) VALUES ('expiration.notification.template','text','New document uploaded<br/>${docUrl}<br/>Expiration date:${date}<br/>');
INSERT INTO OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) VALUES ('expiration.alert.subject','string','Alert documents will expire');
INSERT INTO OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) VALUES ('expiration.alert.template','text','Document ${docUrl} will expire at ${date}<br/>');
INSERT INTO OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) VALUES ('expiration.expired.subject','string','Documents expired');
INSERT INTO OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) VALUES ('expiration.expired.template','text','Document ${docUrl} expired at ${date}<br/>');INSERT INTO OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) VALUES ('expiration.expirated.reminder.days', 'string', '15');INSERT INTO OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) VALUES ('expiration.expirated.reminder.subject', 'string', 'Reminder alert of documents expired');INSERT INTO OKM_CONFIG (CFG_KEY, CFG_TYPE, CFG_VALUE) VALUES ('expiration.expirated.reminder.template', 'text', 'Document ${docUrl} expired at ${date}<br/>');

Configurar parámetros

Field / Property	Type	Description
expiration.date.pattern	String	Establece el patrón de fecha. dd-MM-yyyy HH:mm:ss
expiration.notification.subject	String	Asunto del correo. Newly uploaded document with an expiration
expiration.notification.template	String	Cuerpo del correo. Newly uploaded document ${docUrl} Expiration date: ${date}
expiration.expiration.alert.days	Integer	Establece el número de días antes de la expiración en que se enviará el mensaje de alerta de expiración. 15 La expiración de documentos por defecto establece un único valor para todos los documentos. Esta es la lógica por defecto, pero puede implementar la suya propia.
expiration.alert.subject	String	Asunto del correo. Alert: documents will expire
expiration.alert.template	String	Cuerpo del correo. Document ${docUrl} will expire at ${date}
expiration.expired.reminder.days	Integer	Establece el número de días para enviar notificaciones de recordatorio de documentos que expiraron hace más de esos días. 15 La expiración de documentos por defecto establece un único valor para todos los documentos. Esta es la lógica por defecto, pero puede implementar la suya propia.
expiration.expired.reminder.subject	String	Asunto del correo. Reminder alert for expired documents
expiration.expired.reminder.template	String	Cuerpo del correo. Document ${docUrl} expired at ${date}

Registrar grupo de metadatos

<?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="Expiration" name="okg:expiration">
    <input label="Expiration date" name="okp:expiration.date" type="date">
      <validator type="req"/>
    </input>
    <select label="State" name="okp:expiration.state" type="simple">
      <option label="Notify" value="notify" selected="true"/>
      <option label="Valid" value="valid"/>
      <option label="Expired" value="expired"/>
      <validator type="req"/>
    </select>
    <select label="Notify" name="okp:expiration.group_notify" type="multiple" className="com.openkm.plugin.form.values.OptionSelectUserList">
      <validator type="req"/>
    </select>
    <select label="Notify expiration alert" name="okp:expiration.group_alert" type="multiple" className="com.openkm.plugin.form.values.OptionSelectUserList">
      <validator type="req"/>
    </select>
    <select label="Notify expirated" name="okp:expiration.group_expired" type="multiple" className="com.openkm.plugin.form.values.OptionSelectUserList">
      <validator type="req"/>
    </select>    <select label="Notify expirated reminder alert" name="okp:expiration.group_expired_reminder" type="multiple" className="com.openkm.plugin.form.values.OptionSelectUserList">      <validator type="req"/>    </select>
  </property-group>
</property-groups>

Tarea crontab

Copie los ficheros jar en la carpeta $TOMCAT_HOME/plugins.
Reinicie OpenKM (esto registrará las tareas crontab).

Task	Expression	Description
InitialNotification	0 /1 * * *	Tras añadir un grupo de metadatos al nodo, se envía el correo de “notificación inicial”. La tarea crontab se ejecuta cada minuto, buscando nodos nuevos con un grupo de metadatos.
AlertExpirationNotification	0 30 0 * * *	Envía una alerta diaria por correo para documentos que expirarán pronto.
ExpirationNotification	0 0 0 * * *	Envía una alerta diaria por correo para documentos que expiraron hoy. Esta tarea crontab debería ejecutarse antes que la tarea AlertExpirationNotification.
AlertExpiredReminderNotification	0 0 1 * * *	Envía una alerta diaria por correo para documentos que expiraron hace x días.

Registrar informes

Report	Description
ValidDocuments.jrxml	Lista todos los documentos válidos.
ExpiredDocuments.jrxml	Lista todos los documentos expirados.
NextExpirationDocuments.jrxml	Lista los documentos que expirarán pronto.