Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar...

42
PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371 / 72 / 73 KRYSTAL™ DMS Administrator’s Guide Standard Edition Version 8.0

Transcript of Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar...

Page 1: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

PRIMELEAF CONSULTING [P] LTD 29 Hendre Castle DSBabrekar Marg Gokhale Road (North) Dadar Mumbai 400 028 India Tel No + 91 2447 3371 72 73

KRYSTALtrade DMS Administratorrsquos Guide Standard Edition ndash Version 80

The contents of this document are strictly confidential and remain the property of Primeleaf Consulting [P] Ltd The document or any part thereof must not be distributed to any person other than those within the Client organization who are authorized to view the same

FIRST EDITION

JUNE 2013

This edition applies to the licensed program KRYSTALtrade DMS ndash Standard Edition Version 80 and to all subsequent releases and modifications until otherwise indicated in new editions Please make sure you are using the proper edition for the level of the product

All the names in this guide manual are fictional and any resemblance to existing people or firms is purely coincidental If you have any comments about the guide manual or the product we would very much like to hear from you

Please send your comments by e-mail to infokrystaldmsin or by fax to +91 2447 3373

Table of Content

Installing KRYSTALtrade DMS - Standard Edition 1

System Requirements 1

Installation Procedure 2

Windows Installation 2

Linux Installation 5

Starting KRYSTALtrade DMS - Standard Edition 6

Configuring KRYSTALtrade DMS - Standard Edition 7

System Configuration Wizard 7

Setup ndash Web application 11

Administering KRYSTALtrade DMS - Standard Edition 12

Control Panel 12

Manage Users 13

New User 13

Edit User 14

Delete User 15

Manage Groups 16

New Group 16

Edit Group 17

Delete Group 17

Manage Roles 18

New Role 18

Edit Role 19

Delete Role 19

Manage Indexes 19

Add Index 20

Edit Index 21

Delete Index 21

Manage Document Classes 22

Add Document Class 22

Edit Document Class 23

Delete Document Classes 24

Manage Indexes 24

Add Index 25 Edit Index 25 Delete Index 25

Manage ACL Templates 26 Add ACL Template 26 Edit ACL Template 27 Delete ACL Template 27 Manage Permissions 27

Manage Checkouts 28

Manage Global Settings 29

Manage Jobs 30 Document Import Monitor 30 Document Expiry Processor 30 Document Expiry Notifier 31

System Reports 32

Repository Content Summary 32

Access History 33

Access History for Document Class 34

Recycle Bin 36

Conclusions 38

Further Reading 38

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

1 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Installing KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition is easy to use powerful and cost-effective document management software that allows companies to centralize the management storage retrieval and distribution of electronic as well as paper based documents

Built with robust scalable architecture KRYSTALtrade DMS - Standard Edition can be deployed over LAN WAN or Internet in organizations These products also empower individuals and organizations by acting as powerful knowledge management tools

KRYSTALtrade DMS - Standard Edition addresses the needs of many vertical markets including manufacturing architecture engineering and construction utilities universities and government agencies

System Requirements KRYSTALtrade DMS - Standard Edition software completely written in JAVA Technologies and supports ORACLE Microsoft SQL Server MySQL Apache Derby and POSTGRE SQL on any Operating System It is build in Java and uses an XML interface to exchange documents Hence it is fully platform independent all Windows Servers UNIX Servers and all IBM e-Servers are supported

Minimum System Requirements for KRYSTALtrade DMS - Standard Edition

Hardware Pentium IV RAM 1024 MB 20GB free hard disk space

Operating System (Server) Microsoft Windows 2003 2008 2012 Server Standard or higher

Microsoft Windows XP Professional Windows 7 Professional or higher

Red Hat Linux 71 or higher

Sun Solaris 100 or higher

Database Software (Server)

Microsoft SQL Server 2000 or higher

Oracle 90 or higher

MySQL 50 or higher

POSTGRE SQL 8o or higher

Software on the client side Internet Explorer 7x or Mozilla Firefox or Google Chrome

Additional software for end user

Java Runtime Environment 16 or higher

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

2 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Installation Procedure KRYSTALtrade DMS - Standard Edition is available on a CD-ROM or can be downloaded from httpwwwkrystaldmsin website

The installation process is very simple and straight forward

Windows Installation KRYSTALtrade DMS - Standard Edition Installation CD is setup so that installation onto Windows machine is automatic

If yoursquore installing from the CD insert it into your computerrsquos CD-ROM drive After a series of setup screens appears the installation process begins and the Welcome screen appears

Alternately you can execute run SetupSEexe available in the CD-ROM drive

Click on Next button the license agreement appears

Read the License Agreement in its entirety and then click ldquoI accept the terms in the License Agreementrdquo if you want to continue with the installation After accepting the license agreement you will be asked to select the installation folder

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

3 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Once you have selected the installation folder the setup wizard will be ready to install KRYSTALtrade DMS - Standard Edition

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

4 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Click Install button to continue

Installation progress screen is displayed

Click Finish button to complete the installation

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

5 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Copy ldquoserverlicenserdquo file provided to you by your vendor to KRYSTAL_HOMEconf directory and restart the KRYSTALtrade DMS - Standard Edition server where KRYSTAL_HOME is folder where you have installed the KRYSTALtrade DMS - Standard Edition

Linux Installation To install onto Linux system you must be logged in as a super user (with root privileges) so that you have write permissions for all folders If you donrsquot do this you may not be able to install the software See your network system administrator if you need to obtain super user password

If you want to install the software on a Sun Microsystems computer see the Sun web site or check with your Sun representative or network administrator Because the Sun installation is not officially supported by KRYSTALtrade DMS - Standard Edition those instructions are not repeated here

If you are installing from CD

Copy KRYSTAL_Setup_SEtargz to your directory

Un-tar the file using

tar ndashzxvf KRYSTAL_Setup_SEtargz

Important Note Copy the ldquoserverlicenserdquo file provided to you into KRYSTAL_HOMEconf folder

This will complete the setup of KRYSTALtrade DMS - Standard Edition on Linux UNIX based platform

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

6 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On completion of installation KRYSTALtrade DMS - Standard Edition is not ready for use You have to configure the KRYSTALtrade DMS - Standard Edition server for database and mail server integration

Please refer to Configuring KRYSTALtrade DMS - Standard Edition for more details

Starting KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server is installed as a Windows Service on Microsoft Windows platforms You can use services control panel to start and stop KRYSTALtrade DMS - Standard Edition

On Linux or Solaris distributions you can use the script ldquoStartServershrdquo located in KRYSTAL_HOMEbin folder to start the server

To verify the installation and configuration of KRYSTALtrade DMS - Standard Edition server you can open the browser and visit httplocalhost to get connected

If you are on a machine other than on which KRYSTALtrade DMS - Standard Edition is installed then visit httphostnameportno where hostname is the name IP address of the machine where it is installed and port number on which it is configured to be running

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

7 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Configuring KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server can be configured using System Configuration Wizard or using the Setup web application You can access the System Configuration Wizard on Windows based system using

Start -gt All Programs -gt KRYSTALtrade DMS - Standard Edition 80 -gt System Configuration Wizard

Or on completion of installation you can use wizard directly

On Linux or UNIX based system you can use Web setup application

System Configuration Wizard Follow the steps given below to configure KRYSTALtrade DMS - Standard Edition

Welcome screen is displayed click on Next button to continue

Database Configuration screen appears as shown below You can choose any database with which you would like to setup KRYSTALtrade DMS - Standard Edition Keep DBA user name and password ready for configuration

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

8 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On selection of database and clicking on Next button you will be presented with database parameter screen Input required parameter and click on Next button to continue

