Skip to main content

How to import prompt questions

Written by Teresa Bui
Updated over a week ago

What You'll Learn

  • How to import prompt sets and prompt questions by CSV


Before you start

Requirements:

  • The Prompts module must be enabled in your workspace. If you don't see Prompts in your main menu, contact [email protected]

  • Permission needed: Can change site configuration settings- When the Prompts module is enabled, prompts will immediately become visible to technicians working on tasks. To avoid disruptions to ongoing tasks, enable the module during low-activity periods, such as late in the day or at the end of a workweek.


For information on how to set up prompt questions directly in Uptick, refer to this article.

How to import new prompt sets and prompt questions

1. Go to the main menu, and navigate to Tools > Data Importer

2. Download the prompt question import template with example rows

3. Fill out the csv template.

Important:

  • Every prompt set requires at least 1 Header question type before you add other questions

  • Please note, the order of the questions is on the CSV is the order they will present in Uptick.

The table will include information to define your prompt set and questions. Below are the mandatory fields:

is_active

is_required

type

ref

label

promptset_name

promptset_ref

promptset_config

promptset_assettypes

promptset_routineservicetypes

Is Active

Is Required

Type

Prompt Ref

Label

Promptset Name

Promptset Ref

Promptset Config

Promptset Assettypes

Promptset Routineservicetypes

MANDATORY
Set to TRUE or leave blank if this should be active. Set to FALSE to make inactive.

MANDATORY
Set to TRUE if this is mandatory. Set to FALSE or leave blank to leave optional.

MANDATORY
Select from the following options:
HEADER (At least 1 is required per prompt set)
ASSERTION
REMARK
TEXT
INTEGER
DECIMAL
DATE
CHOICE
TERNARY
PHOTO
MULTICHOICE

MANDATORY
Unique reference for the question within the promptset. Used to identify questions across imports. For HEADER questions, this ref is used to identify sections.

E.g.
1.1

MANDATORY
Question label shown to users

E.g.
Check the discharge nozzle for this extinguisher

MANDATORY
Name of the promptset this question belongs to.
This is required for all questions.
Questions with the same promptset name will be grouped under the same promptset.
If a promptset with this name already exists, the question will be added to that promptset. Otherwise, a new promptset will be created.

E.g.
Fire Extinguisher Portables

MANDATORY
Reference for the promptset.
Must be consistent across all questions with the same promptset name.

E.g.
1

MANDATORY:
Default: {}

MANDATORY:
List of asset types this promptset applies to.
Separate each asset type on a new line in the same cell.
Must be consistent across all questions with the same promptset name.

E.g.
Fire Extinguisher: Portables
Fire Extinguisher: Wheeled

MANDATORY:
List of routine service types this promptset applies to.
Separate each routine service type on a new line in the same cell.
Must be consistent across all questions with the same promptset name.

E.g.
Fire Extinguisher: Portables (2012)
Fire Extinguisher: Portables (2005)

There are also optional fields:

help_text

limit_to_variants

limit_to_routineserviceleveltypes

remarktypes

config

choice_keys

choice_values

promptset_type

rules

Help Text

Limit To Variants

Limit To Routineserviceleveltypes

Remarktypes

Config

Choice Keys

Choice Values

Promptset Type

Rules

Additional help text shown to users

E.g.
Make sure you open the nozzle to check

List of asset variants to limit this question to.
Each line should be in the format "Asset Type - Variant" name as it displays in your control panel.
Separate each variant on a new line.
Only variants that are applicable to the promptset's asset types can be assigned.


E.g.
Fire Extinguisher: Portables - Portable AB(E) 4.5kg Extinguisher

List of routine level type to limit this question to.
Each line should be in the format "Routine Service Type - Level" name as it displays in your control panel.
Separate each level on a new line.
Only levels that are applicable to the promptset's routine service types can be assigned.

E.g.
Fire Extinguisher: Portables (2012) - Annual

