Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 144 additions & 0 deletions i18n/rw/docusaurus-plugin-content-docs/current/Connections/odk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
---
id: odk
title: Open Data Kit (ODK)
description: The Open Data Kit server connection is available for organizations looking to collect structured data using forms.
slug: /odk
---

# Open Data Kit (ODK) Connection

The [Open Data Kit (ODK)](https://getodk.org/) is an open standard used to create custom forms and collect data.

An Open Data Kit server allows organizations to aggregate, in a central repository, data collected by their members or partners. Tella users connect to their organization's ODK instance, fill forms as many times as they need (even if they don't have internet connectivity), and upload the data. Organizations can download the data from the server or analyze it on the server, depending on the chosen server alternatives.

Similarly to any other server connection (like [Tella Web](/tella-web), [Google Drive](/g-drive), [Dropbox](/dropbox), [Nextcloud](/nextcloud) or [Uwazi](/uwazi)), connecting to the ODK server enhances the security of data collected on Tella by:

1. Allowing users to collect data directly inside Tella's encrypted container.
2. Ensuring that data is sent directly from Tella to the ODK server, without relying on a third-party tool or app.
3. Allowing users to back up their data on a remote server, to lower the risk that data is discovered on their mobile device.
4. Ensuring that organizations can preserve important information even in the event of device seizure or destruction, and can organize it for research, advocacy, or accountability processes.

:::danger
Even though data is transferred to the server securely (SSL), anyone with access to the ODK account can view the files. If you need encrypted file transfers, explore [Nearby Sharing](/nearby-sharing).
:::


### Choosing and Installing Your ODK Server {#choosing-and-installing-your-odk-server}

Because ODK is an open standard, Tella can be used with any of the tools that are ODK-compliant.

