OpenKM 6.3 - CE

Hardware and software requirements

Installation

Setup

Troubleshooting

Administration guide

Configuration parameters

MIME types

Statistics

Scripting

Metadata

Manage users and roles

Profiles

Database query

Reports

Activity log

Workflow

Automation

Crontab

OMR templates

Thesaurus

Languages

Repository import

Repository export

Utilities

User guide

Migration guide

Development

Activity log

This application performs a complete audit trail. Audit trail is mainly a datastore service. It defines a data record structure that will be used for storing audit information.

The activity log is shown in a table structure.

			Filter
Date	User	Action	Item	Path	Parameteres

Filter options:

Field	Description	Required
From date	Start of date range.	true.
To date	End of date range.	true.
User	Specific user.	false.
Action	Any action.	false.

Auth actions

Field / Property	Description
LOGIN	User log in.
LOGOUT	User log out.
SESSION_EXPIRATION	User session expiration date
GRANT_USER	Adds user grant on a node.
REVOKE_USER	Removes user grant on a node.
GRANT_ROLE	Add role grant on a node.
REVOKE_ROLE	Removes user grant on a node.

Document actions

Field / Property	Description
CANCEL_DOCUMENT_CHECKOUT	Cancels document edition.
CHECKIN_DOCUMENT	Updates document.
CHECKOUT_DOCUMENT	Edits document.
CREATE_DOCUMENT	Creates a new document.
DELETE_DOCUMENT	Deletes a document.
GET_CHILDREN_DOCUMENTS	Retrieves a document list in a node. List of documents in a folder or record.
GET_DOCUMENT_CONTENT	Retrieves binary data.
GET_DOCUMENT_CONTENT_BY_VERSION	Retrieves binary data by document version.
GET_DOCUMENT_PROPERTIES	Retrieves all document properties. It does not include metadata. It has a direct relationship with the panel properties when a document is selected.
GET_DOCUMENT_VERSION_HISTORY	Retrieves a list of all versions of a document.
GET_PROPERTY_GROUP_PROPERTIES	Retrieves all metadata properties of a document.
LOCK_DOCUMENT	Locks a document.
MOVE_DOCUMENT	Moves a document.
PURGE_DOCUMENT	Purges a document. A purged document is definitively removed from the application.
RENAME_DOCUMENT	Renames a document.
SET_DOCUMENT_PROPERTIES	Sets document properties. For example when a user is subscribed to a document.
UNLOCK_DOCUMENT	Unlocks a document

Folder actions

Field / Property	Description
COPY_FOLDER	Copies a folder.
CREATE_FOLDER	Creates a folder.
DELETE_FOLDER	Deletes a folder.
GET_CHILDREN_FOLDERS	Retrieves a folder list in a node. List of folders in a folder or record.
GET_FOLDER_CONTENT_INFO	Counts nodes into a folder ( documents, folders, records and mails that are into ).
GET_FOLDER_PROPERTIES	Retrieves all folder properties. Does not include metadata. it has a direct relationship with panel properties when a folder is selected.
MOVE_FOLDER	Moves a folder.
PURGE_FOLDER	Purges a folder. A purged folder is definitively removed from application.
RENAME_FOLDER	Renames a folder.

Mail actions

Field / Property	Description
CREATE_MAIL	Creates a mail.
GET_MAIL_PROPERTIES	Retrieves all mail properties. Does not include metadata. It has a direct relationship with panel properties when a mail is selected.
DELETE_MAIL	Deletes a mail.
PURGE_MAIL	Purges a mail. A purged mail is definitively removed from application.
RENAME_MAIL	Renames a mail.
MOVE_MAIL	Moves a mail.
COPY_MAIL	Copies a mail.
GET_CHILDREN_MAILS	Retrieves mail list in some node. List of mail in a folder or record.
DOWNLOAD_MAIL	Downloads a mail

Repository actions

Field / Property	Description
PURGE_TRASH	Trash is purged. All related nodes are definitively removed from application.

Field / Property

Description

PURGE_TRASH

Trash is purged.

All related nodes are definitively removed from application.

Admin actions

These actions are only done by users with Administration grants.

