Tutorials

Purpose

Tutorials are used in the CGR Platform to provide extra context to the end users, from the use of the platform itself, or your own business context and rules (e.g. Risk framework and/or process for approvals).

Important Notes

• You must be an admin user to create a tutorial. You do not need to be an admin user to view a tutorial.
• Tutorials are context based, and as the user navigates around the software, different tutorials will be available upon clicking the “?” help button, this means that you can ensure that only relevant tutorials will be displayed to your end users. The help menu is divided into two sections: Tutorials and Manuals.
• Tutorials can be created by your system administrators.
• Manuals are created and managed by CGR only.

Step by Step Guide To Create a Tutorial

Tutorials can be created in the Admin section > Tutorials.

1. Navigate to Admin > Tutorials. This will display a list of all tutorials [if any]. Click 'Add' to start.
   
   
   
   
2. You will then see a form that is divided into two sections, Core and Page Linking. Please complete the Core form [each field detailed below].
   
   

   Field	Description
   Title	This the name for your tutorial, and the name that the users will see when they open the tutorial help menu.
   Key Phrases	They help surface your article in search results by showing all matching tutorials, rather than only those directly linked to the current page.
   Category	This tag is used to create a hierarchical structure (parent/child articles) or Special. The special one is considered “starred” for all users and appear first.

   
   
   
   
   
   
3. Now it is time to complete the Page Linking form. Here you can customise the linking of the articles and make it available in specific pages or modules. Page Linkage Type, Page, Modules and Custom Types are dropdowns where you can choose from and make it available. The fields are described in detail below
   
   
4. Parent Linkage Type and based on your selection you will be able to specify the linkage further through an additional dropdown menu.
   
   

   Field	Description
   Through modules and/or custom types	You can link your tutorial to specific modules or custom types (e.g. Risk or Opportunity). If they are in use the tutorial will appear in the help icon.
   Through admin controller page	The tutorial will appear at a specific page in the admin section.
   Through controller	This is a more advanced option that makes the tutorial available on more general pages (e.g. Dashboard or My Items)You can customise where the tutorial appears by linking it to specific pages or modules. This is done using the dropdown: Page Linkage Type.

   
   
5. Page: Allows you to select a specific page for the tutorial to show for a particular module as follows:
   • List: On a list view where you see many records on a table.
   • Show: On the record detailed view.
   • Create: When creating a record.
   • Edit: When editing a record.
     
     
     
     
6. Now use the free text area below to write your article. You can customise the font, adjust the layout, and insert images as needed to enhance the content. To review your tutorial, click the eye icon in the top left corner to preview it.
   
   

Frequently Asked Questions

The article doesn’t appear on the page you have linked it to.

After initially creating a tutorial and setting the Page Linkage Type, changes to the linkage may not always be processed correctly if modified later. In such cases, it’s often more effective to create a new tutorial, configure it with the correct linkage settings from the start, and then copy and paste the content from the original.