Archive

Archive for the ‘Studio Manual’ Category

Script Writer’s Function Hand-Book

August 15, 2012 1 comment

This document contains most of the common every-day usable functions in SurveyToGo.
Explained, demonstrated and elaborated.
This document is directly connected to us, and is constantly updated with new functions and info by our professional team, stay updated!
A Survey Script Writers True Gem!

-

FilterAnswersByAnswers \ FilterTopicsByAnswers:

Explanation: This function gets a target question index and a source question.
It filters the Current Question’s answers through, according to the answers chosen in the source questions specified.

Input: Gets 2 Parameters

1st Parameter: The Target Question.

2nd Parameter: A Boolean value – ‘true’ for showing answers selected, ‘false’ for showing answers not selected.

3rd Parameter: The Source Questions.

Output: Filters the specified answer index’s

Example of How to write:
FilterAnswersByAnswers(CurrQues,true,QRef(15));
FilterAnswersByAnswers(CurrQues,
true,QRef(15),QRef(16),QRef(17));
FilterTopicsByAnswers(3,
false,QRef(2));

-

SelectedAnswerText:

Explanation: This function gets a target question index and returns the text of the answer selected

Input: Gets 2 Parameters.

1st Parameter: The Target Question index.

2nd Parameter: A Boolean value – ‘true’ for getting the ‘Other Specify’ input too, ‘false’ for not getting the ‘Other Specify’ input text.

Output: Text of the answer selected

Example of How to write:
SelectedAnswerText (5,true);
SelectedAnswerText (2,
false);

-

Answer:

Explanation: This function gets a target question index of only single choice questions such as:
(Single-Choice, Numeric, Open Ended, Scale, Expression)
and returns its selected answer index.

Input: Gets 1 Parameters

1st Parameter: The Target Question.

Output: Returns its selected answer index

Example of How to write:
Answer(CurrQues);

-

Contains:

Explanation: This function gets a target question index of only Multi-Selection questions and an answer index, and checks if this answer was selected.

Input: Gets 2 Parameters

1st Parameter: The Target Question Index.

2nd Parameter: The Target Answer Index.

Output: returns ‘True’ if the given answer was selected – returns ‘False’ if the given answer was not selected.

Example of How to write:
Contains(2,1);

-

SetAnswerVisible \ SetTopicVisible:

Explanation: This function gets a target question index, a answer\topic index, and a Boolean value (true/false), and shows\hides the given answer\topic.

Input: Gets 3 Parameters

1st Parameter: The Target Question Index.

2nd Parameter: The Target Answer\Topic Index.

3rd Parameter: A Boolean value. (‘true’ for showing – ‘false’ for hiding)

Output:

Example of How to write:
SetAnswerVisible(CurrQues,2,false);
SetTopicVisible(CurrQues,4,
false);

-

AnswerChoice:

Explanation: This function gets a target question index of a ‘Single-Choice-Grid’ question only, and a topic index.
it returns the index of the selected answer in the given topic.

Input: Gets 2 Parameters

1st Parameter: The Target Question Index.

2nd Parameter: The Target Topic Index.

Output: returns an index of the selected answer in the given topic within the given multi-topic question.

Example of How to write:
AnswerChoice(CurrQues,3);
AnswerChoice(1,2);

-

NumOfSelectedChoices:

Explanation: This function gets a target question index of a multi-selection question only, and returns the number of selected answers.

Input: Gets 1 Parameters

1st Parameter: The Target Question Index.

Output: returns the number of selected answers.

Example of How to write:
NumOfSelectedChoices(CurrQues);

-

GetTopicCount:

Explanation: This function gets a target question index of a Single-Choice Grid question only, and returns the number of topics.

Input: Gets 1 Parameters

1st Parameter: The Target Question Index.

Output: returns the number of topics.

Example of How to write:
GetTopicCount(CurrQues);

-

AnswerIter:

Explanation: This function gets a target question index of questions that are within a loop of only single choice questions such as:
(Single-Choice, Numeric, Open Ended, Scale, Expression)
and an iteration index.
It returns the answer of the target question in the given Iteration Index.

Input: Gets 2 Parameters

1st Parameter: The Target Question Index.

2nd Parameter: The Specific Iteration Index.

Output: Returns its answer in the given iteration index within the loop.

Example of How to write:
AnswerIter (CurrQues,
3);

AnswerIter (CurrQues,IterationIndex);

