Introduction
Transform your web app’s information panel into a user-friendly experience! Easily reorder, group and validate attributes to make managing complex objects effortless and intuitive.
What is possible:
Grouping attributes
Make attribute Read Only
Add authorized values
Make attribute mandatory
Prevent forbidden characters
Hide attribute
Mask customization is available within the ENOVIA Properties panel for both OOTB and custom attributes.
Version – Validated on 2026x GA
Pre-requisites:
Administrator role
How to do it
When an Administrator user opens the properties panel for any object on any of the OOTB App, an Options facet is visible.
On selecting this Options facet, Mask management interface can be accessed.
An Autocomplete feature is available from where an user can select Types, Relationships, Extensions (with Extensions and Interfaces treated equivalently), and Custom Types. All matching types are displayed in the suggestion list as the user types.
This matching is based on both the name and the display name.
When a type is selected from the autocomplete, the view updates to display the list of applicable actions, as shown in Figure 3.
In this example, the Admin user has selected Manufacturing Assembly (CreateAssembly) as the type.
The following buttons are available in above interface and perform these actions:
- Download – Downloads the most recently uploaded mask.
- Upload – Allows you to upload a new customization mask.
- Original – Downloads the original OOTB mask for the selected type.
- Backup – Downloads the previous backup of the most recent mask.
Note: For the following use cases, we will customize masks for the “CreateAssembly” type. Similarly, you can select any required type and customize masks accordingly.There are two types of attributes: OOTB attributes and custom attributes (added through the Attribute Management Console). Therefore, the two masks need to be customized independently.
- The mask associated with the OOTB type Manufacturing Assembly (CreateAssembly) is used to manage OOTB attributes.
- The mask associated with the custom type XP_CreateAssembly_Ext (XP_CreateAssembly_Ext) is used to manage custom attributes.
For Manufacturing Assembly instance attributes, we need to customize DELFmiFunctionIdentifiedInstance (DELFmiFunctionIdentifiedInstance) mask
Default mask will be inserted into database for types only and not extensions and relationships
Note:If a user uploads a mask through any OOTB application, the changes are reflected across other OOTB applications as well. For example, if a mask is uploaded via Manufacturing Items Management app, the updated results will also be visible in the Process Management app.
Mask files enable you to specify the properties displayed for each type of objects in the Properties tab of the Information widget or panel. The mask file has various sections. We will discuss what these sections do and what should be included in each section.
- Write section: This section impacts the display of the properties in the Properties tab of the Properties or Information panel. In the Write section, indicate which attributes you want to display in the order of your choice, with their read-only (RO) or read-write (RW) status, and their group (if any). The order in which you specify the attributes in this section is the order in which the attributes are displayed in the user interface.
- Groups section: This section impacts the display of the groups of properties in the Properties tab of the Properties or Information panel. In the
Groupssection, indicate the user interface name of the group, and its position regarding the other groups. Note: This section is not included in default mask files. If you want to use groups, you need to create it. - Create section: The
Createsection impacts New … dialog boxes only. TheWriteandGroupsections impact the Properties tab only. - Details section: In the
Detailssection, add the other characteristics for each attribute (authorized values, read-only or read-write status, mandatory attribute, forbidden characters, ...).
Use Case 1: Group OOTB & Custom attributes in properties panel
In this use case, the Admin creates three groups of attributes and organizes the OOTB attributes within them.
Before grouping OOTB and custom attributes using a mask, the Properties panel appeared as follows:
To define groups using mask, the Admin must specify three parameters:
- Group Name: The internal name of the group. This must be unique.
- NLS: The display name of the group. The text entered here will appear as-is on the Properties panel.
- Weight: Determines the order of the group on the Properties panel. If multiple groups have the same weight, or if the weight is set to 0 (same as the Attributes group), they are sorted alphabetically based on their display name.
In the example shown in the video:
- "Identification" appears first with a weight of 3
- "Lifecycle Stage" appears second with a weight of 2
- "ERP_Related" appears third with a weight of 3
- "Other" appears fourth with a weight of 0
Following video illustrates the process:
When mask customization is completed for OOTB & custom attributes, they all will appear under their respective groups as illustrated in below figure
If we want to change the order of attributes inside a particular group, we can do it by changing the order of attribute grouping in JSON, with the next upload, the order will be updated in the properties panel
The order of attribute grouping defined in the JSON is reflected in the Properties panel as shown below (see figure).
If the order is modified, the updated sequence is reflected in the Properties panel as shown in below figure:
Use Case 2: Configure the following attribute behaviors on OOTB & Custom Attributes
Make attribute mandatory
Make attribute Read Only (RO)
Add forbidden characters
Add authorized values
Hide attribute
Following video illustrates the process:
Use Case 3: Configure the following attribute behaviors on Instance Attributes
Make attribute mandatory
Make attribute Read Only (RO)
Add forbidden characters
Following video illustrates the process:
JSON Examples:
References link
User assistance Manual : Mask File Syntax