Field / Property	Description
ADMIN_ACTIVITY_LOG	The administrator uses "activity log".
ADMIN_ACTIVE_SESSIONS	The administrator uses Logged users.
ADMIN_USER_CREATE	Creates a user.
ADMIN_USER_EDIT	Edits a user.
ADMIN_USER_DELETE	Deletes a user.
ADMIN_USER_ACTIVE	Enables or disables a user.
ADMIN_ROLE_CREATE	Creates a role.
ADMIN_ROLE_EDIT	Edits a role.
ADMIN_ROLE_DELETE	Deletes a role.
ADMIN_ROLE_ACTIVE	Enables or disables a role.
ADMIN_CHECK_EMAIL	Checks email poll. The application reads email accounts to import emails.
ADMIN_CONFIG_CREATE	Creates a configuration parameters.
ADMIN_CONFIG_EDIT	Edits a configuration parameter.
ADMIN_CONFIG_DELETE	Deletes a configuration parameter.
ADMIN_CRONTAB_CREATE	Creates a crontab task.
ADMIN_CRONTAB_EDIT	Edits a contab task.
ADMIN_CRONTAB_DELETE	Deletes a crontab task.
ADMIN_CRONTAB_EXECUTE	Executes a crontab task.
ADMIN_DATABASE_QUERY	Executes a database query.
ADMIN_DATABASE_UPDATE	Executes an update database query.
ADMIN_LANGUAGE_CREATE	Creates a new laguage.
ADMIN_LANGUAGE_EDIT	Edits a language.
ADMIN_LANGUAGE_DELETE	Deletes a language.
ADMIN_LANGUAGE_IMPORT	Imports a language.
ADMIN_LOGCAT_LIST	The administrator user logcat tool.
ADMIN_LOGCAT_VIEW	The administrator user logcat tool.
ADMIN_LOGGED_USERS	The administrator uses Logged users.
ADMIN_MAIL_ACCOUNT_CREATE	Creates a mail account.
ADMIN_MAIL_ACCOUNT_EDIT	Edits a mail account.
ADMIN_MAIL_ACCOUNT_DELETE	Deletes a mail account.
ADMIN_MAIL_ACCOUNT_CHECK	Checks a mail account.
ADMIN_MAIL_FILTER_CREATE	Creates a mail account filter.
ADMIN_MAIL_FILTER_EDIT	Edits a mail account filter.
ADMIN_MAIL_FILTER_DELETE	Deletes a mail account filter.
ADMIN_MAIL_FILTER_RULE_CREATE	Creates a mail account rule.
ADMIN_MAIL_FILTER_RULE_EDIT	Edits a mail account rule.
ADMIN_MAIL_FILTER_RULE_DELETE	Delete a mail account rule.
ADMIN_MIME_TYPE_CREATE	Creates a new MIME type
ADMIN_MIME_TYPE_EDIT	Edits MIME type.
ADMIN_MIME_TYPE_DELETE	Deletes MIME type.
ADMIN_USER_PROFILE_CREATE	Creates a profile.
ADMIN_USER_PROFILE_EDIT	Edits a profile.
ADMIN_USER_PROFILE_DELETE	Deletes a profile.
ADMIN_PROPERTY_GROUP_REGISTER	Registers a metadata group.
ADMIN_PROPERTY_GROUP_LIST	Lists metadata groups.
ADMIN_REPORT_CREATE	Creates a report.
ADMIN_REPORT_EDIT	Edits a report.
ADMIN_REPORT_DELETE	Deletes a report.
ADMIN_REPORT_EXECUTE	Executes a report.
ADMIN_REPOSITORY_SEARCH	Performes a Lucene search.
ADMIN_REPOSITORY_REINDEX	Reindexes Lucene repository.
ADMIN_REPOSITORY_UNLOCK	Unlocks a node from a repository view.
ADMIN_REPOSITORY_CHECKIN	Updates a node from a repository view.
ADMIN_REPOSITORY_EDIT	Edits a node from a repository view.
ADMIN_REPOSITORY_SAVE	Modify a node from a repository view.
ADMIN_REPOSITORY_LIST	Refreshes folder contents from repository view.
ADMIN_REPOSITORY_REMOVE_CONTENT	Purges folder lo dentro
ADMIN_REPOSITORY_REMOVE_CURRENT	Deletes all folder todo
ADMIN_WORKFLOW_REGISTER	Registers a workflow.
ADMIN_PROCESS_DEFINITION_DELETE	Deletes a workflow process definition.
ADMIN_PROCESS_INSTANCE_DELETE	Deletes a workflow process instance.
ADMIN_PROCESS_INSTANCE_END	Workflow process instance finished.
ADMIN_PROCESS_INSTANCE_RESUME	Workflow process instance resumed.
ADMIN_PROCESS_INSTANCE_SUSPEND	Workflow process instance suspended.
ADMIN_PROCESS_INSTANCE_ADD_COMMENT	Adds comment on a workflow process instance.
ADMIN_PROCESS_INSTANCE_VARIABLE_DELETE	Deletes variable on a workflow process instance.
ADMIN_PROCESS_INSTANCE_VARIABLE_ADD	Adds variable on a workflow process instance.
ADMIN_TASK_INSTANCE_SET_ACTOR	Sets actor on a a workflow task instance.
ADMIN_TASK_INSTANCE_START	Workflow task instance started.
ADMIN_TASK_INSTANCE_END	Workflow task instance ended.
ADMIN_TASK_INSTANCE_SUSPEND	Workflow task instance suspeded.
ADMIN_TASK_INSTANCE_ADD_COMMENT	Adds comment on a workflow task instance.
ADMIN_TASK_INSTANCE_VARIABLE_DELETE	Deletes variable on a workflow task instance.
ADMIN_TASK_INSTANCE_VARIABLE_ADD	Adds variable on a workflow task instance.
ADMIN_TASK_INSTANCE_RESUME	Resumes a workflow task instance.
ADMIN_TOKEN_SIGNAL	Workflow task signal sent from administration view.
ADMIN_TWITTER_ACCOUNT_CREATE	Creates a twitter account.
ADMIN_TWITTER_ACCOUNT_EDIT	Edits a twitter account.
ADMIN_TWITTER_ACCOUNT_DELETE	Deletes a twitter account.
ADMIN_USER_CONFIG_EDIT	Changes a user profile.
ADMIN_SCRIPTING	Executes scripting.

