SurveyCTO Programming

Revision as of 11:28, 5 April 2018 by Admin (talk | contribs)
Jump to: navigation, search

There are two common ways to program your questionnaire in SurveyCTO. Either by using the form builder or by writing your code in an Excel Sheet. The form builder is useful for the absolute beginner and also when you need to make a quick edit in a form already uploaded to the server. However, the complexity of a typical DIME survey makes all projects sooner or later switch to coding in Excel.

As a questionnaire grows bigger, even the best coders lose the overview over the questionnaire. This is the most significant advantage of coding in Excel. While it is possibly to push through and keep using the form builder, data sets from questionnaires not finalized in Excel tend to be less well structured and more cumbersome to work with.

We do not object towards starting programming in the form builder, but we strongly recommend that the questionnaire is at least reviewed in Excel. Experienced coders tend to skip the form builder part altogether, apart from when making a quick update to a form already uploaded to the server.

Read First

  • It is easy to switch back and forth between the form builder and the Excel method. Therefore, one way to transition into coding in Excel might be to create something in the form builder that can be downloaded and inspected in Excel format.
  • While it is easier for a beginner to start in the form builder, we strongly recommend you to switch over to the Excel method as soon as possible, as you will have to do that eventually unless your questionnaire is very short.

Form Builder

The form builder is a feature that SurveyCTO provides on their servers.

How to access?

You access it by going to the Design tab and click on any form that already exist. After clicking the form a menu appears below it. Click edit and this questionnaire will be opened in the form builder. If you do not already have a form you want to edit, then click start new right at the top of the section Your Forms. After you have filled in the forms and generated your questionnaire, you can click edit online and it will open your new questionnaire in the form builder.

How to use?

The form builder is an intuitive web interface where you add new questions, groups, etc. by the click of a button. After creating a question you fill in a form with question type, question label, skip patterns, etc.

How to switch to the Excel method?

Save your work in the form builder and when you are back to the Design tab on your server, you can click the questionnaire. After clicking it you have a menu below the questionnaire, click download, and in the second menu that appears click form files. You then get a list of the files associated with the questionnaire. Download the Spreadsheet form definition (filename.xlsx) and then open that file in Excel.

Programming in Excel

This method is inherited from ODK (the open source CAPI language that SurveyCTO is built on).

How to access?

The questionnaire is saved as an Excel file. To edit a form that already exist, you simply open that file in Excel. Each row is a element in the questionnaire, for example, question, group, note, repeat group etc. Each column is the information that controls how the question, group, note, repeat group etc. behaves and/or is displayed.

To start a new form, it is easiest to set up encryption if you create a questionnaire from SurveyCTO's template forms from the form builder. Download the new form as described in the How to switch to the Excel method? above and open the downloaded file in Excel. You can also access SurveyCTO's most basic template form here in which you can make quick experiments. Remember to encrypt this form if you were to upload it to for data collection.

How to use?

The language used to program Questionnaires in Excel is inherited from ODK. It is more difficult for a beginner to get started with the Excel method compared to the form builder, but there are a lot of resources to help you. All Excel versions of the form templates provided by SurveyCTO has help tabs with quick help on how to write the Questionnaire. SurveyCTO provides detailed documentation on in the help section of all of their servers. Many experienced SurveyCTO programmers have gained their skills by looking at other people's code. Finally, the ODK community also provide resources. However, use this with care as SurveyCTO have made some alterations to how ODK is implemented. Use the ODK community's resources as a final solution if no SurveyCTO source provides you with an answer.

Tip: An excellent way to learn is by trying out new constraints, settings, and checks on Form Builder and then downloading the excel file for that form and studying the code.

How to switch to the form builder?

After logging in to a SurveyCTO server, go to the design tab and in the menu at the top of the Your forms section click the Upload Form button. Upload your form by following the instructions. The name of your form on the server is set in the form settings in the settings tab in your questionnaire file.

Scroll down to find your form and access the form builder according tot the How to access the form builder instructions.

Back to parent article

This article is a part of the chapter Questionnaire Programming.

Additional Resources