Difference between revisions of "Complex questionaires"

From TempusServa wiki
Jump to navigation Jump to search
old>Admin
m (36 revisions imported)
 
(33 intermediate revisions by one other user not shown)
Line 1: Line 1:
== Questionaire building process ==
In order to create a complex questionaire you first choose between copying a solution and creating from scratch.
We strongly reccomend the copying if you are unfamiliar with designing solutions.
=== Creating from scratch ===
Steps to create a questionaire includes
# Create solution and add fields
# Configure questionaire order and messages
# Setup inetrface for external users
# Configure email invitation
# Build report template
For detailed information read the section '''Setting up a questionaire with report''' below.
=== Copying a solution ===
Steps include
# Backup existing solution
#* ''Entity'' > Advanced > Backup > Create new backup
# Promote backup to standard
#* Click top backup > Promote to standard
# Create instance from standard
#* Quickstart > Respository > ''choose'' > Create this item
# Deploy solution
#* ''New entity'' > Deploy live
== Setting up a questionaire with report ==


=== Field types ===
=== Field types ===
Complex questionaires contain fields for sending the questionaire and answering questions.
Complex questionaires contain fields for sending the questionaire and answering questions.
Dependening on how the questionaire is distributed to the users, you will also need contact information such as name and email.


==== Questions and scores ====
==== Questions and scores ====
For normal questions that are answered once use teh field type: '''Complex question'''
A complex question contains a single question and multiple answer. Each answer contains
* Value shown when selecting
* Response showed in report
* Color and icons
* Score


* Complex question
You can optionaly calculate scores across multiple questions using the field: '''Calc: Complex question (sum)'''
* Formula


==== Support for multiple questions ====
==== Support for multiple questions ====
 
Multi line questions consists of the following
* Multiline: Location editor
* Multiline: Location editor
* Mulitiline: Complex question
* Mulitiline: Complex question


There should only be exactly one '''Multiline: Location editor''', while there can be multiple '''Mulitiline: Complex question'''.
First the users enters lines values in the location editor. Then questions are created for each '''Mulitiline: Complex question''' - one for each line entered in the location editor.


Lines can be removed by clicking the checkboc next to them in the '''Multiline: Location editor'''.


=== Questionaire ===
=== Questionaire ===
Normal users will see data represented as a form, while external users will most often have displayed a step-by-step questionaire.


* Fields inclusion and order
Inclusion of fields and their page order is managed in the questionaire order editor: '''Entity > Advanced > Questionaire: Question order'''
* Start and end messages


Note that
* If a field have a sortorder of 0 (zero), it will never be displayed for external users.
* Order numbers are not dispayed to the user and do not need to be consecutive - ex. 10, 20, 30 ...


=== Contact information ===
The initial and final messages of the questionaire is edited in: '''Advanced > Questionaire: Messages'''


* Text: Enter the nam eof recipient
From a normal view normal users can see data in questionaire form, by appending and extra command to the address bar in the browser: '''&StepNumber=0'''
 
=== Granting access for external users ===
The process consists of 2 activities
# Add access for external users by adding a new permission
# Add an interface for the solution: Advanced > Interface: Add
#* Enter a descriptive and unique name
#* Check "UPDATE"
#* Check "Use questionaire style interface"
 
=== Sending emails with links ===
In order to send personalized message you solution will need to contain these fields
* Text: Enter the name of recipient
* Email: Email of the recipient
* Email: Email of the recipient


=== Reports ===
These fields are refered to in the message template in a status action, which is where subject and body of the email is edited.
 
A message is sent to the recipient, when a record in the system reaches a certain state.
 
=== Configuring reports ===
Report are Word documents containing special tags where content from the records are merged into the document.
# Create a new Word document
# Write content and add special field tags
#* Entity > Advanced > Template: Add > Office > (copy special tags)
# Add template to the solution
#* Entity > Advanced > Template: Add
#* Choose Word or PDF add
#* Uplaod the Word file
 
Note that certain configuration options for fontsize, margin etc. can be configured per solution: Entity > Advanced > Configurations
* GlyphPageWidthPercentage
* HeatmapColumnMaxCharacters
* renderExtraLinjeBeforeNotes
* renderExtraLinjeBeforePicture
* renderQuestionInTable
 
Often you will want at heatmap of the answered questions in first pages of the report. For this you add a field of the type: '''Word heatmap index'''
 
In case you want a dedicated button at the top of the page please add a field of the type: '''Action button: Export template'''
 
== Cheatsheet ==
 
=== Fields in solution ===
Normal questions
* "Complex question"
 
Sum of scores in normal questions
* "Calc: Complex question (sum)"
 
Setting up multiple response for a question
* "Multiline: Location editor"
* "Multiline: Complex question"
 
Contact information for sending emails
* Text and Email for contact information
 
Content for the Word report
* "Word heatmap index"
 
=== Questionaire field order ===
Entity > Advanced > Questionaire: Question order
 
