Custom Types

Modified on Wed, 23 Jul, 2025 at 4:44 PM

Purpose

Custom Types allow further customisation into a module in the CGR Platform. The most common examples are Risk and Opportunities, Risk Treatment Actions and Audit Actions. The enable different forms within a module where user can populate with the configured fields within the application. 


It allows users to create different type of items within same module with distinctive workflow and fields allowing specific customisation without affecting a different record.



Step by Step Guide to Create or Edit a Custom Type

  1. Navigate to Admin > Custom Types. This will open a list of existing custom types. Please note that there is always at least one custom type that typically is preconfigured to all modules in the software.

  2. Click Add adjacent to each module panel to Create within a respective module. A form will open up with the following fields:

  3. Click 'Save'.


 

The only required field is the title of the new custom type. This title should clearly differentiate between the other custom types.

FieldDescription
TitleUsed as the title to name the custom type and the name that all users will see and refer to in the CGR Platform.
DescriptionUsed to as an extra piece of information for anyone reading this custom type.
Custom TypesScope the custom types available to be created from this custom type (used for linked other records like actions). For example, you may want to only allow “Risk Treatment Actions” to be created from a Risk type, so, you would scope only that Action type and not the others.
Short titleIf left blank, the system will use the first character from the custom type title. You can choose up to 3 characters. This is used on tables around the software.
ColourThis colour is used on item lists [tables] and also in the dashboard charts. The colour is applied to the “Short title” column [seen above]
Rollup actionsThis applies to few modules. Example: risk custom types, and it will make all actions that are linked directly to risk controls to also show under the risk actions sub panel. It simply “rolls up” any sub actions from select linked records.
Hide from add buttonThis will hide the custom type from add buttons across the application, and it is helpful in cases where you need only to allow certain users to see the add via the “Create” button.
Hide from add button on list view and project pageThis will hide the custom type from add buttons across within the project/register page and also on the list view of the module. It is helpful in cases where you need users to add them only via another custom type and stop them from creating standalone items. For example, Audit Actions should not be created as a standalone record.


Core Field Settings

This allows you to hide and display core fields on different forms and pages. Any fields for which you can see the 'Hidden fields on New Form' box will be hidden. You can customise the 'New Form', 'Edit Form', 'Mass Edit Form' and 'Show View'.


 

FieldDescription
Hidden fields on new formThe selected will be hidden from new form when the record is being created.
Hidden fields on edit formThe selected fields will be hidden from edit form when the record is being updated.
Hidden fields on mass edit formThe selected fields will be hidden from mass edit form when the record is being mass edited.
Hidden fields on show viewThe selected fields will be hidden from the show view when a user with Read access is visualising the record.


Custom Field Settings

This will be covered in in detail within the Custom Fields article, you can find here.

  • For other settings: Click the edit button.
    Note: the following differs depending on the module.
  • For adding hint text under the core fields and other settings you can access them via 'Fields' and 'Properties' panel within the Custom Type.

 


 



Sub-Panels Administration - Configuration

Sub-panels are used to display related records to a specific type. For example, the Action sub-panel appears under the Risk module to show related actions. 


They provide users with a structured view of all associated data such as actions, attachments, comments or linked records, within the same interface. This enhances usability by offering quick access to relevant information, streamlining workflows, and improving traceability and decision-making.



Step by Step Guide to enable a Sub-Panel

  1. Navigate to Admin > Custom Types in the Modules section. This will open a page displaying all custom types from various modules.

  2. Select the desired module and custom type where you want to add the sub-panel.

  3. For example: To add the Action sub-panel to the Risk module, select the custom type for the Risk module.

  4. Add 'Action' to the 'Custom Types' field. This links the Action type to your selected custom type.

  5. Scroll down to the 'Task (Action)' section and click the toggle button to enable the Action sub-panel in your module (e.g. Risk).


  6. Enable the different actions for the sub-panel, as needed:

    FieldDescription
    AddAllows users to add new actions.
    LinkAllows users to link existing actions.
    UnlinkAllows users to unlink an action.
    DeleteAllows users to delete an action from the sub-panel.
    ExportAllows users to export the records in the subpanel as a CSV.

    Note: If you want to enable more than one action for the sub-panel, separate them with commas.
    For example: add, link, unlink

  7. Click on ‘Save’ button to save changes.











Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article