In this form, you can modify the definition of an entity managed by CARL Source and referenced in the Dictionary to adapt it to your specific needs.
On the left side, the tree structure displays the main object as a root node, with all its attributes listed below it.
By selecting an item, you can view its properties in detail in the right-hand Section. Each item is identified by an icon representing its type, which is also listed in the property header on the right.
The property display is responsive; only the relevant properties are shown on the form based on the selected item type and the displayed object category.
For the properties of an object’s attributes, see Attributes below, following the Section on object properties.
Available actions
Action buttons allow you to manipulate the elements in the object's tree structure on the left:
: Add an attribute to an object in the "Search" category only, specifying the name, label, and data type (Alphanumeric, Date & Time, Code, etc.)
: Sort in ascending alphanumeric order
or descending
the list of attributes for the displayed object.
When creating an attribute on a Search object, the following naming conventions must be followed:
- The attribute name must begin with the character string "xtrat"to avoid conflicts with standard elements,
- The following prefixes (case-insensitive) are reserved for standard attributes: xtraDate, xtraNul, xtraTxt, xtraBool.
Properties of an object
The object category is visually identified by specific icons for clarity; there are four of them:
: Entity
: Search
: Screen controller
: Other
- Purpose : Object ID, unique within the application.
- Description : Name of the object.
General Information
- Category : Object type. Editable objects are essentially entities.
- Module : The module to which the object belongs.
- Specific : Indicates whether the item was created for a specific need or is provided as standard.
- Tooltip : Name of the object.
- Indexed : Elasticsearch indexing; that is, the object used for full-text search.
- Translatable : Indicates whether at least one attribute of the object is managed in multiple languages. Unchecking this option disables all attributes of the object that are managed in multiple languages.
Functional Properties
- Authorized related documents : Related documents can be attached to the subject line.
If you designate an entity as one that can have associated documents, don’t forget to perform the assignment of access rights to those documents in the details of the
Profiles If the necessary permissions do not exist for the feature, a custom development is required.
- Duplication possible : You can create an item by copying an existing one. In this case, you can choose which attributes to copy or not in the [Attributes] tab, "Copy" box.
Access restriction
- An object is an entity stored in the database,
- No entity attribute is used as the carrier of the restrictionIn fact, in this case, the restriction is applied indirectly, see Object [Attributes], restriction carrier.
- Attribute : An attribute used as a filter criterion, if available.
Customization
- Attribute : Enter this if you want the form detailing the relevant object to vary depending on the value of this attribute.
Examples:
- By selecting the "Equipment Type" attribute for the MATERIAL object, you can configure the forms so that the detail form for a Asset or specific to each type of equipment.
- By selecting the "Skill" attribute for the TECHNICIAN object, you can configure the forms so that a Technician’s detail form adapts according to their skill.
- The "Customization Attribute" drop-down list is available only for objects that have a detail form.
- Only the attributes associated with a list of values or linked to another entity in the form of a selection / InfoZone, are permitted.
To customize the screens, you must then create the various forms you need using the Custom form, and then define, for each form, the values for which this attribute applies.
Processing
- Status workflow : Object lifecycle. It is possible to define a workflow specific to an object.
- Multi-workflow : Indicates whether the object supports workflows with multiple conditional lifecycles.
Useful in the details of a workflow when the object is specified: allows (or does not allow) the creation of alternative branches to the main workflow branch (which cannot be modified).
Storage
- Table : Main table where the object's data is stored.
GDPR
- GDPR - To be anonymized : checkbox used to indicate whether the object is included in the anonymization process.
- Data retention period (in months) : This duration allows you to define the threshold value beyond which the data must be automatically anonymized.
Attribute properties
The display of the right-hand detail pane adjusts based on the attribute field or even the relevant object category.
As a reminder, an icon identifying the attribute type is associated with each attribute in the Tree structure. The icon is also displayed in the header of the attribute’s properties:
: Alphanumeric
: Digital
: Boolean
: Date
: Date and time
: Schedule
: Monetary
: List
: Sub-topic
: Other
Select the attribute in the tree structure and modify its properties in the left pane.
Most properties can only be modified for custom attributes—that is, non-standard attributes that you have added CARL Source is here to meet your specific needs.
- Icon : Reuses the attribute's category.
- Attribute : Attribute ID. The attribute must begin with two lowercase letters or two uppercase letters.
Example: "monAttribut" and "MONATTRIBUT" are allowed. "MonAttribut" is not allowed.
- Description : Attribute name.
- Field : Possible values for the attribute; see Field.
- Tooltip : Descriptive text that will be displayed when the user hovers the cursor over the attribute in a form.
- Translatable : If checked, allows the attribute (alphanumeric) to be handled in multiple languages within the application. Enabling this property on one of an object’s attributes automatically enables this property on the object to which the attribute belongs.
In the context of international use, it is preferable that translations are available for labels and tooltips.
Links
Ownership data
Data entry
- List of values : The attribute value must be selected from a standard or custom drop-down list; see list of values.
- Format : To be filled in for a "Date" domain attribute:
- DATEHOURMN includes the date and time, without the seconds,
- SHORT_DATE displays only the date without the time,
- DTIME specifies that a "Time" attribute is displayed in the HH:mm format.
Other formats can be added to the file formats.properties.
- If the field can contain multiple values, list them in square brackets, separated by commas. Example: [VALIDATED, INPROGRESS], for a list of statuses in a search form.
- If the field is a date or time, the format is always DD/MM/YYYY hh:mm:ss, even if the date or time portion is to be ignored. Example: '12/31/2010 08:00:00'.
- For a Boolean value, the value is either 'true' or 'false'.
- The default value of status must be specified in the "statusCode" attribute. For example: 'VALIDATE' to create the Asset directly in the "Validated" status.
Property attributes
These attributes must be specified when the value of one attribute is itself stored in another attribute. For example, on a purchase request (PR object), the currency of the "amount including tax" (amountTTC) is indicated in the "Supplier Currency" field (vendorCurrency attribute).
- Currency : Attribute where the field's Currency is stored, for a "Amount" domain attribute.
- Unit : Attribute where the field’s unit is stored; required for a “Quantity” domain attribute. (Example: “unit” for the “askedQty” attribute of the “PRLINE” object).
- Number of decimal places : Attribute where the number of decimal places for the field is stored, for a domain attribute of type "Quantity," "Amount," or "Numeric." (Example: "precision" for the "askedQty" attribute of the "PRLINE" object).
Value
- Minimum / Maximum / Precision / Decimal places : Applicable to numeric attributes. Precision refers to the number of digits in the integer part, while "decimals" refers to the number of digits after the decimal point.
- Character count : Maximum number of characters for the value. Applies to alphanumeric attributes.
Input form
These checkboxes allow you to define the appearance of the value displayed in the field corresponding to the attribute.
They may or may not be editable, depending on the domain to which the attribute belongs.
- Capital letters : Capitalization is required when entering the value. This applies to codes.
- No space : Spaces are replaced by '_' during data entry. This applies to codes.
- Dynamic expression : Entering dynamic expression is permitted.
- Time : Indicates a time-based display. This applies to durations.
- Percentage : Displays the '%' symbol after the number.
- Currency display : Automatic for AMOUNT domain attributes.
- Unit display : Automatic for QUANTITY domain attributes.
- Truncate : Applies to numerical values.
If the number of decimal places is 2, and the user enters the value 1.123, then:
- If "Truncate" is checked: the base value (and displayed value) is 1.12.
- If "Truncate" is not checked: The base value is 1.123 and the displayed value is 1.12.
- Multi-line : The value may contain line breaks, and the input field may span multiple lines. This is the case for comments.
- Publisher : Formatted text entry is possible; see Detailed descriptionNote: The formatting bar will only be enabled if the field is at least 3 lines long.
Persistence - Only objects stored in the database
- To be copied : Check this box if the attribute should be copied from the source element to the target element when creating a duplicate.
- Persistent : The attribute is saved in the database.
- Table / Column : The table column in which the attribute is stored.
Search
This section allows you to configure the attributes involved in full-text search.
The elements in this section are accessible only if the property "Persistent"The attribute is set to "True" (checkbox selected).
Please note that for certain attributes, this information is already pre-filled and cannot be modified.
- Indexed : If the box is checked, this indicates that this attribute should be used in full-text searches.
-
Text analyzer : Determines the text analyzer to be applied to this attribute. The options are as follows:
- Keyword : Converts the term to lowercase and encodes it in ASCII characters. The term is then indexed without segmentation.
- Sentence : Converts the term to lowercase, converts it to ASCII characters, and then splits it into words (based on spaces, commas, etc.). These words are then indexed using a Filter n-gram prefix, which allows you to find entries containing only the beginning of the word.
- HTML : Applies a filter that removes HTML tags, then performs the same processing as the "Phrase" parser described above.
Any configuration changes are not automatically reflected in the full-text search.
You must notify CARL Source that the indexing has been modified; to do so, in the [Dictionary] feature, go to the actions menu
and select "Updating the Elastic index configuration".
The indexing time depends on the number of selected attributes and the size of the database.
This process is therefore not instantaneous and may take several tens of minutes.
You can track its processing by viewing the CARL logs. Source: CARL Source
- Upon startup, a log appears with the message "Start indexing entities in Elastic" will be visible.
- During processing, several lines will be entered with a message such as: "Index: carl_s1300374_cs02-csst_item, bulk process operations succeeded: ...".
- Once the process is complete, the following log will be displayed: "Finish indexing entities in Elastic".
Checks
- Bulk update : The bulk update is available for this attribute. This checkbox is active only for attributes where a change in value does not trigger standard processing. It is checked by default; you can uncheck it for attributes that you do not want to make available for bulk updates.
- Access restriction : This attribute can be used as data access restriction criteriaThe requirements are as follows:
- The attribute is of the "Code" domain or linked to a list of values.
- The "Access restriction" checkbox is selected for the object.
- Restriction holder : If the object does not have a specific access restriction, the restriction can be applied to one of its attributes. For example: You can decide that no restriction is applied directly to the "Occupation" object, but that the restriction will be the same as the one applied to the Technician performing the work (the "technician" attribute).
This assumes that the "Access restriction" checkbox is not selected for the object.
- Unique : The attribute value does not allow duplicates for this object.
- Required : The attribute will be required: it will be impossible to save the object without filling in this attribute. However, to display the asterisk *, you must customize forms.
Export
These settings apply to exports performed from the Actions menu
from a list, see Export data.
- Exported flat file : The attribute is included in the data exported to Excel, CSV, and plain text formats. (Collections are never exported.) In all cases, if the attribute is displayed in the list, it will be included in the export.
- Exported in XML format : The export mode is defined as follows:
- Checkbox unchecked: The attribute is not exported,
- Checkbox selected: The attribute is exported, along with the linked object, if the attribute has an associated entity,
- Box with a colored background (orange, blue, green, or purple) depending on the theme: The attribute is exported, but not the linked object.
GDPR
This block allows you to define the attributes subject to the .
- GDPR? : If checked, the attribute is subject to GDPR rules and therefore to anonymization processing,
- Signature upon modification : indicates whether modifying this attribute requires a electronic signature to be validated.
Filter criteria - Only items in the "Search" category
- Operator : Type of comparison between the entered search criteria and the value of the object being searched for.
- Criteria : An attribute used as a search criterion. It can be an attribute of the object or of a related object.
- Relationship : The relationship between the main object and the object to which the attribute used as a search criterion belongs.
- Target audience : Related object to which the attribute used as a search criterion belongs.
See Add a search criterion.
Audit
These features are available if the "Audit enabled" is checked in the tab Subject [Audit].
Each checked box will result in a row in the trace table. It is therefore recommended to check the "Insert" and "Delete" boxes only for the attribute used to identify the row, typically the code.
- Insertion : The addition of an occurrence will be tracked, along with the attribute value.
- Modification : Any change to the attribute will be tracked, showing both the new and old values.
- Delete : A strikethrough line will be drawn across the row, along with the attribute value.