From this landing page, you can set up the structure and content for your template. We’ll take you through these stages, which are shown as tabs at the top of the page:
- REPORT DESIGNER
- RULES AND VARIABLES
- SIMULATE REPORT
REPORT DESIGNER
The REPORT DESIGNER sets up the essential structure and content of your template. To begin, you’ll add sections/chapters using the left-hand panel. Once you’ve created the sections, you can add questions and set up the format that you require for the answers in the template report.
- To create your first chapter/section, click the Chapters and Sections [+] button on the left-hand panel. You’ll be taken to the Add Section form…
Add Section
The information you provide in the Add Section form fields will help users to complete this particular chapter/section of a report:
- Title: choose clear, descriptive section/chapter headings that make the template easy for Users to navigate
- Section Tips: enter any instructions that would help a user to complete the report section. Section Tips will appear to the user when they click the[?] icon while filling in the report. (For example, if a user is completing a report that has questions relating to FCA rules – such as financial promotions – a Section Tip can provide guidance on those FCA rules, or perhaps definitions of terms used.)
Section Tip
This is the information that will appear at the top of the chapter to guide the user through the questionnaire. This is optional.
Assigned User Type
- Choose from Assignee or Reviewer: bydefault, all chapters are set to Assignee (meaning that the Reviewer can see them too, as they have a higher level of permissions than an Assignee). But you can choose to mark particular chapters so that only Reviewers can see them. You might select this option for an employee review, for example, where a manager may wish to keep their own comments hidden.
- Next, check the boxes that fit what you need for your template.
- Is Visible?: if you check this option, the chapter/section will be visible to users. If you leave it unchecked, the chapter/section will be invisible by default. (You can make it appear with a more specific rule if certain conditions are met – as explained under Rules.)
- Is Scored?: if you check this option, each of the answers to multiple choice questions within the chapter/section can be given a numerical value. These values can be totalled as a ‘score’ in the PDF report. This can be useful when options would not be considered to be a Red Flag or Concern. However, it’s important to consider carefully the idea of assigning a score to responses in terms of the overall purpose or outcome of any
- Is Cloneable?: if you check this option, the section/chapter can be cloned (or duplicated) by the end user. This is useful if users need to provide details about more than one client, firm or other entity when they complete the report. For example, if the report is gathering information about counterparties, you will need to add a section that requests details about each relevant But as the template designer, you probably won’t know how many counterparties the user will need to submit information for, so you cannot know in advance how many counterparties sections to create. The user will be able to clone/duplicate the section as many times as they need.
NOTE: if you check Is Cloneable? you’ll need to enter the Cloneable Text on the form. The Clonable Text will be the name that appears in the clonable button.
- If you want to add more sections/chapters to your template now, click CREATE & CONTINUE
- Or if you want to create just one section/chapter for now, click CREATE. You can add more later.
Now that you have created the first section/chapter of your template, the next step is to add your questions for users to answer, so they can complete and submit their report.
Setting up Questions and Answers
- Click on the section/chapter that you have just created
- The section/chapter title will appear to the right
- Just beneath it, click on the[+] to the right of ^ Questions and Answers to create a question. You’ll be taken to a pop-up.
Using the question-creating pop-up
Here we explain the information that you need to enter or select in each of the form fields:
- In the Text box, type the question you want to ask (see our examples, above).
- Select the most useful Answer Type from the following options:
- Label: this is for explanatory text; no actual question is asked. Use this when you want to make an introduction/statement as part of the report that will help give context or support for other answers.
- Assigned User: use this if your question requires users to select the name of a person at your firm from a dropdown list of employees.
- Text Field: select this if your question requires a short written answer, such as a name or a date.
- Rich Text: similar to Text Field, but allows for more formatting, so it’s good for longer answers. Use this option when you need users to provide a longer explanation as an answer, or a list.
- Dropdown: select this option if your question requires users to select a single choice from a list of predetermined options.
- Checkbox: similar to dropdown, but users can check any number of appropriate responses from a pre-determined list.
- Radio: similar to dropdown, but presented so you can see all options on screen at once, as opposed to a dropdown selection.
- Image Upload: choose this if the answer will require the user to upload a document, file or image to appear in the report. For example, this option could be used to upload an ID as part of a client onboarding.
- Table: use this if the user is required to enter tabular data in columns. You’ll be able to predetermine the columns and the user will fill out the information within them.
- Add Additional Content: use this if you need the user to provide extra information that hasn’t already been covered by preceding questions.
-
- Signature: this creates a button for the user to click. The system then captures their name, the date and time, and the IP address.
- Add any Additional Text in the box below. For example, if you think that the question might need to be explained to the user in more detail.
- Use the formatting options just above the text box if you wish to add any bullet points or numbered instructions.
Depending upon the Answer Type you have selected, one or more of the checkboxes listed below may appear.
- Check the options that suit your requirements:
- Is Visible?: check this if you want the question you’re setting to be visible to begin with. (Hidden questions can be made to appear with Rules - as explained below).
- Is Required?: select if a response to the question is required from the user before they can submit the report (these are usually marked with a [*] on forms).
- Set up on Creation?: whenever a report is created, the user is asked a standard set of questions (e.g. title, due date, etc.). Check the box for Set up on creation? if you want to add the question you’ve just created to a list of standard questions.
- Is Token?: this will create a token (essentially, a placeholder) for the answer that will be given by the end You can use the token to position and format the user’s answer in the report: it provides you with fine control over how the answer will appear. We recommend strongly that you select the Is Token? option for most questions, because it is usually needed for the user’s answer to trigger some text in the report. The report token that you set up will be replaced by the user’s response to the question.
For example: one use of a token would be when you need the name and registered address of a person or client to appear multiple times throughout a report. You can assign this request as a token/placeholder wherever you might need those details to appear in the report text. When the user provides the information for the first time, the token will then update that information automatically wherever the token has been placed throughout the report.
-
- Token*: If you have checked the box for Is Token?, you must provide a token ‘name’ here. It should be short and descriptive. We recommend that you use keywords from the question text, but it can be anything - as long as it’s unique within the template. The report token that you set up will be replaced by the user’s response to the question. The token name won’t be visible to the user filling in the report.
Depending upon the Answer Type you selected, further options may also appear at the bottom of the screen.
- If the Answer Type you selected is one with various options for the user to choose from (such as Checkbox, Dropdown, Radio and so on), go further down the page and complete:
- Source for Options
At the bottom of the page, just beneath Answer Options, click the [+] to the right and complete these fields:
-
- Display Name: this is the answer option that will be displayed on the screen to the user filling in the report.
- Report Text: this is text that’s triggered depending upon which answer the user selected, and this answer is then substituted for the Token that you created.
- Red Flag (breaching regulation) or Concern (against best practice standards) to an answer.
- Click SAVE. You will now be able to see the question you’ve set up in the Question and Answer
- If you want to add more questions now, click CREATE & CONTINUE.
- If the question you have just set up is the last or only one that you want to create at this stage, click CREATE. You’ll land back on the REPORT DESIGNER
Note: however, you may wish to add some optional information before you continue…
- Custom Report Text: you can enter additional text here, to ensure that you have set up the context of the question in the report before the user’s answer appears. For example:
- Answer Format: if you want to specify a type of answer that isn’t free text, select how you would like the answer to appear from these options on the drop-down:
- Text
- Multiline Text
- Numeric
- Alpha-numeric
- Telephone
- Date
- Future Date
Report Text
Back on the REPORT DESIGNER page, you’ll see the ^ Report Text area (just below ^ Questions and Answers). The Report Text area is where you can specify how the text in the report will be built up from the answers the users enter. The final report text can be a combination of:
Fixed Text: this can give users context for the questions they’re required to answer. It includes any introductory text to the report and any explanatory information across the entire report.
Tokens: these will be replaced in the report with a user’s answers. You will have created a Token for each question.
Custom Report Text: you will have entered this text on the Questions and Answers form when creating a question: it’s to give context to the user’s answer. The Custom Report Text will appear in the report with the answer to that particular question only.
- Click on the […] to the right of the Report Text and choose Configuration to specify how you would like the text in the report to be built up around the user answers.
- Click SAVE.
Changing the order of report questions
New questions are automatically added to the bottom of a section.
- You can change the order of your questions by dragging and dropping them
- You can also move a question up or down using the context menu
- You can move a question to a different section by dragging it to the relevant chapter or section in the list on the right.
Adding subsections
You can add subsections to each section/chapter as follows:
- Click the relevant section in the Section/chapter list
- An ellipsis[…]will appear to the right of the chapter/section name
- Click the […] and select Add a Child from the menu
- From the same menu, you can also re-configure or delete the section.
You can reorder the subsections within a chapter by dragging them and dropping them to where you would like them to be.
RULES AND VARIABLES
Now that you have set up your Questions and Answers, you will be able to show or hide entire sections or particular questions using the RULES AND VARIABLES tab.
To set up a question or section that is only shown if other conditions are met (for example, the answers to previous questions), you need to set up a rule. The same principles apply to both questions and sections.
Once you have created your questions in the Questions and Answers section, follow these steps:
- Click the RULES AND VARIABLES tab near the top of the Template
- To create a new Rule, click the [+] on the far right of ^ Rules bar and enter the following details on the pop-up form:
- Rule Name: enter a name that will make the rule clearly identifiable to you. (The end user will not see it). For example, if you’re writing a rule for a question about AML, you can call the rule AML.
- A rule is set to run when all of the rule’s Triggers are true. Set up your triggers as follows:
- Trigger: click the [+] to the right to create your trigger. To add more than one trigger, click on the [+] for each trigger that you need to create.
- A trigger can contain one or more Conditions. The trigger can be configured to be true if either all of its conditions are true, or if any of its conditions are true.
- From the dropdown options, select the trigger Conditions for:
- Control Name: choose the question the rule will apply to
- Operator: choose from:
- Question is hidden
- Question is shown
- Contains: if you select this option, the Answer field will also show just below:
- Answer
- Now you need to set up the Action (which will be the consequence of the trigger(s) you have set up for the rule). From the dropdown options, select:
- Control Name: the question that will now be activated by the trigger(s) you set up
- Action: choose from the following:
- Show the question
- Hide the question
- Set the answer to the question
- Answer: if you selected Set the answer to the question just above, the answer will appear.
- Now that you have set up the Rule, with its Trigger(s), Condition(s), and Action(s), click the green CREATE button.
SIMULATE REPORT
Now you can test your completed template by checking a preview:
- On the Templates page, click on SIMULATE REPORT (the third tab near the top of the page)
- You will see a preview of the report template layout
- Test the template by entering text
- Click the NEW SIMULATION tab to test the template as many times as you wish
- Make any further edits to the relevant sections.
Releasing the Template
Now that you have finished creating and editing your template, you’re ready to release (or ‘publish') it:
- From Templates landing page, select the template you have created or updated from the index
- Click the […] to the right of the template name and select Update Status
- Set the template status to Released
- Now click […] again and select Permissions and choose which Groups can view or interact with the template at different levels of access.
IMPORTANT NOTE: the template will not be accessible to the relevant Groups and their users until you have completed the crucial last step…
Connecting a Template to a Module
The final stage for releasing your Template is to connect it to the relevant Module (also referred to as a Repository). This ensures that Groups and users with the right permissions can access the template.
For example, if you’ve created an attestation template, you’ll need to add it to the Attestation module. Then, accessing the template from the Attestation module, a user can enter the required answers on the template, creating a PDF report, which will then be published within the Attestation module.
Here are the steps to add your template to the relevant module and ensure it can be accessed by users who will need to see it:
- Go to the Settings page and click Modules
- From the index of Names, select the Module where User Groups will access the Template you have created and click […] to the right
- Select Edit. You’ll land on the pop-up Edit Module form
- From the templates drop-down, select the Template that you have created
- Your template will now appear in the Module so that users from Groups with relevant permissions can access it.