Administration

From H2Know-how Manual

The administration page is used to administer users and forms.

Accessing the Admin Page

To access the administration page Login to H2KnOw-how with your provided credentials and click on the administration icon administration icon on the top right hand corner of the page.

Note: That you must have appropriate permission to access this page. If you do not have permissions the administration icon will not appear and you will have to contact your site administrator.

Managing Users

In the screenshot below individual parts of the user administration interface are marked with red numbers. Those numbers correspond to following description and instruction for each feature:

User Administration
  1. Switch between the User and Forms administration tab.
  2. Add a user by selecting the "+" button on the top left of the user grid. When selected the add user dialog will appear.
  3. Enable easy account creation by generating a link. You can then paste the generated link in an email to your colleagues to enable them to create their own H2KnowHow user account with access to your projects with standard user permissions. You will be able to view new user accounts in the user grid. Untick the "Enable easy account creation" checkbox on the left to disable this feature, or click the Generate new URL button to revoke a previous link and create a new one. All accounts created in this way will have the Standard Editor permission level.
  4. Manage existing users uses the same add user dialog where the user can control project access and reset passwords.

Managing or Adding Users

Each entry of the add user dialog interface, accessed through the user administration interface, are described below:

Add User Dialog
  • User Type - Currently there are four user types to choose from when setting up a user:
    • Standard Admin - The Standard Admin user is the highest level of permissions on the platform they are allowed to:
      • Administer and add users
      • Administer and set up mobile forms
      • Create assets on the map page (if using the MiPlant or Tradewaste Waste modules)
      • Edit data
      • Set data scenarios
      • Run scenarios (currently only available for water modelling projects
    • Standard Editor - The Standard Editor does not have access to any administrative task but can perform all editing tasks including:
      • Create assets on the map page (if using the MiPlant or Tradewaste Waste modules)
      • Edit data
      • Set data scenarios
      • Run scenarios (currently only available for water modelling projects
    • Standard User - The standard user can only view information. This user has access to all pages on the site except for
    • Form User - The form user only has access to the mobile form application currently available from the Google Play Store.
  • Email - The users Email address (must contain a valid email address)
  • Password / Confirm Password - The users Password (the password be at least 6 characters long)
  • First Name - The users first name
  • Last Name - The users last name
  • Deactivated - Deactivates the users account. It always recommend to deactivate a users account rather then delete as any data that has been edited or added by the user will be deleted when the users is deleted, however the data will be remain available if deactivated.
  • Users Work(s) - Allows you to selects which projects the user will have access to. Note that when you enable easy account creation all projects that are available to you will be passed to the new user. However you can edit them at a later date.

Managing Forms

Mobile and web based forms are administered using the forms tab in the administration view. In the screenshot below individual parts of the form administration interface are marked with red numbers. Those numbers correspond to following description and instruction for each feature:

Forms Administration
  1. Switch between the User and Forms administration tab.
  2. Project drop down list used to select which available project the form will be created for.
  3. Add form by selecting the "+" button on the top left of the form grid. When selected the add form dialog will appear.
  4. Manage existing forms.
  5. Add question to the selected form by selecting the "+" button on the top left of the question grid. When selected the add question dialog will appear.
  6. Manage existing question.

Adding Forms

Each entry of the add Forms dialog interface, accessed through the forms administration interface, are described below:

Add Form Dialog
  • Name - Name of the form.
  • Asset type - Drop down list to select which type of asset the form will be used for. Each form can be set up for one or many types of assets allowing the administrator to focus each form for specific asset types. There is one special asset type named "Form Result" which allows the user to create new assets in the field. Form Result assets are typically used when pre-loaded assets are not available (e.g. New properties that were not in the original asset set up)
  • Description - A text description of the form.
  • Order - When an individual project has multiple forms this option allows the user the option to put the forms in a specified order. This option is useful when a set of multiple forms is required to be answered in order. The default form order is alphabetical.
  • Supports Multiple Instances - This allows the form to be completed multiple times differentiated by the data and time initiated. The default for this option is off. This option is primarily used for routine site visits where the same form would be completed at each visit.

Adding Questions to Forms

Add Form Dialog
  • Question - The name of the question to be asked.
  • Question type - Currently there are 7 types of questions that you can choose from to enforce a particular type of answer:
    • Text Answer - Allows any free flow text to be entered into the answer field of the question. This is typically used for general notes and description type questions.
    • Limited Set of Answers - This type of question displays a limited number of fixed answers to the user. This type of question is in multiple choice questions and presents the user with a drop down list of all available answers. The answer set can be created and modified by editing the question.
    • Yes or No Answer - This type of question presents the user with a simple yes or no toggle.
    • Date Answer - This type of question presents the user with a date and time dialog.
    • Photo Answer - This type of question promotes the user for a picture. The user can either take a new picture with the device or upload an existing photo.
    • Numerical Answer - This type of question enforces a number only entry.
    • Time Series Answer - This is a special type of question only available when assets have a time series data. This allows the user to enter and edit time dependent values. This is commonly used for monitoring sites.
  • Order - Allows you to order the question sequence when presented to the user. The default order is alphabetical.
  • Has Formula - Only available for numerical answers and allows the user to specify a formula to transform the user entered value. For example you could use a formula to calculate costs if the user enters a quantity. If the Has Formula box is enabled the administrator will see two new boxes where they can enter:
    • Formula label - A short description of the formula.
    • Formula - The actual formula in mathematical terms. For example (3.14 * a - 3^2) / (12 + 71). Ensure your formula specifies the variable "a" (representing the answer the user has entered).
  • Is Multiple Answer - This is used when the question can be answered multiple times for example it is common to allow multiple pictures to be taken for a given question. Another example would be you could use a limited set of answers questions to list multiple people on the site visit.
  • Is Mandatory - This allows the administrator the capability to make a question mandatory.

Edit Questions

To edit any question simply click on the edit button Edit 16x16.png for any question listed in the the question grid. To edit a set of answers for a limited set of answers question select the edit options button Mag 16x16.png. This will open the question options dialog. Click the add button on the right to add new options, and the delete button to remove an option. Drag items to change the order.

Add Form Dialog