Document Type: Difference between revisions

From ContactsLaw Documentation
m (Wikiadmin moved page Document type to Document Type without leaving a redirect)
 
(8 intermediate revisions by the same user not shown)
Line 2: Line 2:
'''Document types''' serve as a method of categorising [[Document|documents]] in [[ContactsLaw]].  
'''Document types''' serve as a method of categorising [[Document|documents]] in [[ContactsLaw]].  


Types also influence the behaviour of the document, determining:
They also influence the behaviour of the document, determining:


* The '''description''' of the document (dynamically generated)
* The '''description''' of the document (dynamically generated)
* [[Document:Folder|'''Folder''']] in which the document is placed
* [[Document:Folder|'''Folder''']] in which the document is placed
* [[Document:Role|'''Parties''']] to the document
* [[Document:Role|'''Parties''']] to the document
* Custom [[Document:Field|'''fields''']]
* Custom '''[[Custom Field|fields]]'''
A type can be assigned during [[Upload Document|upload]] or at any time afterwards (until the document is [[Destroy Document|destroyed]]). If a type is assigned during upload, ContactsLaw will attempt to [[Catalogue Document|catalogue]] the document automatically (using metadata to populate any required parties); however, if this is not possible then cataloguing must be performed interactively instead. This behaviour can also be overridden for individual document types.
A document type can be assigned during [[Upload Document|upload]] or at any time afterwards (until the document is [[Document:Destruction|destroyed]]). If a type is assigned during upload, ContactsLaw will attempt to [[Catalogue Document|catalogue]] the document automatically (using metadata to populate any required parties); however, if this is not possible then cataloguing must be performed interactively instead. This behaviour can also be overridden for individual document types.
 
For documents [[Create Document|generated]] using ContactsLaw, the document type is determined by the [[Template Configuration|template configuration]]. The cataloguing information is collected as part of the process of generating the document.
 
== Properties ==
Document types have the following properties:
 
* '''Name'''
* Optional '''category''' (used to group similar types)
* '''Default path''' to the folder on the destination (will be created during cataloguing if it does not already exist)
* Optional '''comments''', which help users understand when to choose the document type
* Whether to disable '''automatic cataloguing'''
* Whether to treat documents as '''correspondence''' and, if so, the type of correspondence to assume (if not otherwise specified)
* Content specification for '''document descriptions'''
 
=== Document Descriptions ===
The content specification for document descriptions can contain a mixture of text and [[Expression|expressions]] (but not [[Markdown]]).
 
[[Asset|Assets]] corresponding to the parties and fields of the document type (and its associated [[workgroup]]) are automatically defined for use in expressions. When editing the document type in the [[Desktop App]], the available assets are listed for ease of access.
 
Note: Since the assets are derived from the properties of the document type, the system may modify their names slightly to fit within the required syntax.


== Purposes ==
== Purposes ==
Line 21: Line 41:
* When [[Upload Document|uploading]] documents in a format used exclusively for correspondence (e.g. emails)
* When [[Upload Document|uploading]] documents in a format used exclusively for correspondence (e.g. emails)
* When importing emails from an external provider (e.g. Microsoft 365)
* When importing emails from an external provider (e.g. Microsoft 365)
|-
|Bundle
|
* When creating a bundle from a [[brief]]
|}
|}
Multiple document types can be used for the same purpose. [[ContactsLaw]] will select the most-specific type that applies to a given document; for example, a document type in the same [[workgroup]] will be chosen over one in a parent workgroup or at the [[subscription]] level.
Multiple document types can be used for the same purpose. [[ContactsLaw]] will select the most-specific type that applies to a given document; for example, a document type in the same [[workgroup]] will be chosen over one in a parent workgroup or at the [[subscription]] level.
== Description Definitions ==
If desired, document types can define how document '''descriptions''' are generated. Description definitions use the same syntax and semantics as [[Document template|templates]] (although they cannot contain any formatting, such as bold typeface). An important difference is that, while templates draw upon the '''assets''' created by their author, description definitions can only draw upon assets which directly correspond to the parties and fields on the document. When editing the definition, the available assets are listed for ease of access.
Note: Since the assets are derived from the properties of the document type, the system may modify their names slightly to fit within the required syntax.


{{DEFAULTSORT:Document_Type}}
{{DEFAULTSORT:Document_Type}}
[[Category:Documents]]
[[Category:Documents]]

Latest revision as of 17:06, 19 June 2025

Document types serve as a method of categorising documents in ContactsLaw.

They also influence the behaviour of the document, determining:

  • The description of the document (dynamically generated)
  • Folder in which the document is placed
  • Parties to the document
  • Custom fields

A document type can be assigned during upload or at any time afterwards (until the document is destroyed). If a type is assigned during upload, ContactsLaw will attempt to catalogue the document automatically (using metadata to populate any required parties); however, if this is not possible then cataloguing must be performed interactively instead. This behaviour can also be overridden for individual document types.

For documents generated using ContactsLaw, the document type is determined by the template configuration. The cataloguing information is collected as part of the process of generating the document.

Properties

Document types have the following properties:

  • Name
  • Optional category (used to group similar types)
  • Default path to the folder on the destination (will be created during cataloguing if it does not already exist)
  • Optional comments, which help users understand when to choose the document type
  • Whether to disable automatic cataloguing
  • Whether to treat documents as correspondence and, if so, the type of correspondence to assume (if not otherwise specified)
  • Content specification for document descriptions

Document Descriptions

The content specification for document descriptions can contain a mixture of text and expressions (but not Markdown).

Assets corresponding to the parties and fields of the document type (and its associated workgroup) are automatically defined for use in expressions. When editing the document type in the Desktop App, the available assets are listed for ease of access.

Note: Since the assets are derived from the properties of the document type, the system may modify their names slightly to fit within the required syntax.

Purposes

Document types can be assigned a purpose, which causes the system to automatically select that type in certain situations:

Purpose When Used
Correspondence
  • When uploading documents in a format used exclusively for correspondence (e.g. emails)
  • When importing emails from an external provider (e.g. Microsoft 365)
Bundle
  • When creating a bundle from a brief

Multiple document types can be used for the same purpose. ContactsLaw will select the most-specific type that applies to a given document; for example, a document type in the same workgroup will be chosen over one in a parent workgroup or at the subscription level.