List of remark types that are applicable to this question.
Each line should be the remark type label name as it displays in your control panel.
Separate each remark type on a new line in the same cell.
Only remark types that are global or applicable to the promptset's asset types can be assigned.

E.g.
Custom Note
Damaged Extinguisher

Configure your Prompt Question in this field for the following types:

PHOTO: Copy and paste the following for PHOTO question types. Set allow_multiple_photos to true (for multiple) or false for single photos:
{"choices": [], "allow_multiple_photos": false, "ternary_expected_value": "Y"}

TERNARY: Copy and paste the following to set the ternary expected value. Set ternary_expected_value to Y or N or NA
{"choices": [], "allow_multiple_photos": false, "ternary_expected_value": "Y"}

This field is only applicable for CHOICE questions.
Add a list of choice keys corresponding to the choices for this question. This should be in lower case with no spaces.
Separate each choice on a new line.
Must be used in conjunction with 'Choice Values'.
If both 'config' and 'Choice Keys/Values' are provided, the choices from 'Choice Keys/Values' will override any choices specified in the 'config' field.

E.g.:
apple
orange
no_fruit

This field is only applicable for CHOICE questions.
Add a list of choice values corresponding to the choices for this question. This should be how you want it to display to users.
Separate each choice on a new line.
Must be used in conjunction with 'Choice Keys'.
If both 'config' and 'Choice Keys/Values' are provided, the choices from 'Choice Keys/Values' will override any choices specified in the 'config' field.

E.g.:
Apple
Orange
No Fruit

Choices:
- ASSET_BASED=Asset Based
- TASK_BASED=Task Based

MANDATORY:
Type of the promptset.
Must be consistent across all questions with the same promptset name.

Choices:
- ASSET_BASED=Asset Based
- TASK_BASED=Task Based

Set the frequency which this question will present to users.
Ensure the frequency exists on the routine service type.
Separate each routine frequency on a new line in the same cell.
Each rule should be in the format 'Standard Name - Frequency', where frequency is one of the following: W, 2W, M, 2M, Q, 4M, H, Y, 2Y, 3Y, 4Y, 5Y, 6Y, 10Y, 12Y, 24Y, 25Y, 30Y, 32Y.

E.g.
Fire Extinguishers: Portables (2012) - Y
Fire Extinguishers: Portables (2012) - H

4. Once your import csv is ready, Go to the main menu, and navigate to Tools > Data Importer

5. Select what you are importing and pick Prompt Questions

6. Choose your CSV file and import it. Click Preview Import

7. Complete the field mapping. Select the appropriate Uptick Header for each column of data in your CSV. If you are using the template, this should be prefilled for you.

8. Click Save and Preview

9. If you have no errors, click Finalise. If you receive errors, please address them on the CSV, and repeat steps 4-9 again.


How to edit prompt questions and add new questions to a prompt set

Important rules:

  • You cannot move a question once it is saved under a header. This is because the question may have answers stored against it.
    Solution: Duplicate the question and save it under the new header. Then make the original question inactive.

  • You cannot add a single question via CSV import. You must import an entire promptset at a time
    Solution: If you want to add a single question, please add it directly in Uptick. If you want to add a few questions, please download the prompt questions (Control Panel > Asset Types > Download Prompt Questions). Please insert the new questions amongst the original questions in the order you want them to show.

  • Every promptset requires at least 1 Header question type at the beginning.

1. Download the prompt questions (Control Panel > Asset Types > Download Prompt Questions)

2. Edit/add the prompt questions. Please note the rules above

3. Once your import csv is ready, Go to the main menu, and navigate to Tools > Data Importer

4. Select what you are importing and pick Prompt Questions

5. Choose your CSV file and import it. Click Preview Import

6. Complete the field mapping. Select the appropriate Uptick Header for each column of data in your CSV. If you are using the template, this should be prefilled for you.

7. Click Save and Preview

8. If you have no errors, click Finalise. If you receive errors, please address them on the CSV, and repeat steps 3-8 again.

Did this answer your question?