CorrelAid docs
  • Welcome
  • Wiki
    • How We work - Hitchhiker's Guide to CorrelAid
    • FAQ
    • Communication channels
      • Conference calls ​☎
      • Slack
      • Blog
    • Infrastructure
      • Newsletter: MailerLite
      • Google Workspace
      • Password management
      • Video conferences
      • Kobotoolbox for Forms
      • Gitbook for documentation
      • NextCloud
      • Azure & DNS management
      • CorrelBase (Metabase)
      • GitHub and GitLab
      • Directus (Content Management System)
      • Pretix
    • PR Guide
    • Design Guide
    • CorrelAid Merch
    • How to create an event
  • CorrelAidX Manual
    • What is CorrelAidX?
    • Get started!
      • Finding partners
      • E-mail templates to contact NPOs
      • Room booking and catering
    • Finding a legal form
    • Role definitions
    • Event formats
      • Data dialogue
      • Workshops
      • Introducing CorrelAid
      • Panel discussion
      • Hackathons
    • Cooperation Agreements
    • PR activities
    • Doing a project
    • Contact
  • Project manual
    • CorrelAid Data4Good projects
    • Toolbox
    • The Ethics Questionnaire and its Companion Document
    • Project coordination
      • Project Acquisition
      • Scoping & Call for Applications
      • Team selection
      • Onboarding
      • Kickoff
      • Project work
      • Handover workshop
      • Follow-up
      • Documentation
    • Team lead
    • For the project team
      • Project Follow-Up
      • Best practices
        • General/Collaboration
        • Dataviz / Reporting
        • Python
        • R
    • Data privacy & security
    • When do we do a project? When not?
  • CorrelAid Website
  • EDUCATION MANUAL
    • General
    • Educational Formats
      • R Lernen
      • Daten verstehen und nutzen
      • CorrelCompact
      • Community Workshops
    • For educational volunteers
      • Toolbox: Methods in live sessions
      • Guide to source citation and licences
Powered by GitBook

The CorrelAid Docs are licensed under CC-BY 4.0.

On this page
  • User management
  • Adding a User
  • CorrelAid collection
  • Subscribe to the collection
  • Use the template surveys
  • API
  • Documentation
  • Getting your token

Was this helpful?

Edit on GitHub
Export as PDF
  1. Wiki
  2. Infrastructure

Kobotoolbox for Forms

PreviousVideo conferencesNextGitbook for documentation

Last updated 6 months ago

Was this helpful?

  • We host our own instance of at .

  • To request an account, join the slack channel #infrastructure-kobo-toolbox and ask there

  • The above-mentioned slack channel also serves as a communication channel for announcing maintenance periods and for asking general questions about the service

User management

Users are managed by _super admins _in the administrative backend which is available at .

Here, admins can create and delete users and manage other settings of the Kobo instance (but most of which should be just left alone).

Important: this is not where you give access to individual surveys etc. This is done in the User Interface at .

Adding a User

Go to .

  1. Add user

Click on "Add" next to "Users" and you can set a user name and password for the new user.

Important: User names should follow the {firstname}_{first letter of surname} format. Using dots (".") in user names definetly causes some weird problems, so this should be avoided at all cost. The password should obviously follow good password principles.

Once you click on "Save", you'll be redirected to the settings page for this user. Leave the default settings and click "Save" again.

  1. Associate Email address to user

Since an update to a newer version, we have to associate an email address to the user, otherwise the login will not work. To do that:

  1. top right, click add email address.

  2. A pop up will appear where you can select the target user by clicking on their name

  3. the pop up should close. The displayed number is the numeric ID for the user you selected.

  4. enter the email address and check both tick boxes (Verified and Primary)

  1. Share the password with the user

CorrelAid collection

Subscribe to the collection

  1. In the dropdown at the bottom, select "CorrelAid" if it is not already selected.

  2. Click "POST"

Use the template surveys

When creating a new project, you can use the template surveys by selecting "Use a template" in the "Create project" dialogue. This will copy the template survey into your project.

API

Kobo has an API you can use.

Documentation

You can find the documentation here:

Getting your token

go to Email addresses:

next to "User" there is a . Click on it.

Adding the email will not send out an automated invitation. To share the password with the new user, you can use a (make sure to change the expiration date to one week).

We have created the public CorrelAid collection which you can see when going to and selecting "Public collections" in the bar on the left. The collection provides template surveys and question blocks for questions that we ask. In order to use the questions and template surveys in this collection, you need to "subscribe" to it. Unfortunately, there is a in the frontend of Kobo - the "Subscribe" button does not work. However, there is a workaround:

Open .

If you go back to , the CorrelAid collection should now be in your personal library and you can use the questions and/or the template surveys.

version 2: -> current version of the API - covers getting data, uploading forms etc.

version 1: (should only rarely be used) -> upload data to existing forms

You can find your token in your user settings:

🔍
https://kobo.correlaid.org/admin/account/emailaddress/
Yopass link
https://kobo.correlaid.org/#/library
bug
https://kobo.correlaid.org/collection_subscriptions/
https://kobo.correlaid.org/#/library
https://kobo.correlaid.org/api/v2/
https://kc.correlaid.org/api/v1/
https://kobo.correlaid.org/#/account-settings
kobotoolbox
kobo.correlaid.org
kobo.correlaid.org/admin
kobo.correlaid.org
https://kobo.correlaid.org/admin/