Order 0 means field is NEVER displayed
 
=== Questionaire start and end messages ===
Entity > Advanced > Questionaire: Messages
 
=== Send invitation to customer ===
# Entity status: Click status > Add status action
# Set email recipient = Email field
# Integrate name in message: Dear {NAME}


*Word heatmap index
=== Template for report ===
# Create Word document
# Add content tags - ex. "${NAME}"
# Add to solution: Entity > Advanced > [Template list] > Add

Latest revision as of 11:51, 10 December 2021

Questionaire building process

In order to create a complex questionaire you first choose between copying a solution and creating from scratch.

We strongly reccomend the copying if you are unfamiliar with designing solutions.

Creating from scratch

Steps to create a questionaire includes

  1. Create solution and add fields
  2. Configure questionaire order and messages
  3. Setup inetrface for external users
  4. Configure email invitation
  5. Build report template

For detailed information read the section Setting up a questionaire with report below.

Copying a solution

Steps include

  1. Backup existing solution
    • Entity > Advanced > Backup > Create new backup
  2. Promote backup to standard
    • Click top backup > Promote to standard
  3. Create instance from standard
    • Quickstart > Respository > choose > Create this item
  4. Deploy solution
    • New entity > Deploy live

Setting up a questionaire with report

Field types

Complex questionaires contain fields for sending the questionaire and answering questions.

Dependening on how the questionaire is distributed to the users, you will also need contact information such as name and email.

Questions and scores

For normal questions that are answered once use teh field type: Complex question

A complex question contains a single question and multiple answer. Each answer contains

  • Value shown when selecting
  • Response showed in report
  • Color and icons
  • Score

You can optionaly calculate scores across multiple questions using the field: Calc: Complex question (sum)

Support for multiple questions

Multi line questions consists of the following

  • Multiline: Location editor
  • Mulitiline: Complex question

There should only be exactly one Multiline: Location editor, while there can be multiple Mulitiline: Complex question.

First the users enters lines values in the location editor. Then questions are created for each Mulitiline: Complex question - one for each line entered in the location editor.

Lines can be removed by clicking the checkboc next to them in the Multiline: Location editor.

Questionaire

Normal users will see data represented as a form, while external users will most often have displayed a step-by-step questionaire.

Inclusion of fields and their page order is managed in the questionaire order editor: Entity > Advanced > Questionaire: Question order

Note that

  • If a field have a sortorder of 0 (zero), it will never be displayed for external users.
  • Order numbers are not dispayed to the user and do not need to be consecutive - ex. 10, 20, 30 ...

The initial and final messages of the questionaire is edited in: Advanced > Questionaire: Messages

From a normal view normal users can see data in questionaire form, by appending and extra command to the address bar in the browser: &StepNumber=0

Granting access for external users

The process consists of 2 activities

  1. Add access for external users by adding a new permission
  2. Add an interface for the solution: Advanced > Interface: Add
    • Enter a descriptive and unique name
    • Check "UPDATE"
    • Check "Use questionaire style interface"

Sending emails with links

In order to send personalized message you solution will need to contain these fields

  • Text: Enter the name of recipient
  • Email: Email of the recipient

These fields are refered to in the message template in a status action, which is where subject and body of the email is edited.

A message is sent to the recipient, when a record in the system reaches a certain state.

Configuring reports

Report are Word documents containing special tags where content from the records are merged into the document.

  1. Create a new Word document
  2. Write content and add special field tags
    • Entity > Advanced > Template: Add > Office > (copy special tags)
  3. Add template to the solution
    • Entity > Advanced > Template: Add
    • Choose Word or PDF add
    • Uplaod the Word file

Note that certain configuration options for fontsize, margin etc. can be configured per solution: Entity > Advanced > Configurations

  • GlyphPageWidthPercentage
  • HeatmapColumnMaxCharacters
  • renderExtraLinjeBeforeNotes
  • renderExtraLinjeBeforePicture
  • renderQuestionInTable

Often you will want at heatmap of the answered questions in first pages of the report. For this you add a field of the type: Word heatmap index

In case you want a dedicated button at the top of the page please add a field of the type: Action button: Export template

Cheatsheet

Fields in solution

Normal questions

  • "Complex question"

Sum of scores in normal questions

  • "Calc: Complex question (sum)"

Setting up multiple response for a question

  • "Multiline: Location editor"
  • "Multiline: Complex question"

Contact information for sending emails

  • Text and Email for contact information

Content for the Word report

  • "Word heatmap index"

Questionaire field order

Entity > Advanced > Questionaire: Question order

Order 0 means field is NEVER displayed

Questionaire start and end messages

Entity > Advanced > Questionaire: Messages

Send invitation to customer

  1. Entity status: Click status > Add status action
  2. Set email recipient = Email field
  3. Integrate name in message: Dear {NAME}

Template for report

  1. Create Word document
  2. Add content tags - ex. "${NAME}"
  3. Add to solution: Entity > Advanced > [Template list] > Add