Misc actions

Field / Property	Description
MISC_OPENKM_START	Starts application.
MISC_OPENKM_STOP	Stops application.
MISC_STATUS	Application check. Several internal checks to ensure application is alive: Database connection. Repository connection.
MISC_TEXT_EXTRACTION_FAILURE	Text extraction failure.

Table of contents [ Hide Show ]

Auth actions
Document actions
Folder actions
Mail actions
Repository actions
Admin actions
Misc actions

Activity log

This application performs a complete audit trail. Audit trail is mainly a datastore service. It defines a data record structure that will be used for storing audit information.

The activity log is shown in a table structure.

			Filter
Date	User	Action	Item	Path	Parameteres

Filter options:

Field	Description	Required
From date	Start of date range.	true.
To date	End of date range.	true.
User	Specific user.	false.
Action	Any action.	false.

Auth actions

Field / Property	Description
LOGIN	User log in.
LOGOUT	User log out.
SESSION_EXPIRATION	User session expiration date
GRANT_USER	Adds user grant on a node.
REVOKE_USER	Removes user grant on a node.
GRANT_ROLE	Add role grant on a node.
REVOKE_ROLE	Removes user grant on a node.

Document actions

Field / Property	Description
CANCEL_DOCUMENT_CHECKOUT	Cancels document edition.
CHECKIN_DOCUMENT	Updates document.
CHECKOUT_DOCUMENT	Edits document.
CREATE_DOCUMENT	Creates a new document.
DELETE_DOCUMENT	Deletes a document.
GET_CHILDREN_DOCUMENTS	Retrieves a document list in a node. List of documents in a folder or record.
GET_DOCUMENT_CONTENT	Retrieves binary data.
GET_DOCUMENT_CONTENT_BY_VERSION	Retrieves binary data by document version.
GET_DOCUMENT_PROPERTIES	Retrieves all document properties. It does not include metadata. It has a direct relationship with the panel properties when a document is selected.
GET_DOCUMENT_VERSION_HISTORY	Retrieves a list of all versions of a document.
GET_PROPERTY_GROUP_PROPERTIES	Retrieves all metadata properties of a document.
LOCK_DOCUMENT	Locks a document.
MOVE_DOCUMENT	Moves a document.
PURGE_DOCUMENT	Purges a document. A purged document is definitively removed from the application.
RENAME_DOCUMENT	Renames a document.
SET_DOCUMENT_PROPERTIES	Sets document properties. For example when a user is subscribed to a document.
UNLOCK_DOCUMENT	Unlocks a document

