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

Reports pack

Activity log

Workflow

Automation

Crontab

OMR templates

Thesaurus

Languages

Repository import

Repository export

Utilities

User guide

Migration guide

Development

Reports pack

Most of these reports are based on Activity log events audit trail.

For more information Activity log.

Template reports

Name	Use Activity log	Require parameters	Description
JavaReportPattern.jrxml	No.	No.	Template pattern that use Java to retrieve data.
SQLReportPattern.jrxml	No.	No.	Template pattern that use SQL to retrieve data.

Authentication

Name	Use Activity log	Require parameters	Description
UsersLogin.rep	Yes.	Yes.	Users login, filtered by date range.
UsersLogout.rep	Yes.	Yes.	Users logout, filtered by date range.
UsersSessionExpiration.rep	Yes.	Yes.	Users that session expired, filtered by date range.

Documents

Name	Use Activity log	Require parameters	Description
DocumentCanceledCheckout.rep	Yes.	Yes.	Lists documents that cancelled the edition, filtered by date range.
DocumentCheckin.rep	Yes.	Yes.	List documents updated, filtered by date range.
DocumentCheckout.rep	Yes.	Yes.	List documents on edition, filtered by date range.
DocumentCreate.rep	Yes.	Yes.	List documents created, filtered by date range.
DocumentDelete.rep	Yes.	Yes.	List documents deleted, filtered by date range.
DocumentGetChildren.rep	Yes.	Yes.	Show when the users listed the documents into some folder or record. Results are filtered by date range. To list documents into a folder is called internally method named "getChildren".
DocumentContent.rep	Yes.	Yes.	Show when the users retrieved the content of a document. Results are filtered by date range. For example, when a user download or preview a document ( among other actions ) is retrieving the content of the document.
DocumentContentByVersion.rep	Yes.	Yes.	Show when the users retrieved a specific version of the content of a document. Results are filtered by date range.
DocumentGetProperties.rep	Yes.	Yes.	Show when user retrieved the properties of a document. Results are filtered by date range. For example, when document is selected, is called internally a method named "getProperties" to fill the contents of properties tab in user interface.
DocumentGetVersionHistory.rep	Yes.	Yes.	Shown when the users retrieved the list of all versions of a document. Results are filtered by date range.
DocumentGetPropertyGroupProperties.rep	Yes.	Yes.	List when has been retrieved the fields of a metadata group. For example, when a metadata group is shown in users interface, is called internally a method named "getPropertyGroupProperties" to fill the metadata group values.
DocumentLock.rep	Yes.	Yes.	List documents updated, filtered by date range.
DocumentMove.rep	Yes.	Yes.	List documents moved, filtered by date range.
DocumentPurge.rep	Yes.	Yes.	List documents purged, filtered by date range. When a document is purged it will definitively disappear from application repository.
DocumentRenamed.rep	Yes.	Yes.	List documents renamed, filtered by date range.
DocumentUnlock.rep	Yes.	Yes.	List documents unlocked, filtered by date range.
DocumentsAccessibleByUserOrdered.jrxml	No.	No.	Retrieve a list of available documents - security filtered - ordered by folder name. Optimized for csv format. Not recommended for large repositories, can take a lot of time.
DuplicatedFiles.jrxml	No.	No.	List of duplicated files into application repository, based on document checksum.
ListDocumentsWithChecksum.rep	No.	Si.	List of all documents into some folders and subfolders with checksum value.

Folders

Name	Use Activity log	Require parameters	Description
FolderCopy.rep	Yes.	Yes.	List folders copyed, filtered by date range.
FolderCreate.rep	Yes.	Yes.	List folders created, filtered by date range.
FolderDelete.rep	Yes.	Yes.	List folders deleted, filtered by date range.
FolderGetChilden.rep	Yes.	Yes.	Show when the users listed the folders into some folder or record. Results are filtered by date range. To list folders into a folder is called internally method named "getChildren".
FolderGetContentInfo.rep	Yes.	Yes.	Shown when the internal method named "getContentInfo" has been executed. To do some operations is needed to calculate folder deep, for example before starting folder ZIP download. There's an internal method named "getCotentInfo" that does it.
FolderGetProperties.rep	Yes.	Yes.	Show when user retrieved the properties of a folder. Results are filtered by date range. For example, when folder is selected, is called internally a method named "getProperties" to fill the contents of properties tab in user interface.
FolderMove.rep	Yes.	Yes.	List folders moved, filtered by date range.
FolderPurge.rep	Yes.	Yes.	List folders purged, filtered by date range. When a folder is purged it will definitively disappear from application repository.
FolderRename.rep	Yes.	Yes.	List folders renamed, filtered by date range.

Mails

Name	Use Activity log	Require parameters	Description
MailCreate.rep	Yes.	Yes.	List mails created, filtered by date range.
MailGetProperties.rep	Yes.	Yes.	Shown when a user retrieved the properties of a mail. Results are filtered by date range. For example, when mail is selected, is called internally a method named "getProperties" to fill the contents of properties tab in user interface.
MailPurge.rep	Yes.	Yes.	List mails purged, filtered by date range. When a mail is purged it will definitively disappear from application repository.
MailRename.rep	Yes.	Yes.	List mails renamed, filtered by date range.
MailMove.rep	Yes.	Yes.	List mails moved, filtered by date range.
MailCopy.rep	Yes.	Yes.	List mails copyed, filtered by date range.
MailGetChilden.rep	Yes.	Yes.	Show when the users listed the mails into some folder or record. Results are filtered by date range. To list mails into a folder is called internally method named "getChildren".

Others

Name	Use Activity log	Require parameters	Description
WorkflowWorkload.jrxml	No.	No.	Each workflow task with the time spent on it.
RegisteredUsers.jrxml	No.	No.	Registered users.