Enter other required database configuration parameters if required or click Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

9 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter server configuration parameters like server port auto login etc and click on Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

10 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter SMTP (Mail Settings) configuration parameters and click on Next button to continue the configuration wizard Review your settings Click on Execute button to execute configuration setting wizard The wizard will create a database called KRYSTALDB6 into your selected database

To complete System Configuration Wizard click on Finish button and exit

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 2: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

The contents of this document are strictly confidential and remain the property of Primeleaf Consulting [P] Ltd The document or any part thereof must not be distributed to any person other than those within the Client organization who are authorized to view the same

FIRST EDITION

JUNE 2013

This edition applies to the licensed program KRYSTALtrade DMS ndash Standard Edition Version 80 and to all subsequent releases and modifications until otherwise indicated in new editions Please make sure you are using the proper edition for the level of the product

All the names in this guide manual are fictional and any resemblance to existing people or firms is purely coincidental If you have any comments about the guide manual or the product we would very much like to hear from you

Please send your comments by e-mail to infokrystaldmsin or by fax to +91 2447 3373

Table of Content

Installing KRYSTALtrade DMS - Standard Edition 1

System Requirements 1

Installation Procedure 2

Windows Installation 2

Linux Installation 5

Starting KRYSTALtrade DMS - Standard Edition 6

Configuring KRYSTALtrade DMS - Standard Edition 7

System Configuration Wizard 7

Setup ndash Web application 11

Administering KRYSTALtrade DMS - Standard Edition 12

Control Panel 12

Manage Users 13

New User 13

Edit User 14

Delete User 15

Manage Groups 16

New Group 16

Edit Group 17

Delete Group 17

Manage Roles 18

New Role 18

Edit Role 19

Delete Role 19

Manage Indexes 19

Add Index 20

Edit Index 21

Delete Index 21

Manage Document Classes 22

Add Document Class 22

Edit Document Class 23

Delete Document Classes 24

Manage Indexes 24

Add Index 25 Edit Index 25 Delete Index 25

Manage ACL Templates 26 Add ACL Template 26 Edit ACL Template 27 Delete ACL Template 27 Manage Permissions 27

Manage Checkouts 28

Manage Global Settings 29

Manage Jobs 30 Document Import Monitor 30 Document Expiry Processor 30 Document Expiry Notifier 31

System Reports 32

Repository Content Summary 32

Access History 33

Access History for Document Class 34

Recycle Bin 36

Conclusions 38

Further Reading 38

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

1 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Installing KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition is easy to use powerful and cost-effective document management software that allows companies to centralize the management storage retrieval and distribution of electronic as well as paper based documents

Built with robust scalable architecture KRYSTALtrade DMS - Standard Edition can be deployed over LAN WAN or Internet in organizations These products also empower individuals and organizations by acting as powerful knowledge management tools

KRYSTALtrade DMS - Standard Edition addresses the needs of many vertical markets including manufacturing architecture engineering and construction utilities universities and government agencies

System Requirements KRYSTALtrade DMS - Standard Edition software completely written in JAVA Technologies and supports ORACLE Microsoft SQL Server MySQL Apache Derby and POSTGRE SQL on any Operating System It is build in Java and uses an XML interface to exchange documents Hence it is fully platform independent all Windows Servers UNIX Servers and all IBM e-Servers are supported

Minimum System Requirements for KRYSTALtrade DMS - Standard Edition

Hardware Pentium IV RAM 1024 MB 20GB free hard disk space

Operating System (Server) Microsoft Windows 2003 2008 2012 Server Standard or higher

Microsoft Windows XP Professional Windows 7 Professional or higher

Red Hat Linux 71 or higher

Sun Solaris 100 or higher

Database Software (Server)

Microsoft SQL Server 2000 or higher

Oracle 90 or higher

MySQL 50 or higher

POSTGRE SQL 8o or higher

Software on the client side Internet Explorer 7x or Mozilla Firefox or Google Chrome

Additional software for end user

Java Runtime Environment 16 or higher

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

2 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Installation Procedure KRYSTALtrade DMS - Standard Edition is available on a CD-ROM or can be downloaded from httpwwwkrystaldmsin website

The installation process is very simple and straight forward

Windows Installation KRYSTALtrade DMS - Standard Edition Installation CD is setup so that installation onto Windows machine is automatic

If yoursquore installing from the CD insert it into your computerrsquos CD-ROM drive After a series of setup screens appears the installation process begins and the Welcome screen appears

Alternately you can execute run SetupSEexe available in the CD-ROM drive

Click on Next button the license agreement appears

Read the License Agreement in its entirety and then click ldquoI accept the terms in the License Agreementrdquo if you want to continue with the installation After accepting the license agreement you will be asked to select the installation folder

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

3 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Once you have selected the installation folder the setup wizard will be ready to install KRYSTALtrade DMS - Standard Edition

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

4 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Click Install button to continue

Installation progress screen is displayed

Click Finish button to complete the installation

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

5 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Copy ldquoserverlicenserdquo file provided to you by your vendor to KRYSTAL_HOMEconf directory and restart the KRYSTALtrade DMS - Standard Edition server where KRYSTAL_HOME is folder where you have installed the KRYSTALtrade DMS - Standard Edition

Linux Installation To install onto Linux system you must be logged in as a super user (with root privileges) so that you have write permissions for all folders If you donrsquot do this you may not be able to install the software See your network system administrator if you need to obtain super user password

If you want to install the software on a Sun Microsystems computer see the Sun web site or check with your Sun representative or network administrator Because the Sun installation is not officially supported by KRYSTALtrade DMS - Standard Edition those instructions are not repeated here

If you are installing from CD

Copy KRYSTAL_Setup_SEtargz to your directory

Un-tar the file using

tar ndashzxvf KRYSTAL_Setup_SEtargz

Important Note Copy the ldquoserverlicenserdquo file provided to you into KRYSTAL_HOMEconf folder

This will complete the setup of KRYSTALtrade DMS - Standard Edition on Linux UNIX based platform

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

6 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On completion of installation KRYSTALtrade DMS - Standard Edition is not ready for use You have to configure the KRYSTALtrade DMS - Standard Edition server for database and mail server integration

Please refer to Configuring KRYSTALtrade DMS - Standard Edition for more details

Starting KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server is installed as a Windows Service on Microsoft Windows platforms You can use services control panel to start and stop KRYSTALtrade DMS - Standard Edition

On Linux or Solaris distributions you can use the script ldquoStartServershrdquo located in KRYSTAL_HOMEbin folder to start the server

To verify the installation and configuration of KRYSTALtrade DMS - Standard Edition server you can open the browser and visit httplocalhost to get connected

If you are on a machine other than on which KRYSTALtrade DMS - Standard Edition is installed then visit httphostnameportno where hostname is the name IP address of the machine where it is installed and port number on which it is configured to be running

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

7 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Configuring KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server can be configured using System Configuration Wizard or using the Setup web application You can access the System Configuration Wizard on Windows based system using

Start -gt All Programs -gt KRYSTALtrade DMS - Standard Edition 80 -gt System Configuration Wizard

Or on completion of installation you can use wizard directly

On Linux or UNIX based system you can use Web setup application

System Configuration Wizard Follow the steps given below to configure KRYSTALtrade DMS - Standard Edition

Welcome screen is displayed click on Next button to continue

Database Configuration screen appears as shown below You can choose any database with which you would like to setup KRYSTALtrade DMS - Standard Edition Keep DBA user name and password ready for configuration

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

8 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On selection of database and clicking on Next button you will be presented with database parameter screen Input required parameter and click on Next button to continue

Enter other required database configuration parameters if required or click Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