For civil society organizations and human rights defenders, we recommend using [KoboToolbox](https://www.kobotoolbox.org/) to create forms with custom questions, manage users, and aggregate the data submitted by users. Based on our experience, KoboToolbox is user-friendly and flexible, and it is also open source. KoboToolbox offers a [community plan for non-profits](https://www.kobotoolbox.org/pricing/) and offer free training resources and guidance on how to structure the data on the server (Self-serve learning base and Community Forum). It is also possible [to use a private instance of KoboToolbox](https://www.kobotoolbox.org/services/private-servers/) or [self-host it](https://support.kobotoolbox.org/kobo_your_servers.html).

:::tip
We are work closely with the Kobotoolbox team. If you are interested in using the Tella-KoboToolbox connection and would like some support or to discuss the best hosting plan for your use case, please [contact us](/contact-us).
:::

There are other ODK-compliant apps available, like [Ona](https://ona.io/home/) or [ODK Cloud](https://https://getodk.org/index.html). Tella works with any of these.


### When to Use ODK {#when-to-use-odk}

We recommend ODK to organizations that need on-the-ground users to collect data in a structured manner like forms. We also recommend it to organizations that don't have the technical capacity to install and maintain a server and want to use a ready-to-use cloud instance. If you use a cloud instance, remember that the organization hosting your ODK instance will be able to access your data. This is an important consideration when deciding whether to self-host or use a cloud service.

ODK and KoboToolbox are widely used, well-documented, and easy to use. There are guides available, and they offer support to non-profit organizations on how to structure and maintain their data.

:::tip
If you need help figuring out if ODK is best for your use-case, [read our guide](/for-organizations) or [contact us](/contact-us)!
:::

## Model Your Data {#model-your-data}

KoboToolbox offers a detailed guide on how to create your project and add questions to your forms, and how to deploy them to make them available to on-the-ground users [here](https://support.kobotoolbox.org/overview_of_creating_a_project.html).

## Connect Tella to an ODK Instance to Collect Data {#connect-tella-to-an-odk-instance-to-collect-data}

In this documentation, we focus on how to collect data using Tella. There are alternative mobile apps that can be used to collect data on ODK, including the ODK Collect Android app. You can see a comparison of these alternatives [here](/faq#how-is-tella-different-from-other-documentation-apps).

:::info
The ODK connection is not available for Tella iOS.
:::

### Connect to an ODK Server {#connect-to-an-odk-server}
After creating and deploying a Form using any ODK-compliant server, in Tella, go to **Settings** > **Connections** > **+** > **Open Data Kit (ODK)**. Fill the following fields:
- **Server Name**: A descriptive name for your server in Tella. The name you select is only visible in the app and does not impact the ODK connection.
- **Server URL**: Your server URL. For example, `kc.kobotoolbox.org` if you are using the KoboToolbox public server.
If your server requires user authentication, tap the **Advanced** button and enter your **Username** and **Password**. Your server's administrator should provide all this information to you.


### Fill forms {#fill-forms}

After you successfully connected to the ODK instance, you'll see a new card called "Forms" in the **Connections** sections of the Tella homescreen.

After you enter the **Forms** section, you will see a list of Forms available to you on the instance(s) that you are connected to. Using the **Download** button you can download forms to Tella so that you can fill them, even if you are not connected to the internet.

You can tap on each blank form to start filling it.


#### Submit forms {#submit-forms}

As you collect data and fill forms the following options are available to increase offline support on Tella:
- Submit: send the filled form to the ODK server.
- Save as draft: save a form that is not completed so you can continue working on it later.
- Submit later: mark a form as complete to submit it a later point. Until it is sent, it will be available in the Outbox tab.
- Drafts tab: a tab with the list of all draft forms. Drafts can be edited or deleted.
- Outbox tab: a table with the list of all forms ready to be submitted. Forms in the Outbox tab can be edited, deleted, or submitted.
- Submitted tab: a tab with the list of all forms that have been successfully sent to the server. Submitted forms can be deleted.
- Pause/Resume submission: you can manually pause a submission and resume it when ready.
- Automatically pause submission when offline: forms will be sent to the Outbox tab if the submission fails due to connectivity issues.

### Supported Question Types {#supported-question-types}
Below is an overview of the ODK question types that are supported in Tella Android. If there is a question type that isn't supported in Tella and that is critical to your workflow, please [contact us](/contact-us).

| **Question type** | **Tella Android** |
|------|------|
| Select One | ✔️ |
| Select Many | ✔️ |
| Text | ✔️ |
| Number / Decimal | ✔️ |
| Date | ✔️ |
| Time | ✔️ |
| Date & time | Oya |
| Point (calculate my current location) | ✔️ |
| Point (show my location on a map) | ✔️ |
| Point (let me choose my location on a map) | ✔️ |
| Line | Oya |
| Area | Oya |
| Photo | ✔️ |
| Photo signature (handwrite my signature) | ✔️ |
| Amajwi | ✔️ |
| Amasanamu (video) | ✔️ |
| File | ✔️ |
| Note | ✔️ |
| Barcode / QR Code | Oya |
| Acknowledge | ✔️ |
| Rating | ✔️ |
| Question Matrix | Oya |
| Ranking | ✔️ |
| Calculate | Oya |
| Hidden | Oya |
| Range | Oya |
| External XML | Oya |

### Supported Features {#supported-features}

Below is an overview of the ODK features that are supported in Tella Android. If there is a feature that isn't supported in Tella and that is critical to your workflow, please [contact us](/contact-us).

| **Feature** | **Tella Android** |
|------|------|
| [Offline data collection](/odk#submit-forms) | ✔️ |
| [Form logic](https://docs.getodk.org/form-logic/) | ❌ |
| [Requiring responses](https://docs.getodk.org/form-logic/#requiring-responses) | ✔️ |
| [Setting default responses](https://docs.getodk.org/form-logic/#setting-default-responses) | ❌ |
| [Triggering calculations on value change](https://docs.getodk.org/form-logic/#triggering-calculations-on-value-change) | ❌ |
| [Validating and restricting responses](https://docs.getodk.org/form-logic/#validating-and-restricting-responses) | ❌ |
| [Conditionally showing questions](https://docs.getodk.org/form-logic/#conditionally-showing-questions) | ✔️ |
| [Groups of questions](https://docs.getodk.org/form-logic/#groups-of-questions) | ✔️ |
| [Repeating questions](https://docs.getodk.org/form-logic/#repeating-questions) | ✔️ |
| [Filtering options in select questions](https://docs.getodk.org/form-logic/#filtering-options-in-select-questions) | ✔️ |
| [Generating select ones from repeats](https://docs.getodk.org/form-logic/#generating-select-ones-from-repeats) | ❌ |
| [Form metadata (background data collection)](https://docs.getodk.org/form-audit-log/) | ❌ |


:::tip
If you need a fully offline way to share files with others, consider exploring [Nearby Sharing](/nearby-sharing).
:::
134 changes: 134 additions & 0 deletions i18n/rw/docusaurus-plugin-content-docs/current/Connections/uwazi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
---
id: uwazi
title: Uwazi
description: The Uwazi server connection is available for organizations looking to collect structured data.
slug: /uwazi
---

# Uwazi Connection

[Uwazi](https://uwazi.io/) is an open-source documentation tool developed by [HURIDOCS](https://huridocs.org). It is a flexible, web-based database application designed for human rights defenders to manage their collections of information, including documents, evidence, cases, and complaints.

Uwazi allows organizations to aggregate, in a central repository, data collected by their members or partners. Tella users connect to their organization's Uwazi instance, download forms (called templates), fill templates as many times as they need (even if they don't have internet connectivity), and upload the data. Organizations can then curate, organize, and publish their data directly from Uwazi.

Similarly to all other server connections([Tella Web](/tella-web), [Google Drive](/g-drive), [Nextcloud](/nextcloud), [Dropbox](/dropbox), and [Open Data Kit](/odk)), connecting to Uwazi enhances the security of data collected on Tella by:
1. Allowing users to collect data directly inside Tella's encrypted container.
2. Ensuring that data is sent directly from Tella to Uwazi, without having to rely on a third-party tool or app.
3. Allowing users to back up their data on a remote server, to lower the risk that data is discovered on their mobile device.
4. Ensuring that organizations can preserve important information even in the event of device seizure or destruction, and can organize it to use for research, advocacy, or accountability processes.

:::danger
Even though data is transferred to the server securely (SSL), anyone with access to the Uwazi account can view the files. If you need encrypted file transfers, explore [Nearby Sharing](/nearby-sharing).
:::

### Testing Uwazi {#testing-uwazi}

You can test Uwazi using [this Demo instance](https://demo.uwazi.io/).

### When to use Uwazi {#when-to-use-uwazi}

We recommend Uwazi to organizations that need on-the-ground users to collect data in a structured manner through forms.

Uwazi also allows project managers to easily organize, analyze, visualize, and publish the collected data. It is especially powerful because of its database allows making relationships between entities, which helps connect data points (such as incidents, perpetrators, and victims) to emerge patterns. Uwazi is also great to collect data in many different languages and to facilitate collaboration between teams.

Uwazi does not have an official mobile app, so by integrating Uwazi and Tella, you can leverage Tella's encryption and offline capabilities and take full advantage of Uwazi's abilities to organize, search, download, visualize, and publish information.

Here there are some pointers on Uwazi may be particularly suitable to your use case:
- You need to make the data collected publicly accessible on a website.
- You need to establish relationships between data points.
- Data must be contained in structured database registers.
- You need to clean up, edit, organise and curate the collected data.
- You need to quickly search, find and analyse data.
- You work in a multilingual environment.
- You work in a collaborative environment with multiple users and different profiles.
- You need to preserve information in a secure way over the long term.

You can learn more about Uwazi on [Uwazi's official documentation](https://uwazi.readthedocs.io/en/latest/). HURIDOCS is a great friend of Horizontal, so if you have questions about Uwazi or would like us to connect you to the HURIDOCS team, [contact-us](contact-us).

:::tip
If you need help figuring out if Uwazi is best for your use-case, [read our guide](/for-organizations) or [contact us](/contact-us)!
:::

## Configure Uwazi on a server {#configure-uwazi-on-a-server}


The HURIDOCS team offers 2 alternatives on how to set up your uwazi server:

1. Self-hosted: Share this [comprehensive administrator guide](https://uwazi.readthedocs.io/en/latest/sysadmin-docs/index.html) with your system's administrator for step-by-step instructions on how to install Uwazi on your server, configure backups, and set up advanced features.
2. Hosted by HURIDOCS: HURIDOCS offer hosting packages as a service. Free hosting services (up to a storage limit) and a trial version of Uwazi are available for human rights organizations. [Reach out to HURIDOCS](https://huridocs.org/services/) for more details about the service.

## Model Your Data {#model-your-data}

An Uwazi collection is made up of Entities. An entity has Properties which are the fields that Tella users will fill to collect data. Entities can hold Primary Documents and/or Supporting Files and some properties that are defined by administrators on the Uwazi server when they create templates. A template is an empty form that can be filled as many times as needed; once a template is filled, it becomes an Entity.

[You can read here](https://uwazi.readthedocs.io/en/latest/admin-docs/building-info-architecture.html#understanding-properties) about the properties that are available on the Uwazi server and how to model your data and create your templates. For the moment we only support properties and functionalities that have been flagged as high priority by Uwazi users. If you need other properties, [contact us](/contact-us).

:::info
If Tella users download a template that has properties that are not supported in Tella, those properties won't be shown in the app. However, users will still be able to submit the entities, and admins will be able to access these entities, including all the properties that were filled, without any problems.
:::

### Available Properties {#available-properties}

| **Property or Feature** | **Tella Android**| **Tella iOS** | **Tella Android FOSS** |
|------|------|-----|-----|
| Primary and Supporting Documents | ✔️ | ✔️ | ✔️ |
| Plain Text | ✔️ | ✔️ | ✔️ |
| Numeric | ✔️ | ✔️ | ✔️ |
| Single Select | ✔️ | ✔️ | ✔️ |
| Multiple Select | ✔️ | Oya | ✔️ |
| Relationship | ✔️ | ✔️ | ✔️ |
| Single Date | ✔️ | ✔️ | ✔️ |
| Multiple Date | ✔️ | Oya | ✔️ |
| External Link | ✔️ | Oya | ✔️ |
| Rich Text | ✔️ | ✔️ | ✔️ |
| Single and Multiple Date Range | ✔️ | Oya | ✔️ |
| Attach Media (Image, Video, or Audio) | ✔️| ✔️ | ✔️ |
| Geolocation | ✔️ | Oya | ✔️ |
| Generated ID | ✔️ | Oya | ✔️ |


## Get People on the Ground Ready to Start Submitting Data {#get-people-on-the-ground-ready-to-start-submitting-data}

### Connect to the Server {#connect-to-the-server}

In order to connect to an Uwazi server:

* Navigate to **Settings ⚙️** > **Connections** > **+**
* Select "Uwazi" from the list of available server types.
* Enter the organization’s Uwazi server URL (generated and provided by admins).
* Choose between:
* **Log In:** if a username and password were provided by admins.
* **Public Access:** if the server is configured to accept anonymous submissions.
* If the server requires two-factor authentication, enter the one-time code.
* Choose the **Language** in which you want to display templates.

:::info
You can watch [this video](/video-tutorials#uwazi) on how to connect to an Uwazi server from the Tella.
:::

### Send Your Information {#send-your-information}

Once you successfully connected to an Uwazi instance, you'll see a new card with the label "Uwazi" in the **Connections** sections of your Tella homescreen.

To download a template, tap the **+** button at the bottom of the screen. You will see a list of templates that are available to you on all the Uwazi instances you are connected to. Tap on the **Download** button to download templates or the **Refresh** button to see if there are updates to the templates available to you on the server.

Then go back to the Uwazi main screen and tap the template you want to use to create an entity.


#### Data Submission Alternatives {#data-submission-alternatives}

| **Feature** | **Details**| **Tella Android** | **Tella iOS** |
|------|------|------|------|
| Submit | Send the filled form to the connected server. | Ego | Ego |
| Save as draft | Save a form that's not completed. | Ego | Ego |
| Submit later | Mark a form as ready and send it to the Outbox tab. | Ego | Ego |
| Drafts Tab | A tab with all drafts. Drafts can be edited or deleted. | Ego | Ego |
| Outbox Tab | A tab with forms ready to submit. Forms on the outbox tab can be edited or deleted. | Ego | Ego |
| Submitted Tab | A tab with all forms that have been successfully sent to the server. Submitted forms can be deleted. | Ego | Ego |
| Pause/Resume submission | Users can manually pause a submission and resume it when ready. | Ego | Oya |
| Automatically pause submission when offline | Submissions will be sent to the Outbox tab if submission fails due to connectivity issues. | Ego | Ego |


:::tip
If you need a fully offline way to share files with others, consider exploring [Nearby Sharing](/nearby-sharing).
:::
Loading