Folder actions

Field / Property	Description
COPY_FOLDER	Copies a folder.
CREATE_FOLDER	Creates a folder.
DELETE_FOLDER	Deletes a folder.
GET_CHILDREN_FOLDERS	Retrieves a folder list in a node. List of folders in a folder or record.
GET_FOLDER_CONTENT_INFO	Counts nodes into a folder ( documents, folders, records and mails that are into ).
GET_FOLDER_PROPERTIES	Retrieves all folder properties. Does not include metadata. it has a direct relationship with panel properties when a folder is selected.
MOVE_FOLDER	Moves a folder.
PURGE_FOLDER	Purges a folder. A purged folder is definitively removed from application.
RENAME_FOLDER	Renames a folder.

Mail actions

Field / Property	Description
CREATE_MAIL	Creates a mail.
GET_MAIL_PROPERTIES	Retrieves all mail properties. Does not include metadata. It has a direct relationship with panel properties when a mail is selected.
DELETE_MAIL	Deletes a mail.
PURGE_MAIL	Purges a mail. A purged mail is definitively removed from application.
RENAME_MAIL	Renames a mail.
MOVE_MAIL	Moves a mail.
COPY_MAIL	Copies a mail.
GET_CHILDREN_MAILS	Retrieves mail list in some node. List of mail in a folder or record.
DOWNLOAD_MAIL	Downloads a mail

Repository actions

Field / Property	Description
PURGE_TRASH	Trash is purged. All related nodes are definitively removed from application.

Field / Property

Description

PURGE_TRASH

Trash is purged.

All related nodes are definitively removed from application.

Admin actions

These actions are only done by users with Administration grants.