*NOTE:IterationIndex Represents the current iteration when running within a loop, so it’s value is set according to the iteration which is currently running.

-

ContainsIter:

Explanation: This function gets a target question index of questions that are within a loop of only multi-selection question, an answer index and an iteration index.
It checks if the given answer was selected in the target question within the given Iteration Index.

Input: Gets 2 Parameters

1st Parameter: The Target Question Index.

2nd Parameter: The Specific Iteration Index.

3rd Parameter: The Specific Iteration Index.

Output: returns ‘True’ if the given answer was selected in the given iteration – returns ‘False’ if the given answer was not selected in the given iteration index.

Example of How to write:
ContainsIter(CurrQues,
3,7);

ContainsIter (CurrQues,2,IterationIndex);

*NOTE:IterationIndex Represents the current iteration when running within a loop, so it’s value is set according to the iteration which is currently running.

-

Random():

Explanation: This function gets an integer and returns a random number between the 0 and the integer number given minus 1.

Input: Gets 1 Parameter.

1st Parameter: Maximum number. (Please note that the number generated is between zero till a number that is 1 less than the maximum number given)

Output: returns a random integer within the given range.

Example of How to write:
Random(5);

Random(732);

-

SelectedAnswerText():

Explanation: This function gets a target question index and a Boolean and returns a text string with all the answers chosen in the given question index, separated with a comma.

Input: Gets 2 Parameters

1st Parameter: The Target Question Index.

2nd Parameter: ‘true’ for including any ‘Other Specify’ text, ‘false’ for not including any ‘Other Specify’ text.

Output: returns a text string with all the answers chosen in the given question index, separated with a comma.

Example of How to write:
SelectedAnswerText(12,true);

SelectedAnswerText(CurrQues,false);

-

SetAnswer():

Explanation: This function gets a target question index and a target answer index and sets this answer is chosen in the given question index

Input: Gets 2 Parameters

1st Parameter: The Target Question Index.

2nd Parameter: The Target Answer Index

Output: doesn’t return anything, just sets the answer given.

Example of How to write:
SetAnswer(5,2);
SetAnswer(CurrQues,8);

Child Survey Chapter

May 23, 2012 2 comments

Back to Table Of Contents
Back to
Chapter 8 – Start/End Scripts

About child surveys

SurveyToGo enables you to start a survey from within another survey. This feature can be used for a bunch of different purposes such as:

  • Filling out surveys in response to conditions. For example: a survey for a retail store, that requires a different survey if the store was close.
  • Filling out surveys in response to events in the field. For example: general medical device survey, where if while filling out the general questions, the patient suddenly reacts you need to fill out a survey about his/her reaction then continue back to filling the general survey.
  • Simple loops.

Each child survey is rendered as a menu option on the device allowing for quick ad-hoc filling of child surveys.

How to make it happen?

In order to configure child surveys for a father survey, you just need to specify for the master survey which survey(s) are its child surveys. To accomplish this, do the following:

  1. Open the main survey.
  2. Click the “Edit Child Surveys” link on the advanced tab of the survey node:

  3. Click the “+” button to add a new child survey, then fill out the “Button Text” text. This text will be shown on the menu of the device:

    Then, click the “…” button to select the actual child survey from your existing surveys. Please note you can select any survey you want, and you can have a survey be a child survey of more then 1 parent.
  4. Click the “+” button to add more surveys or the “OK” button to finish.
  5. That’s it. You can now deploy the survey to the device and on the device you will see a menu

Working with child surveys on the device

Now, on the device when running the survey you will see a menu named “More”:


Clicking on this menu will bring up the ability to add or edit child surveys:

You can then select the relevant child survey from the list of surveys. This will start a new run of the child survey, after which you will return to the current survey.

To edit surveys you have already conducted tap the “Edit Additional Surveys” menu option, and then select the relevant survey.

How to change the “Data” field of child surveys for later editing?

When you choose to edit additional surveys from the device by clicking the option:

You will see a screen that lists out the various child surveys you have filled out. For example:


If you wish executing a child survey automatically, without needing the surveyor to do it manually, you can write the following script in your desired location in your questionnaire:

ChildMgr.StartChildSurvey(“THE NAME OF YOUR CHILD SURVEY”);

Column

Description

Name

Name of the child survey

ID

Internal ID

Time

The time when you have started the child survey run

Data

Additional data that can be associated with the child survey run.

