In this article you'll find all the information you need to transform a field audit template from a non-standard format to the standard format that can be imported as a questionnaire in FranchiseBlast.
Let's take a quick example of some rows of a sample field audit questionnaire that needs to be imported and compare it with the standard format it needs to be transformed to in order to be imported into FranchiseBlast.
Initial Format
Biscuits | Pt. Value | Yes(X) | No(X) | NA(X) |
---|---|---|---|---|
Biscuit Maker Certified | 3 | |||
Biscuit Appearance / Color / Size | 4 | |||
Wets Prepared & Handled Properly | 1 | |||
Dough Handling & Rolling / Biscuit Cutting procedures | 1 | |||
Par Bake Biscuit Procedures Followed & Correct (Hold Times) | 1 | |||
Oven Rack Positions Correct / Ovens loaded properly | 1 | |||
All Other Biscuit Procedures Followed & Correct | 2 |
Standardized Format
Name | Weight | Type | Level |
---|---|---|---|
Biscuits | Section | 1 | |
Biscuit Maker Certified | 3 | YesNo | 2 |
Biscuit Appearance / Color / Size | 4 | YesNo | 2 |
Wets Prepared & Handled Properly | 1 | YesNo | 2 |
Dough Handling & Rolling / Biscuit Cutting procedures | 1 | YesNo | 2 |
Par Bake Biscuit Procedures Followed & Correct (Hold Times) | 1 | YesNo | 2 |
Oven Rack Positions Correct / Ovens loaded properly | 1 | YesNo | 2 |
All Other Biscuit Procedures Followed & Correct | 2 | YesNo | 2 |
As you can see, column names are not the same, we are defining which questions go under which section with the Level column. This standard formatted table could now be imported in our system.
Specific Formatting rules
This section will cover several basic rules to follow when transforming a questionnaire. Column names annotated with an asterix (*) are mandatory to be imported.
Valid columns
- Name *
- This column either contains the name of the question, section, option or option group the row is referring to.
- Documentation
- This column contains some documentation related to a question or section
- Type *
- Determine the type of the row.
- Here are all the possible types:
- Section/Heading
- A section containing questions under it. Rows immediately under a Section should have a Level # of + 1 this section. For example if a section has a level 2, all questions under this section should have level 3.
- YesNo
- A question that can be answered with either Yes, No or N/A
- Text
- A question that can be answered with a short text (single line text)
- TextArea
- A question that can be answered with a longer text (multiple lines)
- Radio
- A multiple choice question where we can choose only one answer. See the options section below.
- CheckBoxList
- A multiple choice question where we can choose multiple answers from the list of choices. See the options section below.
- SingleImage
- A question where we can upload a single image
- MultipleImages
- A question where we can upload multiple images
- Number
- Just like Text, but with an extra validator to ensure only numbers are typed.
- Email
- Just like Text, but with an extra validator to ensure only emails are typed.
- Address
- A special control letting you choose an address (polling only)
- Timer
- A timer control to calculate speed of service. See point rules definition section below.
- Files
- A question that requests to upload a file.
- PhoneNumber
- A question that requests a phone number in text format.
- Date
- A question that requests a date with a date picker.
- Address
- A question that requests for a complete address (multiple fields including country, street # etc.).
- Temperature
- A question that asks for a temperature and provides an acceptable range for that temperature. See point rules definition section below.
- Concentration
- A question that asks for a concentration and provides an acceptable range for that concentration. See point rules definition section below.
- Section/Heading
- Level (Sections, sub-sections and questions)*
- Define how deep a section or a question is in the tree view of the questionnaire. See "Sections and tree levels" in this document for further explanations.
- Weight *
- Each question has to have a Weight which represent how much points is given when we answer it positively.
- IsMandatory
- Define if a question has to be answered or not
- Options
- For multiple choice questions (Radio and CheckBoxList), a list of options have to be defined. See "Options definitions" in this document for further explanations.
- IsNoRightAnswer
- For questions of type "YesNo" we can set this column to "TRUE" if "No" is the right answer for the question instead of "Yes".
- ForceComment
- If this column is set to "TRUE", then users will get forced to enter a comment to the questions when they fill out the questionnaire.
- MandatoryPictureOnQuestionFailure
- If this column is set to "TRUE", then users will get forced to enter a picture to the questions when they fill out the questionnaire.
- MandatoryTaskOnQuestionFailure
- If this column is set to "TRUE", then users will get forced to enter a task to the questions when they fill out the questionnaire.
- CorrectiveAction
- We can have several CorrectiveAction column for each language. CorrectiveActionFR, CorrectiveActionNL, etc. Just append the correct culture at the end.
- Corrective action text will be shown when the auditor creates a task on a specific question. The corrective action text will be shown when opening the task in FranchiseBlast.
- Severity
- Defines the severity of a question which is then used in our points engine as well as to trigger automatic failures as per the severity rules defined for the questionnaire.
- Valid values are "Low", "Normal", "High", "Critical" and "Bonus" (case sensitive).
- Included In Summary
- If this column is set to "TRUE", then this section will be included in the 'Section Summary' of the read-only audit. This field currently only applies to sections, although that may change in the feature. The read-only audit always includes top-level sections, regardless of this field.
Sections and tree levels
Sections are groups of questions, a section has questions under it. There is no limit on the number of levels but questions must be within a Section (as such, the first element must be a SectionSections can have sub-sections as well etc.
For example:
- Section 1
- YesNo Question 1
- YesNo Question 2
- Section 1.1
- YesNo Question 1
- YesNo Question 2
- YesNo Question 3
- Section 1.2
- YesNo Question 1
Transforming this tree view to a flattened view:
Name | Weight | Type | Level |
---|---|---|---|
Section 1 | Section | 1 | |
Question 1 | 1 | YesNo | 2 |
Question 2 | 1 | YesNo | 2 |
Section 1.1 | Section | 2 | |
Question 1 | 1 | YesNo | 3 |
Question 2 | 1 | YesNo | 3 |
Question 3 | 1 | YesNo | 2 |
Section 1.2 | Section | 2 |
Category definition
Name | Weight | Type | Level |
---|---|---|---|
My awesome question. | 4 | YesNo | 2 |
Happiness | Category | ||
Candies | Category |
Options definition
For questions of type Radio and CheckBoxList, we have to define a column of type Options. This column is used to define a list of multiple choice for this particular question. Each choice as to have a text and a weight value. It is also an option to say that an option can be inputted by the user using the Freeform Text option feature. Here is an example for a Radio button with the following choices
- What is your favorite movie?
- Jackass: 0 points
- Inception: 5 points
- Other (specify which one by writing it): 1 point
Here is the resulting format that should be used:
Name | Weight | Type | Level | Is Freeform Text |
---|---|---|---|---|
What is your favorite movie? | 5 | Radio | 2 | |
Jackass | 0 | Option | FALSE | |
Inception | 5 | Option | FALSE | |
Other | 1 | Option | TRUE |
Option Groups
Optionally, some options can also be grouped in what is called an "Option Group", in order for them to be shown under one option while answering the question. This is only applicable to questions of type Radio.
When selecting the option group's name while answering the question, the user is prompted to pick one of the options from the option group as the answer to the question. It basically simplifies the user interface when options have lengthy names, for instance.
In order to specify an option group for some options of a Radio question, insert a new row before the options to put into the option group and give the option group a name under the Name column and set the Type column to "OptionGroup". An example is shown below.
Keep in mind that option groups must be the last options in a Radio question's option in terms of ordering. you cannot put an option group before option rows that aren't grouped in an option group.
Name | Weight | Type | Level | Is Freeform Text |
---|---|---|---|---|
What is your favorite movie? | 5 | Radio | 2 | |
Superman | 3 | Option | ||
A movie from the 2000s | OptionGroup | |||
Jackass | 0 | Option | FALSE | |
Inception | 5 | Option | FALSE | |
Other | 1 | Option | TRUE |
Point Rules Definition
- The entry Name has to be entered as well as its type (either Temperature or Concentration). The Point Rules Unit is mandatory for Temperature and Concentration question types when specifying point rules. Valid point rules units are the following:
- Celsius (Temperature)
- Fahrenheit (Temperature)
- PPM (Concentration)
- Seconds (Timer)
- When specifying the actual point rules:
- The name column defines the label of the point rules. That is the text that will be shown when the result is in the range specified by that rule.
- The type of a point rule must be set to PointRule (mandatory).
- Each point rule can have a weight for scoring, similarly to our scoring feature for multiple choice options.
- A point rule operator is used with each rule to define the range that it will test. Valid operators consists of:
- LessOrEqual
- Between
- Greater
- Point rule parameters are the actual numbers that the point rule operator uses to defined the range of a rule.
- The Severity column can be used to indicate the color on Point Rules for Sections and Settings.
- Color is one of: Green, Yellow, Orange, Red, Blue, Violet, Black, White, Pink
- Although they utilize colors, they do not take the Weight into account at this time.
- The example below depicts a question where the acceptable range for the interior temperature in a truck is:
- Below the acceptable range between -10 Celsius and 0 Celsius (0 point)
- In the acceptable range between 0 Celsius and 4 Celsius (2 points)
- Above the acceptable range if greater than 4 Celsius (0 point)
Name | Type | Point Rules Unit | Weight | Point Rule Operator | Point Rule First Parameter | Point Rule Second Parameter |
---|---|---|---|---|---|---|
Interior Truck Temp | Temperature | Celsius | 2 | |||
Below Acceptable Range | PointRule | 0 | Less | -10 | ||
In Acceptable Range | PointRule | 2 | Between | 0 | 4 | |
Above Acceptable Range | PointRule | 0 | Greater | 4 |
Global Audit Questionnaire Settings
We have begun adding some questionnaire settings to the export. Although not all settings are currently supported, a few have been added for convenience. Global settings should be added at the end of the questionnaire.
- Passing Score
- Type: Settings
- Name: Passing Score
- Weight: 80 to represent 80%
- Score Label Rules
- Type: Settings
- Name: Score Label Rules
- The following rows are Point Rules (as defined in the Point rules section or as in the example below)
- Note Less/Greater rows ignore the Point Rule Second Parameter
Name | Type | Severity | Weight | Point Rule Operator | Point Rule First Parameter | Point Rule Second Parameter |
---|---|---|---|---|---|---|
Score Label Rules | Settings | |||||
F | PointRule | Red | 0 | Less | 76 | 1 |
C | PointRule | Orange | 0 | Between | 76 | 86 |
B | PointRule | Yellow | 0 | Between | 86 | 95 |
A | PointRule | Green | 0 | Greater | 95 | 1 |
Projects
Transforming a non-standard project to a FranchiseBlast standard format follows the same methodology listed above along with a few additional columns:
UserGroup
- Who is actually doing this task? Example: Legal, Marketing, Finance etc
- Note that the Usergroup must be defined in FranchiseBlast
- For any tasks that need to be assigned to a Franchisee, the user group on the csv is "Franchisee Staff". This user group does not need to be created and it does not need a leader to be assigned to it.
DaysToMainEvent
- Number of days before the main event upon which the task must be completed
- Note: entry must be listed in days. Most of the time, we receive the format as weeks or months.
Type
- With the exception of Sections, the type for actions plans is Task.