Aspects
An aspect is a named group of metadata, attached to contents or to business objects. It is the basic building block of the Any data model: every metadata belongs to an aspect, and is referenced everywhere in the configuration by aspect.metadata: for instance core.name or standard.status.
Grouping metadata by aspect reuses it: a single "contract" aspect can be carried by documents of several applications, and a content carries as many aspects as needed. It is also what makes the model extensible: adding an aspect adds metadata without touching the existing contents.
Aspects are of two types, content or case (business objects). A switch in the navigation bar moves from one to the other.
You can create as many aspects as needed.
Rules to know before creating an aspect
Metadata names can only use lowercase characters and the underscore, and no space.
Once an aspect module has been saved, the names of the metadata, their types and their filter types can no longer be changed. They must therefore be settled before saving.
The "System" metadata cannot be changed. The only exception is the "User" aspect, to which business metadata can be added, but not removed. That added metadata is visible in the "Metadata" tab of the user record, in the Users module of the administration part.
Link contents and business objects
- To link a content to a business object: give it a "Data Object" metadata and associate a data object to it. In the "Displayed value" column, select the metadata that identifies the objects.
- To link a business object to another business object: give it a "Data Object" metadata and associate a business object to it.
- To link contents to a business object: give it a content-type metadata, which associates contents of the document base to it.
A business object can also carry attachments. Unlike linked contents, these are not stored in the document base: they are deleted at the same time as the object.
Options of a metadata
Name: name of the metadata
Type: Boolean, Data Object, Date, Date and time, Number (decimal or integer), Text, URL, or User / Group
Data Object: targeted data object, for a Data Object metadata
Label: label in the different languages, entered by clicking the globe icon
Multiple value: says whether the metadata accepts one or several values
Value constraint: see Value constraint
Validity messages: message displayed if the constraint is not met
Description: description of the metadata in every language
Data list: data list used to offer the values of the metadata
Stored value: value stored on save
Displayed value: value displayed in the lists and the properties dialog boxes
Value constraint
A value constraint restricts what the user can type, through a regular expression (pattern) the value must match. If the value does not match, the validity message is displayed.
Usable tokens:
| Token | Matches |
|---|---|
\d | Any digit |
\D | Any character that is not a digit |
\w | Any word character (letter, digit or underscore) |
\W | Any character that is not a word character |
\s | Any whitespace character |
\S | Any character that is not a whitespace |
[a-z] | A character in the range a-z |
[^a-z] | A character not in the range a-z |
b{4} | Exactly 4 "b" characters |
b{3,} | 3 "b" characters or more |
b{3,6} | Between 3 and 6 "b" characters |
. | Any character |
? | 0 or 1 occurrence of the previous element |
* | 0 or more occurrences of the previous element |
+ | 1 or more occurrences of the previous element |
^ | Start of string |
$ | End of string |
\\ | Escapes a special character |
For instance, \$\d{1,3} requires a dollar amount between $0 and $999.
For advanced combinations, refer to a JavaScript regular expression documentation.
Personal data
To designate users or groups, use a User / Group metadata: it reduces the exposure of personal data.
Such a metadata only keeps the login of the user, and only indexes that login in the full-text search: the full name is never indexed. In return, in the form configuration, that metadata is handled directly: a data list cannot be associated to it, nor can the stored user metadata be chosen.
Facet filtering stays possible: the name of the user is resolved on the fly when displayed.
From the point of view of the user, the login is never displayed: only the full name appears, both in the metadata and in the creators of the audits.