The “Data” field can be used to specify whatever data you might want to associate with the child survey run. This value would populate the SubjectData variable.  To set it’s value from within the survey you can use SubjectData = “this is a value”;

The SubjectData is a variable that can later be presented as additional attribute of the survey on the Operations Console and assist with identifying a specific survey run. An example can be a survey of a household that then calls for a child survey for each member of the family. You can call the child survey with the family member name  by entering ChildMgr.StartChildSurvey(<Member Name>); or you can set it from within the child survey if the surveyor codes the name as one of the child survey questions. It will then be presented in the Operations Console and in the Additional Info column of the survey result in the surveyor’s device.

Please note you can interact with the “SubjectData” variable anywhere in the questionnaire, including Expression questions, start/end question scripts etc..

‘Communication’ between a Parent survey and a Child survey 

The most efficient way to perform information exchange between child and parent survey is by using the Parent object from within the child survey.

You can call any SurveyToGo function by using Parent. for example Parent.Answer(1) would return the value of question 1 in the parent survey. Parent.SetAnswer(1, 2) would set the value of question 1 in the the Parenet survey to 1. 

Go To Chapter 10 – Quota Management
Back to
Table Of Contents

Visit us at:
http://www.dooblo.net

Categories: Studio Manual

Chapter 4 – Capturing Multi-Media

May 22, 2012 Leave a comment

Back to Table Of Contents
Back to 
Chapter 3 – Managing a Tablet Survey

About attaching files to the running surveys 

SurveyToGo is enabled by default to accept any file that is created during the survey as an attachment to the running survey result. Because of this, any pictures that you take during the survey or any sounds that you record during the survey are automatically attached to the current survey result and will be sent along with the result to the server.

Creating A Multimedia question

Multimedia questions are types of questions which allow you to choose whether it will record Picture, Sound or Video.


Now, once the survey is running, you can capture the multimedia you chose by using the action button that will be displayed in the question.

  1. Pictures:

  2. Sounds:

  3. Videos:

The Clear button will clear the latest multimedia file captured.
Of course, you can capture multiple files at once:

Any multimedia that you capture while you are in a survey is automatically bound to that survey result. Continue running the survey normally and once you synchronize the results back to the server, the pictures are synced with the results.
You can view attachments of specific results in the operations console.

Enter a result, and go to its answer’s tab, there you can see their attachments and the question the attachment was captured.


You can also view the attachment through the link to our server and save a local copy.

How to export the attached pictures/sounds
Attachments can be exported through the regular exporting wizard while exporting the results of a survey.


There are two options for exporting the attachments:

  1. ‘Include attachment Results': If you specify this option and select a folder location, any picture attachment that was included in the results will be placed in this folder. The name of the picture will be according to the relevant SubjectID field in the results file.
  1. ‘Include attachment list’ : If checked, you can choose a csv file that will receive a list of links to the various pictures that were included in the results. This is useful if you need links to the attachments instead of the actual pictures.

Both options can be selected together.

In the last screen of the export wizard, you can specify the folder for the attachments and choose your attachment exporting configuration.


Option Description
Export Data File This is the file name that will be filled with all the results according to your selection
Include result attachments If you specify this option and select a folder location, any picture attachment that was included in the results will be placed in this folder. The name of the picture will be according to the relevant SubjectID field in the results file.
Include attachment list If checked, you can choose a csv file that will receive a list of links to the various pictures that were included in the results. This is useful if you need links to the attachments instead of the actual pictures.

Go To Chapter 5 – Showing pictures & media on the tablet

Back to Table Of Contents
Visit us at:
  
http://www.dooblo.net

Categories: Studio Manual

Chapter 6 – Exporting & Printing

May 14, 2012 2 comments

Back to Table Of Contents
Back to 
Chapter 5 – Showing pictures & media on the PDA

About Exporting & Printing

SurveyToGo enables you to export the data of a survey at any point, to a number of different applications & formats. Furthermore, additional export providers can be written easily to support additional formats. Currently, the supported formats include MS Excel, MS Access, SPSS & XML. When exporting, you have complete control on the order of the exported columns, enabling you to separate the way the survey is presented from the way the data is to be exported.

The Export Wizard

Whenever you wish to export the data of the survey, you simply double click on the “Collected Data” Node in the relevant project:


On the screen that opens you have the choice of exporting the interviews or the actual survey structure. Choose the “Survey Results” option and select the relevant survey, then click “Export”:


