Custom Types

Custom Types

How to create, configure, and manage custom types and sub-panels in the Clew Platform

Contents

• 1. Introduction & Context
• 2. Key Features & Functions
• 3. Requirements
• 4. Step-by-Step Guide
  • Creating or Editing a Custom Type
  • Core Field Settings
  • Custom Field Settings
  • Enabling a Sub-Panel
• 5. Common Issues & Troubleshooting
• 6. Related Articles

1. Introduction & Context

Custom Types let you create distinct forms within a module in the Clew Platform, each with its own fields and workflow, so you can capture different kinds of records without one type affecting another.

Common examples include Risks and Opportunities, Risk Treatment Actions, and Audit Actions. Each custom type gives users a tailored data entry experience while keeping records organised within the same module.

Who is this for? System administrators who need to configure modules by adding or editing custom types and enabling sub-panels.

What does it impact? Custom type changes affect how forms appear to all users creating or editing records of that type. Sub-panel changes affect which related record panels are visible on the record view.

2. Key Features & Functions

• Per-module custom types: Each module can have multiple custom types, each with its own configuration. Every module has at least one preconfigured type by default.
• Scoped linked types: Control which action types can be created from a given custom type, so users only see the options relevant to that record.
• Core field visibility: Show or hide specific fields on the New Form, Edit Form, Mass Edit Form, and Show View for each custom type independently.
• Custom field configuration: Add and configure custom fields specific to each type, giving you granular control over what data is captured.
• Sub-panels: Enable related record panels on a custom type's record view, and control which actions (add, link, unlink, delete, export) users can perform from each panel.
• Visibility controls: Hide a custom type from add buttons across the platform, or restrict it from appearing on list views and register pages, to guide how records are created.

3. Requirements

• System administrator access is required to create or edit custom types via the Admin section.
• Each module always has at least one existing custom type. You cannot delete the last remaining type for a module.
• To enable a sub-panel, the relevant action type must first be added to the Custom Types field on the parent custom type.

4. Step-by-Step Guide

Creating or Editing a Custom Type

1. Navigate to Admin > Custom Types. This will open a list of existing custom types grouped by module. Note that every module has at least one custom type that is preconfigured by default.
2. To create a new custom type, click Addnext to the relevant module panel. To edit an existing type, click the edit button next to it. A form will open with the fields listed below.
   

   The Add Custom Type form.

3. Complete the fields using the table below. Only the Title field is required. Click Save when done.

Core Field Settings

Core Field Settings let you control which built-in fields are visible on each form and view for this custom type. You can configure visibility separately for the New Form, Edit Form, Mass Edit Form, and Show View.

Any field added to a "Hidden fields" setting will be hidden from users when they use that form or view.

The Core Field Settings panel.

Custom Field Settings

Custom Field Settings let you add and configure custom fields specific to this type. Full details are covered in the Custom Fields article.

To access additional settings such as hint text on core fields, use the Fields and Properties panels within the Custom Type. Note that the available options differ depending on the module.

The Fields panel within a Custom Type.

The Properties panel within a Custom Type.

Enabling a Sub-Panel

Sub-panels display related records within a record's view. For example, an Actions sub-panel on a Risk record shows all actions linked to that risk. They provide a structured view of associated data such as actions, attachments, comments, and linked records, all within the same interface.

The following steps use adding an Actions sub-panel to a Risk type as an example.

1. Navigate to Admin > Custom Types. This will open the page displaying all custom types grouped by module.
2. Select the module and custom type where you want to add the sub-panel. For example, select the Risk module and choose the relevant Risk custom type.
3. In the Custom Types field, add the action type you want to link. For example, add "Action" to link it to the Risk type. This makes the action type available to the sub-panel.
4. Scroll down to the relevant sub-panel section, such as Task (Action), and click the toggle to enable it.
   

   The sub-panel toggle and action configuration fields.

5. Enable the actions you want to allow on the sub-panel using the table below. To enable more than one action, enter them as a comma-separated list, for example: add, link, unlink

6. Click Save to apply the changes.

5. Common Issues & Troubleshooting

Best practices:

• Give each custom type a clear, specific title that reflects what the record represents. Users see this name throughout the platform when selecting or filtering by type.
• Use the Custom Types field to scope which action types are available from each parent type. This prevents users from creating inappropriate record combinations.
• Before hiding core fields, check whether those fields are required by other parts of the platform, such as triggers or reports, to avoid breaking existing configurations.
• When enabling sub-panel actions, grant only the permissions users genuinely need. For example, avoid enabling Delete if records should be unlinked rather than permanently removed.

6. Related Articles

• Custom Fields