Schemas

Purpose 

The CGR platform uses dynamic forms for configuration, which are known as schemas. Essentially, a customised pop-up form created for a module, such as risks or actions is referred to as a schema. There are two different types of schemas, one that creates a new record and one that updates an existing record. The create and edit schema can be set up independently from each other.  

Schemas allow users to customise modules to fit their specific needs, making it easier to collect, display, and manage data in an organised way.    

Schemas affect how different modules within CGR function, interact and record data.  

Important Notes 

• Keep in mind that any changes to a custom field will impact the schema and will need to be synchronised.  

Step by Step Guide to Create a Schema 

1. Navigate to Admin > Schemas. The page will show any existing schemas. 
   
   
   
   
   
2. Click add to create a new schema. A form will appear, please complete the form and click ‘create’. Below is a description of all fields in the form: 
   • Title [required]: This is the name for your form. 
   • Title Translations: This is only applicable if you have more than one language enabled in the CGR Platform. 
   • Module: The module that this form applies to. Once that is selected, the next field becomes active. 
   • Type: The type you want to apply the form to [e.g. Risk or Opportunity]. 
   • Form Action: Select if you want to create a ‘Create’ or ‘Edit’ schema.
     
     
     
     
     
3. Once you click create, the page will be reloaded, and you will see the ‘Builder’ section where you configure the form. A sub-panel ‘Prepared Schema’ will appear below the ‘Builder’, this is CGR code that makes the schema work. 
   
   
4. Click on 'Builder' and you will see the fields that exist in the CGR Platform for the module and the custom type. You can find the all core fields and custom fields for one custom type on the relevant Custom Type page.
   
   
   
   
   The check box options on the top are explained below:  
   • Only show enabled sub-item panels: This setting will only show the sub-item panels that are turned on, hiding any that are not enabled for the custom type.  
   • Only show visible nodes: This option ensures that only the fields or sections that are currently visible (based on your conditions) will appear in the builder, keeping things clean and relevant.  
     
     
5.  Apart from the existing fields, you'll also find multiple ‘Sections’, each with its own ‘Items’ and ‘Rules’. 
   • Sections help group related fields together, while ‘Items’ are the individual fields within each section.    
   • Rules let you set conditions, like when certain fields should appear or become required. This setup makes it easier to organise and customise the form based on what you need.
     
     
6. On the right side, a few icons, please see the below overview of what they do.
    

   Icon	Description
   Required [*]	If you choose this option, the field will be marked as required, so it must be filled out.
   View [Eye]	This icon allows you to enable the visibility of a field/section on the schema.
   Edit [Pencil]	This allows you to edit a specific section.
   Delete [Bin]	If you want to delete a section, just click the icon. However, you can only delete a section if it doesn’t contain any items (fields).

   
   
7.  You can also expand a section to and do the following: 
   • Add Instruction: Allows you to add an instruction or guideline for the user that will appear on top of the section on the schema.  
   • Add Section: Lets you create a new section in the form.  
   • Transfer node here: This option allows you to move a specific node (or section/field) to this location. Please note that this option only appears when you selected one or more fields or instructions via the checkbox. 
     
     
8. You can also add Rules. With rules, you can control the visibility of fields in a section by setting conditions and effects under the option ‘Rule’. 
   
   For example, if ‘Create as Simple Risk?’ is equal to ‘True’, the ‘Category field will be hidden.  This helps keep the form simple and easy to navigate by only showing the fields that are relevant to the user’s choices.  

Sections

1. Some sections are pre-existing groups in every new schema that help organise different types of core fields. 
2. For example, the ‘Dates’ section automatically includes core fields like ‘date’ or ‘date time’.   
   
   
   
   
   
3. The ‘Linked Item’ section shows modules that are connected to the current module. On the create form, these fields allow you to link a new record to existing records from those related modules. 
   
   
   
   
   
4. The ‘Extra Fields’ section displays any custom fields you have created for this module. From here, you can move them to other sections or edit the fields. 
   
    
   
   
   
5. Once you’ve made changes in the builder, make sure to click ‘Save’ at the bottom to keep your updates. 
   For peace of mind, you can also hit ‘Save' at the top. It's a good idea to save your work every time you make changes, because if you refresh the page or leave, anything unsaved might be lost. This ensures your changes stay intact.
     
6. Now when you go back to the module and click on ‘Add’ the add form will open as a ‘pop-up’ with all the customisation that you have made. If the schema doesn’t reflect your changes, please navigate to admin > schemas and sync the schema.  

Step by Step Guide to Edit a Schema 

1. Navigate to Admin > Schemas. The page will reload showing any existing schemas.  
   
   
   
   
   
2. Click the hyperlinked title of the schema that you need to update. To update the schema, please refer to the section above. Making changes on a new or existing schema is the same.  

Common Issues & Troubleshooting 

Impact of Custom Field Changes

• Issue: Custom fields may appear or disappear on schemas after changes to the custom field or custom type. 

• Solution: Verify on the custom type that fields are enabled to display on the intended form. 

Changes Not Reflecting

• Issue: After creating a new custom field or adjusting visibility settings in the custom type, the changes are not reflected in the schema. 
• Solution: Allow 1-2 minutes for the server to update the backend, then synchronise the schemas using the provided button. 

User Interface Anomalies

• Issue: Embedded rules may not be applied as intended. 
• Solution: Double-check the rule conditions and review the ‘hidden’ settings to ensure proper configuration.