Skip to main content
Documentation Tab
Updated over 7 months ago

The Documentation tab contains generated documents and correspondence related to the currently selected case, based on the available range of templates, along with relevant documents that have been manually authored and uploaded by users. While the information stored in the Case Notes tab is for simple text recording case-specific information, the Documentation tab is intended for full-scale publishable documents to serve as reports and posted correspondence.

The Documentation tab contains simple interface controls to manage and utilize this functionality, as detailed below.

  • New

Clicking the 'New' button allows the user to add a document to the currently selected case through the use of the 'Create New Document' wizard. The newly added documentation will appear in the document list below according to the properties that the user sets during the document creation process.

  • Upload

Clicking the 'Upload' button will allow the user to manually upload a document to the Iinsight system. This document does not need to be based on the document templates within Iinsight and is completely independent of them. The only requirement is that the selected document be in a Microsoft Word or Microsoft Excel format. This functionality requires that the document to be uploaded be on the users local computer, or a location accessible to it and will store the file within the Iinsight system where it will become available to other users. The document upload process requires that the user define a title for the uploaded document and assign an author and date to it, along with any required notes (these notes will typically summarise its purpose and content). Once this information has been defined, the user will click 'Browse' to select the required file from their local computer and 'Upload' to complete the process.

  • Delete

Clicking the 'Delete' button will prompt the user to provide confirmation, before permanently removing the selected document from the Iinsight system.

  • Edit

Clicking the 'Edit' button will allow the user to update the title, author, and date of the currently selected document, as well as to add to or amend the associated notes.

  • Download Copy

Download a copy of the selected document.

  • Approve Doc

The 'Approve' doc button is used to change the document status to Approved.

  • Select the Documents to export

The 'Select the Documents to export' button is used to export the multiple documents in the.zip file

  • Clone

Will copy the selected document which will be saved as a copy under the given name.

  • The Search Field

The 'Search Field' is filled by the user in order to define the information based on which the list of documents will be filtered.

  • The 'by' Dropdown

The 'by Dropdown' allows the user to define the condition based on which the Documentation list will be filtered when they search. For example, if this dropdown is set to 'Author' then clicking 'Find' will filter the list to only include those documents which include the text entered in the search field in their author's name.

  • Find

Clicking 'Find' will filter the currently displayed Document list according to the query and condition set by the Search Field and Criterion Dropdown.

  • Fields Edit

The 'Fields Edit' button is used to determine the information columns displayed for each document currently shown in the Documentation list.

  • All Status dropdown

The 'All Status' dropdown filters the document list based on the document status.

  • The 'Open Doc' Button

The 'Open Doc' button is used to launch the appropriate Microsoft Office application to view or edit the selected document. By opening a document through Microsoft Office, it is also possible to print copies should physical format documentation be required.

  • The 'Email' Button

The Email button opens a new window listing all the available documents. The user selects the target document and then clicks on the 'Send Email, button.

  • The 'Notes' Field

The 'Notes' field contains plain-text notes describing the contents of the selected document. This can avoid the need to open a document in Microsoft Office to confirm its contents.

Creating a New Document

The 'Create New Document' wizard is accessed by clicking the 'New' button displayed on the documentation tab. This wizard allows the user to select a document template to serve as a basis for the new document from those available to the currently selected case

This template will be automatically populated by the Iinsight system using the available case information, and after this may be further edited by the user if any additional changes are required.

The document creation interface is detailed below.

  • The Search Field

The 'Search Field' is filled by the user in order to define the information based on which the list of document templates will be filtered.

  • The' by' Dropdown

The 'by Dropdown' allows the user to define the condition based on which the document template list will be filtered when they search. For example, if this dropdown is set to 'Name' then clicking 'Find' will filter the list to only include those document templates which include the text entered in the search field in their name.

  • Find

Clicking 'Find' will filter the currently displayed Document template list according to the query and condition set by the Search Field and Criterion Dropdown.

  • Fields Edit

The 'Fields Edit' button is used to determine the information columns displayed for each document template currently shown in the Document template list.

  • Title

The title will be assigned to the new document. This will be used in order to label the document within the Iinsight system and will allow it to be searched for and filtered appropriately.

  • Author

The staff member is responsible for authoring the new document. This will default to the user currently signed in.

  • Date

The recorded date of creation of the new document. This will default to the current date.

  • Labels

The 'Label' dropdown is used to assign the label for the document, by default is "Select a document label"

  • Document Status

The 'Status' dropdown is used to set the status of the document

  • Notes

Plain-text notes describing the contents of the selected document. These notes should not replicate the content of the document itself, but rather serve as a description to allow users to recognize the document without any need to open it on the local computer.

Multiple Document Upload

This function allows users to upload multiple documents to a case all at once. There is extra functionality implemented for Chrome and Safari users but Internet Explorer users can also use a simplified version.

Go to the Documentation tab as highlighted below:

Press the Multiple button which will then give you the below window:

Then, click on the "browse" button on the left-hand side of the screen.

Then, select the file(s) you would like to attach as per the below example:

Uploading an Email

An email can be saved as a .msg file from Outlook and uploaded to a case via the Documentation tab in that Case List. Simply save the Outlook email message by clicking 'Save As...' then select the file type as '.msg', save this to a location on your computer then upload the email through the documentation tab in the desired case.

Did this answer your question?