9 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter server configuration parameters like server port auto login etc and click on Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

10 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter SMTP (Mail Settings) configuration parameters and click on Next button to continue the configuration wizard Review your settings Click on Execute button to execute configuration setting wizard The wizard will create a database called KRYSTALDB6 into your selected database

To complete System Configuration Wizard click on Finish button and exit

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 3: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

Table of Content

Installing KRYSTALtrade DMS - Standard Edition 1

System Requirements 1

Installation Procedure 2

Windows Installation 2

Linux Installation 5

Starting KRYSTALtrade DMS - Standard Edition 6

Configuring KRYSTALtrade DMS - Standard Edition 7

System Configuration Wizard 7

Setup ndash Web application 11

Administering KRYSTALtrade DMS - Standard Edition 12

Control Panel 12

Manage Users 13

New User 13

Edit User 14

Delete User 15

Manage Groups 16

New Group 16

Edit Group 17

Delete Group 17

Manage Roles 18

New Role 18

Edit Role 19

Delete Role 19

Manage Indexes 19

Add Index 20

Edit Index 21

Delete Index 21

Manage Document Classes 22

Add Document Class 22

Edit Document Class 23

Delete Document Classes 24

Manage Indexes 24

Add Index 25 Edit Index 25 Delete Index 25

Manage ACL Templates 26 Add ACL Template 26 Edit ACL Template 27 Delete ACL Template 27 Manage Permissions 27

Manage Checkouts 28

Manage Global Settings 29

Manage Jobs 30 Document Import Monitor 30 Document Expiry Processor 30 Document Expiry Notifier 31

System Reports 32

Repository Content Summary 32

Access History 33

Access History for Document Class 34

Recycle Bin 36

Conclusions 38

Further Reading 38

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

1 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Installing KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition is easy to use powerful and cost-effective document management software that allows companies to centralize the management storage retrieval and distribution of electronic as well as paper based documents

Built with robust scalable architecture KRYSTALtrade DMS - Standard Edition can be deployed over LAN WAN or Internet in organizations These products also empower individuals and organizations by acting as powerful knowledge management tools

KRYSTALtrade DMS - Standard Edition addresses the needs of many vertical markets including manufacturing architecture engineering and construction utilities universities and government agencies

System Requirements KRYSTALtrade DMS - Standard Edition software completely written in JAVA Technologies and supports ORACLE Microsoft SQL Server MySQL Apache Derby and POSTGRE SQL on any Operating System It is build in Java and uses an XML interface to exchange documents Hence it is fully platform independent all Windows Servers UNIX Servers and all IBM e-Servers are supported

Minimum System Requirements for KRYSTALtrade DMS - Standard Edition

Hardware Pentium IV RAM 1024 MB 20GB free hard disk space

Operating System (Server) Microsoft Windows 2003 2008 2012 Server Standard or higher

Microsoft Windows XP Professional Windows 7 Professional or higher

Red Hat Linux 71 or higher

Sun Solaris 100 or higher

Database Software (Server)

Microsoft SQL Server 2000 or higher

Oracle 90 or higher

MySQL 50 or higher

POSTGRE SQL 8o or higher

Software on the client side Internet Explorer 7x or Mozilla Firefox or Google Chrome

Additional software for end user

Java Runtime Environment 16 or higher

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

2 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Installation Procedure KRYSTALtrade DMS - Standard Edition is available on a CD-ROM or can be downloaded from httpwwwkrystaldmsin website

The installation process is very simple and straight forward

Windows Installation KRYSTALtrade DMS - Standard Edition Installation CD is setup so that installation onto Windows machine is automatic

If yoursquore installing from the CD insert it into your computerrsquos CD-ROM drive After a series of setup screens appears the installation process begins and the Welcome screen appears

Alternately you can execute run SetupSEexe available in the CD-ROM drive

Click on Next button the license agreement appears

Read the License Agreement in its entirety and then click ldquoI accept the terms in the License Agreementrdquo if you want to continue with the installation After accepting the license agreement you will be asked to select the installation folder

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

3 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Once you have selected the installation folder the setup wizard will be ready to install KRYSTALtrade DMS - Standard Edition

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

4 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Click Install button to continue

Installation progress screen is displayed

Click Finish button to complete the installation

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

5 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Copy ldquoserverlicenserdquo file provided to you by your vendor to KRYSTAL_HOMEconf directory and restart the KRYSTALtrade DMS - Standard Edition server where KRYSTAL_HOME is folder where you have installed the KRYSTALtrade DMS - Standard Edition

Linux Installation To install onto Linux system you must be logged in as a super user (with root privileges) so that you have write permissions for all folders If you donrsquot do this you may not be able to install the software See your network system administrator if you need to obtain super user password

If you want to install the software on a Sun Microsystems computer see the Sun web site or check with your Sun representative or network administrator Because the Sun installation is not officially supported by KRYSTALtrade DMS - Standard Edition those instructions are not repeated here

If you are installing from CD

Copy KRYSTAL_Setup_SEtargz to your directory

Un-tar the file using

tar ndashzxvf KRYSTAL_Setup_SEtargz

Important Note Copy the ldquoserverlicenserdquo file provided to you into KRYSTAL_HOMEconf folder

This will complete the setup of KRYSTALtrade DMS - Standard Edition on Linux UNIX based platform

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

6 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On completion of installation KRYSTALtrade DMS - Standard Edition is not ready for use You have to configure the KRYSTALtrade DMS - Standard Edition server for database and mail server integration

Please refer to Configuring KRYSTALtrade DMS - Standard Edition for more details

Starting KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server is installed as a Windows Service on Microsoft Windows platforms You can use services control panel to start and stop KRYSTALtrade DMS - Standard Edition

On Linux or Solaris distributions you can use the script ldquoStartServershrdquo located in KRYSTAL_HOMEbin folder to start the server

To verify the installation and configuration of KRYSTALtrade DMS - Standard Edition server you can open the browser and visit httplocalhost to get connected

If you are on a machine other than on which KRYSTALtrade DMS - Standard Edition is installed then visit httphostnameportno where hostname is the name IP address of the machine where it is installed and port number on which it is configured to be running

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

7 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Configuring KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server can be configured using System Configuration Wizard or using the Setup web application You can access the System Configuration Wizard on Windows based system using

Start -gt All Programs -gt KRYSTALtrade DMS - Standard Edition 80 -gt System Configuration Wizard

Or on completion of installation you can use wizard directly

On Linux or UNIX based system you can use Web setup application

System Configuration Wizard Follow the steps given below to configure KRYSTALtrade DMS - Standard Edition

Welcome screen is displayed click on Next button to continue

Database Configuration screen appears as shown below You can choose any database with which you would like to setup KRYSTALtrade DMS - Standard Edition Keep DBA user name and password ready for configuration

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

8 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On selection of database and clicking on Next button you will be presented with database parameter screen Input required parameter and click on Next button to continue

Enter other required database configuration parameters if required or click Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

9 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter server configuration parameters like server port auto login etc and click on Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

10 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter SMTP (Mail Settings) configuration parameters and click on Next button to continue the configuration wizard Review your settings Click on Execute button to execute configuration setting wizard The wizard will create a database called KRYSTALDB6 into your selected database

To complete System Configuration Wizard click on Finish button and exit

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 4: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

Add Index 25 Edit Index 25 Delete Index 25

Manage ACL Templates 26 Add ACL Template 26 Edit ACL Template 27 Delete ACL Template 27 Manage Permissions 27

Manage Checkouts 28

Manage Global Settings 29

Manage Jobs 30 Document Import Monitor 30 Document Expiry Processor 30 Document Expiry Notifier 31

