Create a Snippet

Contents

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

Overview

Find more information on how to create a snippet, a pre-set block of text that can be inserted into documents and templates for easier population of repeatable content.

Pre-conditions

  • System Level Permission: 'Create Documents', 'System Administration'.

Steps

Create Method:

  1. Click +New button in the top-right corner of the dashboard.
  2. Select Create from scratch.
  3. Select As Snippet.
  4. Enter snippet title.
  5. Enter snippet version number.
  6. Select the document language* (English (UK) is set by default).
  7. Click Create.
  8. Select screens for the layouts:
    • (Optional): Add or remove layouts by clicking on Add layout or X next to the optional layout's screen. 
      • Document Actions or States:
        1. On Creation
        2. Published on Portal
      • Layout for document stages:
        1. Draft
        2. Release
        3. Custom stages (that users created in Templates)
  9. Click Continue.
  10. Set metadata fields as needed.
  11. Click Continue.
  12. (Optional): Set the stage deadlines - click on a stage name and select the due date*.
  13. Click Continue.
  14. (Optional): Select a category to map a snippet to and tick the box next to the category name.
  15. Click Complete.

Upload Method:

  1. Click +New button in the top-right corner of the dashboard.
  2. Select Upload DOCX.
  3. Select As Snippet.
  4. Choose a file to upload*.
  5. Click on the newly created snippet appearing on the dashboard or click on the Incomplete collection and select the snippet.
  6. Select screens for the layouts:
    • (Optional): Add or remove layouts by clicking on Add layout or X next to the optional layout's screen. 
      • Document Actions or States:
        1. On Creation
        2. Published on Portal
      • Layout for document stages:
        1. Draft
        2. Release
        3. Custom stages (that users created in Templates)
  7. Click Continue.
  8. Set metadata fields as needed.
  9. Click Continue.
  10. (Optional): Set the stage deadlines - click on a stage name and select the due date*.
  11. Click Continue.
  12. (Optional): Select a category to map a snippet to and tick the box next to the category name.
  13. Click Complete*.

Supplementary Information

When using the Upload Method, once a new snippet was created, a notification will appear next to the bell icon to indicate that the document was successfully uploaded in Clausematch. The document will be visible on the dashboard and marked as incomplete requesting users' attention to finalize it.

 

When using the Upload Method, users can update snippet name, version number and spellcheck affected while the snippet is in the Draft stage or when releasing the snippet:

  1. Click File.
  2. Select Document settings.
  3. (Optional): Edit snippet title.
  4. (Optional): Edit snippet version number.
  5. (Optional): Select the document language* (English (UK) is set by default).
  6. Click Save.

 

Once the snippet was updated and ready to be released:

  1. Click Move to stage.
  2. Select Release.
  3. (Optional): Update snippet title.
  4. (Optional): Update snippet version number.
  5. Click Continue.
  6. (Optional): Update metadata fields.
  7. Click Continue.
  8. (Optional): Select a category to map a snippet to and tick the box next to the category name.
  9. Click Complete.
  10. (Optional): Add a note.
  11. Click Confirm.

Notes

  • Users can edit snippets in the same way as a regular document.
  • Snippets do not have a configurable workflow.
  • Only files in DOCX format can be uploaded.
  • The upload functionality is semi-automatic, review this guide on how to edit the uploaded snippet.
  • Selected language(s) determines which dictionaries get used in that document's spell-check.
  • A snippet's Document Type is fixed to Policy.
    • The ability to select a Document Type for documents and templates is a feature that must be enabled for the instance, to request this to be enabled please contact Clausematch Support at support@clausematch.com.
      • For any document, template, snippet, and modification that existed before the enabling of this feature, their Document Type will be Policy.