Configure a Document Type

Contents

  • Overview
  • Pre-conditions
  • Steps
  • Supplementary Information
  • Notes

Overview

Document Type Relationship and Lineage Viewing

In the regulatory and compliance space, it is key to understand the relationships between different types of documents, whether they are:

  • Regulations
  • Enforcements
  • Policies
  • Procedures
  • Controls
  • Etc...

 

In the Clausematch platform, once configured in the Admin Panel module, a document type can be chosen when creating a document in Policy Management.

Afterwards, in the document's metadata form*, document owners can pick out connections for their document to other documents that are of different document types, which builds out a relationship structure between your documents.

This then allows the multi-level lineage between any selected types of documents to be specified and viewed within different parts of the platform.

  • Policy Management:
  • Policy Portal
    • Policy Portal Collections (a PP collection is a group of documents that match a specified set of criteria)
      • A collection is automatically created and managed for any document type.

Purpose Configuration

A Document Type, apart from its name and the industry-standard definition assigned to it, allows the configuration of various aspects of any document that is to assign its type to better fit the purpose of any document that belongs to that type:

  • Template - Define if any, what the default template should show during document creation when a user selects this Document Type.
  • Base:
    • Paper-based:
      • Ideal for detailed content like policies, procedures, or guidelines. This type supports rich text, allowing you to draft and structure comprehensive documents with sections, paragraphs, and formatting.
    • Metadata-based:
      • Perfect for document types like controls, obligations, or compliance checklists that focus on key data points. This type contains structured fields to capture metadata without the need for rich text content.
  • Editable
  • Document Actions (whether any of the following can be done to it):
    • Archive
    • Clone
    • Clone as Template
  • Collaboration:
    • Approvals
    • Comments
    • Tasks
  • Document Vault - Control backup options for these documents.
    • This option will be affected if Document Vault is enabled.

Document Type View

This configures how the corresponding module collection (collection being a group of similar documents) is visually presented to the end user when they're viewing said collection in a particular module.

The following aspects of each module's view can be configured:

  • Default View:
    • List
    • Table
  • List View Metadata - What default metadata fields appears in what order when List View is selected, either automatically or manually by the end user
  • Table View Columns - What default columns appears in what order when List View is selected, either automatically or manually by the end user

Pre-conditions

  • System Level Permission: 'System Administration'
  • The Document Types master toggle is switched on in the Platform Configuration tab in Admin Panel.

Steps

Configure Document Type

  1. Navigate to the Admin Panel module through the grid selector in the top pane when outside of a document. 

  2. Switch to the Document Types tab.
  3. If creating, click +Document Type, if not click the existing Document Type.
  4. Configure any of the following aspects:
    1. Base:
      1. Paper-based (has text content filled in by document users)
      2. Metadata-based (has no text content, only has metadata fields)
    2. Info:
      1. Name
      2. Description
    3. Design (how does the document icon look for this document type):
      1. Icon (what letter is next to it)
      2. Select Color
        1. (Optional): You can enter a hex color code.
      3. Toggle - Show Document Type label
    4. Functionality:
      1. Editing - Whether the document is editable or not. Useful for documents that are managed outside of the platform.
      2. Document Actions:
        1. Archive
        2. Clone
        3. Clone as Template
      3. Collaboration:
        1. Approvals
        2. Comments
        3. Tasks
      4. Document Vault - Control backup options for these documents. This option will be affected if Document Vault is enabled.
    5. Policy Management:
      1. Default View
      2. List View Metadata
      3. Table View Columns
      4. Document Preview Card
    6. Policy Portal:
      1. Display - 
      2. Default View
      3. List View Metadata
      4. Table View Columns
      5. Document Preview Card
  5. Click Create Type / Save Type.

Supplementary Information

Document Card Preview

As configured in the corresponding section, like Policy Management, you can preview the document card as if you were in the module as an end user and you had the List view mode on for the Document Type collection.

Show/Hide Document Types during Document Creation

If needed, you can show/hide the Document Type selector in the Document Creation modal by going to the Platform Configuration tab and toggling Show when creating a document.

Show/Hide Policy Management Collections corresponding to specific Document Types

Users in Policy Management by default can see each system-generated collection corresponding to its specific Document Type.

You can decide for each one whether to hide/show it in the Platform Configuration tab, as well as its order if shown.

Connection Pickers in Default Table Views

You can add specific connection picker fields in the table's columns for any Document Type so as to affect the default table view of that Document Type's collection in Policy Management.

This provides a more comprehensive view of the connections that a particular document type has.

The specific document type needs to be enabled in Platform Configurations tab for its corresponding collection to show in Policy Management.

Notes

Document Type Icon

  • If the Document Types master toggle is turned off in the Platform Configurations tab, icons will default to standard document icons.

Connection Pickers

  • The desired connection picker(s) have to be available in 1 or more of a template's layouts so as to allow for document owners of associated documents to pick the connections through its drafting cycle.
    • View this dedicated article for connection pickers inclusion to ensure that document types, in line with their chosen default templates, are able to have their assigned documents be connected to other specific document types during their drafting cycle.

Editing

  • Not editable configuration will:
    1. Hide Editing toolbar.
    2. Hide Add Paragraphs buttons.
    3. In Paragraph menu we will show only
      1. Only copy the Paragraph link and Tags options
    4. No Insert and Format menus.
    5. Everything related to Suggestion will be hidden:
      1. Suggestions Sidebar
      2. Suggestions Indicators
  • Document Actions configuration: Archive / Clone / Create Template will
    1. Hide related Buttons inside the Editor interface and menu.
    2. Hide related Quick actions inside the Table and List view of Documents.
  1. Collaborations
    1. Approvals
      1. Hide approval sidebar.
      2. Hide approval tabs in document/paragraph.
      3. Hide Approval events type and filters.
      4. Hide Approvals configuration in Document Permissions modal.
    2. Comments
      1. Hide comments inside document/paragraph.
      2. Hide comments events type and filters.
      3. Hide Comments configuration in Document Permissions modal.
    3. Tasks
      1. Hide task sidebar.
      2. ‼️ NOTE: document will be available for selection if the user creates task via the tasks dashboard.

Default values for List and Table View

  • Policy Management List View

    ‼️ Top - not changeable

    1. Title
    2. Document Type
    3. Stage
    4. Favourite

    Bottom

    1. Category
    2. Updated at / Release at and by
    3. Version
  • Policy Management Table View

    1. ‼️ Title - not removable
    2. Version
    3. Stage
    4. Stage Age
    5. Approvals
    6. Approvers
    7. Categories
    8. Last modification date
    9. Last modified by
    10. Release date
    11. Released by
    12. Publication date
    13. Published by
  • Policy Portal List View

    ‼️ Top - not changeable

    1. Title
    2. Document Type
    3. Stage
    4. Read status
    5. Changes
    6. Favourite

    Bottom

    1. Categories
    2. Modification type
    3. Access level
    4. Owner
    5. Version
    6. Published at
    7. Viewed
  • Policy Portal Table View

    1. ‼️ Title - not removable
    2. Modification type
    3. Version
    4. Categories
    5. Published Date
    6. Stage
    7. Read status
    8. Access
    9. Changes
    10. Viewed
    11. Favourite
  • ‼️ In the List View, you can only configure the second line of metadata.

Document Card Layout

  • ‼️ If the Document Card Layout was configured in the Document Types configuration, we will use that configuration even if the document types were disabled in the Configuration panel.
  • ‼️ If the Document Card Layout is not configured, we will use the configuration that is currently used in a document.