Please note only active surveys will be displayed in the list. If your survey is marked as “Draft” or “Closed” then it will not be shown. If you need to export results of closed surveys, simply change their mode back to production or test.

Survey select screen


In this screen, simply select the survey who’s results you would like to export and click Next:

Export provider screen


Simply select the desired export provider and click the Next button.

Export options screen


To see a list of all the fields and their descriptions please click here: List of all fields and descriptions
When done you can either click the columns order tab to change the columns order settings, or click Next to continue.

Columns Order screen

The columns order screen allows you to define the exact order of the columns you would like to have when exporting the survey results. You can choose to export all or only a subset of the columns available, or even export a column more then once. Both the left list and the right list support multiple selections (by using the Shift and or Control keys) and are completely sort able by any column you desire.

When you are done configuring the order and number of columns you need to export, simply click the options tab or click Next to continue the export process.

Note: export settings are saved on your computer for the when you need to export the same survey again.


Option Description
Left list – Source columns Contains all the available columns. You can select one or more columns from this list to move to the output columns list. Internal columns, like the ‘duration’ column etc have a yellow background while survey specific columns have a white background. The list supports multiple selections & sorting. To sort, simply click the column of the list you would like to sort by.
Right list – output columns Contains all the columns that will be included in the output export file. The order of the columns is the actual order of the exported file. To change the order of the columns you can press the up/down arrows. To create a copy of a column, right click that column:
Up/down buttons Control the actual order of the columns. You can select either one or more columns and press the up down buttons to move these columns up or down.
Left/right buttons Control the movement of columns between the left and right list.

Options screen

The options screen allows you to specify some general options regarding the exported file. When you are done, simply click the Next button to continue.


Option Description
Include Filtered Out subjects Subjects who participate in your survey can be filtered out from the survey due to certain conditions. If checked filtered out subjects will also be included in the exported file, and an additional column – “Filter” is added to the exported data. The “Filter” column contains the index of the question the subject was filtered at.
Export only results submitted between… and … Enables you to specify a date range for the exported results. If specified, only results from the specified range are included in the export.
Swap rows and cols If checked, the results are exported so that each subject is a column, and each question is a row, instead of the regular format where each subject is a row and each question is a column.

File name selection screen

The file name selection screen allows you to enter the name of the output file name. When you are done, click the finish button to continue.


Option Description
Export Data File This is the file name that will be filled with all the results according to your selection
Include result attachments If you specify this option and select a folder location, any picture attachment that was included in the results will be placed in this folder. The name of the picture will be according to the relevant SubjectID field in the results file.
Include attachment list If checked, you can choose a csv file that will receive a list of links to the various pictures that were included in the results. This is useful if you need links to the attachments instead of the actual pictures.

After you click the finish button, you will see the following screen:


Answer Yes to open the exported file using its associated application, or no to continue without opening the external application.

Exporting the survey (not the results)

Sometimes there comes a need to export the actual survey structure. This can include backup purposes, moving a survey from one SurveyToGo server to another one and more. To export a survey to XML, simply choose “Survey > Export” then choose Export Survey:



Choose the survey you would like to export, and click Next:


Choose the default SurveyToGo export provider and click Next:


Then choose a file name and click the finish button. The survey will be saved to the path you indicated.

Printing

Printing a survey can be very useful for both keeping a hard copy version of the survey & for sending to clients & team members for review. You can both directly print a survey or perform a print preview.

Direct Printing

To directly print a survey in SurveyToGo, choose the “Survey > Print” menu option:


Then choose the printer you desire from the standard printer selection screen and press OK to print:


Print Preview

To preview a survey before printing, select the “Survey > Print Preview” menu option:


Then the print preview screen will show, allowing you to preview the output before printing:


Go To Chapter 7 – Rules

Back to Table Of Contents
Visit us at:
 
http://www.dooblo.net

Categories: Studio Manual

SurveyToGo – Built-In Functions Hand Book

May 14, 2012 1 comment

Overview

SurveyToGo contains an enormous set of built-in functions ready to use.
We have assembled all of them in one file – a useful handbook for scripting surveys.
Please see this link for the download:

http://www.dooblo.net/downloads/SurveyToGoCommands.zip

It contains all the functions but in a more raw form. We are in the process of moving them from this file to a more elegant web manual. The beta version of the web manual is here: http://stg.dooblo.net/ULDocs – but it is only in beta so please expect things to be a bit weird with it.

We strongly recommend having this, Very Handful!

