New article
Recently updated
Template Design
Who is this article for?Users who want to learn about Configuration Action View Methodology.
Elevated permissions are not required.
This article outlines an overview of Configuration Action View Methodology within Business User Portal System Configuration.
1. Template Design
- The visibility and editable capacity of individual fields within Recommendations and Actions can be controlled for each Recommendation Type, Origin and User Type that is present in the system.
- This level of functionality can be used to create a unique working experience for different users, eliminating unnecessary amounts of information that may not be relevant for them to see or edit.
- To access this component of the Configuration, select Configure Action View Methodology from the main menu.
- This following screen will be presented with the user initially taken to the Template design section.
- The Template design section is split into three elements.
-
Template designs
- Each template design represents the opportunity to customise the view for Recommendations associated to the chosen Origin, User Type and Recommendation Type
-
Template general rules
- For each Template design, two predetermined rules can be enabled to control consistency in the methodology users adopt when using End Date and/or Closed Date.
-
Template Layout: Sections and visible items
- For each Template design, determine which field will be hidden or shown, the order that they will appear in and which users can edit the visible fields.
- To create a new template design select Add Template as shown below.
- The following properties are presented in a new window.
- Using the drop-down menus provided, select the Recommendation Origin that should inherit this customised template design.
- Audit Recommendations are created in the Pentana client application against Risks, Controls, Tests, Audits and Entities.
- Risk Actions are created in the Enterprise Risk Management (ERM) module.
- Project Actions are created via the Business User portal by users with access to the Project Universe.
- Continue to select the User Type that will also be subject to this customised view.
- Any refers to all users.
- Enterprise User refers to all Ideagen Internal Audit (Aura) Users and Risk Users.
- Business User refers to the auditees, also known as Business Users in Pentana.
- Finally, as detailed below, use the menus provided to determine the Type of Recommendations that will receive this specific design.
- Please note if there are no Types visible here, these can be created via Defined Lists which is covered in a previous chapter of this manual.
- If this template design should be inherited by all Types, select Clear Selection so that the Type displays < n/a >.
- Click OK to confirm the Type and continue to click OK once more to add the template design.
- The template will now be added to the list of available template designs.
2. Additional Components
- To continue to define additional components, ensure the template is highlighted in blue as shown above, by clicking once on Select.
- Within Template general rules use the check boxes provided to decide whether there should be dependencies placed over the End Date and/or Closed Date.
- Require end date before setting auditee agreed
- In order to save a Recommendation with Agreed with Auditee set to Yes (i.e. ticked) the End Date must also be set.
- Require close date before setting terminal status
- In order to save a Recommendation with a terminal status (i.e. ‘Closed’ or ‘No Longer Valid’) the Closed Date must also be set.
- Within Template Layout: Sections and visible items the user may now determine what areas will be shown or hidden, which order they appear and whether there should be any specific edit restrictions applied to individual fields.
- Please note that these settings will only apply to the template design created. Recommendations opened by users not falling into the categories selected will not be affected.
- To decide which fields will be hidden completely, click and drag the relevant items to the Hidden Items section as indicated below.
- The click-and-drag utility can also be used to re-order items or display them under different sections.
3. Creating Sections
- To create a new section heading select Create new section.
- The new section will appear at the bottom of the list.
- Click once to highlight the item and define the Name and Tooltip (optional).
- Select OK to confirm the changes and begin placing the appropriate fields under this heading.
- Please note that the Audit Trail component must have its own section heading and cannot be merged with other fields.
- Furthermore, it is not possible to delete existing sections but any section that does not have any fields present within them be automatically removed by the system.
- To determine the editability of fields for the template chosen, the user has two options.
- All fields will be governed by one setting
- Each individual field has its own setting
- To apply a setting that governs all input fields, select Default change permissions (applies to all recommendation/action field items) from the top of the section list so that it appears highlighted in blue.
- In the pane that appears on the right and using the checkboxes provided, the user may determine the overall Usage rights based on Roles, Teams or individual Users.
- As standard Everyone will be selected which relates to all Pentana users, though this can be adjusted as needed.
- A unique option to this component of the system is Users Assigned to the Recommendation. When user fields such as Owner, Instigator, Auditor, Issue Manager and Associated People are available, this level of usage rights will automatically recognise which Pentana users have been associated to these assignments, and only grant those users the ability to edit the Recommendation.
- Once the usage rights are determined select OK to confirm.
- To apply settings that govern each individual input field, begin by selecting the field that should not inherit the usage rights identified above.
- Ensure the field is highlighted in blue to confirm that the appropriate field settings are being changed and under Selected item details, untick the option that states Item uses default change permissions.
- In doing so, a new pane is presented beneath to determine the Usage rights of this individual field. Using the check-boxes provided, the user may determine the individual Usage rights based on Roles, Teams, Users or simply Users Assigned to the Recommendation.
- Once the usage rights are determined select OK to save the changes.
- In doing so, a new pane is presented beneath to determine the Usage rights of this individual field. Using the checkboxes provided, the user may determine the individual Usage rights based on Roles, Teams, Users or simply Users Assigned to the Recommendation.
- Once the usage rights are determined select OK to save the changes.
- When configuring the Usage rights of individual fields, it is also possible to enforce the completion of that field by selecting Item is mandatory with the check-box provided.
- When using this function, the Recommendation cannot be saved to the system until all mandatory items have been completed.
- If the item is determined to be mandatory, select OK to save this setting.
- Please note that not all fields can be controlled in this manner, as not all fields require a specific input.
- The following fields are all provided automatically by the system against each Recommendation that is created, and cannot be configured for usage rights.
- Unique Reference
- Created By
- Created Date
- Modified Date
- Last Update Date
- Type
- Origin
- In addition to the above, the following items cannot be configured for mandatory completion.
- Revised End Date
- Agreed with Auditee
- Update Notes
- Metadata
- Associated People
- Attachments
- With all Template general rules and Template layout options determined, to commit the design of this template to the shared server, select Save changes (for the selected template) from the main toolbar menu.
- Once complete, the system will provide the confirmation banner:
- Once the configuration is saved, a coloured symbol will appear next to any field that has a specific configuration set.
- There is a Key at the top of the Template Layout Section which explains the purpose of each symbol.