Fields identifiers (keys) in cards and dynamic masks notation
- 27 Apr 2023
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Fields identifiers (keys) in cards and dynamic masks notation
- Updated on 27 Apr 2023
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
This article applies to BOOST EMPOWER licenses
Purpose and scope
Cooperlink allows great flexibility in generating document codes, file names, version controls or exporting data in the form of Excel reports. This automatic generation is carried out through configurable masks that are explained here.
Prerequisite
For masks based on custom metadata, knowledge of the keys to this metadata is required.
Masks and Mustach notation
Base
A mask is therefore a textual description of a dynamic character string formed by the combination of information contained within Cooperlink. A mask uses:
- fixed character strings (e.g. STATION-)
- system fields (e.g. name, version)
- custom fields (e.g. gare_document_type)
A mask is therefore made up of these 3 elements. The fields are surrounded by braces according to the Mustach notation:
Example: STATION-{{gare_document_type}}-{{version))
Formatting
Some data requires specific formatting. This is the case, for example, for digits that must be displayed as a fixed-size string supplemented by 0s. Formatting is achieved by adding the character ":" to the key. The string following this character defines the formatting.
| Description | Format | Example |
| Formatting a fixed-width number (e.g. 001) | ###000 | {{std_building_no_fiche:##000}} |
| Exporting the key or label of a value to a list (e.g. FT vs Data Sheet) | :label :.key | {{std_building_type:key}} |
Custom fields
Custom fields are referenced by the unique key that you assigned to them based on each object type. Please refer to the card configuration to find out which keys to use. See What is a card?
System fields
Cooperlink has a database of predetermined fields as follows:
Projects
| Key | Description | Comment |
| name | Name | |
| Id | Identifier | |
| < personalized> | See custom fields |
Workspace
| Key | Description | Comment |
| name | Name | |
| id | Identifier | |
| < personalized> | See custom fields |
Documents
| Key | Description | Comment |
| base_name | File name (without extension) | |
| name | File name (with extension) | |
| id | Identifier | |
| public_id | Public IDENTIFIER | |
| Path | Path | |
| creation_date | Date of first creation | |
| modification_date | Date last modified | |
| published_on | Date of file version | |
| type | Document type (directory, document, ...) | |
| owner | Owner | |
| modification_user | User / Partner of last modification | |
| document_code | Documentary code | |
| document_unique_id | Unique document identifier | |
| publication_date | Date of publication | Workspace only |
| received_date | Date of receipt | Workspace only |
| external_name | Source name | Workspace only |
| external_path | Source path | Workspace only |
| size | Size (in bytes) | |
| current_flow_date | Date of modification of the current version | Workspace only |
| current_flow_type | Version type (audit log: received, published, checked out, deleted) | Workspace only |
| locallink | URL link to document | Workspace only |
| partnerlink.mypartnerGUID | URL link for licensed partners | mypartnerGUID is the partner ID (please see support) |
| < personalized> | See custom fields |
Workflows
| Key | Description | Comment |
| name | Name | |
| design_label | Workflow template name | |
| startdate | Start date | Format date ISO |
| completedate | Closing date | Format date ISO |
| owner | Owner | |
| current_step | Current stage | Step names defined in the workflow configuration |
| due_date | Deadline | |
| life_status | State (current or obsolete) | |
| last_updated | Last updated date | |
| published_on | Publish date of document version | |
| completed_status | Closing status | |
| target_name | Attachment name | |
| attachment_count | Number of attachments | |
| attachment_labels | Attachment names | |
| markup_count | Number of markups | |
| locallink | URL link to document | Workspace only |
| partnerlink. mypartnerGUID | URL link for licensed partners | mypartnerGUID is the partner ID (please see support) |
| < personalized> | See custom fields |
Response cards
| Key | Description | Comment |
| completeDate | Closing date | |
| completed_by | User that has completed the card | To see partner users, GDPR compliance needs to be disabled |
| assignee | Assigned User / Partner | |
| attachement_count | Number of card attachments | |
| attachement_labels | Card attachment names | |
| markup_count | Number of markups | |
| due_date | Deadline | |
| < personalized> | See custom fields |
Tasks
| Key | Description | Comment |
| id | Identifier | |
| friendly_id | User-friendly ID | |
| common_friendly_id | Common user-friendly identifier | |
| title | Summary | |
| type | Task Type | |
| priority | Task Priority | |
| due_date | Deadline | |
| Status | Status | |
| perc_complete | Percentage of completion | |
| owner | Owner | |
| creation_date | Creation date | |
| modification_user | User / Partner of last modification | |
| modification_date | Date last modified | |
| assignee_list | List of assigned users and partners | |
| parent_id | Parent task ID | |
| locallink | URL link to document | Workspace only |
| partnerlink. mypartnerGUID | URL link for licensed partners | mypartnerGUID is the partner ID (please see support) |
| < personalized> | See custom fields |
Was this article helpful?