Difference between revisions of "Document Expiration"

From OpenKM Documentation
Jump to: navigation, search
(Created page with '== Document expiration == Document expiration is a notification alert system which can be used to advice users nearly document expiration and expired documents. Document expirat…')
 
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Document expiration ==
+
{{TOCright}} __TOC__
Document expiration is a notification alert system which can be used to advice users nearly document expiration and expired documents.
 
  
Document expiration is based in metadata and crontab features.
+
Document expiration is a notification system alert which can be used to advice users nearly document expiration and expired documents. Notification messages can be configured by administration parameters.
  
Document expiration metadata has tree states:
+
Document expiration is based in metadata, crontab features and report features.
* Initial notification
 
* Valid document
 
* Document expired
 
  
 +
=== Properties ===
 +
In configuration properties can be defined several parameters, for example, days to expiration alert or mail text message.
 +
 +
 +
[[File:Document_expiration_004.png|center]]
 +
 +
=== Metadata ===
 +
Document expiration has this metadata definition:
 +
 +
 +
[[File:Document_expiration_002.png|center]]
 +
 +
 +
Document expiration metadata state has tree values:
 +
 +
* Notification
 +
* Valid
 +
* Expired
 +
 +
Notification indicates document is pending send mail to users indicating new document with expiration dates.
 +
Valid indicates the document is valid.
 +
Expired indicates the document has been expired.
 +
 +
Each state can have sevaral notification groups. Each notification group can has one or more users. Which user groups configuration from administration can be defined any type of associations grouping users.
 +
 +
=== Crontab ===
 +
There are three crontab task:
 +
 +
 +
[[File:Document_expiration_001.png|center|1020px]]
 +
 +
 +
* Crontab '''InitialNotificationation.jar''' task is used to send notification to user groups linked with notify select multiple.
 +
* Crontab '''AlertExpirationNotificationation.jar''' task is used to send notification to user groups linked with notify nearly expiration select multiple.
 +
* Crontab '''ExpirationNotificationation.jar''' task task is used to send notification to user groups linked with notify expiration select multiple.
 +
 +
=== Reports ===
 +
There are three reports, valid, pending to expiration and expired document reports.
 +
 +
 +
'''Administration reports view'''
 +
[[File:Document_expiration_003.png|center|920px]]
 +
 +
 +
'''Front end reporting menus'''
 +
[[File:Document_expiration_005.png|center]]
 +
 +
 +
[[File:Document_expiration_006.png|center]]
  
 
[[Category: User Guide]]
 
[[Category: User Guide]]

Latest revision as of 16:00, 17 March 2013

Document expiration is a notification system alert which can be used to advice users nearly document expiration and expired documents. Notification messages can be configured by administration parameters.

Document expiration is based in metadata, crontab features and report features.

Properties

In configuration properties can be defined several parameters, for example, days to expiration alert or mail text message.


Document expiration 004.png

Metadata

Document expiration has this metadata definition:


Document expiration 002.png


Document expiration metadata state has tree values:

  • Notification
  • Valid
  • Expired

Notification indicates document is pending send mail to users indicating new document with expiration dates. Valid indicates the document is valid. Expired indicates the document has been expired.

Each state can have sevaral notification groups. Each notification group can has one or more users. Which user groups configuration from administration can be defined any type of associations grouping users.

Crontab

There are three crontab task:


Document expiration 001.png


  • Crontab InitialNotificationation.jar task is used to send notification to user groups linked with notify select multiple.
  • Crontab AlertExpirationNotificationation.jar task is used to send notification to user groups linked with notify nearly expiration select multiple.
  • Crontab ExpirationNotificationation.jar task task is used to send notification to user groups linked with notify expiration select multiple.

Reports

There are three reports, valid, pending to expiration and expired document reports.


Administration reports view

Document expiration 003.png


Front end reporting menus

Document expiration 005.png


Document expiration 006.png