Object Masks

Object masks enable you to automatically generate unique object identifiers, and to ensure that these types of identifiers have a constant format. The ODM administrator is responsible for setting up masks to generate identifiers in the format used by the organization.

The ODM administrator must set up object masks for particular object attributes, such as document revisions and changes. For other object attributes, such as folder IDs and document IDs, the ODM administrator can optionally set up object masks.

You can set up multiple masks for particular object attributes. For example, you can define several masks for the document ID, depending on the document type.

The mask generating mechanism is based on mask codes and mask configurations. A mask code is defined for each object attribute for which masks can be set up. The mask code is used to identify the masking mechanism that must be used for the attribute. Object Data Management is provided with the necessary predefined mask codes, and the addition of new mask codes does not affect Object Data Management operation.

In some cases, more than one mask code can be associated with a field. In each situation, Object Data Management determines which mask must be used.

For example, two mask codes are associated with the document revision field, one of which is used to generate the temporary revision, and the other mask code for permanent revision.

To specify the format to be used to generate attribute values, you must define a mask configuration for the mask code associated with the attribute.

You can set up multiple mask configurations for particular attributes. The mask configuration that must be used depends on the value of a different attribute. For example, you can set up various mask configurations that must be used to generate documents for various document types. The mask code definition specifies whether multiple mask configurations can be defined, and which attribute value must be used to determine the mask configuration.

For many object attributes, a default mask is included in the mask code definition in the initial system data. This default mask is used only if no mask configuration is defined for the mask code. The ODM administrator can enter a default mask if none is provided, and change an existing default mask.

Each mask must include at least one generated segment. The generated segment is incremented for each new object created.

To set up a major and minor revision mechanism for a revision field, you must include at least two generated segments in the mask. If the user creates a new revision, the user will be prompted to choose the mask segment that must be incremented. In this way, the user must indicate whether the revision is a major or a minor revision.

For some object attributes for which mask codes are defined, you have the option to set up a mask configuration. In these types of cases, if no default mask value is defined, and no mask configuration has been set up, the user can type in a value when they create a new object, for example, for the document ID.

Although the mask configurations are supplied in ODM setup data dumps for all the objects, a more effective method is to have the mask configuration for the following object masks, according to the organization requirements. If no mask configuration is defined for the following object masks, you cannot create document/document revision and change. For attributes for which multiple mask configurations can be set up, the user must set up at least one mask configuration as active. The configuration of the active object mask is used to generate a mask for a new instance of an object.