Commit 46833ba412d780ef753f9b8d2921f29fb33b819b
1 parent
ce3cad44
KTS-2685
"Update Onscreen Help" Updated. Added new content from manuals (provided by Carolyn) Committed By: Philip Arkcoll Reviewed By: git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@8736 c91229c3-7414-0410-bfa2-8a42b809f60b
Showing
18 changed files
with
582 additions
and
168 deletions
kthelp/ktcore/EN/admin/admin-mode.html
| ... | ... | @@ -6,14 +6,28 @@ |
| 6 | 6 | |
| 7 | 7 | <body> |
| 8 | 8 | |
| 9 | -<h2>Administrator Mode</h2> | |
| 10 | 9 | <p> |
| 11 | -There are instances where systems administrators may be denied access to certain documents in the repository - management level documents containing classified information, for example. | |
| 10 | +Administrator mode is a system state that allows KnowledgeTree administrative users to override the permissions system, in an audited fashion, in order to access all documents in the system. With administrator mode enabled, Unit administrators will only be provided access to all documents in their Unit. | |
| 12 | 11 | </p> |
| 12 | +<br /> | |
| 13 | 13 | <p> |
| 14 | -However, because problems with these documents in the repository will also need to be fixed, administrators must be granted a way of overriding the controls in an audited manner that protects this information. | |
| 15 | -</p><p> | |
| 16 | -Enabling Administrator mode allows system and unit administrators to view and manage all documents in the system, including those documents where they are normally denied access. | |
| 14 | +Administrator mode provides an audited method of fixing errors on documents or in folders where even administrative users are usually denied access, such as content containing classified information. | |
| 15 | +</p> | |
| 16 | +<br /> | |
| 17 | +<p> | |
| 18 | +Note: Administrators are not able to delete immutable documents using the 'Delete' button in Browse Documents, even if they're working in Administrator mode. To delete an immutable document, use the 'Delete' action from the immutable document's Document Detail page. This ensures that immutable documents are only deleted one at a time, and avoids the mistaken deletion of an immutable document in a mass action delete. | |
| 19 | +</p> | |
| 20 | +<br /> | |
| 21 | +<h2>How to Enable and Disable Administrator Mode</h2> | |
| 22 | +<p> | |
| 23 | +<ul> | |
| 24 | +<li>1. Open Browse Documents.</li> | |
| 25 | +<li>2. Locate the Administrator mode menu; then, click the maximize icon to expand the Administrator mode menu.</li> | |
| 26 | + <ul> | |
| 27 | + <li>To ENABLE administrator mode, click 'Enable Admin Mode'. </li> | |
| 28 | + <li>To DISABLE administrator mode, click 'Disable Admin Mode'. </li> | |
| 29 | + </ul> | |
| 30 | + </ul> | |
| 17 | 31 | </p> |
| 18 | 32 | </body> |
| 19 | 33 | </html> | ... | ... |
kthelp/ktcore/EN/admin/archived documents.html
kthelp/ktcore/EN/admin/authentication sources.html
| 1 | -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | |
| 2 | -"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | |
| 3 | 1 | <html> |
| 4 | 2 | <head> |
| 5 | - <title>Authentication Sources</title> | |
| 3 | + <title>AUTHENTICATION SOURCES</title> | |
| 6 | 4 | </head> |
| 7 | 5 | |
| 8 | 6 | |
| 9 | 7 | <body> |
| 10 | -<h2>Authentication Sources</h2> | |
| 11 | -KnowledgeTree allows you to control access to the DMS for the users and groups in its database, using KnowledgeTree's own default authentication method - Database Authentication. | |
| 12 | -<br></br><br></br> | |
| 13 | -However, KnowledgeTree also allows you to add external authentication sources where your organization maintains its own list of users and groups that require controlled access to the DMS. | |
| 14 | -<br></br><br></br> | |
| 15 | -You can also modify or delete the details of external authentication sources and authentication provider information. | |
| 16 | -<br></br><br></br> | |
| 17 | -Note: You need to add the credentials of each user to KnowledgeTree (see Managing Users and Managing Groups) to allow the system to retrieve their details, even if you're using an external authentication source. | |
| 8 | +<h2>ABOUT AUTHENTICATION SOURCES</h2> | |
| 9 | +<br /> | |
| 10 | +<h3>KnowledgeTree Default - Database Authentication</h3> | |
| 11 | +<p> | |
| 12 | +By default, KnowledgeTree's inbuilt authentication method stores information about users and groups in the KnowledgeTree database, and retrieves this information to control access to the KnowledgeTree document management system (DMS). | |
| 13 | +</p> | |
| 14 | +<br /> | |
| 15 | +<h3>External Authentication Sources</h3> | |
| 16 | +<p> | |
| 17 | +If you want to maintain your own predefined user and group information to control access to KnowledgeTree, you can add users from a preconfigured external authentication source. | |
| 18 | +</p> | |
| 19 | +<br /> | |
| 20 | +<p> | |
| 21 | +When using external authentication sources, you need to add the authentication source, then, when adding your users to KnowledgeTree, select your preferred authentication source. When a user from your preferred authentication source first logs in to KnowledgeTree, their user credentials are automatically imported into KnowledgeTree. | |
| 22 | +</p> | |
| 23 | +<br /> | |
| 24 | +<h2>HOW TO VIEW / ADD / EDIT / DELETE AN EXTERNAL AUTHENTICATION SOURCE</h2> | |
| 18 | 25 | |
| 19 | -For more detail, please refer to the Administrator Manual. | |
| 26 | +<p> | |
| 27 | +<ul> | |
| 28 | +<li>1. In DMS Administration, click 'Users and Groups'.</li> | |
| 29 | +<li>2. To open the Authentication configuration page, click 'Authentication'.</li> | |
| 30 | +<li>3. What do you want to do?</li> | |
| 31 | +</ul> | |
| 32 | +</p> | |
| 33 | +<br /> | |
| 34 | +<p> | |
| 35 | +<h3>VIEW EXISTING EXTERNAL AUTHENTICATION SOURCES</h3> | |
| 36 | +<li>a. External authentication source that have been added to your system are listed on the page.</li> | |
| 37 | +</p> | |
| 38 | +<br /> | |
| 39 | +<p> | |
| 40 | +<h3>ADD A NEW EXTERNAL AUTHENTICATION SOURCE </h3> | |
| 41 | +<ul> | |
| 42 | +<li>a. To open the 'Add an authentication source' page, click 'Add a new authentication source'.</li> | |
| 43 | +<li>b. Define a name for the authentication source. </li> | |
| 44 | +<li>c. Select an authentication provider - by default, the pick list contains the standard options (LDAP, and Active Directory). To add more authentication providers, check the KnowledgeTree community forums at www.knowledgetree.com for developer information.</li> | |
| 45 | +<li>d. Click 'Add a new source'. </li> | |
| 46 | +<li>e. The authentication provider settings page opens, where you can edit the authentication provider settings.</li> | |
| 47 | +</ul> | |
| 48 | +</p> | |
| 49 | +<br /> | |
| 50 | +<p> | |
| 51 | +<h3>EDIT THE STANDARD CONFIGURATION FOR AN EXISTING AUTHENTICATION SOURCE (NAME AND PROVIDER)</h3> | |
| 52 | +<ul> | |
| 53 | +<li>a. On the Authentication page, view the list of existing authentication sources. </li> | |
| 54 | +<li>b. In the Edit column for the relevant listed authentication source, click the 'Edit' icon to open the 'Edit an authentication source' page. </li> | |
| 55 | +<li>c. Edit the authentication source name and/or the authentication provider.</li> | |
| 56 | +<li>d. Click 'Save'. </li> | |
| 57 | +</ul> | |
| 58 | +</p> | |
| 59 | +<br /> | |
| 60 | +<p> | |
| 61 | +<h3>EDIT AUTHENTICATION PROVIDER SETTINGS FOR AN EXISTING AUTHENTICATION SOURCE</h3> | |
| 62 | +<ul> | |
| 63 | +<li>a. On the Authentication page, view the list of existing authentication sources.</li> | |
| 64 | +<li>b. In the 'Edit Provider Information' column for the relevant listed authentication source, click the 'Edit' icon to open the 'Edit an authentication source' page. </li> | |
| 65 | +<li>c. Add or edit the following settings: server name, port, whether to use Transaction Layer Security, base DN, search user, search password, search attributes, object classes. </li> | |
| 66 | +<li>d. Click 'Save'. </li> | |
| 67 | +</ul> | |
| 68 | +</p> | |
| 69 | +<br /> | |
| 70 | +<p> | |
| 71 | +<h3>DELETE AN AUTHENTICATION SOURCE</h3> | |
| 72 | +<ul> | |
| 73 | +<li>a. On the Authentication page, view the list of existing authentication sources. </li> | |
| 74 | +<li>b. Click the Delete icon for the authentication source you want to remove.</li> | |
| 75 | +</ul> | |
| 76 | +</p> | |
| 20 | 77 | |
| 21 | 78 | </body> |
| 22 | 79 | </html> | ... | ... |
kthelp/ktcore/EN/admin/automatic workflows.html
| ... | ... | @@ -11,7 +11,7 @@ |
| 11 | 11 | Automatic workflows allow you to define the conditions for automatically assigning a |
| 12 | 12 | specific workflow to a document.</p><p> |
| 13 | 13 | Workflow assignment may occur on a per folder basis or on a per document type |
| 14 | -basis. Only one mode may be selected for a particular system.</p> | |
| 14 | +basis. Only one mode may be selected for a particular system. </p> | |
| 15 | 15 | |
| 16 | 16 | </body> |
| 17 | 17 | -</html> |
| 18 | +</html> | |
| 18 | 19 | \ No newline at end of file | ... | ... |
kthelp/ktcore/EN/admin/control units.html
| 1 | -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | |
| 2 | -"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | |
| 3 | 1 | <html> |
| 4 | 2 | <head> |
| 5 | 3 | <title>Unit Administration</title> |
| 6 | 4 | </head> |
| 7 | 5 | <body> |
| 8 | 6 | <h2>Unit Administration</h2> |
| 9 | -<p>KnowledgeTree provides Units as a means of organizing groups. Units may be used to model your organization's business units.</p> | |
| 10 | 7 | <p> |
| 11 | -<strong>Note:</strong> By default, each time a new Unit is created on the system, a Unit folder is created in the Organization (root) directory.</p> | |
| 8 | +KnowledgeTree's <b>Unit</b> concept allows you to arrange the content of your document management system into standalone, separately managed sections. | |
| 9 | +</p> | |
| 10 | +<br /> | |
| 11 | +<p> | |
| 12 | +For example, you may want to create Units that match the business model of your organization, such as a Unit folder for each department or regional office. | |
| 13 | +</p> | |
| 14 | +<br /> | |
| 15 | +<p> | |
| 16 | +Units are also useful where you want to restrict access to certain parts of the DMS for specific users. User-level control is thus set up for specific Units - when these users log on, they will see only the Unit folder/s where they have been granted at least the 'read' permission. All other system folders and files are hidden. | |
| 17 | +</p> | |
| 18 | +<br /> | |
| 19 | +<p> | |
| 20 | +As with other system folders, Unit level access is controlled through KnowledgeTree's permissions system, by user group, and on specific folders. | |
| 21 | +</p> | |
| 22 | +<br /> | |
| 23 | +<p> | |
| 24 | +<b>Note:</b> By default, new Unit folders are added to the root directory, but you can specify a different location in the DMS. | |
| 25 | +</p> | |
| 26 | +<br /> | |
| 27 | +<p> | |
| 28 | +The KnowledgeTree system administrator adds Units, and assigns Unit administrator privileges to one or more users who are responsible for managing content and users in their Unit. The system administrator retains administrator privileges over the entire DMS, including all Units. | |
| 29 | +</p> | |
| 12 | 30 | </body> |
| 13 | 31 | </html> | ... | ... |
kthelp/ktcore/EN/admin/deleted documents.html
| ... | ... | @@ -4,16 +4,14 @@ |
| 4 | 4 | <head> |
| 5 | 5 | <title>Deleted Documents</title> |
| 6 | 6 | </head> |
| 7 | - | |
| 8 | - | |
| 9 | 7 | <body> |
| 10 | 8 | <h2>Deleted Documents</h2> |
| 11 | 9 | <p> |
| 12 | -This page allows you to restore or expunge documents that have been deleted in the KnowledgeTree repository. | |
| 13 | -</p><p> | |
| 14 | -<strong>Note:</strong> Expunging saves disk space by permanently deleting documents that are no longer useful or required. | |
| 15 | -</p><p> | |
| 16 | -<strong>Note:</strong> By default, documents are restored to the folder location where they were originally deleted. If that folder no longer exists on the system, the document is restored to the root directory in the repository. | |
| 10 | +Documents that are deleted from Browse Documents in the DMS are not permanently deleted - they are 'soft deleted' and hidden from view until the system administrator restores those documents or permanently removes them from the system (expunge). | |
| 11 | +</p> | |
| 12 | +<br /> | |
| 13 | +<p> | |
| 14 | +Expunging deleted documents frees up disk space in your system. Restored documents are returned to their original folder location or to the root directory if the original folder no longer exists. | |
| 17 | 15 | </p> |
| 18 | 16 | </body> |
| 19 | 17 | </html> | ... | ... |
kthelp/ktcore/EN/admin/document checkout.html
| ... | ... | @@ -8,13 +8,13 @@ |
| 8 | 8 | |
| 9 | 9 | |
| 10 | 10 | <body> |
| 11 | -<h2>Document Checkout</h2> | |
| 11 | +<h2>Override Document Check out</h2> | |
| 12 | 12 | <p> |
| 13 | -This page lets you override the currently checked out status of a document and forces the document to be checked back in to the repository. | |
| 14 | -</p><p> | |
| 15 | -Forced check ins are used where a checked out document is urgently required back in the repository so that another user can check it out. | |
| 16 | -</p><p> | |
| 17 | -<strong>Note:</strong> The document is checked back in to the repository without saving any changes that may have been made to it while it was checked out. | |
| 13 | +The KnowledgeTree administrator may override the checked-out status of a document to force a document back in to the repository. This action restores the content version of the document as it was before it was checked out. | |
| 14 | +</p> | |
| 15 | +<br /> | |
| 18 | 16 | <p> |
| 17 | +Forced check-in is used when a checked out document is urgently required back in the repository so that another user can check out the document to update it, and the original document is no longer available and/or the user who checked that document out is not available to check-in the document. | |
| 18 | +</p> | |
| 19 | 19 | </body> |
| 20 | 20 | </html> | ... | ... |
kthelp/ktcore/EN/admin/document fieldsets.html
| ... | ... | @@ -5,57 +5,74 @@ |
| 5 | 5 | <title>Document Fieldsets</title> |
| 6 | 6 | </head> |
| 7 | 7 | <body> |
| 8 | -<h2>Document Fieldsets</h2> | |
| 9 | 8 | <p> |
| 10 | -Document Fieldsets allow you to associate custom metadata with documents in the | |
| 11 | -repository. | |
| 9 | +A <b>Fieldset</b> is a collection of Fields that may be associated with a specific Document Type, or with all Document Types in the system. | |
| 12 | 10 | </p> |
| 11 | +<br /> | |
| 13 | 12 | <p> |
| 14 | -There are two types of document fieldsets: | |
| 13 | +<h3>Types of Fields</h3> | |
| 14 | +There are three types of fields: | |
| 15 | 15 | <ul> |
| 16 | -<li><strong>Normal</strong> - users are allowed to edit normal fieldsets only if they have been | |
| 17 | - associated with the document type that is being edited.</li> | |
| 18 | -<li><strong>Generic</strong> - users may add and edit generic fieldsets to any document type in | |
| 19 | - KnowledgeTree.</li> | |
| 16 | +<li><b>Normal</b> - stores text metadata, such as invoice code</li> | |
| 17 | +<li><b>Lookup</b> - contains a list of selectable options that display in a pick list</li> | |
| 18 | +<li><b>Tree</b> - allows you to select metadata values by browsing a tree structure</li> | |
| 20 | 19 | </ul> |
| 21 | 20 | </p> |
| 22 | -<p> | |
| 23 | -<strong>Note:</strong> KnowledgeTree auto-generates an editable system name (namespace) for every | |
| 24 | -fieldset. Plug-ins use this namespace to call the fieldset, and to control how the fieldset works. | |
| 25 | -For more information on developing Plug-ins for KnowledgeTree, see the KnowledgeTree Wiki | |
| 26 | -at <a href ="http://support.knowledgetree.com/confluence/">http://support.knowledgetree.com/confluence/</a> | |
| 27 | -</p> | |
| 28 | - | |
| 29 | -<h2>Document Fields</h2> | |
| 21 | +<br /> | |
| 22 | +<p> | |
| 23 | +<h3>Types of Fieldsets</h3> | |
| 30 | 24 | <p> |
| 31 | -KnowledgeTree uses fields to group sets of related information into predefined | |
| 32 | -fieldsets. The custom fieldsets are then associated with specific document types, to | |
| 33 | -define the information (metadata) that should be included on documents of that | |
| 34 | -type.</p> | |
| 25 | +The following two fieldset types are KnowledgeTree defaults: | |
| 26 | +</p> | |
| 35 | 27 | <p> |
| 36 | -There are three classes of custom fields in KnowledgeTree: | |
| 28 | +<b>Note:</b> You can add plugins to KnowledgeTree that add different types of fieldsets, if required. | |
| 29 | +</p> | |
| 30 | +<p> | |
| 37 | 31 | <ul> |
| 38 | -<li><strong>Normal</strong> - stores text metadata, such as invoice code</li> | |
| 39 | -<li><strong>Lookup</strong> - used to allow users to select from a predefined set of options</li> | |
| 40 | -<li><strong>Tree</strong> - used to allow users to select a metadata value by browsing a tree structure</li> | |
| 41 | -</ul> | |
| 32 | +<li><b>Normal</b> - may contain a variety of field types, i.e. one or more, or a combination, of Lookup field's, Tree field's, and Normal field's.</li> | |
| 33 | +<li><b>Conditional</b> - contains two or more Lookup fields. This fieldset must be configured in the Fieldset editing pages after you add the fieldset, in order to set one field as the 'master' field, and to define how user-selected values in the master field determine the display of subsequent fields and values that are presented when the user adds document metadata. Since conditional fieldsets comprise a collection of interdependent fields and values, you need to plan the fieldset structure before creating the fieldset in the DMS. To use this feature, enable the 'Conditional Metadata' plugin in <b>DMS Administration >> Miscellaneous</b></li> | |
| 34 | +</ul>. | |
| 42 | 35 | </p> |
| 43 | -<h3>Managing Tree Fields</h3> | |
| 44 | - | |
| 36 | +<h3>Generic Fieldsets</h3> | |
| 45 | 37 | <p> |
| 46 | -Trees can have multiple sub-categories and levels. You need to add sub-categories at | |
| 47 | -each level in order to organize the options into a 'tree'.</p> | |
| 38 | +A fieldset that is defined as 'generic' is automatically associated with each document type you add to the repository. Define a fielset as 'generic' when adding or editing the fieldset. | |
| 39 | +</p> | |
| 40 | +<br /> | |
| 41 | +<p> | |
| 42 | +<h3>Working with Fieldsets</h3> | |
| 43 | +How to View Existing Fieldsets | |
| 44 | +<p> | |
| 45 | +<li>1. To open the Fieldset management page, click Document Fieldsets in Document Metadata and Workflow Configuration.</li> | |
| 46 | +<li>2. On the Document Fieldsets page, view existing fieldsets listed in the table.</li> | |
| 47 | +</p> | |
| 48 | +<br /> | |
| 49 | +<p> | |
| 50 | +<h3>How to Add a New Fieldset</h3> | |
| 48 | 51 | <p> |
| 49 | -The top level of the tree is called the root. The root, which holds all the top level | |
| 50 | -items, is not shown to the user, but it provides a single 'parent' to the top level items.</p> | |
| 52 | +<li>1. On the Fieldset management page in DMS Administration, click Create New Fieldset.</li> | |
| 53 | +<li>2. Define a name for the fieldset in the Fieldset Name field; then, add a description in the Description field.</li> | |
| 54 | +<li>3. In the Fieldset Type section, define whether the fieldset is 'Normal' or Conditional'; then, define whether this is a 'generic' fieldset.</li> | |
| 55 | +<li>4. Click Create Fieldset.</li> | |
| 56 | +</p> | |
| 57 | +<br /> | |
| 58 | +<p> | |
| 59 | +<h3>How to Add a New Conditional Fieldset</h3> | |
| 60 | +<p> | |
| 61 | +Before you begin, plan the fieldset, and its lookup fields and lookup values. | |
| 62 | +</p> | |
| 63 | +<br /> | |
| 64 | +<p> | |
| 65 | +<ul> | |
| 66 | +<li>1. Add a new fieldset, and define the fieldset as 'Conditional'.</li> | |
| 67 | +<li>2. On the Edit Fieldset page, click Add New Field to add two or more lookup fields to this fieldset, and add lookup values for each field.</li> | |
| 68 | +<li>3. Once you have added all the fields and their lookup fields, set one field as the 'master' field - click Manage Field Ordering on the Edit Fieldset page.</li> | |
| 69 | +<li>4. Define the control field / dependent field relationship between all fields in the fieldset, starting with the master field - click Manage Field Ordering on the Edit Fieldset page. Repeat this step until all fields have been ordered into the control / dependent structure.</li> | |
| 70 | +<li>5. Edit fieldset rules to define conditional behaviour. To do this, click Manage Conditional Behaviour on the Edit Fieldset page.</li> | |
| 71 | +<li>6. For each control field, select a lookup value; then, select two or more lookup values in the dependent field - the dependent field values will display when the user selects the control field lookup value in the conditional fieldset. Click save this dependency to save each behaviour; then, when you're ready to configure the next field, click edit field.</li> | |
| 72 | +<li>7. When fieldset rules (conditional behaviour) have been set up on all control/dependent fields, click View Overview on the Edit Fieldset page to walk through a test of the fieldset you created.</li> | |
| 73 | +</ul> | |
| 74 | +</p> | |
| 75 | +<br /> | |
| 51 | 76 | <p> |
| 52 | -For example, let's say you create a tree of the countries in the world. In this case, the | |
| 53 | -actual countries would be keywords - e.g. South Africa, England, Singapore, etc. And | |
| 54 | -the highest group of categories (the top level or 'root') would be continents - e.g. | |
| 55 | -Africa, Europe, Asia etc. The sub-categories, which fall below the top level 'continents' | |
| 56 | -could be 'regions' - e.g. Sub-Saharan Africa, Western Europe, South East Asia.</p><p> | |
| 57 | -KnowledgeTree allows you to create more sophisticated tree fields on the Edit | |
| 58 | -Lookup Tree page.</p> | |
| 59 | - | |
| 60 | 77 | </body> |
| 61 | 78 | -</html> |
| 79 | +</html> | |
| 62 | 80 | \ No newline at end of file | ... | ... |
kthelp/ktcore/EN/admin/document types.html
| ... | ... | @@ -2,44 +2,90 @@ |
| 2 | 2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| 3 | 3 | <html> |
| 4 | 4 | <head> |
| 5 | - <title>Archived Documents</title> | |
| 5 | +<title>Document Types</title> | |
| 6 | 6 | </head> |
| 7 | 7 | <body> |
| 8 | -<h2>Archived Documents</h2> | |
| 8 | +<h2>Document Types</h2> | |
| 9 | 9 | <p> |
| 10 | -Document Types are used to group together documents that have a similar function. | |
| 11 | -They also allow you to associate custom fieldsets for specific information that must be | |
| 12 | -included with a particular document type. | |
| 10 | +KnowledgeTree uses Document Types to group documents in the repository. This allows you to search for and manage your documents by 'Document Type', e.g. Invoice, Report, Template, Order, etc. | |
| 13 | 11 | </p> |
| 14 | -Let's say you create a document type called 'Invoice', and you want to ensure that | |
| 15 | -all documents of the type 'Invoice' contain the following fields: invoice number, | |
| 16 | -customer name, delivery address. You can group these fields in a fieldset called | |
| 17 | -Invoice Details, for example. And then you may want to create another fieldset for | |
| 18 | -the monetary values in the invoice, which you could call 'Amount'. The fieldset | |
| 19 | -Amount may include the following fields: Nett Item Value, Tax, Discount, and | |
| 20 | -Total Due. | |
| 12 | +<br /> | |
| 21 | 13 | <p> |
| 22 | -There are two ways you can configure the document type - Invoice - and the | |
| 23 | -fieldsets you want to associate with this document type. | |
| 14 | +For each Document Type, you can create a collection of fields, called 'fieldsets', and then associate the fieldsets (one or more) with selected Document Types. For example, for an 'Invoice' document type, you could create a fieldset called 'Invoice Details', for which you can create a collection of fields, such as: Invoice Number, Customer Name, Date, etc. When a user adds a document of the type 'Invoice', the fields display, and the user is required to enter field values, such as the invoice number, the name of the customer, and the date. When adding fieldsets and fields, you can specify whether they are 'required' - i.e. whether the user is must enter values for those fields. | |
| 24 | 15 | </p> |
| 25 | - | |
| 16 | +<br /> | |
| 26 | 17 | <p> |
| 27 | -1. You can first create the document type in the Document Types section, and then | |
| 28 | -create one or more custom fieldsets in the Document Fieldsets section. The | |
| 29 | -collection of fieldsets you define are automatically listed in the Document Type | |
| 30 | -editing page. Having created the fieldset(s), you need to edit the document type you | |
| 31 | -created in order to to add (associate) the fieldset(s) you want to use in this document | |
| 32 | -type. | |
| 18 | +<b>Note:</b> Fields, Fieldsets, and Document Type are Metadata - they are descriptive references for documents in the repository. | |
| 33 | 19 | </p> |
| 20 | +<br /> | |
| 34 | 21 | <p> |
| 35 | -2. Alternatively, you can first create a set of custom fieldsets in the Document | |
| 36 | -Fieldsets section, and then create the document type. Having added the document | |
| 37 | -type, KnowledgeTree automatically opens the Document Type editing page, where | |
| 38 | -you can select the fieldsets out of the collection of fieldsets you have pre-defined in | |
| 39 | -Document Fieldsets, and which now display on the Document Type editing page. | |
| 22 | +<h2>Working with Document Types</h2> | |
| 40 | 23 | </p> |
| 24 | +<br /> | |
| 41 | 25 | <p> |
| 42 | -<b>Note:</b> Document types cannot be deleted in KnowledgeTree; they can only be disabled. Since a document type may be associated with a large amount of documents, deleting a document type may cause the loss of required metadata. | |
| 26 | +<h3>How to Add a New Document Type</h3> | |
| 27 | +<ul> | |
| 28 | +<li>1. On the Document Types page, enter a name for the new document type in the Name field.</li> | |
| 29 | +<li>2. Click Create.</li> | |
| 30 | +<li>3. On the document type configuration screen that displays, you can:</li> | |
| 31 | +<ul> | |
| 32 | +<li>change the document type name (click Change to save the new document type name)</li> | |
| 33 | +<li>associate one or more fieldsets with this document type (available fieldsets are listed in the Available Fieldsets menu; or you can add more fieldsets in the Fieldset configuration section of DMS Administration, and then return to this page to associate additional fieldsets). When you're done, click Associate Fieldsets.</li> | |
| 34 | +</ul> | |
| 35 | +</ul> | |
| 36 | +</p> | |
| 37 | +<br /> | |
| 38 | +<p> | |
| 39 | +<h3>How to View Existing Document Types</h3> | |
| 40 | +<ul> | |
| 41 | +<li>1. Existing document types are listed in a table on the Document Types page. The table provides access to the following configuration options:</li> | |
| 42 | +<ul> | |
| 43 | +<li>Edit document type (edit document type name and associated fieldsets)</li> | |
| 44 | +<li>Enable / disable the document type</li> | |
| 45 | +<li>Delete document type (if the document type may be deleted)</li> | |
| 46 | +</ul> | |
| 47 | +</ul> | |
| 48 | +</p> | |
| 49 | +<br /> | |
| 50 | +<p> | |
| 51 | +<h3>How to Edit a Document Type</h3> | |
| 52 | +<ul> | |
| 53 | +<li>1. View existing document types in the table on the Document Types page.</li> | |
| 54 | +</p> | |
| 55 | +<br /> | |
| 56 | +<p> | |
| 57 | +<li>2. Do you want to ...</li> | |
| 58 | +<ul> | |
| 59 | +<li>change the document type name? Click the Edit icon in the Edit column for the relevant document type. On the editing screen, change the name of the document type. Click Change.</li> | |
| 60 | +<li>associate or disassociate fieldsets on a document type? Click the Edit icon in the Edit column for the relevant document type. To associate fieldsets, on the editing screen, select fieldsets in the menu; then, click Associate Fieldsets; Or, to disassociate fieldsets, on the editing screen, select fieldsets you want to remove from this document type; then, click Disassociate Fieldsets.</li> | |
| 61 | +</ul> | |
| 62 | +</ul> | |
| 63 | +</p> | |
| 64 | +<br /> | |
| 65 | +<p> | |
| 66 | +<h3>ENABLE OR DISABLE A DOCUMENT TYPE</h3> | |
| 67 | +<ul> | |
| 68 | +<li>1. View existing document types in the table on the Document Types page.</li> | |
| 69 | +<li>2. Click on the icon in the Enable/Disable column for the relevant document type. If the document type is currently disabled, clicking the icon enables the document type; if the document type is currently enabled, clicking the icon disables the document type.</li> | |
| 70 | +</ul> | |
| 71 | +</p> | |
| 72 | +<br /> | |
| 73 | +<p> | |
| 74 | +<h3>EDIT A FIELDSET ASSOCIATED WITH A DOCUMENT TYPE</h3> | |
| 75 | +<ul> | |
| 76 | +<li>1. View existing document types in the table on the Document Types page.</li> | |
| 77 | +<li>2. Click on the fieldset you want to edit (listed in the Associated Fieldsets column for the relevant document type).</li> | |
| 78 | +<li>3. On the Edit Fieldset page, to edit the fieldset name, description, and to define whether the fieldset is generic, click Edit these details); you can also manage (add, edit, or remove) fields in the fieldset.</li> | |
| 79 | +</ul> | |
| 80 | + </p> | |
| 81 | +<br /> | |
| 82 | +<p> | |
| 83 | +<h3>DELETE A DOCUMENT TYPE</h3> | |
| 84 | +<ul> | |
| 85 | +<li>1. View existing document types in the table on the Document Types page.</li> | |
| 86 | +<li>2. Click the delete icon in the Delete column for the relevant document type.</li> | |
| 87 | +<b>Note:</b> You may only delete document types that have no associated documents in the repository - i.e. you cannot delete the 'Invoice' document type if you have documents in the repository of the type 'Invoice'. This prevents the removal of required metadata. You may however 'disable' a document type if you have no further use for it. | |
| 88 | +</ul> | |
| 43 | 89 | </p> |
| 44 | 90 | </body> |
| 45 | 91 | -</html> |
| 92 | +</html> | |
| 46 | 93 | \ No newline at end of file | ... | ... |
kthelp/ktcore/EN/admin/dynamic conditions.html
| ... | ... | @@ -7,13 +7,31 @@ |
| 7 | 7 | <body> |
| 8 | 8 | <h2>Dynamic Conditions</h2> |
| 9 | 9 | <p> |
| 10 | -You use KnowledgeTree's Dynamic Conditions feature to set up the rules that will determine the permissions that may be applied to documents within a folder.These rules may be applied to a document's metadata, to its contents, or to its transactional information. Dynamic Conditions are applied on a per folder basis, and may be set up in the folder's Folder permissions page. | |
| 11 | -</p><p> | |
| 12 | -Having created a new dynamic condition, you need to assign it to a folder. You can also unassign dynamic conditions when they're no longer useful for the folder. </p><p> | |
| 13 | - | |
| 14 | -<strong>Note:</strong> Dynamic Conditions are configured in the same way as Saved Searches. | |
| 15 | -</p><p> | |
| 16 | -<strong>Note:</strong> Having defined a dynamic condition, you cannot delete it because that may change permission assignments. | |
| 10 | +A dynamic condition filters content in the system to selectively apply permissions to documents that meet the criteria of the condition. | |
| 11 | +</p> | |
| 12 | +<br /> | |
| 17 | 13 | <p> |
| 14 | +After creating the dynamic condition you need to associate permissions with it on the Folder Permissions management page in Browse Documents. | |
| 15 | +</p> | |
| 16 | +<br /> | |
| 17 | +<p> | |
| 18 | +<h3>Dynamic Conditions and Workflows</h3> | |
| 19 | +</p> | |
| 20 | +<p> | |
| 21 | +Dynamic Conditions are also used to create Guard permissions, which are required to perform transitions on Workflows. | |
| 22 | +</p> | |
| 23 | +<br /> | |
| 24 | +<p> | |
| 25 | +<h3>Viewing / Adding / Editing / Running Dynamic Conditions</h3> | |
| 26 | +</p> | |
| 27 | +<p> | |
| 28 | +On the Dynamic Conditions page you can perform the following actions: | |
| 29 | +<ul> | |
| 30 | +<li>View existing dynamic conditions</li> | |
| 31 | +<li>Add a new dynamic condition</li> | |
| 32 | +<li>Edit an existing dynamic condition - add/remove/or edit criteria</li> | |
| 33 | +<li>Run a dynamic condition to test results</li> | |
| 34 | +</ul> | |
| 35 | +</p> | |
| 18 | 36 | </body> |
| 19 | 37 | </html> | ... | ... |
kthelp/ktcore/EN/admin/help administration.html
| ... | ... | @@ -6,18 +6,43 @@ |
| 6 | 6 | </head> |
| 7 | 7 | <body> |
| 8 | 8 | <h2>Help Administration</h2> |
| 9 | - | |
| 9 | +KnowledgeTree Document Management System contains several built-in Help files. | |
| 10 | +</p> | |
| 11 | +<br /> | |
| 12 | +<p> | |
| 13 | +You can access Help for the page you're on, wherever you see this icon <b><font color='blue'>(?)</font></b> in the bar at the top right of the page. The Help file that displays provides information on using the system function relevant to your current location in the DMS. | |
| 14 | +</p> | |
| 15 | +<br /> | |
| 16 | +<p> | |
| 17 | +You can customize any Help file and restore the default text if necessary. | |
| 18 | +</p> | |
| 19 | +<br /> | |
| 10 | 20 | <p> |
| 11 | -The KnowledgeTree Document Management System contains several built in system | |
| 12 | -help files. | |
| 21 | +<h3>Customize a Help File</h3> | |
| 22 | +<ul> | |
| 23 | +<li>1. Open the relevant Help file in KnowledgeTree's Web interface.</li> | |
| 24 | +<li>2. Click the Help icon in the top bar to open the file.</li> | |
| 25 | +<li>3. Click Edit this help page to open the file editing screen.</li> | |
| 26 | +<li>4. Make the required changes; then, click Update.</li> | |
| 27 | +</ul> | |
| 13 | 28 | </p> |
| 29 | +<br /> | |
| 14 | 30 | <p> |
| 15 | -You can open a help file anywhere in the system by clicking this help page icon:(?) | |
| 31 | +<h3>View Your Customized Help Files</h3> | |
| 32 | +<ul> | |
| 33 | +<li>1. In DMS Administration - Miscellaneous - Edit Help Files, click Edit Help Files to open the Current Help Assignments page.</li> | |
| 34 | +<li>2. View the list of files (if any) in the Existing Customized Help Pages section.</li> | |
| 35 | +</ul> | |
| 16 | 36 | </p> |
| 37 | +<br /> | |
| 17 | 38 | <p> |
| 18 | -The help file that displays is relevant to the location of the icon. For example, in the | |
| 19 | -image below, you click the help page icon on the right of the page to view help for | |
| 20 | -Browse Documents. | |
| 39 | +<ul> | |
| 40 | +<h3>Delete a Custom Help File</h3> | |
| 41 | +<li>1. View the list of custom help files.</li> | |
| 42 | +<li>2. Click Delete for the relevant file.</li> | |
| 43 | +<li>3. The default file replaces the custom file.</li> | |
| 44 | +</ul> | |
| 21 | 45 | </p> |
| 46 | +<br /> | |
| 22 | 47 | </body> |
| 23 | 48 | -</html> |
| 49 | +</html> | |
| 24 | 50 | \ No newline at end of file | ... | ... |
kthelp/ktcore/EN/admin/link type management.html
| ... | ... | @@ -6,10 +6,42 @@ |
| 6 | 6 | </head> |
| 7 | 7 | <body> |
| 8 | 8 | <h2>Link Type Management</h2> |
| 9 | - | |
| 10 | -Document links allow users to establish associations between documents in the | |
| 11 | -repository. When creating a document link, you should specify the type of relationship that the | |
| 12 | -link implies between the linked documents - i.e. 'associated with', or 'duplicated by'. | |
| 13 | - | |
| 9 | +You can create various types of links between documents in the system that informs the user about the relationship between the linked documents. | |
| 10 | +<p> | |
| 11 | +When creating a link, you specify the type of link, such as 'associated with' or 'duplicated by'. When a document is linked to one or more other documents, the link to associated documents display on the document's Document Details page. | |
| 12 | +</p> | |
| 13 | +<br /> | |
| 14 | +<p> | |
| 15 | +<h3>Viewing Existing Link Types</h3> | |
| 16 | +<ul> | |
| 17 | +<li>1. Scroll down to the bottom of the page, to the 'Manage Existing Link Types' section, where you can view existing link types.</li> | |
| 18 | +</ul> | |
| 19 | +</p> | |
| 20 | +<br /> | |
| 21 | +<p> | |
| 22 | +<h3>Editing Link Types</h3> | |
| 23 | +<ul> | |
| 24 | +<li>1. Click the Edit icon for the relevant link type to open the the link type editing screen.</li> | |
| 25 | +<li>2. Make the required changes (change the name or description).</li> | |
| 26 | +<li>3. Click Change Link Type.</li> | |
| 27 | +</ul> | |
| 28 | +</p> | |
| 29 | +<br /> | |
| 30 | +<p> | |
| 31 | +<h3>Adding New Link Types</h3> | |
| 32 | +<ul> | |
| 33 | +<li>1. Define a name for the link type in the Name field.</li> | |
| 34 | +<li>2. Provide a brief description of the link in the Description field.</li> | |
| 35 | +<li>3. Click Add Link Type.</li> | |
| 36 | +</ul> | |
| 37 | +</p> | |
| 38 | +<br /> | |
| 39 | +<p> | |
| 40 | +<h3>Deleting Link Type</h3> | |
| 41 | +<ul> | |
| 42 | +<li>1. Locate the link type in the Manage Existing Link Types section at the bottom of the page.</li> | |
| 43 | +<li>2. Click the Delete icon for the relevant link.</li> | |
| 44 | +</ul> | |
| 45 | +</p> | |
| 14 | 46 | </body> |
| 15 | 47 | -</html> |
| 48 | +</html> | |
| 16 | 49 | \ No newline at end of file | ... | ... |
kthelp/ktcore/EN/admin/manage groups.html
| ... | ... | @@ -7,17 +7,36 @@ |
| 7 | 7 | <body> |
| 8 | 8 | <h2>Manage Groups</h2> |
| 9 | 9 | <p> |
| 10 | -Only a <b>User</b> that has been assigned to a <b>Group</b> is allowed to access the KnowledgeTree Document Management System. | |
| 10 | +Any system User may belong to more than one Group, and any Group may be added as a member of another Group, as a Sub Group. | |
| 11 | 11 | </p> |
| 12 | -<strong>Note:</strong> Groups can be members of other groups, and can have other groups as members. These memberships pass the permissions set on to the parent group to user members of the member groups, possibly along a few chains. | |
| 13 | - | |
| 14 | -<h3>Example:</h3> | |
| 15 | - | |
| 16 | -<p>Let's say you create a new Group called Testers. Having created the Testers Group, you must assign the it to a Unit. You can name the Unit 'Quality Assurance'. So, the group named Testers is part of the unit Quality Assurance. | |
| 12 | +<br /> | |
| 13 | +<p> | |
| 14 | +Permissions and Group Membership | |
| 15 | +</p> | |
| 16 | +<br /> | |
| 17 | +<p> | |
| 18 | +KnowledgeTree permissions are assigned at the Group level (and also at the Role level), but not to individual users. Each user requiring access to the system must be added to KnowledgeTree as an individual user, and then that user is added to one or more Groups, or is assigned to a Role, in order to obtain the permissions allocated to the Group (or the Role). | |
| 19 | +</p> | |
| 20 | +<br /> | |
| 21 | +<p> | |
| 22 | +Permissions are passed on to users through their membership of a Group (or a Role), and any sub group that is a member of another Group (the parent) obtains the permissions that are allocated to the parent group. | |
| 17 | 23 | </p> |
| 18 | -<p> | |
| 19 | -Group: Testers<br> | |
| 20 | -Unit: Quality Assurance | |
| 24 | +<br /> | |
| 25 | +<p> | |
| 26 | +Add users to groups in DMS Administration - Manage Users. | |
| 27 | +</p> | |
| 28 | +<br /> | |
| 29 | +<p> | |
| 30 | +<h3>Tasks in Manage Groups</h3> | |
| 31 | +</p> | |
| 32 | +<p> | |
| 33 | +In Manage Groups you can perform the following tasks: | |
| 34 | +<ul> | |
| 35 | +<li>View existing groups - search for a group by entering all or part of the group name, or click View All Groups to display a list of all groups</li> | |
| 36 | +<li>Add new groups</li> | |
| 37 | +<li>Edit groups - change the name of a group, allocate Unit Administrator rights and/or System Administrator rights to group members, remove a Group from a Unit</li> | |
| 38 | +<li>Add or remove sub groups from a Group</li> | |
| 39 | +</ul> | |
| 21 | 40 | </p> |
| 22 | 41 | </body> |
| 23 | 42 | </html> | ... | ... |
kthelp/ktcore/EN/admin/manage permissions.html
| ... | ... | @@ -6,8 +6,36 @@ |
| 6 | 6 | </head> |
| 7 | 7 | <body> |
| 8 | 8 | <h2>Manage Permissions</h2> |
| 9 | -KnowledgeTree 3 provides several default (core) permissions - <b>Read</b>, Write</b>, <b>Add Folder</b>, <b>Manage Permissions</b>, <b>Delete</b> - but it also allows you to create your own permissions. | |
| 10 | -<br></br><br></br> | |
| 11 | -You can create permissions for controlling user and group access for plug-ins, or create permissions to use as Guard Permissions for workflow transitions. | |
| 9 | +<p> | |
| 10 | +KnowledgeTree provides several default (core) permissions: | |
| 11 | +<ul> | |
| 12 | +<li>Read</li> | |
| 13 | +<li>Write</li> | |
| 14 | +<li>Add Folder</li> | |
| 15 | +<li>Manage Security</li> | |
| 16 | +<li>Delete</li> | |
| 17 | +<li>Manage Workflow</li> | |
| 18 | +<li>Folder Details</li> | |
| 19 | +<li>Rename Folder</li> | |
| 20 | +</ul> | |
| 21 | +</p> | |
| 22 | +<br /> | |
| 23 | +<p> | |
| 24 | +You may create additional (custom) Permissions, which are useful where you want to control access for Plug-ins, or to create Permissions as Guard permissions on Workflows. | |
| 25 | +</p> | |
| 26 | +<br /> | |
| 27 | +<p> | |
| 28 | +<b>Note:</b> Only custom permissions may be deleted. | |
| 29 | +</p> | |
| 30 | +<br /> | |
| 31 | +<h3>Tasks in Manage Permissions</h3> | |
| 32 | +<p> | |
| 33 | +In this section you can perform the following tasks: | |
| 34 | +<ul> | |
| 35 | +<li>View existing permissions</li> | |
| 36 | +<li>Remove custom permissions</li> | |
| 37 | +<li>Add new custom permissions</li> | |
| 38 | +</ul> | |
| 39 | +</p> | |
| 12 | 40 | </body> |
| 13 | 41 | </html> | ... | ... |
kthelp/ktcore/EN/admin/manage plugins.html
| ... | ... | @@ -7,19 +7,32 @@ |
| 7 | 7 | <body> |
| 8 | 8 | <h2>Manage plugins</h2> |
| 9 | 9 | <p> |
| 10 | -Plug-ins allow you to add new features to your implementation of the KnowledgeTree Document Management System. | |
| 10 | +KnowledgeTree allows the use of Plugins that extend the functionality of the document management system. | |
| 11 | 11 | </p> |
| 12 | - | |
| 12 | +<br /> | |
| 13 | 13 | <p> |
| 14 | -<strong>Note:</strong> Go to <a href="http://support.knowledgetree.com/confluence/x/xg">our Wiki </a> to view a list of the plug-ins that have been developed by the KnowledgeTree community. | |
| 14 | +View descriptions of the plugins on the Plugins Index at the <a href="http://forge.knowledgetree.com">KnowledgeTree Forge</a>. | |
| 15 | 15 | </p> |
| 16 | +<br /> | |
| 17 | +<h3>Updating Plugins</h3> | |
| 16 | 18 | <p> |
| 17 | -You use <strong>Manage Plugins</strong> to: | |
| 18 | -</p> | |
| 19 | -<ul> | |
| 20 | -<li>re-read the plug-ins list for new plug-ins that you copy to the plug-in directory</li> | |
| 21 | -<li>enable plug-ins</li> | |
| 22 | -<li>disable plug-ins</li> | |
| 19 | +The plugins list must be re-read from the filesystem in the following instances: | |
| 20 | +<ul> | |
| 21 | +<li>if you have moved the location of your KnowledgeTree installation to another server</li> | |
| 22 | +<li>after installing or upgrading KnowledgeTree</li> | |
| 23 | +<li>if you have installed new plugins or removed unwanted plugins from the filesystem</li> | |
| 23 | 24 | </ul> |
| 25 | + </p> | |
| 26 | +<br /> | |
| 27 | +<p> | |
| 28 | +Rereading the plugins from the filesystem refreshes the plugins list that displays on the Manage Plugins page in the DMS. | |
| 29 | +</p> | |
| 30 | +<br /> | |
| 31 | +<h3>Enabling and Disabling Plugins</h3> | |
| 32 | +<p> | |
| 33 | +Most plugins are enabled by default. To enable a plugin so that you can use this functionality in the system, select the check box adjacent to the plugin name. To disable a plugin, deselect the check box. When you're done, save your changes. | |
| 34 | +</p> | |
| 35 | +<br /> | |
| 36 | +<p> | |
| 24 | 37 | </body> |
| 25 | 38 | </html> | ... | ... |
kthelp/ktcore/EN/admin/manage users.html
| ... | ... | @@ -8,11 +8,108 @@ |
| 8 | 8 | <body> |
| 9 | 9 | <h2>Manage Users</h2> |
| 10 | 10 | <p> |
| 11 | -You use the <b>Manage Users</b> section of <b>Users</b> and <b>Groups</b> to add or remove users from the KnowledgeTree Document Management System. You can also search for user details, or view a list of all the users that exist in the system. | |
| 11 | +<h3>In DMS Administration >> User and Groups >> Manage Users you can:</h3> | |
| 12 | +<ul> | |
| 13 | +<li>add new users (add users manually, or import user details from an external authentication source)</li> | |
| 14 | +<li>search for users</li> | |
| 15 | +<li>view a list of all users that exist in the system</li> | |
| 16 | +<li>enable, disable, or delete users</li> | |
| 17 | +<li>edit users (add and edit login name, username, email address, mobile number, enable/disable email notification, password, maximum login sessions)</li> | |
| 18 | +<li>view, add, and edit a user's group membership</li> | |
| 19 | +</ul> | |
| 12 | 20 | </p> |
| 21 | +<br /> | |
| 13 | 22 | <p> |
| 14 | -The system uses the information you specified when you added the user or group, to retrieve their details from the authentication source. This allows verification of the user or group's login rights, and of the permissions they have for accessing information in the repository. | |
| 23 | +<h2>Adding Users</h2> | |
| 24 | +<h3>Adding New Users (manually)</h3> | |
| 25 | +<ul> | |
| 26 | +<li>1. Click Add a new user.</li> | |
| 27 | +<li>2. Add details for the user:</li> | |
| 28 | +</ul> | |
| 29 | +<ul> | |
| 30 | +<li>login name</li> | |
| 31 | +<li>full name</li> | |
| 32 | +<li>email address</li> | |
| 33 | +<li>define whether to enable email enable notifications</li> | |
| 34 | +<li>password</li> | |
| 35 | +<li>mobile number</li> | |
| 36 | +<li>maximum login sessions (prevents multiple users logging in on the same account)</li> | |
| 37 | +</ul> | |
| 38 | +<li>3. Click create user.</li> | |
| 39 | +</ul> | |
| 15 | 40 | </p> |
| 16 | - | |
| 41 | +<br /> | |
| 42 | +<h3>Adding New Users (From External Authentication Source)</h3> | |
| 43 | +<p> | |
| 44 | +KnowledgeTree uses the information you specified when adding the user or group to retrieve their details from the specified authentication source. The user or group's login details and permissions are verified when they first log in to the DMS. | |
| 45 | +</p> | |
| 46 | +<br /> | |
| 47 | +<p> | |
| 48 | +<b>Note:</b> You can't change the authentication source for a user after adding the user from a selected authentication source. | |
| 49 | +</p> | |
| 50 | +<br /> | |
| 51 | +<p> | |
| 52 | +Prerequisites: | |
| 53 | +<ul> | |
| 54 | +<li>Add the authentication source to KnowledgeTree</li> | |
| 55 | +<li>Ensure the authentication provider plugin is registered and enabled</li> | |
| 56 | +</ul> | |
| 57 | +</p> | |
| 58 | +<br /> | |
| 59 | +<p> | |
| 60 | +<ul> | |
| 61 | +<li>1. In the Add User From Authentication Source section, select an authentication source from the pick list.</li> | |
| 62 | +<li>2. Click Add from Source to open the Search for user page for the authentication source you selected; then, do one of the following:</li> | |
| 63 | +<ul> | |
| 64 | +<li>search for the user</li> | |
| 65 | +<li>select Mass Import (adds all users from the authentication source); then, click search for users.</li> | |
| 66 | +</ul> | |
| 67 | +</ul> | |
| 68 | +</p> | |
| 69 | +<br /> | |
| 70 | +<p> | |
| 71 | +<b>Note:</b> You won't be able to verify the details of individual users added through Mass Import. When bulk adding users, users that already exist in the system are duplicated in KnowledgeTree with 'duplicate' appended to the username. | |
| 72 | +</p> | |
| 73 | +<br /> | |
| 74 | +<p> | |
| 75 | +<h3>Display All Users</h3> | |
| 76 | +<ul> | |
| 77 | +<li>1. In Search for Users, click View All Users. A list of all users displays at the bottom of the page.</li> | |
| 78 | +</ul> | |
| 79 | +</p> | |
| 80 | +<br /> | |
| 81 | +<p> | |
| 82 | +<h3>Search for Users</h3> | |
| 83 | +<ul> | |
| 84 | +<li>1. In Search for Users, enter all or part of the username in the Username field.</li> | |
| 85 | +<li>2. Click Search for Users to display the user's details.</li> | |
| 86 | +</ul> | |
| 87 | +</p> | |
| 88 | +<br /> | |
| 89 | +<p> | |
| 90 | +<h3>Enable / Disable User</h3> | |
| 91 | +<ul> | |
| 92 | +<li>1. Search for the user.</li> | |
| 93 | +<li>2. Select the user; then, click Enable or Disable as required.</li> | |
| 94 | +</ul> | |
| 95 | +</p> | |
| 96 | +<br /> | |
| 97 | +<p> | |
| 98 | +<h3>Edit User Details</h3> | |
| 99 | +<ul> | |
| 100 | +<li>1. Search for the user to display the user's details.</li> | |
| 101 | +<li>2. Click the Edit icon for the user to open the Edit User Details page.</li> | |
| 102 | +<li>3. Make the required changes; then, save your changes.</li> | |
| 103 | +</ul> | |
| 104 | +</p> | |
| 105 | +<br /> | |
| 106 | +<p> | |
| 107 | +<h3>Edit User's Group Membership</h3> | |
| 108 | +<ul> | |
| 109 | +<li>1. Search for the user.</li> | |
| 110 | +<li>2. Click Manage Groups for the relevant user to open the Change [username] Groups page.</li> | |
| 111 | +<li>3. Make the required changes (add user to groups, remove user from groups).</li> | |
| 112 | +<li>4. Save your changes. </li> | |
| 113 | +</ul> | |
| 17 | 114 | </body> |
| 18 | 115 | -</html> |
| 116 | +</html> | |
| 19 | 117 | \ No newline at end of file | ... | ... |
kthelp/ktcore/EN/admin/role administration.html
| ... | ... | @@ -6,10 +6,42 @@ |
| 6 | 6 | </head> |
| 7 | 7 | <body> |
| 8 | 8 | <h2>Role Administration</h2> |
| 9 | -Roles include, for example, a document creator, a document reviewer, a document publisher, or writer, editor, developer, secretary, and so on. | |
| 10 | -<br></br><br></br> | |
| 11 | -Workflow actions - e.g. review, or publish - are typically assigned to a specific role. The role is granted permissions for working with the document, based on the type of tasks their role performs - e.g. reviewers need read and write permissions. | |
| 12 | -<br></br><br></br> | |
| 13 | -User Groups are allocated to Roles on a per-directory basis, and are inherited from the root folder of the DMS. | |
| 9 | +<h3>In DMS Administration >> Security Management >> Role Management page, you can:</h3> | |
| 10 | +<p> | |
| 11 | +<ul> | |
| 12 | +<li>add new roles</li> | |
| 13 | +<li>edit roles (change the name of the role)</li> | |
| 14 | +<li>delete a role</li> | |
| 15 | +</ul> | |
| 16 | +</p> | |
| 17 | +<br /> | |
| 18 | +<p> | |
| 19 | + | |
| 20 | +<h3>What are Roles?</h3> | |
| 21 | +</p> | |
| 22 | + | |
| 23 | +<p> | |
| 24 | +To access the DMS, users must be assigned to Groups, or to Roles. Permissions are assigned to Groups and Roles on the Folder level. Roles are used to assign permissions to specific users for specific tasks. Example Roles may be: Reviewer, Publisher, Writer, Editor, Developer, Secretary, Anonymous. In smaller organizations there are likely to be groups with only one user, e.g. the 'manager', and in this case the Group concept can be replaced entirely by the 'Role'. | |
| 25 | +</p> | |
| 26 | +<br /> | |
| 27 | +<p> | |
| 28 | + | |
| 29 | + | |
| 30 | +<h3>Roles and Workflows</h3> | |
| 31 | +</p> | |
| 32 | + | |
| 33 | +<p> | |
| 34 | +Workflow actions, e.g. 'review', or 'publish', are typically assigned to a specific Role. The Role is granted permissions for working with the document, based on the type of tasks their role performs - e.g. reviewers need read and write permissions. | |
| 35 | +</p> | |
| 36 | +<br /> | |
| 37 | +<p> | |
| 38 | + | |
| 39 | + | |
| 40 | +<h3>Groups and Roles</h3> | |
| 41 | +</p> | |
| 42 | + | |
| 43 | +<p> | |
| 44 | +User Groups are allocated to Roles on a per-directory basis (by location), and are inherited from the root folder of the DMS. When assigning permissions or actions to Roles in a Workflow, you can use that Workflow anywhere in the site by assigning the appropriate Groups to it in that location. | |
| 45 | +</p> | |
| 14 | 46 | </body> |
| 15 | 47 | </html> | ... | ... |
kthelp/ktcore/EN/admin/system information.html
| ... | ... | @@ -6,24 +6,26 @@ |
| 6 | 6 | </head> |
| 7 | 7 | <body> |
| 8 | 8 | <h2>System information</h2> |
| 9 | - | |
| 10 | 9 | <p> |
| 11 | -KnowledgeTree provides a Support and System Information page in the Miscellaneous section of DMS Administration, which helps you identify and fix problems with your system.The Support and System Information page displays the output of a php_info command in a scrollable window. You may be asked to copy and send this information to the KnowledgeTree support staff if you require assistance with your problem. | |
| 10 | +In DMS <b>Administration >> Miscellaneous >> Support and System Information</b> you can download support information that helps you to identify and fix problems. | |
| 12 | 11 | </p> |
| 12 | +<br /> | |
| 13 | +<h3>View System Support Information</h3> | |
| 13 | 14 | <p> |
| 14 | -Clicking the Download PHP Information link on this page automatically runs <strong>phpinfo</strong> and prints the results to the KnowledgeTree Document Management System. | |
| 15 | +1. Click Download Support Information. | |
| 15 | 16 | </p> |
| 17 | +<br /> | |
| 16 | 18 | <p> |
| 17 | -<strong>Note:</strong> If you believe that distributing this information represents a security risk for your organization, we recommend that you sanitize the output before copying and sending it. Alternatively, please enquire about sending the information directly to the developer dealing with your issue. | |
| 19 | +This action downloads a collection of information on your KnowledgeTree installation. | |
| 20 | +</p> | |
| 21 | +<br /> | |
| 18 | 22 | <p> |
| 19 | - | |
| 23 | +<b>Note:</b> You may required to send this information to KnowledgeTree support staff to assist with your issue. Sanitize the information before sending it to us if you believe that distribution represents a security risk for your organization, or enquire about sending the information directly to the KnowledgeTree developer dealing with your issue. | |
| 24 | +</p> | |
| 25 | +<br /> | |
| 26 | +<h3>KnowledgeTree Issue Tracker</h3> | |
| 20 | 27 | <p> |
| 21 | -You can also click the direct link to the KnowledgeTree Issue Tracker, where you can: | |
| 28 | +To report bugs, view known issues, or to find out whether fixes have already applied for your problem in a newer version of KnowledgeTree, click on the link to the KnowledgeTree Issue Tracker. | |
| 22 | 29 | </p> |
| 23 | -<ul> | |
| 24 | -<li>report bugs</li> | |
| 25 | -<li>view known issues</li> | |
| 26 | -<li>find out whether fixes have already been applied for your problem in a new version of KnowledgeTree</li> | |
| 27 | -</ul> | |
| 28 | 30 | </body> |
| 29 | 31 | </html> | ... | ... |