Custom Forms

Purpose

Custom Forms are used as an additional edit form for a record in a CGR module. They are also available as “columns” [column set] in Datagrid.

-    Datagrid: Custom forms are an elegant way to create field sets that are available for users to work from datagrid. 

-    Record View restricted edit [also applicable to datagrid]: Custom forms are an elegant way to display certain fields to only certain users [users named against a field – e.g. owner, specific roles, or teams].

Important Notes

-    System Administrator access is required to configure custom forms via admin.

-    The custom forms are available in CGR modules.

-    The end user must also be able to “update” a record in order to see the link to the custom form you create.

Step by Step Guide to creating and managing Custom Forms

1.    Navigate to Admin > Custom Forms. On this page you will see custom forms that exist grouped under the module they belong to. Scroll down to the module you wish to create a custom form for, and click Add. Please note that if he table has a pink header, it means that the module is disabled.

2.    When the page reloads, you will see the form. Complete the form [see each field below] and click save when finished.

• Title [required]: This is the name of your custom form. It is displayed in the admin page, and it is also what the end user will see when they access via the record view or datagrid columns.
• Description: Please enter a description explaining the purpose for this custom form. This is not displayed anywhere except admin, and it is used to share information between admins or as a reference in the future.
• Form Fields [required]: Here you need to select the fields you would like to display in your custom form. Please note that the order here matters and it will be the order that they will display in the form [top to down] or columns [left to right].
• Required Form Fields: Here you will select which fields you need to be mandatory in your form. Order here is not relevant.
• Show on datagrid: Marking as yes, it will allow the form to be displayed as a column set under columns in datagrid.
• Icon: An icon to be used besides the title when the end user sees the link to the form.

Restrictions

• Custom Types: If you have more than one custom type, this is a very useful way to ensure this form will only display under the correct type. Leave it blank if you wish to display in all types.
• Field Restrictions: Here you can select the fields where the end user must be named in order to see the custom form. For example, if you select “owner” only users that are set as the owner for a record will be able to see the form link.
• Role Restrictions: Here you can set which roles [if you are using roles in the CGR platform] will be allowed to see the link to the form.
• Team Restrictions: Here you can select the teams that can see or not the custom form.
• Title Translations: This is where you can set the name for this form in different languages [in the case that your CGR platform has multiple languages enabled.
  
  
  

3.    If you need to edit a custom form, click the pencil button on the corresponding row. If you want to delete the custom form, click the delete [bin] button [please note that this action is irreversible].