Table of contents [ Hide Show ]

Template reports
Authentication
Documents
Folders
Mails
Others

Reports pack

Most of these reports are based on Activity log events audit trail.

For more information Activity log.

Template reports

Name	Use Activity log	Require parameters	Description
JavaReportPattern.jrxml	No.	No.	Template pattern that use Java to retrieve data.
SQLReportPattern.jrxml	No.	No.	Template pattern that use SQL to retrieve data.

Authentication

Name	Use Activity log	Require parameters	Description
UsersLogin.rep	Yes.	Yes.	Users login, filtered by date range.
UsersLogout.rep	Yes.	Yes.	Users logout, filtered by date range.
UsersSessionExpiration.rep	Yes.	Yes.	Users that session expired, filtered by date range.

Documents

Name	Use Activity log	Require parameters	Description
DocumentCanceledCheckout.rep	Yes.	Yes.	Lists documents that cancelled the edition, filtered by date range.
DocumentCheckin.rep	Yes.	Yes.	List documents updated, filtered by date range.
DocumentCheckout.rep	Yes.	Yes.	List documents on edition, filtered by date range.
DocumentCreate.rep	Yes.	Yes.	List documents created, filtered by date range.
DocumentDelete.rep	Yes.	Yes.	List documents deleted, filtered by date range.
DocumentGetChildren.rep	Yes.	Yes.	Show when the users listed the documents into some folder or record. Results are filtered by date range. To list documents into a folder is called internally method named "getChildren".
DocumentContent.rep	Yes.	Yes.	Show when the users retrieved the content of a document. Results are filtered by date range. For example, when a user download or preview a document ( among other actions ) is retrieving the content of the document.
DocumentContentByVersion.rep	Yes.	Yes.	Show when the users retrieved a specific version of the content of a document. Results are filtered by date range.
DocumentGetProperties.rep	Yes.	Yes.	Show when user retrieved the properties of a document. Results are filtered by date range. For example, when document is selected, is called internally a method named "getProperties" to fill the contents of properties tab in user interface.
DocumentGetVersionHistory.rep	Yes.	Yes.	Shown when the users retrieved the list of all versions of a document. Results are filtered by date range.
DocumentGetPropertyGroupProperties.rep	Yes.	Yes.	List when has been retrieved the fields of a metadata group. For example, when a metadata group is shown in users interface, is called internally a method named "getPropertyGroupProperties" to fill the metadata group values.
DocumentLock.rep	Yes.	Yes.	List documents updated, filtered by date range.
DocumentMove.rep	Yes.	Yes.	List documents moved, filtered by date range.
DocumentPurge.rep	Yes.	Yes.	List documents purged, filtered by date range. When a document is purged it will definitively disappear from application repository.
DocumentRenamed.rep	Yes.	Yes.	List documents renamed, filtered by date range.
DocumentUnlock.rep	Yes.	Yes.	List documents unlocked, filtered by date range.
DocumentsAccessibleByUserOrdered.jrxml	No.	No.	Retrieve a list of available documents - security filtered - ordered by folder name. Optimized for csv format. Not recommended for large repositories, can take a lot of time.
DuplicatedFiles.jrxml	No.	No.	List of duplicated files into application repository, based on document checksum.
ListDocumentsWithChecksum.rep	No.	Si.	List of all documents into some folders and subfolders with checksum value.

Folders

Name	Use Activity log	Require parameters	Description
FolderCopy.rep	Yes.	Yes.	List folders copyed, filtered by date range.
FolderCreate.rep	Yes.	Yes.	List folders created, filtered by date range.
FolderDelete.rep	Yes.	Yes.	List folders deleted, filtered by date range.
FolderGetChilden.rep	Yes.	Yes.	Show when the users listed the folders into some folder or record. Results are filtered by date range. To list folders into a folder is called internally method named "getChildren".
FolderGetContentInfo.rep	Yes.	Yes.	Shown when the internal method named "getContentInfo" has been executed. To do some operations is needed to calculate folder deep, for example before starting folder ZIP download. There's an internal method named "getCotentInfo" that does it.
FolderGetProperties.rep	Yes.	Yes.	Show when user retrieved the properties of a folder. Results are filtered by date range. For example, when folder is selected, is called internally a method named "getProperties" to fill the contents of properties tab in user interface.
FolderMove.rep	Yes.	Yes.	List folders moved, filtered by date range.
FolderPurge.rep	Yes.	Yes.	List folders purged, filtered by date range. When a folder is purged it will definitively disappear from application repository.
FolderRename.rep	Yes.	Yes.	List folders renamed, filtered by date range.

Mails

Name	Use Activity log	Require parameters	Description
MailCreate.rep	Yes.	Yes.	List mails created, filtered by date range.
MailGetProperties.rep	Yes.	Yes.	Shown when a user retrieved the properties of a mail. Results are filtered by date range. For example, when mail is selected, is called internally a method named "getProperties" to fill the contents of properties tab in user interface.
MailPurge.rep	Yes.	Yes.	List mails purged, filtered by date range. When a mail is purged it will definitively disappear from application repository.
MailRename.rep	Yes.	Yes.	List mails renamed, filtered by date range.
MailMove.rep	Yes.	Yes.	List mails moved, filtered by date range.
MailCopy.rep	Yes.	Yes.	List mails copyed, filtered by date range.
MailGetChilden.rep	Yes.	Yes.	Show when the users listed the mails into some folder or record. Results are filtered by date range. To list mails into a folder is called internally method named "getChildren".

Others

Name	Use Activity log	Require parameters	Description
WorkflowWorkload.jrxml	No.	No.	Each workflow task with the time spent on it.
RegisteredUsers.jrxml	No.	No.	Registered users.