- Print
- DarkLight
- PDF
1. The metadata
The metadata screen has three important elements to know:
No | Element | Function | Image |
1 | Navigation tab | Custom metadata: Metadata created by a user |
|
Value Domain Metadata, Virtual Space: DDV and Virtual Space Metadata | |||
System metadata: Metadata generated automatically when a collection is created, according to the installed modules | |||
Metadata disabled: Metadata disabled for a particular metadata scheme | |||
2 | "Add" button | Allows the creation of a new metadata | |
3 | List of metadata | Allows you to view the list of metadata in a tab, modify or delete it |
2. Creation of a new metadata
Note
As a general rule, good practice suggests that metadata should be created in the default schema and then populated in specific schemas. This prevents unnecessary duplication of metadata fields.
In order to create a new metadata, we will have to follow the following steps:
- Click on "Administration" in the navigation menu;
- Click on "Metadata schema";
- Click on the magnifying glass to the right of the schema type name;
- Click on "Metadata" to the right of the metadata schema name;
- In the metadata window of a metadata schema, click on "Add".
After clicking on the "Add" button, a form will appear on the screen.
List of fields present in the form | |
---|---|
Element | Fonction |
Code | Allows you to set a unique value to a metadata. |
French label | Allows you to name a metadata for the French interface. |
English label | Allows you to name a metadata for the English interface. |
Type of data entry | Allows you to choose whether the metadata is entered manually, copied from another reference metadata (For example, a document copies the description of its folder) or calculated. |
Type | Allows you to define the format of the new metadata. |
Multivalue | Allows multiple values to be associated with the metadata. |
Entry type | Allows you to define a format type for the metadata, if applicable. |
Input mask | Allows you to standardize the values entered in the metadata field by creating an input pattern. This mask must be composed of "A" to limit alphanumeric characters, or "9" to limit numeric characters. (Ex. 999-999-9999). |
Maximum length | Allows you to define a maximum length of characters for the metadata. |
Display tab | Allows you to choose in which display tab the metadata will appear. |
Type of object | Allows "Reference" type metadata to link a metadata to a value domain. |
Obligatory | Allows you to make it mandatory to enter the metadata in the input form. |
Duplicable | Allows to duplicate a value inside a field when duplicating a record. |
Activated | Allows you to enable and disable a metadata in a particular schema. |
Searchable | Allows the search engine to index the entered values associated with the metadata field. |
Sortable | Allows the metadata to be considered in the "Sort by" window in the search results page. |
Advanced search | Allows you to display the metadata in the choices available in an advanced search equation. |
Highlighting | Allows the search term to be bolded in the search results page. |
Autocompletion | Allows the software to suggest values already entered when populating the metadata field. Works with Text, Content, Date, Date and Time, String metadata. |
Available in search and tables | Allows to add the default metadata in the gear of the advanced search table view, in addition to adding it even if the global configuration "Allow dynamic display of metadata fields in table columns" is enabled in Steering -> Configuration -> Search. Warning! It is mandatory to "Restart and rebuild the cache" after activating this item via Control -> Update Center. |
Unique | Allows you to prohibit the entry of a value that has already been entered in the metadata field, for a particular schema. |
Contextual help | Allows you to add an information bubble to the metadata in the creation form. |
Default value | Allows you to enter a default value when creating a record. |
Display type | Allows you to orient the "Radio button" and "Boolean" metadata on a horizontal or vertical axis. |
Value sorting | Allows you to choose whether multi-value reference metadata appears in order of entry or in alphabetical order. |
Modification
Only the code and the metadata type cannot be modified after the metadata has been created.
Types of metadata | |
---|---|
Type | Fonction |
Boolean | Allows you to create a metadata that supports the choice of a "True" or "False" value. |
Text | Allows you to create a metadata that supports an unlimited sequence of alphanumeric characters. |
Content | Allows you to create a metadata supporting the import of a file. |
Date | Allows you to create a metadata that supports the manual entry of date or assist with a calendar. |
Date & Time | Allows you to create a metadata that supports the manual entry of a date and time or assist with a calendar. |
Reference | Allows you to create a metadata that feeds into a list of controlled vocabulary in the value domain. |
String of characters | Allows you to create a metadata that supports a sequence of character limits. |
Number | Allows you to create a metadata that only supports the entry of a numeric value. |
Type of entry according to the type of metadata | ||
---|---|---|
Type | Choice | Function |
Text | Text zone | Allows the entry of values with a minimalist formatting. |
Rich text zone | Allows you to enter values with advanced text formatting options. | |
Content | Content | Allows you to create a field to import a file. |
Content Borrowing/Returning | Allows you to create a field for importing a file, as well as an interface for versioning it. | |
Reference | Lookup | Allows you to create a field with the ability to view controlled vocabulary values in a highlighted window. |
Drop down menu | Allows you to create a field with the ability to view controlled vocabulary values in a drop-down menu. | |
Radio button | Allows you to create a field with the ability to view controlled vocabulary values as a button. | |
String of characters | Basic field | Allows you to create a field where it is possible to enter an alphanumeric value, without supporting carriage returns. |
URL | Allows you to create a field where the value entered will refer to a URL. | |
Password | This field is not useful for Constellio users, only for advanced development operators. |
3. Copied metadata
Copied metadata are metadata whose values come from another entity (e.g.: The code of a container in a folder).
In this tab, the user will be able to create copied metadata by selecting the reference metadata (e.g.: "Container") and the copied metadata (e.g.: "Container code"). It is also possible to delete copied metadata created by the user and to modify certain attributes such as their title.
A system configuration allows to activate an advanced search criteria display mode using the new "Contains" or "Does not contain" criteria. With this new mode, the copied metadata will no longer appear in the metadata selection drop-down menu, but rather in a 2nd drop-down menu when the "Contains" criterion is chosen. It will be possible to make the same criteria available on metadata of the same type.
The reference metadata created by users will not always be able to be used to copy values. For example, if a reference metadata to folders is created in the "Folders" type, it cannot be used to copy a value. However, it will be possible to copy a value using a reference metadata to a value domain created by users.
It is only possible to copy metadata of type "String", "Date", "Date and time", "Boolean", "Number" and "Enumeration". It is not possible to copy "Content", "Structure" and "Text" metadata.
To copy a value from a custom metadata, it must be in the default schema of its type.
Caution!
Adding copied metadata may slightly reduce performance, we recommend to only create this metadata if it is used.
3.1 Adding a copied metadata
- Go to "Administration";
- Then in "Metadata schema";
- Follow the path of the schema type in which you want to create a copied metadata;
- In the schema metadata, "Add";
- In the data entry type, select "Copied".
- Fill in the metadata for your metadata;
The reference metadata allows you to choose from which type of schema the metadata to be copied is selected.
The source metadata is the metadata whose value will be copied into the new copied metadata.
7. "Save". Do a reindexing.
Attention!
Re-indexing is necessary after activating the behavior in the metadata modification form.
3.2 Add a copied metadata from a value domain
It is possible to add a copied metadata from a metadata of a value domain. For example, I have created a value domain «Suppliers» . In it, I added a custom metadata «End of contract» . Each reference in my value domain now contains an «End of contract» metadata. I can now create a reference type metadata called «Suppliers» that leads back to my value domain list. In this value domain is indicated the end of contract. To have this information at the level of my file, I can then create a copied metadata that will copy the value linked to my choice of reference of the value domain «Suppliers».
- Go to "Administration" ;
- Then in "Metadata schema";
- Follow the path of the schema type in which you want to create a copied metadata;
- In Metadata schema, "Add" ;
- In the entry type of data, select "Copied";
- Fill in the metadata for your metadata. Here you can choose a metadata that is related to your value domain;
- "Save". Do a reindexing.
3.3 Search for a copied metadata
You can choose to search for the metadata directly or to search by the reference metadata. The configuration is in the "Search" tab and is called "Show metadata copied separately in the advanced search".
3.3.1 Checked configuration
If the configuration is checked, you will have the "Contains" and "Does not contain" options available in the search criteria signs. A system configuration allows to enable an advanced search criteria display mode using the new "Contains" or "Does not contain" criteria. With this new mode, the copied metadata will no longer appear in the metadata selection drop-down menu, but rather in a 2nd drop-down menu when the "Contains" criterion is chosen. It will be possible to use the same criteria as those available for metadata of the same type. You will then have to search for the name of the source metadata. For example, I have created a copied metadata "Category Code" whose source metadata is "Classification plan heading" and whose reference metadata is "Code". If my configuration is checked, I will have to search for "Classification plan heading". You will then be able to choose the "Contains" sign, then the "Code" metadata.
3.3.2 Unchecked configuration
If the setting is not checked, you will need to search for the copied metadata that you created. So in my previous example, that would be the "Category Code" metadata.
4. Secure metadata management
The management of secured metadata allows to control the display of metadata according to the type of user. In this way, the functionality allows for the addition of security by role for each metadata. For example, the person in charge of document management could view specific metadata that would not be displayed to the user, such as the retention period.
By default, no security is applied to metadata management. The functionality therefore consists in hiding the metadata and preventing it from being used in simple or advanced searches for the users concerned. It is essentially an access control on the reading of the metadata.
4.1 Adding and editing secure metadata
To assign a security to a metadata, it is necessary to consult the page of addition or modification of a metadata.
First, in the "Administration" menu:
- Click on "Metadata schemas" in the navigation menu;
- Then click on a metadata schema type;
- On the schema type page, click on "Metadata";
- On the metadata page, click on "Add" or the "Edit" button of an existing metadata;
- Locate the "Limit read access on metadata to roles" field.
To validate the securing of a metadata, simply select the desired role(s).
Note that at least one role must be selected for the functionality to be operational. Otherwise, if no role is selected, the display will be granted for all. If all four roles are selected, the metadata will also appear in the displays as the default value.
4.2 Viewing secure metadata
The consultation of secured metadata is done in the same way as for non-secured metadata. The metadata, whose reading will be specific to one or more defined roles, will appear in the metadata page linked to the schema.
In the case of metadata assigned to a document or folder, it will appear in the folder or document record. If read access is granted to only one role, the metadata will not be displayed for the others.
Finally, during advanced searches, the feature hides the secured metadata. They are therefore no longer visible to users who do not have read access. For more information, see the article "Secure metadata".
5. Configurations
You will find in this section all the system configurations that impact the metadata. To learn more about the configurations, see the article "System configurations".
Advanced Tab | |||
---|---|---|---|
Configuration | Description | Possible values | Impacts |
Make the input of multilingual values mandatory | This configuration allows you to make the entry of certain metadata fields mandatory (e.g. the "Title" field of a plan item, a conservation rule, a value field, etc.) in order to facilitate the retrieval of information in a bilingual collection. *The configuration is only effective if the Constellio environment has a bilingual collection. | Activated | All fields are mandatory. |
Deactivated | Only fields in French are required. | ||
Remove the extension in the title of a document | This configuration allows you to remove the extension (e.g. .txt, .doc) in the "Title" field of a document when it is fed using the metadata extractors (extraction by properties). | Activated | The title of the metadata record will not include the file extension. |
Deactivated | The title of the metadata record will include the file extension. | ||
Enable dynamic display of metadata fields in table columns | This configuration allows to dynamically modify the metadata displayed in some tables. | Activated | The display of the metadata is done from the table. |
Deactivated | The display of the metadata is based on the metadata schemas. |
Disposal Tab | |||
---|---|---|---|
Configuration | Description | Possible values | Impacts |
Enable sorting of records in decommissioning lists. | This configuration allows you to change the order of the folders in the tables by pressing the column labels. | Activated | It is possible to order the columns by different metadata in the tables. |
Deactivated | It is not possible to order the columns by different metadata in the tables. | ||
Allow you to change the archival status and expected dates of a file. | This configuration allows you to manually change the value of the "Archival status" metadata in the input form of a file. The action leads to a change in the dates for the calculation of retention periods. | Activated | Allow to modify the dates for all the files |
Activated for imported records | Allows you to modify the dates for all the files imported using Constellio | ||
Deactivated | Do not allow to modify these dates | ||
Calculation of metadata based on the first part of the intervals | This configuration allows you to define a calculation year for records with an opening year that overlaps two years (e.g., 2017-2018). | Activated | The calculation will be based on the first year of the interval. |
Deactivated | The calculation will be based on the second year of the interval. | ||
Delete the records of the documents at the time of the destruction | This configuration allows you to permanently delete the metadata record of a document when it is destroyed inactive. | Activated | The metadata sheets of the documents are to be destroyed at the time of decommissioning. |
Deactivated | The metadata records of the documents are kept at the time of declassification. | ||
Delete the records from the files during the destruction | This configuration allows you to permanently delete the metadata record of a folder when it is destroyed inactive. | Activated | The metadata records of the files are destroyed during decommissioning. |
Deactivated | The metadata records of the files are retained upon decommissioning. |
Others Tab | |||
---|---|---|---|
Configuration | Description | Possible values | Impacts |
Number of items loaded in autocomplete fields (maximum 100, may slow down screens) | This setting allows you to define the maximum number of suggestions that will be displayed below an input field. *This setting only applies to metadata fields with the "Autocomplete" option enabled. | Number of items | The number of items displayed is limited according to this number. |
Rich text editor toolbars | This configuration allows you to define the default display options of a rich text field. *It is preferable to consult the Constellio team before changing these settings. | Consult the Constellio team | This changes the options offered to the user in the rich text fields. For example: for rich text metadata. |
Date format | This configuration allows you to configure the format of the "Date" metadata displayed in the application. | Day = dd Month - MM Year = yyyy | Attention! Not putting the month format in upper case (MM) can cause problems in Constellio, since lower case (mm) refers to minutes. |
Date and time format | This configuration allows you to configure the format of the "Date and time" metadata displayed in the application. | Day = dd Month = MM Year = yyyy Hour = HH Minute = mm Second = ss | Attention! It is important to respect upper and lower case in Constellio's formats, since this changes the meaning and refers to other data. |
Default tab when consulting a file | This configuration allows you to define the tab that is displayed by default when consulting a file. Each user can configure the tab they want in "Edit my profile". | C | Content |
M | Metadata | ||
Hide leading zeros when displaying the ID metadata | This configuration allows you to hide leading zeros when displaying the ID metadata. | Activated | Hides leading zeros when displaying the ID metadata. |
Deactivated | Does not hide leading zeros when displaying the ID metadata. | ||
Priority when populating metadata | This configuration allows you to determine the order of prioritization for populating the metadata when automatically extracting the title in the document import. | Styles: For a Word document, the style created in the Word document will be imported and taken into account first. | Example: For the choice Styles -> Regular expressions -> Properties, Constellio will extract in the following order if the data are available. Styles Name of the file Properties: If there is no data in the styles and regular expressions, Constellio will automatically export the properties data. |
File name: The file name will be used. | |||
Properties: The title defined in the properties will be used. | |||
Delineate multi-value metadata | This configuration allows you to select a delimiter for the display of multivalue metadata. | Semicolon (;) | Selects the semicolon as the delimiter for the display of multivalue metadata. |
Comma (,) | Selects the comma as the delimiter for displaying multivalued metadata. | ||
Priority in the settlement of the title | This configuration allows you to specify the order in which the title metadata will be extracted when importing documents. To do this, the Metadata Extractors module must be set up. | Styles: For a Word document, the style created in the Word document will be imported and taken into account first. | Example: For the choice Styles -> Regular expressions -> Properties, Constellio will extract in the following order if the data are available: Styles Name of the file Properties If there is no data in the styles and regular expressions, Constellio will automatically export the properties data. |
File name: The file name will be used. | |||
Properties: The title defined in the properties will be used. |
Reports Tab | |||
---|---|---|---|
Configuration | Description | Possible values | Impacts |
Sorting metadata for labels and metadata reports | This configuration is used to choose the metadata on which to sort the multi-value reference fields with alphabetical sorting. This is only effective with metadata labels and PDF reports. | Title | The sorting metadata for labels and metadata reports is "Title". |
Code | The sorting metadata for labels and metadata reports is "Code". |
Search Tab | |||
---|---|---|---|
Configuration | Description | Possible values | Impacts |
Show only summary metadata in searches and tables | This configuration allows for more performance by displaying only summary metadata in searches and tables. | Activated | Only summary metadata will be displayed in the table view of the advanced search. |
Deactivated | All metadata will be displayed in the table view of the advanced search. | ||
Show inactive schemas in the advanced search | This configuration allows inactive metadata schemas to be displayed in the advanced search. | Activated | Inactive metadata schemas will be displayed in the advanced search. |
Deactivated | Inactive metadata schemas will not be displayed in the advanced search. | ||
No links for metadata in search results (improves search performance) | This configuration allows you to remove links to folders and containers in the metadata of search results. | Activated | The links are clickable. |
Deactivated | Links are not clickable. | ||
Show copied metadata separately in the advanced search | This configuration allows the removal of all | Activated | The copied metadata are removed from the list of available metadata in a search criteria. These metadata will then be accessible via their reference metadata by choosing one of the 2 new search operators Contains and Does not contain. When one of these two operators is selected, a drop-down menu is displayed allowing you to choose a copied metadata that has the selected metadata as a reference and a component to enter the value of the copied metadata to be searched. (For example, searching on the Document type or the Folder metadata contains an opening date X). |
Deactivated | The copied metadata are directly available in the search criteria. |