In CivilPro, you can create and add custom fields to most of the main registers. The purpose of this feature is to allow users to assign an identifiable value to an item and in doing so, they can be used for tagging and tracking a specialized task, a subset attribute, etc.
For example, a Custom register of 'Teams' can be created and assigned to Lots to help with allocating specific team members and tracking accountabilities. Lots can then be grouped or filtered by their assigned Team.
In addition, Custom Registers can be used to customize Lot numbers based on additional information (e.g. sub grades), on top of Work Types and Area Codes, to create a subset of tags for your Lot. Refer to 'Create Custom Lot Numbers Using Custom Registers'.
Covered in the below:
- Setting up Custom Registers
- Establishing Parent / Child Custom Register hierarchy
- Re-ordering Custom Registers
Related Links:
Create Custom Lot Numbers Using Custom Registers
Setting up Custom Registers
1. Select the relevant project, navigate to "Other Setup", then "Custom Registers".
2. Click on the tab “New Custom Registers”.
3a. There are two tabs – Details and Items. You’ll see the Details tab first.
Under the Details tab, complete the following fields:
- Custom Register – enter a suitable name e.g. Teams. Note that this will be the name of the new field appearing on the other registers to which this is added.
- Short Code – this is not required to be completed unless you are creating a customized Lot Number
- Type – select Lookup or Text. Lookup means the custom register values will be displayed as a list of pre-defined options. Text means that the values will be freehand and entered manually in the linked registers.
- Parent Custom Register - if you select a parent custom register in this field, then your current custom register will become a subgroup register to the items in the parent customer register. For example, the items in your parent custom register can be : Activity Type A, B and C. You can then create an activity sub-type register based on what is selected e.g. Activity Sub-Type 1 for Activity Type A, Activity Sub-Type 2 for Activity B, etc.
- Custom Register Activations – you can select here which register to add your custom field. Under each register, there is a list of options to select :
IsActive: you must select this option to activate the custom register in your selected register e.g. Lot or NCR
IsRequired : if you select this option, then the custom register value field becomes compulsory for the selected register, for example, you will be not able to create a lot without entering a value for the custom register if this is marked as IsRequired in the Lot register.
IsReported : if you select this option, the custom register values will be included on the report of the related register. Note : This option is allowed only for selected registers, not all types.
3b. If you have selected LookUp for Type under the Details tab in 3a, then you’ll need to enter the Values under the Items tab:
- New Value – Click on the “New Value” tab to add multiple values (e.g. team members' names, cost codes, etc.) and press Enter. It is not necessary for you to enter a short code here unless you are creating a custom lot number.
Click “Save”.
Note: If you have selected a Parent Custom Register in 3a, please also refer to 3c.
Establishing Parent / Child Custom Register hierarchy
3c. If you have selected a Parent Custom Register, this is where you'll need to select the Parent Selector Id to link to your values.
4a. You can now navigate to the linked registers and the new field can be accessed on the "Custom Reg" tab. In this example, the newly created "Teams" can be used to assign a Team Member to a Lot as shown below.
4b. If your custom register is linked to a Parent Custom Register, then you must select an option from the Parent Custom Register first, before selecting the item in the secondary register.
Re-ordering Custom Registers
Within the 'Custom Registers' Register, simply click and drag the 6 dots to the left of the Custom Register and re-order as required. This will set the appearance order where Custom Registers are assigned (e.g. in the Custom Register tab in a Lot).