CMiC Field - Masks and Auto-Numbering Objects

Masks are used within CMiC Field to number objects automatically, rather than entering the object numbers manually every time a new object is created. This helps ensure objects are using consistent numbering conventions.

Code masks consist of two parts, the object type code and the object number. The object type code can be linked to the object type (for example, RFIs can be auto-numbered according to their RFI type codes, projects according to their project codes, and so on) which allows for easier identification and organization of object records within CMiC Field log screens. Refer to Numbering Field Objects by Type for more information.

Masks can be set up at both the company and project levels, as detailed below. Masks defined at the company level are defaults only for the creation of new projects. The mask settings at the company level are not used outside of the copy action at the time of the project creation. Masks at the project level are used and different settings can be applied on a project-by-project basis by overriding the copied values.

Company Level

Code masks can be set at the company level in the Code Masks tab of the Company Control screen. This is where default company-level masks are initially defined and then subsequently copied over to a new project.

Project Level

When a new project is created, company-level masks default from the Company Control screen. Optionally, these company-level defaults can be overridden at the project level using the [Masks] button on the Project Maintenance screen.

Numbering Field Objects by Type

This section details how to link an object's type code to its mask and auto-numbering settings. As an example, this section explains the process for numbering RFIs, but the process can be applied to other PM objects.

  1. Set up PM object type.

    Ensure that the PM object type has been created. These types apply to all projects for the company and are not project-specific. For our example, RFI types can be created in the RFI Types screen.

  2. Set up mask on Project Maintenance screen.

    Next, enter the mask code on the Project Maintenance screen. The first half of the mask relates to the object being numbered and is the same for all auto-numbered objects. The second half is the number of that object, the length of which is determined by the number of asterisks. Either enter a code manually or link it to the object type directly by using the codes shown below.

    c=Company Code, p=Project Code or j=Job Code, y=Year, m=Month, d=Day, *Next Available Number

    For RFIs, we recommend entering the code mask as rrrr**** using a lowercase letter "r". This will set the RFI number as the first four characters of the RFI type code (which was created in step 1 using the RFI Type screen), followed by a three-digit number, starting with 001 and increasing sequentially with every new RFI the user creates.

  3. Complete any optional settings.

    For our example using RFIs, users can consider the following optional settings:

    • Field security can be assigned to the RFI Type field located on the RFI screen using the Role Maintenance screen. For example, field security for the RFI Type field could be set to "Read Only" for some specific subcontractor roles, if required.

    • The 'Allow Override' checkbox, located in the RFI No. row of the Masks pop-up window launched from the [Mask] button on the Default tab of the Project Maintenance screen, can be used to control whether the user can change the automatically generated number prior to saving the object record. If this box is checked, an override is permitted.

    • The 'Include Partner Abbreviation in External RFI' checkbox, located at the bottom of the Masks pop-up window launched from the [Mask] button on the Project Maintenance screen, can be used to control whether partner abbreviations are included in the RFI numbers for RFIs generated by external users. By default, this box is checked. If checked, the partner abbreviation code is included in the RFI auto-numbered code when the From contact is the Partner contact. If unchecked, the general project mask is used.