Skip to content
This repository was archived by the owner on May 6, 2022. It is now read-only.

Administrator Guide

Jeremy Ho edited this page Jun 26, 2020 · 2 revisions

Administrator Guide

This page provides information on how a form administrator can use the standard COMFORT features. Depending on your access level, you may be able to see the following buttons in the navigation bar:

Submissions

This page shows a table of all the form submissions received.

You can search for submissions using the search box above the table. The text you enter will return results that have a full or partial match on a submission's: 'Status', 'Assignee', 'Business Name' or 'Confirmation ID'. The table can be sorted by clicking on the column headings.

The PDF download is generated using the CDOGS API.

Clicking the 'View' link will open the individual submission on the 'Review' page.

Review Page

Here you can view all the details of a single form submission. There is also a link to download a PDF copy of the submission at the top of this page.

All Admin users will have 'read-only' access to the 'Status' pane, showing the current and history of status changes, as well as the Notes that have been added to the case below

User's granted the 'Form Reviewer' role or above will be able to perform the following functions:

  • Update the Status
    Each form submission can go through various 'Status' changes that may reflect its state in a workflow or operational process. We can also define the permitted sequence of status changes.
    Typically this would be: Submitted > Assigned > Completed

    When a submission is assigned to a Person, that person will receive an email notification (if an email is specified).
    Note: The assignee must also be granted one of the Admin roles to view the submission. Read the Team section for instructions on how to do this.

  • Add Notes Notes can be associated with this submission. Notes are visible to all admin users.

Dashboards

Dashboards can be used to present usage statistics about your form and the information you are collecting. You can have multiple dashboards and allow Admin users with a specific role to access them.

When you first use COMFORT, we will create a 'Submissions' dashboard that is accessible to all Admin users (with Role 'Form Viewer' or above).
Note: Anyone that has been told the source URL will also be able to see the default 'Submissions' dashboard content.

With some database know-how, and use of the Metabase query builder interface, one can create more dashboards and show other data points.

Team

To manage form submissions, you will need to designate at least one Admin user.

Each Admin user's access to features of the Admin panel can be fine-tuned using the following 4 roles (listed from least to most priveleges granted):

Role Description
Form Viewer read-only access to all submissions as well as its Status, Assignee and Notes
Form Reviewer read all submissions, update Status, assign users and attach Notes to any submission
Form Editor currently identical to the 'Form Reviewer' role but may include access to some editing features for a future release of COMFORT
Form Administrator the top-level role - has all of the permissions listed above and has access to the 'Team' page

We strongly recommend granting at least one other Admin user the top-level 'Form Administrator' role who can manage the team when you are unavailable to do so.

Managing Users

To create a new Admin user, take the following steps:

  • Ask the new user to go to the Admin panel for your form. For example:
    https://comfort.pathfinder.gov.bc.ca/app/YOURFORMNAME/admin
    On this page the person should click the 'Request Access' button. This will send an email notification to the configured Admin Email Address.
  • An existing Admin user (with the role 'Form Administrator') should then sign into the Admin panel and go to the 'Team' page. The new user will show up in the table with current role showing as 'Request Access'. The role can be updated depending on the level of access required.
  • User roles can be updated at any time. All roles can be revoked from a user by setting them to 'No Access'.

Settings

This hidden page is located at your url: /app/YOURFORMNAME/admin/settings and lists some of the configuration values used by your application.

These include:

  • The email notification templates used by the system and the email addresses sending/receiving these emails.
    Email notifications are sent using the CHES API
  • The Metabase dashboard source URL's and Admin roles with permission to access them.
Clone this wiki locally