System Reports 32

Repository Content Summary 32

Access History 33

Access History for Document Class 34

Recycle Bin 36

Conclusions 38

Further Reading 38

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

1 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Installing KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition is easy to use powerful and cost-effective document management software that allows companies to centralize the management storage retrieval and distribution of electronic as well as paper based documents

Built with robust scalable architecture KRYSTALtrade DMS - Standard Edition can be deployed over LAN WAN or Internet in organizations These products also empower individuals and organizations by acting as powerful knowledge management tools

KRYSTALtrade DMS - Standard Edition addresses the needs of many vertical markets including manufacturing architecture engineering and construction utilities universities and government agencies

System Requirements KRYSTALtrade DMS - Standard Edition software completely written in JAVA Technologies and supports ORACLE Microsoft SQL Server MySQL Apache Derby and POSTGRE SQL on any Operating System It is build in Java and uses an XML interface to exchange documents Hence it is fully platform independent all Windows Servers UNIX Servers and all IBM e-Servers are supported

Minimum System Requirements for KRYSTALtrade DMS - Standard Edition

Hardware Pentium IV RAM 1024 MB 20GB free hard disk space

Operating System (Server) Microsoft Windows 2003 2008 2012 Server Standard or higher

Microsoft Windows XP Professional Windows 7 Professional or higher

Red Hat Linux 71 or higher

Sun Solaris 100 or higher

Database Software (Server)

Microsoft SQL Server 2000 or higher

Oracle 90 or higher

MySQL 50 or higher

POSTGRE SQL 8o or higher

Software on the client side Internet Explorer 7x or Mozilla Firefox or Google Chrome

Additional software for end user

Java Runtime Environment 16 or higher

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

2 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Installation Procedure KRYSTALtrade DMS - Standard Edition is available on a CD-ROM or can be downloaded from httpwwwkrystaldmsin website

The installation process is very simple and straight forward

Windows Installation KRYSTALtrade DMS - Standard Edition Installation CD is setup so that installation onto Windows machine is automatic

If yoursquore installing from the CD insert it into your computerrsquos CD-ROM drive After a series of setup screens appears the installation process begins and the Welcome screen appears

Alternately you can execute run SetupSEexe available in the CD-ROM drive

Click on Next button the license agreement appears

Read the License Agreement in its entirety and then click ldquoI accept the terms in the License Agreementrdquo if you want to continue with the installation After accepting the license agreement you will be asked to select the installation folder

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

3 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Once you have selected the installation folder the setup wizard will be ready to install KRYSTALtrade DMS - Standard Edition

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

4 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Click Install button to continue

Installation progress screen is displayed

Click Finish button to complete the installation

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

5 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Copy ldquoserverlicenserdquo file provided to you by your vendor to KRYSTAL_HOMEconf directory and restart the KRYSTALtrade DMS - Standard Edition server where KRYSTAL_HOME is folder where you have installed the KRYSTALtrade DMS - Standard Edition

Linux Installation To install onto Linux system you must be logged in as a super user (with root privileges) so that you have write permissions for all folders If you donrsquot do this you may not be able to install the software See your network system administrator if you need to obtain super user password

If you want to install the software on a Sun Microsystems computer see the Sun web site or check with your Sun representative or network administrator Because the Sun installation is not officially supported by KRYSTALtrade DMS - Standard Edition those instructions are not repeated here

If you are installing from CD

Copy KRYSTAL_Setup_SEtargz to your directory

Un-tar the file using

tar ndashzxvf KRYSTAL_Setup_SEtargz

Important Note Copy the ldquoserverlicenserdquo file provided to you into KRYSTAL_HOMEconf folder

This will complete the setup of KRYSTALtrade DMS - Standard Edition on Linux UNIX based platform

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

6 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On completion of installation KRYSTALtrade DMS - Standard Edition is not ready for use You have to configure the KRYSTALtrade DMS - Standard Edition server for database and mail server integration

Please refer to Configuring KRYSTALtrade DMS - Standard Edition for more details

Starting KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server is installed as a Windows Service on Microsoft Windows platforms You can use services control panel to start and stop KRYSTALtrade DMS - Standard Edition

On Linux or Solaris distributions you can use the script ldquoStartServershrdquo located in KRYSTAL_HOMEbin folder to start the server

To verify the installation and configuration of KRYSTALtrade DMS - Standard Edition server you can open the browser and visit httplocalhost to get connected

If you are on a machine other than on which KRYSTALtrade DMS - Standard Edition is installed then visit httphostnameportno where hostname is the name IP address of the machine where it is installed and port number on which it is configured to be running

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

7 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Configuring KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server can be configured using System Configuration Wizard or using the Setup web application You can access the System Configuration Wizard on Windows based system using

Start -gt All Programs -gt KRYSTALtrade DMS - Standard Edition 80 -gt System Configuration Wizard

Or on completion of installation you can use wizard directly

On Linux or UNIX based system you can use Web setup application

System Configuration Wizard Follow the steps given below to configure KRYSTALtrade DMS - Standard Edition

Welcome screen is displayed click on Next button to continue

Database Configuration screen appears as shown below You can choose any database with which you would like to setup KRYSTALtrade DMS - Standard Edition Keep DBA user name and password ready for configuration

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

8 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On selection of database and clicking on Next button you will be presented with database parameter screen Input required parameter and click on Next button to continue

Enter other required database configuration parameters if required or click Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

9 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter server configuration parameters like server port auto login etc and click on Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

10 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter SMTP (Mail Settings) configuration parameters and click on Next button to continue the configuration wizard Review your settings Click on Execute button to execute configuration setting wizard The wizard will create a database called KRYSTALDB6 into your selected database

To complete System Configuration Wizard click on Finish button and exit

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 5: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

1 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Installing KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition is easy to use powerful and cost-effective document management software that allows companies to centralize the management storage retrieval and distribution of electronic as well as paper based documents

Built with robust scalable architecture KRYSTALtrade DMS - Standard Edition can be deployed over LAN WAN or Internet in organizations These products also empower individuals and organizations by acting as powerful knowledge management tools

KRYSTALtrade DMS - Standard Edition addresses the needs of many vertical markets including manufacturing architecture engineering and construction utilities universities and government agencies

System Requirements KRYSTALtrade DMS - Standard Edition software completely written in JAVA Technologies and supports ORACLE Microsoft SQL Server MySQL Apache Derby and POSTGRE SQL on any Operating System It is build in Java and uses an XML interface to exchange documents Hence it is fully platform independent all Windows Servers UNIX Servers and all IBM e-Servers are supported

Minimum System Requirements for KRYSTALtrade DMS - Standard Edition

Hardware Pentium IV RAM 1024 MB 20GB free hard disk space

Operating System (Server) Microsoft Windows 2003 2008 2012 Server Standard or higher

Microsoft Windows XP Professional Windows 7 Professional or higher

Red Hat Linux 71 or higher

Sun Solaris 100 or higher

Database Software (Server)

Microsoft SQL Server 2000 or higher

Oracle 90 or higher

MySQL 50 or higher

POSTGRE SQL 8o or higher

Software on the client side Internet Explorer 7x or Mozilla Firefox or Google Chrome

Additional software for end user

Java Runtime Environment 16 or higher

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

2 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Installation Procedure KRYSTALtrade DMS - Standard Edition is available on a CD-ROM or can be downloaded from httpwwwkrystaldmsin website

The installation process is very simple and straight forward

Windows Installation KRYSTALtrade DMS - Standard Edition Installation CD is setup so that installation onto Windows machine is automatic

If yoursquore installing from the CD insert it into your computerrsquos CD-ROM drive After a series of setup screens appears the installation process begins and the Welcome screen appears