Visit us at: http://www.dooblo.net

Chapter 19 – GPS Tracking

January 26, 2012 1 comment

Back to Table Of Contents

Back to Chapter 18 – Multiple Languages & Translation

About Viewing GPS Tracking in Survey To Go Studio

SurveyToGo is enabled by default to use the GPS tracking feature of your devices without any pre-configuration needed.
Now you can track your surveyor’s location, know their route of movement and follow the specific location where surveys were conducted.
This feature gives field-managers and any other back-office teams a whole new aspect of benefits in organizing, managing and supervising your field team.

GPS Functionality in SurveyToGo

Where it is?

On your SurveyToGo Studio software, on the left side, where the main tree of your organization is, you can notice that there is an expandable node called ‘GPS Tracking’.


Show Latest Locations Node

This node will allow you to see all latest surveyors’ locations tracked by the GPS feature in their devices.
If you double click this node, you would get a window with the following menu:

  1. This button will provide you with the map, showing the latest surveyor locations tracked.
  2. You can define your search according to a specific user, specific group or all users at once.
  3. Here you can define the time scale according to the time you want to track locations.
    From five days ago until two hours ago.
  4. You can save the map provided in step 1 as a Google Earth file.

After you click the ‘Get latest locations’ button, you would be provided with a map showing the latest locations tracked.

  • In the upper part you have a navigation bar, you can move by using the mouse as well.
  • If you float with the cursor above one of the location pins, you can see the specific user, time and date that this location was tracked.
  • In the bottom right corner, you can see the view scale of the map.
  • The map indicates street names and important locations name as well.

Show Route Node

This node will allow you to view specific routes that the surveyors did, according to the order of the locations tracked.
If you double click this node, you would get the following menu.

  1. Here you can choose the user to track its route, if you click the ‘Get User’s route’, it will provide you with a map indicating the users route.
  2. Here you can define the time scale for viewing the route.

After you click the ‘Get User’s route’ button, you would be provided with a map showing the route of the user chosen.

  • The red triangle sign indicates where the route has begun.
  • The red square sign indicates where the route has finished.
  • The small ‘S’ sign indicates a location where a survey has been conducted.
  • The green lines indicate the route of the user, following the locations tracks according to their order.
  • If you float with the cursor above any of these items, you would get the user, time and date that the item had been tracked.

Viewing the GPS Tracking through the Operations Grid

If you enter to the operations grid, you can choose a specific result and double click it:

If you go under the ‘Map’ tab, you would be able to view the specific place where this result was conducted.

  • You can view this in Google Maps
  • You can copy the specific coordinates to your clipboards.
  • You can save this as a Google Earth file
  • If you float over the location pin with your cursor you would see the user, time, date, result number and survey name.

Back to Table Of Contents

Visit us at:  http://www.dooblo.net


Categories: Studio Manual

Chapter 5 – Showing pictures & media on the tablet

January 23, 2012 2 comments

Back to Table Of Content

Back to Chapter 4 – Taking pictures/recording sounds through the tablet

About Showing pictures & media on the tablet 

SurveyToGo enables you to attach a picture or any other media content, like Word files, sounds, videos etc.. to a specific question of a survey and then enables the surveyor to view that content while he/she is on the relevant question. This is very useful for when you need to show a picture of a product and then ask questions about it.

 How to do it?

 To add content to a question:

  1. Open up SurveyToGo Designer
  2. Select the relevant question and switch to the Advanced tab:
  3. Click the “Attachments” link:
  4. You will then see the question attachments screen from which you can either select a previous loaded attachment or add a new one. To add a new one, click the “New” button:
  5. Click the OK button to close the window, and then ok again to continue:
  6. That’s it. Save a deploy the survey.

Viewing the attachment on the device

In order to view your attachment, you can choose between showing it in the questions body or showing it through the menu.
By default it would be through the menu.
Through your device you can choose to view the attachments: (e.g. emulator)

If you wish to show it as a question body, you should attach the attachment to an ‘Empty’ question, then through the questions ‘Advanced’ tab, you can modify the attachment to be displayed in the questions body:


Please notice that there are several configurations for choosing the display attributes.
You can choose those which suit your requirements.

Go To Chapter 6 – Exporting & Printing 

Back to Table Of Contents

Visit us at:  http://www.dooblo.net

Categories: Studio Manual
Follow

Get every new post delivered to your Inbox.

Join 42 other followers

%d bloggers like this: