KRYSTAL DMS - Enterprise Edition - 2021 - Administrator's Guide

Control Panel


KRYSTAL DMS - Enterprise Edition has two types of users. The first type of users is System Administrators and others are standard DMS users.

The main System Administrator user is known by user name ADMINISTRATOR and by default password admin on the installation.

ADMINISTRATOR has complete rights and access over entire KRYSTAL DMS - Enterprise Edition server. Various administrative tasks can be performed via Control Panel available in KRYSTAL DMS - Enterprise Edition server.

Control Panel Screen

Users with administrative privileges (Users with System Administrator group assigned) can access the Control Panel of KRYSTAL DMS - Enterprise Edition using the menu available on top navigation bar.

This menu item is available only to those users who have administrative rights / privileges.

Domains are top-level structural units intended to organize groups of related users and relevant Document Classes according to their job or business functions.

Administrators can create / edit / delete domains depending on the license restrictions. To perform domain management task, administrators can use Manage Domains feature of Control Panel.

Manage Domains

To ensure privacy of information, user names and passwords are valid only for those domain(s) to which they are assigned: users can only login to their assigned domain(s) and all documents are domain-specific, stored, and manipulated independently of other domains.

To add a new domain, click on the New Domain link on the Manage Domains module. Enter domain name and a small description and check the active check box to set the domain active. Domain(s) can be linked to Active Directory or LDAP Servers.

To create such domain select LDAP / ADSI type and provide the Connection String for connecting to ADSI / LDAP Server.

Administrator can allocate maximum number of concurrent users that can login to a domain as well

Only active domains are available for users to login into Enterprise Document Management Console.

New Domain Form

If Administrators enables Two Factor Authentication for domain then all users logging into that domain must provide an additional One Time Password (OTP) which will be sent via SMS and/or registered Email address once user is authenticated with correct username and password.

Administrator (Username : ADMINISTRATOR) can change the domain details by clicking on the Edit link associated with the domain record on Manage Domains module.

Edit Domain Form

Administrator can make required changes and can click on Submit button to save the changes.

Administrator (Username : ADMINISTRATOR) can delete a domain if no users are logged-in to that domain. Administrator can delete the domain by clicking on the Delete link associated with the domain record on Manage Domains module.

A confirmation message is shown to the administrator and on confirming the action, the domain will be deleted from the system.

Administrator users can restrict the access to a particular domain by IP Addresses. To define access restrictions by IP addresses, administrator can click on IP Restrictions link associated with a domain record.

To add IP Address restriction, administrator can enter From IP and To IP and click on Submit button.

IP Restrictions

Administrators can add IP Address Range for which they want to restrict access to a domain

Add IP Restrictions

To delete IP restriction, administrator need to click on Delete link associated with the record.

On installation only a default administrator user is available. After logging into KRYSTAL DMS - Enterprise Edition the administrator can create new users via Manage Users module.

Manage Users

Manage Users function of Control Panel allows administrators to create, delete, and modify users along with tracking the access history of each user.

Administrators can also change the password of all the users by clicking on the Change Password link associated with the user record.

The default user Administrator cannot be deleted by any other user. Users can be deactivated by editing a user. Details like last login date time, IP address, currently logged in or not is displayed on the user listing page. To add a new user to the system, administrators can use New User link available on this page. To edit or delete user, administrators can use Edit and Delete link respectively.

Administrators can add a new user by clicking on New User link available on the Manage Users module.

Enter details like user name, real name, email, password, description etc. and click on the Submit button to add a new user. On successful addition of user an email will be sent out to the user on entered email address providing login details.

User must be part of at least one group. To define a user to be an administrator, s/he must be made part of System Administrators group.

The access rights of the user can also be controlled from this module. Administrator can define whether user will have access type of ALL to view all the documents or s/he will have rights to view only those documents which are created by him or her. The configuration also depends on the access type defined in Document Classes.

The user created will be active by default. To de-activate a user, administrator can use Edit User feature.

Add User Form

If user name and user email is already used then appropriate message will be displayed to the administrator user.

To edit/modify details of a specific user, administrator can click on Edit link associated with the user record. On clicking the link a pre-populated form will appear as given below.

Edit User Form

User name is not available for modification.

To set a user as administrator, assign the System Administrators group to the user.

Administrators can later revoke these privileges by deassigning the System Administrators group from the user on Edit User screen of Manage Users module.

Administrators can delete users by clicking on Delete link associated with each user record. On clicking a Confirmation is taken for this delete operation and on confirming the delete operation, the user will be deleted from the system.

If user has checked out documents then the user will not be deleted. Also ADMINISTRATOR user cannot be deleted from the system.

To change password for any specific user, administrator can click on Change Password link associated with the user record. On clicking the link a popup form will appear as given below.

Change User Password

Administrator can put any desired password for the user and submit the form to update / change the password of that user.

Administrators can assign filters on list based indexes using this module of the system. On clicking Manage List Filters link associated with the user record a new page is displayed which shows the assigned filters with an option to add new filter and delete existing filter.

Manage List Filters

To add a new list filter Administrator can click on New List Filter link available on the top of the page.

New List Filter

To add a new list filter for selected user, administrator can can click on the New List Filter link. Here administrator can choose the list index and assign filters for the list values available.

New List Filter Form

Edit List Filter

Existing list filter can be modified by clicking on the Edit link associated with the list filter record on the Manage List Filter module.

Administrator user can change the list filters by selecting the values from the selection box.

Edit List Filter

Delete List Filter

Administrators can delete an existing list filter for a user by clicking on the Delete link associated with the list filter record. A confirmation is taken from the user before deleting the list filter. On confirmation, the list filter will be deleted for the user.

Groups consist of one or more users. Administrators can create any number of groups they want and each group can consist of any number of users.

Group management tasks can be performed using Manage Groups module of Control Panel.

Manage Groups

Administrator can add, edit or delete a group using this module.

To add a new group, administrator type of user can click on New Group link on the Manage Groups module of Control Panel.

To create a new group, administrator need to enter following details.

  • Group Name
  • Group Description
  • Group Email
  • Domains

If the group email and group name is already used by an existing group then appropriate message is displayed to the administrator and group will not be added to the system.

Add Group Form

After entering required details and on clicking the Submit button, a new group is created.

To modify a particular group, administrator can click on the Edit link associated with that group record. On clicking the link a pre-populated form will appear as given below.

splayed to the administrator and group will not be added to the system.

Edit Group Form

Administrators can delete association of user with a group by clicking on the icon associated with user assigned to a group.

A confirmation dialog is shown to the user for this action and on confirming the delete operation user will be removed from the Group

Administrator can make required changes and can click on Submit button to save the changes.

Administrators can delete groups by clicking on Delete link associated with each group record. On clicking a Confirmation is taken for this delete operation and on confirming the delete operation, the selected group will be deleted from the system.

On deletion of group, association of the group with users will also be removed from the system.

KRYSTAL DMS - Enterprise Edition allows multiple roles for users and groups of the system. To manage roles click on Manage Roles link on Control Panel. A list of all available roles will be displayed. Roles are primarily assigned to users who participate in the workflow process. Each user can have zero or more roles depending upon participation in workflow process.

Manage Roles

Administrator can add, edit or delete roles using this feature of the Control Panel.

To add a new role, administrator type of user can click on New Role link on the Manage Roles module of Control Panel.

Add Role Form

After entering required details and on clicking the Submit button, a new role is created in the system.

To edit/modify a particular role, administrator can click on the Edit link associated with that role record. On clicking the link a pre-populated form will appear as given below.

Edit Role Form

Administrator can make required changes and can click on Submit button to save the changes.

Administrators can delete association of user with a role by clicking on the icon associated with user assigned to a role.

A confirmation dialog is shown to the user for this action and on confirming the delete operation user will be removed from the Role

Administrators can delete roles by clicking on Delete link associated with each role record. On clicking a Confirmation is taken for this delete operation and on confirming the delete operation, the selected role will be deleted from the system.

On deletion of role, association of the role with users will also be removed from the system.

Indexes are an essential component of document management; they not only provide a stable framework for a document indexing, but ensure that unstructured content can be streamlined and systematized according to any number of user-defined criteria.

Indexes can be used to classify and distinguish documents on the basis of their business function while serving as useful properties for precision searches: if a particular Document Class is selected for searching, any document belonging to the selected class can be searched by any of that class's assigned indexes.

Manage Indexes

KRYSTAL DMS - Enterprise Edition allows multiple meta-data indexes for Document Classes. To manage indexes click on Manage Indexes link on Control Panel. A list of all available indexes will be displayed as shown above.

Administrator can add, edit or delete indexes using this module.

To add an index, administrator type of user can click on New Index link on the Manage Indexes module of Control Panel.

Add Index Form

Indexes can be any one of the following data types:

  • String: free text strings can be used to describe meta-data fields, such as title, subject, etc.
  • Date: the field value must be a valid calendar date.
  • Number: the field value must be a digital number.
  • Auto generated: the automatically generated value.
  • List: list of static values.
  • Digits: only numeric digits that can start with '0'.
  • Barcode: the value read from barcode available on the document.

After entering required details and on clicking the Submit button on Add Index screen, a new index is created in the system.

Auto generated indexes requires user to define the prefix and select the pattern while adding it to a Document Class. For example if index prefix is PRIMELEAF/MUM/ and selected pattern is MM/yyyy then the index value for this field would be PRIMELEAF/MUM/10/2012/000001 (where 000001 is the document id generated by the system)

To modify a particular index, administrator can click on the Edit link associated with index record. On clicking the link, a pre-populated form will appear as given below.

Edit Index Form

Administrator can make required changes and can click on Submit button to save the changes.

Important Note: None of the Document Classes containing the updated index will be modified or updated on this action.

Administrators can delete indexes by clicking on Delete link associated with each index record. On clicking a Confirmation is taken for delete operation and on confirming the delete operation the index will be deleted from the system.

Important Note: If an existing Document Class contains the index, then there will be no changes in the Document Class even after deletion of the index.

Document Classes are nothing but a group of similar documents. Document which are similar in its functional capabilities are grouped under a particular Document Class.

For example, Invoices, Purchase Orders, Shipping Confirmations etc.

Administrators can create any number of Document Classes using this module. Each Document Class can contain any number of meta-data indexes.

Document Class management tasks can be performed using Manage Document Class module of Control Panel.

Administrator can modify the Document Class details by clicking on Edit link associated with Document Class. To delete the Document Class, administrators can use Delete link available with each Document Class record.

Indexes for Document Classes can be managed (added / updated) using the Mange Indexes link available with each Document Class record.

Manage Document Classes

Document classes allow users to sort/group documents based on similar characteristics.

Document classes in addition, controls the way documents can be stored, the expiration of the documents within the Document Class, and access permissions based on ACL templates assigned to it.

To create /add a new Document Class, click on New Document Class link on the Manage Document Classes module of Control Panel. Enter the required details for creation of Document Class and click the Submit button to create the Document Class in to the system.

Add Document Class Form

Document Class may or may not contain any index. To add an index to the Document Class, administrators can use the Mange Indexes link

The same index cannot be added to the Document Class at any point in time.

To create the Document Class administrator can click on a Submit button.

Only those Document Classes which are marked as active will be accessible to the user of the system for document storage, search and retrieval purposes. The revision control functionalities are available only in those Document Classes which are marked for Version Control.

The access to the documents within the Document Classes is controlled by Document Access field. If this is defined as “Public” then all users irrespective of their access type will be able to access the documents. If this is defined as “User Level” then users will be able to access only his/her documents if the Access Type of the user is “SELF”.

Administrator user can modify / edit a Document Class by clicking on the Edit link associated with the Document Class record in Manage Document Classes module of Control Panel.

Edit Document Class Form

Administrator can make required changes and can click on Submit button to save the changes.

Administrators can delete Document Classes by clicking on Delete link associated with each Document Class record. On clicking a confirmation is taken for delete operation and on confirming the delete operation the Document Class will be deleted from the system.

All DocViews (document views) based on the Document Class will also be deleted along with the Document Class.

Administrator can add and edit indexes to a Document Class by clicking on the Manage Indexes link associated with a Document Class record. A new page will be displayed to the user that allows user to add new index or modify an existing index as shown below.

Manage Document Class Indexes

Add Index

To add an index, administrator can select the index from the Index Name drop down. Only those indexes will be available which will be not currently available in the Document Class.

Add Document Class Index

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes module and clicking on the Update button.

Administrator user can only modify the description of the index. Other information like length and type of index is not available for modification or update. Administrator can also modify the order of the index.

Edit Document Class Indexes

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete icon associated with the Index. A confirmation is taken from the user before deleting the index. On confirmation, the index will be deleted from the Document Class.

Important Note: This action is irreversible and all data values associated with the index will be completely lost.

Document Class can contain multiple indexes which can be automatically extracted from the uploaded document using Zonal OCR technologies available in KRYSTAL DMS - Enterprise Edition

Manage Index Zones

Administrator can select and index from the list of available index and draw an zonal on the sample document to define the extraction location from the document. On upload of the document, system will perform OCR based on these zones and indexes will be automatically populated.

Administrator user can create a copy of the existing Document Class by clicking on Create Copy link associated with a Docuement Class in Manage Document Classes module of Control Panel.

A confirmation dialog is displyed to the user and on confirming copy of the selected Document Class is created. Only structure of Document Class is copied. No documents are copied to newly created Document Class.

These are List of static values for indexes. Administrator can define a List which will contain static set of values from where user can index the document.

Manage Lists

KRYSTAL DMS - Enterprise Edition allows multiple lists. To manage lists click on Manage List link on Control Panel. A list of all available static lists will be displayed as shown above.

Administrator can add, edit or delete or mange list items (values) using this module.

To add new list, administrator type of user can click on New List link on the Manage List module of Control Panel.

Add List Form

After entering required details and on clicking the Submit button on Add List screen, a new List is created in the system.

To modify a particular list, administrator can click on the Edit link associated with list record. On clicking the link, a pre-populated form will appear as given below.

Edit List Form

Administrator can make required changes and can click on Submit button to save the changes.

Administrators can delete list by clicking on Delete link associated with each list record. On clicking a Confirmation is taken for delete operation and on confirming the delete operation the list will be deleted from the system.

A list contains set of items or values. Administrators can add, edit or delete these items by clicking on the Mange List Items link available with the list.

All available list values are displayed to the user. To update a particulate value, user can modify the value in the box and click on Submit button to save the changes.

To delete a particular value, administrator can click on Delete button associated with the value and after confirming the delete operation, list value will be deleted from the system.

Manage List Items

To enter a new value user can put the value in List Item text box and can click on Submit button to store the value with the list.

Add List Item Form

Administrators can also upload a Microsoft Excel Spreadsheet containing the list values to be added in the system using this feature

ACL Templates provide smart, efficient and easy way to manage the document access permissions. Administrator can create various ACL Templates and assign rights to these templates for public, users, groups and roles.

These templates can then be assigned to any Document Class and access permissions / rights assigned to templates get automatically delegated to the users, groups and roles that belong to these templates.

Use Manage ACL Templates module to perform ACL Template management tasks from Control Panel.

Manage ACL Templates

To manage permissions for each ACL Template click on Manage Permissions link associated with a particular template

By default one ACL template, DEFAULT ACL Template is available on installation of KRYSTAL DMS – Enterprise Edition.

To add a new ACL Template, administrator type of user can click on New ACL Template link on the Manage ACL Templates module of Control Panel.

Add ACL Template Form

After entering required details and on clicking the Submit button, a new ACL Template is created in the system.

To edit/modify a particular ACL Template, administrator can click on the Edit link associated with ACL Template record. On clicking the link a pre-populated form will appear as shown below.

Edit ACL Template Form

Administrator can make required changes and can click on Submit button to save the changes.

Administrators can delete ACL template by clicking on Delete link associated with each ACL template record. On clicking a confirmation is taken for delete operation and on confirming the delete operation the ACL template will be deleted from the system.

Important Note: If an existing Document Class is assigned the ACL Template then it will be removed from the Document Class and all permissions defined in the ACL Template will also be removed.

Administrator can select public, user, group or role and click on Submit button. Manage Permissions screen will appear, administrator can then assign any of the following permission to selected type of member (user, group, role or public) for the ACL Template.

Administrators can assign following permission to the selected member type of the ACL Template.

  • CREATE / ADD
  • READ / VIEW
  • WRITE / EDIT
  • DELETE
  • PRINT
  • SHARE
  • REVISE
  • ANNOTATE
  • DOWNLOAD
Manage Permissions

All currently assigned permissions are also displayed on this page. Administrator can click on icon associated with a member record to remove the permission. A confirmation is taken on clicking the icon and then permissions will be removed on confirmation.

Now administrator can assign required permission by clicking on next button and then selecting appropriate check box on Assign Permissions screen.

Assign Permissions

Administrator can make required changes and can click on Submit button to save permissions changes.

Administrators can clear all permissions assigned / associated with associated ACL Template by clicking on the Clear Permissions link associated with it.

A confirmation dialog is displayed to the administrator and on confirming the operation, all permissions assigned to ACL Template is cleared.

Administrator user can create a copy of the existing ACL Template by clicking on Create Copy link associated with a ACL Template in Manage ACL Templates module of Control Panel.

A confirmation dialog is displyed to the user and on confirming, copy of the selected ACL Template is created.

Hotlinks features of the KRYSTAL DMS - Enterprise Edition allows administrator to link Document Classes with one another. Hotlinks allow users to view documents from linked classes in a single click.

Hotlinks are available while viewing the document. Users can view documents related to each other by using this feature of the system.

Administrator can create any number of hotlinks for a particular Document Class. Users cannot create hotlinks but they can use hotlinks features to view documents which are linked with each other in other Document Classes.

On clicking the Manage Hotlinks link on the control panel of the application, all available hotlinks are displayed to the ADMINISTRATOR user.

Manage Hotlinks

Administrator can create hotlinks by linking two Document Classes. Two classes must have a common index field in order to be linked with each other.

For example an Invoice class has an index field called PO Number which is also available in the Purchase Order class. On clicking New Hotlink link on this screen, Administrator will be taken to a page which will allow him/her to create a hotlink.

Select Document Class

The system will fetch all the active Document Classes here. Administrator should select a Document Class in order to create a new hotlink.

New Hotlink - Step 1

After selecting a Document Class, Administrator must click on NEXT button to continue. Matching indexes from both the classes will be displayed in next step.

Select Linked Document Class

Now the system will automatically identify all the Document Classes which are available in the system having common indexes with the class selected in previous step.

New Hotlink - Step 2

Select Index

Administrator can select one index on which s/he wants to link the original Document Class with Hot-linked Document Class as given below.

New Hotlink - Step 3

After entering the name for the hotlink, user can click on Submit button to save the Hotlink. User must select one index on which s/he wants to link the two Document Classes.

To delete a hotlink, Administrator user can click on Delete link associated with the hotlink record. On clicking the link a confirmation is taken, and on confirming the delete operation, hotlink is deleted from the system.

 

Administrators can add any number of announcement for one or more domains using this module of the system.

Manage Announcements

Administrator user can add, edit, or delete announcement using this module of the system

To add an announcement, administrator user can click on New Announcement link available on the announcement listing page shown above.

New Announcement Form

On clicking the Submit button the announcement details will be captured in the system. Administrator can chooses to notify the users by clicking on Notify Users checkbok, an email will be sent to all the users of selected domain about this announcement.

When an end-user log-in to the system s/he will be able to view the announcement on his/her workspace.

Administrators can edit announcements by clicking on Edit link associated with announcement.

Edit Announcement Form

After making appropriate changes Administrator can save the announcement details.

To delete an announcement, administrator can click on Delete link associated with the announcement. A confirmation is taken for this delete operation, and on confirmation, the announcement is deleted from the system.

Administrators can add any number of event for one or more domains using this module of the system.

Manage Events

Administrator user can add, edit, or delete event using this module of the system

To add an event, administrator user can click on New Event link available on the event listing page shown above.

Add Event Form

On clicking the Submit button the event details will be captured in the system and when a user signs in to the system s/he will be able to view the event details.

Administrators can edit event by clicking on Edit link associated with event.

Edit Event Form

After making appropriate changes Administrator can save the event details.

To delete an event, administrator can click on Delete link associated with the event. A confirmation is taken for this delete operation, and on confirmation, the event is deleted from the system.

Administrators can add any number of discussions for one or more domains using this module of the system.

Manage Discussions

Administrator user can add, edit, or delete discussion using this module of the system

To add a discussion, administrator user can click on New Discussion link available on the discussion listing page shown above.

Add Discussion Form

On clicking the Submit button the discussion details will be captured in the system and when a user signs in to the system s/he will be able to view the discussion details and can provide his/her feedback, comment or suggestion and participate in the discussion.

Administrators can edit discussion by clicking on Edit link associated with discussion.

Edit Discussion Form

After making appropriate changes Administrator can save the discussion details.

To delete a discussion, administrator can click on Delete link associated with the discussion. A confirmation is taken for this delete operation, and on confirmation, the discussion is deleted from the system.

In KRYSTAL DMS - Enterprise Edition work flows are created using JAWE (Java Workflow Editor Version 1.4). The files created by JAWE (.XPDL XML Process Definition Language) are uploaded into the system as work flow templates. A sample workflow created using JAWE is depicted below.

Manage Workflow Templates

Workflow Templates stores the complete business process logic. Administrators can create new templates and modify existing templates using Manage Workflow Templates module from Control Panel.

Manage Workflow Templates

To add a new workflow template, click on the New Workflow Template link, following screen will be displayed.

Add Workflow Template Form

On entering required details and clicking on Submit button will upload the data into the system and all required business process details are stored into the system.

Users can only access the workflow processes if it is assigned an ACL Template. To assign a ACL template to workflow administrators can use this function.

Edit Workflow Template Form

To save the changes, administrator should click on Submit button.

Administrator user can download the XPDL (XML based Process Definition Language) file associated with the Workflow Template by clicking on the Download XPDL link associated with the workflow template in Manage Workflow Templates module of Control Panel.

Download XPDL (XML based Process Definition Language) file

Workflow Templates stores the complete business process logic. Administrators can create new templates and modify existing templates using Manage Contacts module from Control Panel.

Manage Contacts

To add a new Contact, click on the New Contact link, following screen will be displayed.

New Contact Form

On entering required details and clicking on Submit button capture the contact information in the system which will be used in Transmittal Management Module of KRYSTAL DMS.

To edit a Contact, Administrators can use this module.

Edit Contact Form

To save the changes, Administrators should click on Submit button.

To delete a Contact, Administrator can click on Delete link associated with the Contact record. A confirmation is taken for this delete operation, and on confirmation, the Contact is deleted from the system.

Administrators can view the Reports by clicking on the System Reports icon in the Control Panel. System Reports can be viewed by the Administrators only. There are 9 reports which the Administrators can view as shown below.

  • Repository Content Summary
  • Repository Content Summary – Domain wise
  • Access History
  • Document Class Access History
  • Document Upload Report
  • Document Revision Report
  • Document Emailed(Shared) Report
  • Document Print Report
  • Document Download Report
  • Workflow Case Report
  • Fulltext Summary Report
  • Incomplete Data Report
  • Transmittal Report
  • Server Logs

 

System Reports

View a statistical summary for repository resources. It gives the statistical information regarding the User, Groups, Roles, Document Classes, and Documents.

Repository Content Summary

It also shows the resource count i.e. document count and the attachments Document Class wise.

View a statistical summary for repository resources for each domain. It gives the statistical information regarding the User, Groups, Roles, Document Classes, and Documents for selected domain.

Repository Content Summary - Domain Wise

It also shows the resource count i.e. document count and the attachments Document Class wise.

View a chronological history of user activities. You can get the Audit Log reports from the Access History on the basis of the selected user.

User Access History

Filter criteria is also defined on the basis of the date-range for more granular report.

View a chronological history of activities performed on selected Document Class. You can get the Audit Log reports from the access history for Document Class on the selected Document Class.

Document Class Access History

Filter criteria is also defined on the basis of the date-range for more granular report.

Administrators can generate a document upload report for each Document Class and each user. This report details of the uploads done by users in a Document Class during a selected period. Adminstrators can also download the report in Microsoft Excel format for further processing and filtering.

Docuement Upload Report

Filter criteria is also defined on the basis of the date-range for more granular report.

Administrators can generate a document revision report for each Document Class and each user. This report provides details of the revisions carried out by users in a particular Document Class or all Document Classes during a selected period. Adminstrators can also download the report in Microsoft Excel format for further processing and filtering.

Docuement Revision Report

Filter criteria is also defined on the basis of the date-range for more restrictive period for report.

Administrators can generate a documents emailed (shared) report for each Document Class and each user. This report details the documents emailed (shared) by the users in a particular Document Class or all Document Classes during a selected period. Adminstrators can also download the report in Microsoft Excel format for further processing and filtering.

Docuement Emailed(Shared) Report

Filter criteria is also defined on the basis of the date-range for more restrictive period for report.

Administrators can generate a document print report for each Document Class and each user. This report details the documents printed by the users in a particular Document Class or all Document Classes during a selected period. Adminstrators can also download the report in Microsoft Excel format for further processing and filtering.

Docuement Print Report

Filter criteria is also defined on the basis of the date-range for more restrictive period for report.

Administrators can generate a document download report for each Document Class and each user. This report details the documents downloaded by the users in a particular Document Class or all Document Classes during a selected period. Adminstrators can also download the report in Microsoft Excel format for further processing and filtering.

Docuement Download Report

Filter criteria is also defined on the basis of the date-range for more restrictive period for report.

All instances of the workflow cases can be viewed and downloaded as a report using this feature of the system. Administrator can generate the report by selecting workflow template and supplying date range.

Workflow Case Report

Filter criteria is also defined on the basis of the date-range for more precise report.

Administrator can view the execution timeline of each case. Workflow case can also be deleted by clicking on the Delete link associated with workflow case.

This report displays the summary of the Fulltext extraction process. It displays number of document which are pending for extraction as well as document for which extraction is complete for each of the Document Class.

Fulltext Summary Report

Users can download this report in excel format.

This report provides details of the documents which are not uploaded in the system for specific list item.

Incomplete Data Report

Users can download this report in excel format. This report is emailed to the user who has initiated this report on his/her registered email id.

This report provides details of the transmittal created in the system along with status of the transmittal and number of documents in the transmittal.

Transmittal Report

Administrator can view more details of each transmittal by clicking on View Details link associated with each Transmittal record as given below.

Transmittal Details

Server Log report shows all the activties which are carried out in the system depending upon the log level configured in the system.

Server Logs

Documents that are archived by end users can be viewed in this module of the system.

On clicking the Archived Documents link in Control Panel, ADMINISTRATORS will be able to view the Document Classes and count of documents that are archived as shown below.

Archived Documents

To view the documents archived, administrators can click on the Documents link or the Document Class.

Archived Document List

To restore the document, Administrators can click Restore Document link. Adminsitrators will then be asked to enter the expiry date if required and can click on Restore Document button.

Recycle Bin contains the documents that users have deleted or documents which are marked as expired. This module is used to delete the documents permanently or restore the deleted documents in the system. Only Administrator(s) have the rights to restore the documents or delete the documents permanently.

On clicking the Recycle Bin link in Control Panel, ADMINISTRATORS will be able to view the Document Classes which contains deleted documents as shown below.

To view the documents deleted, click on the Document Class name or on the number of documents which are deleted.

Recycle Bin

Administrator(s) can delete documents by clicking the Delete Document link associated with each document. A confirmation is taken for this action and on confirmation, selected document will be deleted permanently from the system.

Recycle Bin Content

To restore the document, Administrators can click Restore Document link.

System Administrator can use this module to modify settings of the entire server. Manage Global Settings module can be used to edit mail server settings.

Global settings will display following details to the user.

  • License Details
    • Customer ID
    • Customer Name
    • Expiry On
    • Server Name / IP address
    • Total Number of user currently logged in
    • Total number of licenses available
    • Total number of users licenses
  • Database Settings
    • Database Server Name
    • Database Platform
    • Database Name
    • Instance Name
    • Database Username
    • Database Password
    • Database Port

Along with these details user can modify following details as shown below.

Manage Global Settings

Administrator can save the changes and need to restart the server in order to apply these changes.

Only ADMINISTRATOR user will be able to access this module.

Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTAL DMS - Enterprise Edition.

Document Expiry Processor, Document Expiry Notifier and Full Text Processor are three main Jobs of the system. Administrators can manage these predefined schedule jobs by using this module.

 

Document Expiry Processor

This schedule built-in job of the system checks the documents for expiry period and if the document expiry period is lapsed then it marks the document as expired. Once the document is expired then it is accesible in Archived Documents section of the system.

 

Document Expiry Notifier

This schedule built-in job of the system sends document expiry notifications in an email message to the users who have subscribed for expiry notification for a particular Document Class.

 

Full Text Processor

KRYSTAL DMS - Enterprise Edition provides full text search capabilities. Once the documents are uploaded / stored into the system a full text extraction can be carried out from the document using this scheduled job of the system.

 

Document Importer

Administrators can define import location for each and every Document Class, this scheduled job monitors these locations as per the schedule and stores the document in appropriate Document Class after importing documents

A data file with extension .dat need to be created in the import location with pipe (`|`) delimited values as given below.

FILENAME | REVISION NO | INDEX VALUE 1 | INDEX VALUE 2 | INDEX VALUE 3 | ... INDEX VALUE N

For Example: A Document Class (INVOICES) contaning 5 index fields as given below

  1. INVOICE_NUMBER
  2. AMOUNT
  3. INVOICE_DATE
  4. PO_NUMBER
  5. VENDOR NAME

The required .dat file should have following structure and must be place in import location defined in the Document Class.

INV12090.PDF|1.0|12090|12000|10-Sep-2018|PO12340|Trey Research
INV13090.PDF|1.0|13090|15600|11-Sep-2018|PO12341|Third World
INV14090.PDF|1.0|14090|17900|14-Sep-2018|PO12342|Scan Shop

If workflow is associated with the Document Class then this mechanism will not be available for importing documents.

 

Document Cleanup Processor

This scheduled job of the system cleans up all the orphan documents from various Document Class at the scheduled interval.

 

Workflow Notifier

This scheduled job of the system sends reminders to the users who have workflow cases pending in their queues.

 

Document Import Monitor

Document Import Monitor is a built in system job that allows Administrators to import documents into KRYSTAL DMS - Enterprise Edition as a batch. Using KRYSTAL CAPTURE Studio users can scan, index, and release documents to KRYSTAL DMS - Enterprise Edition.

Documents created using KRYSTAL CAPTURE Studio gets imported by Document Import Monitor into KRYSTAL DMS - Enterprise Edition. The location which the Document Import Monitor monitors can be configured using the Manage Job module and modifying the Job parameter string. Document Import Monitor can monitor multiple paths if they are separated by a (; semicolon).

Only ADMINISTRATOR user will be able to access this module.
Manage Jobs

 

Administrators can edit the schedule of these jobs along with certain additional parameters of the job by clicking on Edit link associated with each job.

Administrators can schedule jobs at specific time and interval using this module of the system. Additional parameters required for the job can also be modified using this feature of the system.

Edit Job Form

On clicking the Submit button, job schedule is modified and it is automatically reschedules for execution.

Administrators can view all the logs associated with the job.

View Job Logs

Various utilities are provided to the Administrators of the KRYSTAL DMS - Enterprise Edition for managing the system and up-keep of the application.

Utilities

This utility provides an easy way to test if the email configuration is correct.

Email Settings Test

Administrators can use this utility to re-index a Document Classes for better search performance.

Index Document Classes

Administrators can view or cancel the checkout operation carried out by a particular user using this module.

To manage checkouts, select Manage Checkouts on the Control Panel. Select the Document Class and user for whom you want to manage the checkouts and click on Submit button.

Manage Checkouts

From the list displayed, Administrators can select the documents which are checked-out by user and cancel the check-out operation.

Checkout List

These documents will now be available to all users of the system for version control.

To regenerate the workflow action file, administrator can click on this utility. A confirmation is taken from the logged-in user, and on confiring the action, workflow action file will be re-genererated.

Administrators can unlock workflow cases using this utility. Administrator can select the workflow template and click on Submit button to view locked cases in that workflow.

Unlock Workflow Cases

Administrator can then click on Unlock Case link associated with the case to unlock it.

Unlock Workflow Case List

A confirmation dialog is displayed to the Administrator and on confiring the unlock action, workflow case is made available to other users of the system.

Fulltext extracted from the result of the OCR operation can be further updated by the administrators using this utility of the system.

Update Full Text

Administrator can now change / modify / adjust the extracted content. To save the changes administrator should click on Update button.

Update Full Text Content

Update content will now be searchable by users of the system.

This utility allows administrators to check the effective permisions on a Document Class for all or specific user of the system.

Check Effective Permissions

Final effective permission will be displayed to the administrator on clicking the submit button.

Administrators can change bulk update values of an index of a Document Class.

On clicking this utility user is presented with a module which will allow user to select a Document Class. On selecting any Document Class, user is shown list of available indexes.

Bulk Update Indexe Values

Administrator can then enter existing value and a replacement value in appropriate fields and click on Update button to bulk update index values for selected Document Index of the chosen Document Class

Administrators can download a sample file for importing documents in specific Document Class using this module.

After selecting a Docuement Class from the list of available Document Classes, Administrators can click on Download Import File button to get the import file.

Download Sample Import File

Administrators can archive audit log records of the system before a specific date. Administrator can choose the date and can click on submit button to archive logs.

Manage Audit Logs

Administrator can archive logs prior to 45 days.




© Primeleaf Consulting (P) Ltd. All Rights Reserved.

Last updated on July 1, 2020 18:00 IST