Field / Property	Description
ADMIN_ACTIVITY_LOG	The administrator uses "activity log".
ADMIN_ACTIVE_SESSIONS	The administrator uses Logged users.
ADMIN_USER_CREATE	Creates a user.
ADMIN_USER_EDIT	Edits a user.
ADMIN_USER_DELETE	Deletes a user.
ADMIN_USER_ACTIVE	Enables or disables a user.
ADMIN_ROLE_CREATE	Creates a role.
ADMIN_ROLE_EDIT	Edits a role.
ADMIN_ROLE_DELETE	Deletes a role.
ADMIN_ROLE_ACTIVE	Enables or disables a role.
ADMIN_CHECK_EMAIL	Checks email poll. The application reads email accounts to import emails.
ADMIN_CONFIG_CREATE	Creates a configuration parameters.
ADMIN_CONFIG_EDIT	Edits a configuration parameter.
ADMIN_CONFIG_DELETE	Deletes a configuration parameter.
ADMIN_CRONTAB_CREATE	Creates a crontab task.
ADMIN_CRONTAB_EDIT	Edits a contab task.
ADMIN_CRONTAB_DELETE	Deletes a crontab task.
ADMIN_CRONTAB_EXECUTE	Executes a crontab task.
ADMIN_DATABASE_QUERY	Executes a database query.
ADMIN_DATABASE_UPDATE	Executes an update database query.
ADMIN_LANGUAGE_CREATE	Creates a new laguage.
ADMIN_LANGUAGE_EDIT	Edits a language.
ADMIN_LANGUAGE_DELETE	Deletes a language.
ADMIN_LANGUAGE_IMPORT	Imports a language.
ADMIN_LOGCAT_LIST	The administrator user logcat tool.
ADMIN_LOGCAT_VIEW	The administrator user logcat tool.
ADMIN_LOGGED_USERS	The administrator uses Logged users.
ADMIN_MAIL_ACCOUNT_CREATE	Creates a mail account.
ADMIN_MAIL_ACCOUNT_EDIT	Edits a mail account.
ADMIN_MAIL_ACCOUNT_DELETE	Deletes a mail account.
ADMIN_MAIL_ACCOUNT_CHECK	Checks a mail account.
ADMIN_MAIL_FILTER_CREATE	Creates a mail account filter.
ADMIN_MAIL_FILTER_EDIT	Edits a mail account filter.
ADMIN_MAIL_FILTER_DELETE	Deletes a mail account filter.
ADMIN_MAIL_FILTER_RULE_CREATE	Creates a mail account rule.
ADMIN_MAIL_FILTER_RULE_EDIT	Edits a mail account rule.
ADMIN_MAIL_FILTER_RULE_DELETE	Delete a mail account rule.
ADMIN_MIME_TYPE_CREATE	Creates a new MIME type
ADMIN_MIME_TYPE_EDIT	Edits MIME type.
ADMIN_MIME_TYPE_DELETE	Deletes MIME type.
ADMIN_USER_PROFILE_CREATE	Creates a profile.
ADMIN_USER_PROFILE_EDIT	Edits a profile.
ADMIN_USER_PROFILE_DELETE	Deletes a profile.
ADMIN_PROPERTY_GROUP_REGISTER	Registers a metadata group.
ADMIN_PROPERTY_GROUP_LIST	Lists metadata groups.
ADMIN_REPORT_CREATE	Creates a report.
ADMIN_REPORT_EDIT	Edits a report.
ADMIN_REPORT_DELETE	Deletes a report.
ADMIN_REPORT_EXECUTE	Executes a report.
ADMIN_REPOSITORY_SEARCH	Performes a Lucene search.
ADMIN_REPOSITORY_REINDEX	Reindexes Lucene repository.
ADMIN_REPOSITORY_UNLOCK	Unlocks a node from a repository view.
ADMIN_REPOSITORY_CHECKIN	Updates a node from a repository view.
ADMIN_REPOSITORY_EDIT	Edits a node from a repository view.
ADMIN_REPOSITORY_SAVE	Modify a node from a repository view.
ADMIN_REPOSITORY_LIST	Refreshes folder contents from repository view.
ADMIN_REPOSITORY_REMOVE_CONTENT	Purges folder lo dentro
ADMIN_REPOSITORY_REMOVE_CURRENT	Deletes all folder todo
ADMIN_WORKFLOW_REGISTER	Registers a workflow.
ADMIN_PROCESS_DEFINITION_DELETE	Deletes a workflow process definition.
ADMIN_PROCESS_INSTANCE_DELETE	Deletes a workflow process instance.
ADMIN_PROCESS_INSTANCE_END	Workflow process instance finished.
ADMIN_PROCESS_INSTANCE_RESUME	Workflow process instance resumed.
ADMIN_PROCESS_INSTANCE_SUSPEND	Workflow process instance suspended.
ADMIN_PROCESS_INSTANCE_ADD_COMMENT	Adds comment on a workflow process instance.
ADMIN_PROCESS_INSTANCE_VARIABLE_DELETE	Deletes variable on a workflow process instance.
ADMIN_PROCESS_INSTANCE_VARIABLE_ADD	Adds variable on a workflow process instance.
ADMIN_TASK_INSTANCE_SET_ACTOR	Sets actor on a a workflow task instance.
ADMIN_TASK_INSTANCE_START	Workflow task instance started.
ADMIN_TASK_INSTANCE_END	Workflow task instance ended.
ADMIN_TASK_INSTANCE_SUSPEND	Workflow task instance suspeded.
ADMIN_TASK_INSTANCE_ADD_COMMENT	Adds comment on a workflow task instance.
ADMIN_TASK_INSTANCE_VARIABLE_DELETE	Deletes variable on a workflow task instance.
ADMIN_TASK_INSTANCE_VARIABLE_ADD	Adds variable on a workflow task instance.
ADMIN_TASK_INSTANCE_RESUME	Resumes a workflow task instance.
ADMIN_TOKEN_SIGNAL	Workflow task signal sent from administration view.
ADMIN_TWITTER_ACCOUNT_CREATE	Creates a twitter account.
ADMIN_TWITTER_ACCOUNT_EDIT	Edits a twitter account.
ADMIN_TWITTER_ACCOUNT_DELETE	Deletes a twitter account.
ADMIN_USER_CONFIG_EDIT	Changes a user profile.
ADMIN_SCRIPTING	Executes scripting.

Misc actions

Field / Property	Description
MISC_OPENKM_START	Starts application.
MISC_OPENKM_STOP	Stops application.
MISC_STATUS	Application check. Several internal checks to ensure application is alive: Database connection. Repository connection.
MISC_TEXT_EXTRACTION_FAILURE	Text extraction failure.