Alternately you can execute run SetupSEexe available in the CD-ROM drive

Click on Next button the license agreement appears

Read the License Agreement in its entirety and then click ldquoI accept the terms in the License Agreementrdquo if you want to continue with the installation After accepting the license agreement you will be asked to select the installation folder

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

3 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Once you have selected the installation folder the setup wizard will be ready to install KRYSTALtrade DMS - Standard Edition

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

4 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Click Install button to continue

Installation progress screen is displayed

Click Finish button to complete the installation

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

5 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Copy ldquoserverlicenserdquo file provided to you by your vendor to KRYSTAL_HOMEconf directory and restart the KRYSTALtrade DMS - Standard Edition server where KRYSTAL_HOME is folder where you have installed the KRYSTALtrade DMS - Standard Edition

Linux Installation To install onto Linux system you must be logged in as a super user (with root privileges) so that you have write permissions for all folders If you donrsquot do this you may not be able to install the software See your network system administrator if you need to obtain super user password

If you want to install the software on a Sun Microsystems computer see the Sun web site or check with your Sun representative or network administrator Because the Sun installation is not officially supported by KRYSTALtrade DMS - Standard Edition those instructions are not repeated here

If you are installing from CD

Copy KRYSTAL_Setup_SEtargz to your directory

Un-tar the file using

tar ndashzxvf KRYSTAL_Setup_SEtargz

Important Note Copy the ldquoserverlicenserdquo file provided to you into KRYSTAL_HOMEconf folder

This will complete the setup of KRYSTALtrade DMS - Standard Edition on Linux UNIX based platform

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

6 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On completion of installation KRYSTALtrade DMS - Standard Edition is not ready for use You have to configure the KRYSTALtrade DMS - Standard Edition server for database and mail server integration

Please refer to Configuring KRYSTALtrade DMS - Standard Edition for more details

Starting KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server is installed as a Windows Service on Microsoft Windows platforms You can use services control panel to start and stop KRYSTALtrade DMS - Standard Edition

On Linux or Solaris distributions you can use the script ldquoStartServershrdquo located in KRYSTAL_HOMEbin folder to start the server

To verify the installation and configuration of KRYSTALtrade DMS - Standard Edition server you can open the browser and visit httplocalhost to get connected

If you are on a machine other than on which KRYSTALtrade DMS - Standard Edition is installed then visit httphostnameportno where hostname is the name IP address of the machine where it is installed and port number on which it is configured to be running

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

7 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Configuring KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server can be configured using System Configuration Wizard or using the Setup web application You can access the System Configuration Wizard on Windows based system using

Start -gt All Programs -gt KRYSTALtrade DMS - Standard Edition 80 -gt System Configuration Wizard

Or on completion of installation you can use wizard directly

On Linux or UNIX based system you can use Web setup application

System Configuration Wizard Follow the steps given below to configure KRYSTALtrade DMS - Standard Edition

Welcome screen is displayed click on Next button to continue

Database Configuration screen appears as shown below You can choose any database with which you would like to setup KRYSTALtrade DMS - Standard Edition Keep DBA user name and password ready for configuration

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

8 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On selection of database and clicking on Next button you will be presented with database parameter screen Input required parameter and click on Next button to continue

Enter other required database configuration parameters if required or click Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

9 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter server configuration parameters like server port auto login etc and click on Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

10 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter SMTP (Mail Settings) configuration parameters and click on Next button to continue the configuration wizard Review your settings Click on Execute button to execute configuration setting wizard The wizard will create a database called KRYSTALDB6 into your selected database

To complete System Configuration Wizard click on Finish button and exit

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 6: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

2 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Installation Procedure KRYSTALtrade DMS - Standard Edition is available on a CD-ROM or can be downloaded from httpwwwkrystaldmsin website

The installation process is very simple and straight forward

Windows Installation KRYSTALtrade DMS - Standard Edition Installation CD is setup so that installation onto Windows machine is automatic

If yoursquore installing from the CD insert it into your computerrsquos CD-ROM drive After a series of setup screens appears the installation process begins and the Welcome screen appears

Alternately you can execute run SetupSEexe available in the CD-ROM drive

Click on Next button the license agreement appears

Read the License Agreement in its entirety and then click ldquoI accept the terms in the License Agreementrdquo if you want to continue with the installation After accepting the license agreement you will be asked to select the installation folder

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

3 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Once you have selected the installation folder the setup wizard will be ready to install KRYSTALtrade DMS - Standard Edition

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

4 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Click Install button to continue

Installation progress screen is displayed

Click Finish button to complete the installation

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

5 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Copy ldquoserverlicenserdquo file provided to you by your vendor to KRYSTAL_HOMEconf directory and restart the KRYSTALtrade DMS - Standard Edition server where KRYSTAL_HOME is folder where you have installed the KRYSTALtrade DMS - Standard Edition

Linux Installation To install onto Linux system you must be logged in as a super user (with root privileges) so that you have write permissions for all folders If you donrsquot do this you may not be able to install the software See your network system administrator if you need to obtain super user password

If you want to install the software on a Sun Microsystems computer see the Sun web site or check with your Sun representative or network administrator Because the Sun installation is not officially supported by KRYSTALtrade DMS - Standard Edition those instructions are not repeated here

If you are installing from CD

Copy KRYSTAL_Setup_SEtargz to your directory

Un-tar the file using

tar ndashzxvf KRYSTAL_Setup_SEtargz

Important Note Copy the ldquoserverlicenserdquo file provided to you into KRYSTAL_HOMEconf folder

This will complete the setup of KRYSTALtrade DMS - Standard Edition on Linux UNIX based platform

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

6 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On completion of installation KRYSTALtrade DMS - Standard Edition is not ready for use You have to configure the KRYSTALtrade DMS - Standard Edition server for database and mail server integration

Please refer to Configuring KRYSTALtrade DMS - Standard Edition for more details

Starting KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server is installed as a Windows Service on Microsoft Windows platforms You can use services control panel to start and stop KRYSTALtrade DMS - Standard Edition

On Linux or Solaris distributions you can use the script ldquoStartServershrdquo located in KRYSTAL_HOMEbin folder to start the server

To verify the installation and configuration of KRYSTALtrade DMS - Standard Edition server you can open the browser and visit httplocalhost to get connected

If you are on a machine other than on which KRYSTALtrade DMS - Standard Edition is installed then visit httphostnameportno where hostname is the name IP address of the machine where it is installed and port number on which it is configured to be running

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

7 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Configuring KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server can be configured using System Configuration Wizard or using the Setup web application You can access the System Configuration Wizard on Windows based system using

Start -gt All Programs -gt KRYSTALtrade DMS - Standard Edition 80 -gt System Configuration Wizard

Or on completion of installation you can use wizard directly

On Linux or UNIX based system you can use Web setup application

System Configuration Wizard Follow the steps given below to configure KRYSTALtrade DMS - Standard Edition

Welcome screen is displayed click on Next button to continue

Database Configuration screen appears as shown below You can choose any database with which you would like to setup KRYSTALtrade DMS - Standard Edition Keep DBA user name and password ready for configuration

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

8 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On selection of database and clicking on Next button you will be presented with database parameter screen Input required parameter and click on Next button to continue

Enter other required database configuration parameters if required or click Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

9 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter server configuration parameters like server port auto login etc and click on Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

10 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter SMTP (Mail Settings) configuration parameters and click on Next button to continue the configuration wizard Review your settings Click on Execute button to execute configuration setting wizard The wizard will create a database called KRYSTALDB6 into your selected database

To complete System Configuration Wizard click on Finish button and exit

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 7: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

3 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Once you have selected the installation folder the setup wizard will be ready to install KRYSTALtrade DMS - Standard Edition

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

4 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Click Install button to continue

Installation progress screen is displayed

Click Finish button to complete the installation

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

5 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Copy ldquoserverlicenserdquo file provided to you by your vendor to KRYSTAL_HOMEconf directory and restart the KRYSTALtrade DMS - Standard Edition server where KRYSTAL_HOME is folder where you have installed the KRYSTALtrade DMS - Standard Edition

Linux Installation To install onto Linux system you must be logged in as a super user (with root privileges) so that you have write permissions for all folders If you donrsquot do this you may not be able to install the software See your network system administrator if you need to obtain super user password

If you want to install the software on a Sun Microsystems computer see the Sun web site or check with your Sun representative or network administrator Because the Sun installation is not officially supported by KRYSTALtrade DMS - Standard Edition those instructions are not repeated here

If you are installing from CD

Copy KRYSTAL_Setup_SEtargz to your directory

Un-tar the file using

tar ndashzxvf KRYSTAL_Setup_SEtargz

Important Note Copy the ldquoserverlicenserdquo file provided to you into KRYSTAL_HOMEconf folder

This will complete the setup of KRYSTALtrade DMS - Standard Edition on Linux UNIX based platform

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

6 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On completion of installation KRYSTALtrade DMS - Standard Edition is not ready for use You have to configure the KRYSTALtrade DMS - Standard Edition server for database and mail server integration

Please refer to Configuring KRYSTALtrade DMS - Standard Edition for more details

Starting KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server is installed as a Windows Service on Microsoft Windows platforms You can use services control panel to start and stop KRYSTALtrade DMS - Standard Edition

On Linux or Solaris distributions you can use the script ldquoStartServershrdquo located in KRYSTAL_HOMEbin folder to start the server

To verify the installation and configuration of KRYSTALtrade DMS - Standard Edition server you can open the browser and visit httplocalhost to get connected

If you are on a machine other than on which KRYSTALtrade DMS - Standard Edition is installed then visit httphostnameportno where hostname is the name IP address of the machine where it is installed and port number on which it is configured to be running

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

7 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Configuring KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server can be configured using System Configuration Wizard or using the Setup web application You can access the System Configuration Wizard on Windows based system using

Start -gt All Programs -gt KRYSTALtrade DMS - Standard Edition 80 -gt System Configuration Wizard

Or on completion of installation you can use wizard directly

On Linux or UNIX based system you can use Web setup application

System Configuration Wizard Follow the steps given below to configure KRYSTALtrade DMS - Standard Edition

Welcome screen is displayed click on Next button to continue

Database Configuration screen appears as shown below You can choose any database with which you would like to setup KRYSTALtrade DMS - Standard Edition Keep DBA user name and password ready for configuration

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

8 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On selection of database and clicking on Next button you will be presented with database parameter screen Input required parameter and click on Next button to continue

Enter other required database configuration parameters if required or click Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

9 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter server configuration parameters like server port auto login etc and click on Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

10 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter SMTP (Mail Settings) configuration parameters and click on Next button to continue the configuration wizard Review your settings Click on Execute button to execute configuration setting wizard The wizard will create a database called KRYSTALDB6 into your selected database

To complete System Configuration Wizard click on Finish button and exit

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 8: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

4 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Click Install button to continue

Installation progress screen is displayed

Click Finish button to complete the installation

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

5 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Copy ldquoserverlicenserdquo file provided to you by your vendor to KRYSTAL_HOMEconf directory and restart the KRYSTALtrade DMS - Standard Edition server where KRYSTAL_HOME is folder where you have installed the KRYSTALtrade DMS - Standard Edition

Linux Installation To install onto Linux system you must be logged in as a super user (with root privileges) so that you have write permissions for all folders If you donrsquot do this you may not be able to install the software See your network system administrator if you need to obtain super user password

If you want to install the software on a Sun Microsystems computer see the Sun web site or check with your Sun representative or network administrator Because the Sun installation is not officially supported by KRYSTALtrade DMS - Standard Edition those instructions are not repeated here

If you are installing from CD

Copy KRYSTAL_Setup_SEtargz to your directory

Un-tar the file using

tar ndashzxvf KRYSTAL_Setup_SEtargz

Important Note Copy the ldquoserverlicenserdquo file provided to you into KRYSTAL_HOMEconf folder

This will complete the setup of KRYSTALtrade DMS - Standard Edition on Linux UNIX based platform

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

6 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On completion of installation KRYSTALtrade DMS - Standard Edition is not ready for use You have to configure the KRYSTALtrade DMS - Standard Edition server for database and mail server integration

Please refer to Configuring KRYSTALtrade DMS - Standard Edition for more details

Starting KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server is installed as a Windows Service on Microsoft Windows platforms You can use services control panel to start and stop KRYSTALtrade DMS - Standard Edition

On Linux or Solaris distributions you can use the script ldquoStartServershrdquo located in KRYSTAL_HOMEbin folder to start the server

To verify the installation and configuration of KRYSTALtrade DMS - Standard Edition server you can open the browser and visit httplocalhost to get connected

If you are on a machine other than on which KRYSTALtrade DMS - Standard Edition is installed then visit httphostnameportno where hostname is the name IP address of the machine where it is installed and port number on which it is configured to be running

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

7 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Configuring KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server can be configured using System Configuration Wizard or using the Setup web application You can access the System Configuration Wizard on Windows based system using

Start -gt All Programs -gt KRYSTALtrade DMS - Standard Edition 80 -gt System Configuration Wizard

Or on completion of installation you can use wizard directly

On Linux or UNIX based system you can use Web setup application

System Configuration Wizard Follow the steps given below to configure KRYSTALtrade DMS - Standard Edition

Welcome screen is displayed click on Next button to continue

Database Configuration screen appears as shown below You can choose any database with which you would like to setup KRYSTALtrade DMS - Standard Edition Keep DBA user name and password ready for configuration

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

8 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On selection of database and clicking on Next button you will be presented with database parameter screen Input required parameter and click on Next button to continue

Enter other required database configuration parameters if required or click Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

9 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter server configuration parameters like server port auto login etc and click on Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

10 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter SMTP (Mail Settings) configuration parameters and click on Next button to continue the configuration wizard Review your settings Click on Execute button to execute configuration setting wizard The wizard will create a database called KRYSTALDB6 into your selected database

To complete System Configuration Wizard click on Finish button and exit

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 9: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

5 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Copy ldquoserverlicenserdquo file provided to you by your vendor to KRYSTAL_HOMEconf directory and restart the KRYSTALtrade DMS - Standard Edition server where KRYSTAL_HOME is folder where you have installed the KRYSTALtrade DMS - Standard Edition

Linux Installation To install onto Linux system you must be logged in as a super user (with root privileges) so that you have write permissions for all folders If you donrsquot do this you may not be able to install the software See your network system administrator if you need to obtain super user password

If you want to install the software on a Sun Microsystems computer see the Sun web site or check with your Sun representative or network administrator Because the Sun installation is not officially supported by KRYSTALtrade DMS - Standard Edition those instructions are not repeated here

If you are installing from CD

Copy KRYSTAL_Setup_SEtargz to your directory

Un-tar the file using

tar ndashzxvf KRYSTAL_Setup_SEtargz

Important Note Copy the ldquoserverlicenserdquo file provided to you into KRYSTAL_HOMEconf folder

This will complete the setup of KRYSTALtrade DMS - Standard Edition on Linux UNIX based platform

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

6 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On completion of installation KRYSTALtrade DMS - Standard Edition is not ready for use You have to configure the KRYSTALtrade DMS - Standard Edition server for database and mail server integration

Please refer to Configuring KRYSTALtrade DMS - Standard Edition for more details

Starting KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server is installed as a Windows Service on Microsoft Windows platforms You can use services control panel to start and stop KRYSTALtrade DMS - Standard Edition

On Linux or Solaris distributions you can use the script ldquoStartServershrdquo located in KRYSTAL_HOMEbin folder to start the server

To verify the installation and configuration of KRYSTALtrade DMS - Standard Edition server you can open the browser and visit httplocalhost to get connected

If you are on a machine other than on which KRYSTALtrade DMS - Standard Edition is installed then visit httphostnameportno where hostname is the name IP address of the machine where it is installed and port number on which it is configured to be running

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

7 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Configuring KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server can be configured using System Configuration Wizard or using the Setup web application You can access the System Configuration Wizard on Windows based system using

Start -gt All Programs -gt KRYSTALtrade DMS - Standard Edition 80 -gt System Configuration Wizard

Or on completion of installation you can use wizard directly

On Linux or UNIX based system you can use Web setup application

System Configuration Wizard Follow the steps given below to configure KRYSTALtrade DMS - Standard Edition

Welcome screen is displayed click on Next button to continue

Database Configuration screen appears as shown below You can choose any database with which you would like to setup KRYSTALtrade DMS - Standard Edition Keep DBA user name and password ready for configuration

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

8 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On selection of database and clicking on Next button you will be presented with database parameter screen Input required parameter and click on Next button to continue

Enter other required database configuration parameters if required or click Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

9 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter server configuration parameters like server port auto login etc and click on Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

10 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter SMTP (Mail Settings) configuration parameters and click on Next button to continue the configuration wizard Review your settings Click on Execute button to execute configuration setting wizard The wizard will create a database called KRYSTALDB6 into your selected database

To complete System Configuration Wizard click on Finish button and exit

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 10: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

6 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On completion of installation KRYSTALtrade DMS - Standard Edition is not ready for use You have to configure the KRYSTALtrade DMS - Standard Edition server for database and mail server integration

Please refer to Configuring KRYSTALtrade DMS - Standard Edition for more details

Starting KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server is installed as a Windows Service on Microsoft Windows platforms You can use services control panel to start and stop KRYSTALtrade DMS - Standard Edition

On Linux or Solaris distributions you can use the script ldquoStartServershrdquo located in KRYSTAL_HOMEbin folder to start the server

To verify the installation and configuration of KRYSTALtrade DMS - Standard Edition server you can open the browser and visit httplocalhost to get connected

If you are on a machine other than on which KRYSTALtrade DMS - Standard Edition is installed then visit httphostnameportno where hostname is the name IP address of the machine where it is installed and port number on which it is configured to be running

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

7 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Configuring KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server can be configured using System Configuration Wizard or using the Setup web application You can access the System Configuration Wizard on Windows based system using

Start -gt All Programs -gt KRYSTALtrade DMS - Standard Edition 80 -gt System Configuration Wizard

Or on completion of installation you can use wizard directly

On Linux or UNIX based system you can use Web setup application

System Configuration Wizard Follow the steps given below to configure KRYSTALtrade DMS - Standard Edition

Welcome screen is displayed click on Next button to continue

Database Configuration screen appears as shown below You can choose any database with which you would like to setup KRYSTALtrade DMS - Standard Edition Keep DBA user name and password ready for configuration

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

8 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On selection of database and clicking on Next button you will be presented with database parameter screen Input required parameter and click on Next button to continue

Enter other required database configuration parameters if required or click Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

9 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter server configuration parameters like server port auto login etc and click on Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

10 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter SMTP (Mail Settings) configuration parameters and click on Next button to continue the configuration wizard Review your settings Click on Execute button to execute configuration setting wizard The wizard will create a database called KRYSTALDB6 into your selected database

To complete System Configuration Wizard click on Finish button and exit

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 11: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

7 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Configuring KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard Edition server can be configured using System Configuration Wizard or using the Setup web application You can access the System Configuration Wizard on Windows based system using

Start -gt All Programs -gt KRYSTALtrade DMS - Standard Edition 80 -gt System Configuration Wizard

Or on completion of installation you can use wizard directly

On Linux or UNIX based system you can use Web setup application

System Configuration Wizard Follow the steps given below to configure KRYSTALtrade DMS - Standard Edition

Welcome screen is displayed click on Next button to continue

Database Configuration screen appears as shown below You can choose any database with which you would like to setup KRYSTALtrade DMS - Standard Edition Keep DBA user name and password ready for configuration

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

8 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On selection of database and clicking on Next button you will be presented with database parameter screen Input required parameter and click on Next button to continue

Enter other required database configuration parameters if required or click Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

9 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter server configuration parameters like server port auto login etc and click on Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

10 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter SMTP (Mail Settings) configuration parameters and click on Next button to continue the configuration wizard Review your settings Click on Execute button to execute configuration setting wizard The wizard will create a database called KRYSTALDB6 into your selected database

To complete System Configuration Wizard click on Finish button and exit

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 12: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

8 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

On selection of database and clicking on Next button you will be presented with database parameter screen Input required parameter and click on Next button to continue

Enter other required database configuration parameters if required or click Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

9 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter server configuration parameters like server port auto login etc and click on Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

10 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter SMTP (Mail Settings) configuration parameters and click on Next button to continue the configuration wizard Review your settings Click on Execute button to execute configuration setting wizard The wizard will create a database called KRYSTALDB6 into your selected database

To complete System Configuration Wizard click on Finish button and exit

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 13: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

9 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter server configuration parameters like server port auto login etc and click on Next button to continue the wizard

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

10 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter SMTP (Mail Settings) configuration parameters and click on Next button to continue the configuration wizard Review your settings Click on Execute button to execute configuration setting wizard The wizard will create a database called KRYSTALDB6 into your selected database

To complete System Configuration Wizard click on Finish button and exit

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 14: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

10 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Enter SMTP (Mail Settings) configuration parameters and click on Next button to continue the configuration wizard Review your settings Click on Execute button to execute configuration setting wizard The wizard will create a database called KRYSTALDB6 into your selected database

To complete System Configuration Wizard click on Finish button and exit

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 15: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

11 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Important Note Restart the KRYSTALtrade DMS ndash Standard Edition server using services control panel on Microsoft windows bases system

Setup ndash Web application Alternately you can use Setup Web application for Configuration of KRYSTALtrade DMS - Standard Edition server Once the server is installed and running you can use any standard internet browser to access the web based application to configure the server

Using web browser go to URL httplocalhost if you are working on the same computer where KRYSTALtrade DMS - Standard Edition is installed or go to httpmachinenameportno where machine name is name IP address of the computer running KRYSTALtrade DMS - Standard Edition and port no is where it is configured to run Generally it is default port 80

If the server is already configured then you will see login page for KRYSTALtrade DMS - Standard Edition server else you will see a configuration screen as shown below

Enter required parameters and click on Configure button The server will be configured with required database and other settings To start using KRYSTALtrade DMS - Standard Edition you will need to restart it

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 16: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

12 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administering KRYSTALtrade DMS - Standard Edition KRYSTALtrade DMS - Standard 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 username ADMINISTRATOR and by default password ldquoadminrdquo on the installation

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

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

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

The default administrator user name and password are administrator and admin respectively

Administrator can create other administrator users by assigning them System Administrators group

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 17: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

13 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Users On installation only a default administrator user is available After logging into KRYSTALtrade DMS - Standard Edition the administrator can create new users via Control Panel -gt Manage Users module

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 ldquoAdministratorrdquo 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

New User Administrators can add a new user by clicking on New User link available on the Manage User page

Enter details like username real name email password description etc and click on the Save 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 she 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 ldquoALLrdquo to view all the documents or she 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 18: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

14 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Edit User To editmodify 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

Administrators can modify details like

Real Name

User Email

User Description

Active

Access Type

Groups

Roles

Username is not available for modification

To set a user as administrator assign the ldquoSystem Administratorsrdquo group to the user

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 19: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

15 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Administrators can later revoke these privileges by un-assigning the ldquoSystem Administratorsrdquo group from the user on Edit User screen of Manage Users module

Delete User Administrators can delete users by clicking on Delete link associated with each user record On clicking a Confirmation is taken for 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 ldquoADMINISTRATORrdquo user cannot be deleted from the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 20: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

16 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Groups 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

Administrator can add edit or delete a group using this module

New Group 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

Select Role(s)

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 21: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

17 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

After entering required details and on clicking the Save button a new group is created

Edit Group 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 22: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

18 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Roles KRYSTALtrade DMS - Standard 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

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

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

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 23: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

19 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Edit Role To editmodify 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

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

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

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

Manage Indexes 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 classrsquos assigned indexes

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 24: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

20 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

KRYSTALtrade DMS - Standard Edition allows multiple metadata 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

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

Indexes can be any one of the following data types

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 25: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

21 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

String free text strings can be used to describe metadata 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

After entering required details and on clicking the Save 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 PRIMELEAFMUM and selected pattern is MMyyyy then the index value for this field would be PRIMELEAFMUM102012000001 (where 000001 is the document id generated by the system)

Edit Index 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

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

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

Delete Index 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 26: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

22 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage Document Classes 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 Invoicesrdquo ldquoPurchase Ordersrdquo ldquoShipping Confirmationsrdquo etc

Administrators can create any number of document classes using this module Each document class can contain any number of metadata 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

Document classes allow users to sortgroup documents based on similar characteristics

Document classes in addition controls the way documents can be stored the retention policy of the document and access permissions based on ACL templates assigned to it

Add Document Class 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 Save button to create the document class in to the system

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 27: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

23 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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 Save 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 ldquoPublicrdquo then all users irrespective of their access type will be able to access the documents If this is defined as ldquoUser Levelrdquo then users will be able to access only hisher documents if the Access Type of the user is ldquoSELFrdquo

Edit Document Class 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 28: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

24 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Delete Document Classes 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

Manage Indexes 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 29: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

25 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Add Index

To add an index administrator can select the index from the Index Name dropdown Only those indexes will be available which will be not currently available in the document class

Edit Index

Existing document indexes can be modified by changing the existing values on the Manage Indexes Page 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

Delete Index

Administrators can delete an index from a Document Class by clicking on the Delete link 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 30: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

26 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Manage ACL Templates 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

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 KRYSTALtrade DMS ndash Standard Edition

Add ACL Template

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 31: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

27 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Edit ACL Template

To editmodify 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

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

Delete ACL Template

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 be removed

Manage Permissions

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

EMAIL

CHECK-IN

CHECK-OUT

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 32: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

28 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Now administrator can assign required permission by clicking on the checkbox

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

Manage Checkouts 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 33: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

29 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

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

Manage Global Settings 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 o Customer ID o Customer Name o Expiry On o Server Name IP address o Total Number of user currently logged in o Total number of licenses available o Total number of users licenses

Database Settings o Database Server Name o Database Platform o Database Name o Instance Name o Database Username o Database Password o Database Port

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 34: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

30 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

Manage Jobs Manage Jobs module allows administrators to manage various scheduled jobs of KRYSTALtrade DMS - Standard Edition

Document Import Monitor Document Expiry Processor and Document Expiry Notifier are three main Jobs of the system Administrators can manage these predefined schedule jobs by using this module

Document Import Monitor

Document Import Monitor is a module which allows Administrators to import documents into KRYSTALtrade DMS - Standard Edition as a batch Using KRYSTALtrade CAPTURE Studio users can scan index and release documents to KRYSTALtrade DMS - Standard Edition

Documents created using KRYSTALtrade CAPTURE Studio gets imported by Document Import Monitor into KRYSTALtrade DMS - Standard 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)

Document Expiry Processor

This schedule 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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 35: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

31 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Document Expiry Notifier

This schedule 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

Currently the notifications are sent 7 days before the document is expiring

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 36: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

32 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

System Reports 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 4 types of Reports which the Administrators can view as shown below

Repository Content Summary

Access History

Access History for Document Class

Repository Content Summary View a statistical summary for repository resources It gives the statistical information regarding the User Groups Roles Document Classes and Documents

It also shows the resource count ie document count for each Document Class and the attachments also

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 37: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

33 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Access History 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 Following details are available in tabular format

Action

User

IP Address

Date Time

Type (of Object on which action is performed)

Parameters (Object ID etc)

Comments

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 38: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

34 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

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

On the click of Detailed History link the detailed history is provided for audit logs By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

Access History for Document Class 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

Following details are available in tabular format

Action

User

IP Address

Date Time

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 39: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

35 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Type (Document Class)

Parameters (Object ID etc)

Comments

Filter criteria is also defined on the basis of the date-range for more granular search On the click of Detailed History link the detailed history is provided of audit logs performed on the documents by the users By default it shows last 10 records and if more records are available then pagination is shown to go forward and back in the history

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 40: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

36 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Recycle Bin 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 View Deleted Documents link to view expired documents click on View Expired Documents link

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

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 41: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

37 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

To restore the document Administrators can click Restore Document link A popup window is displayed where Administrator can modify index values and define expiry period of the document and restore it back in the Document Class

Administrator can view the document by clicking on the document type icon associated with the deleted expired document record

To view the access history audit logs of activities performed on the document administrator can click on Access History icon associated with the delete expired document record

On confirmation selected document will be restored back in the Document Class

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID

Page 42: Primeleaf Consulting [P] Ltd€¦ · PRIMELEAF CONSULTING [P] LTD 29, Hendre Castle, D.S.Babrekar Marg, Gokhale Road (North), Dadar, Mumbai 400 028, India Tel No + 91 2447 3371

KRYSTALtrade DMS ndash Administratorrsquos Guide

Standard Edition ndash Version 80

38 | P a g e h t t p w w w k r y s t a l d m s i n h t t p w w w k r y s t a l d m s i n

Conclusions This document is a great help to users who wants to access and manage KRYSTALtrade DMS ndash Standard Edition

After having read it you will be able to administer KRYSTALtrade DMS ndash Standard Edition

Further Reading For comprehensive information on all features of KRYSTALtrade DMS ndash Standard Edition we recommend reading KRYSTALtrade DMS ndash Standard Edition Userrsquos Guide

In order to integrate KRYSTALtrade DMS with existing or custom developed applications using Web Services APIs please refer to KRYSTALtrade DMS ndash Standard Edition Web Services API Guide

Copyrights and Trademarks

Copyright 2001-2013 Primeleaf Consulting [P] Ltd India

All Rights Reserved This guide is subject to copyright protection

All other trademarks are acknowledged as the property of their respective owners

This document and the product to which it pertains are distributed under licenses restricting their use copying distribution and de-compilation No part of this document or of the associated product may be reproduced in any form by any means without prior written authorization of Primeleaf Consulting except when presenting only a summary of the tutorial and then linking to Primeleaf website (httpwwwprimeleafin) KRYSTAL DMS website (httpwwwkrystaldmsin)

DOCUMENTATION IS PROVIDED AS IS AND ALL EXPRESS OR IMPLIED CONDITIONS REPRESENTATIONS AND WARRANTIES INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT ARE DISCLAIMED EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID