diff --git a/source/archiving_projects.md b/source/archiving_projects.md deleted file mode 100644 index e918cc9e6..000000000 --- a/source/archiving_projects.md +++ /dev/null @@ -1,35 +0,0 @@ -# Archiving and Unarchiving Projects -**Last updated:** 26 Jul 2020 - - -**This article describes the purpose and process of archiving and unarchiving a project** - -## Purpose of archiving - -It is advisable to archive forms that are no longer used for data collection. This prevents data collection using wrong forms especially in large teams of data collectors. - -## Process of archiving - -To archive a project you need to take the following steps: - -* Go to the project you would like to archive - -  - -* Tap on the settings page and scroll down to find the archive button - -  - -* You will received a warning that you are about to archive the project. You should accept this by choosing archive - -  - -* If you go back to the list of your projects you will find the project within the archived list - -## Process of unarchiving - -* You will follow the same process by selecting the project, tapping its setting buttons, selecting the unarchiving button - -  - -* You will get a similar warning that message which you have to confirm by selecting unarchive diff --git a/source/delete_project.md b/source/delete_project.md deleted file mode 100644 index bde74ed48..000000000 --- a/source/delete_project.md +++ /dev/null @@ -1,26 +0,0 @@ -# Deleting a Project -**Last updated:** 15 Feb 2022 - - -There are two ways to delete a project and all of its data from your account. -Please note that once a project has been deleted, **THE ACTION CANNOT BE -REVERSED**. We do not store copies of your deleted projects, so make sure that -you have the correct project before proceeding and have all the data downloaded -first, if needed. - -## Deleting Projects From Your Project Dashboard - -In the Project Dashboard page hover over the far right side of the project you -wish to delete. Click the three dot icon (circled) that appears and then click -Delete. A dialogue box will appear that will require you to read and check a set -warnings, before deleting the project from your KoboToolbox account. - - - -## Deleting Projects From The Project Settings Page - -In the General window within the SETTINGS tab of the Project Page, click DELETE -PROJECT AND DATA. A dialogue box will appear that will require you to read and -check a set warnings, before deleting the project from your KoboToolbox account. - - diff --git a/source/howto_edit_multiple_submissions.md b/source/howto_edit_multiple_submissions.md deleted file mode 100644 index a7db02e08..000000000 --- a/source/howto_edit_multiple_submissions.md +++ /dev/null @@ -1,161 +0,0 @@ -# Editing Responses in Multiple Submissions -**Last updated:** 22 Sep 2022 - - -Users could always edit submissions as outlined in our support article -[Editing or Deleting a Single Submission](howto_edit_single_submissions.md). -What if a user has to edit repeated typo errors or update missing responses for -all or most of the submissions from a particular survey project? Following the -method outlined earlier should consume much time. Hence, KoboToolbox has -developed a feature that should make editing straightforward, saving editing -time. - -## Limitations when editing responses for multiple submissions - -There are several limitations when performing the bulk-edit actions described in -this article. The same is not the case when editing -[individual submissions](howto_edit_single_submissions.md). When using this -method: - -- Validation logic and calculations within your form are not re-evaluated. -- Editing questions within repeating groups is not currently supported. -- Coordinate points must follow pattern: `latitude longitude altitude accuracy`. - Failure to do so will not cause an error, but may confuse your data analysis. -- Multiple select responses must consist of the correct **choice names**, - separated by a space. Failure to do so will not cause an error, but will - result in labels not being correctly applied when exported. - -## Editing responses for multiple submissions - -The following is a screen generally seen for **DATA>Table**. - - - -The image shared above shows data input variance with the question **Country** -ranging from _America_, _U.S.A_, _US_, _United States of America_, _United -States_, _usa_ to _USA_. This section of the support article will outline _how -to change all these varying **Country** names to **USA**_. - -**Step 1:** - -To start editing responses for multiple submissions, users should either select -a single record (marked **1**) or select multiple records (marked **2**). -Selecting as shown in the image below should activate the edit features along -with other features. - - - -- **1.** Users could select multiple records that require bulk editing. -- **2.** Alternative to approach outlined above (in **1**), users could select - _all records_ or _all visible records_ under **DATA>Table**. _All records_ - refer to the entire records that are present within the survey project while - _all visible records_ refer to 30 records that are by default visible under - **DATA>Table**. Users should clearly distinguish between the two when there - are more than 30 records (submissions) within the survey project. -- **3.** Shows the total number of records selected for _changing/updating the - validation status_, _bulk editing_ or _bulk deletion_. -- **4.** Users could bulk change the validation status as outlined in our - support article [Record Validation](record_validation.md). -- **5.** Users could bulk edit the responses for multiple submissions. -- **6.** Users could bulk delete the records. - -**Step 2:** - -Users will now have to press **Edit** (**5** as shown in the image above) for -bulk editing after selecting all the records that require modifications. The -following dialogue box should then appear. - - - -Users could filter the required question by typing it in the search filter -located just below the **Question** header. - - - -Users should see _Multiple responses_ under the **Response** header (shown in -the above image) if different values entered. Here we have a range of inputs -from _America_, _U.S.A_, _US_, _United States of America_, _United States_, -_usa_ to _USA_. However, if users select a single record and press **Edit**, -they would see the following dialogue box. - - - -Users could now filter the required response by typing it in the search filter -located just below the **Response** header. This approach is useful when a user -wishes to edit a single record. - - - -**Step 3:** - -Users could press the **EDIT** button once it is known _what to edit and where -to edit_. - - - -**Step 4:** - -So now, there are two approaches to make bulk edits. _Approach 1_ is when users -type in the required text (**USA** in our case) in the blank box (marked -**1.1**) and then press **SAVE** (marked **2**). _Approach 2_ is when users -press **SELECT** (marked **1.2**) for an appropriate text and then press -**SAVE** (marked **2**). - - - -**Step 5:** - -A dialogue box now appears. Users will now have to press **CONFIRM & CLOSE** to -save the changes made. - - - -Users could always go back to **DATA>Table** and check if the bulk edits were -successful. - - - -## Editing blank responses for multiple submissions - -Sometimes, there may be a scenario when users have to add a question at the -middle or end of the survey. In such a case, the survey data from the -**DATA>Table** should see, as shown in the image below. - - - -This section of the support article should outline _how to change all these -empty states to **Alabama**_. - -**Step 1:** - -To start editing blank responses for multiple submissions, users should select -multiple records (marked **1**) and then press **Edit** (marked **2**). - - - -**Step 2:** - -Users will now have to press **Edit** (as shown in the image below), which is in -a parallel line straight to _State_ as we are updating the empty states for all -the records. - - - -**Step 3:** - -In this case, users should type in the required text (**Alabama** in our case) -in the blank box (marked **1**) and then press **SAVE** (marked **2**). - - - -**Step 4:** - -A dialogue box appears. Users will now have to press **CONFIRM & CLOSE** to save -the changes made. - - - -Users could always go back to **DATA>Table** and check if the bulk edits were -successful. - - diff --git a/source/howto_edit_single_submissions.md b/source/howto_edit_single_submissions.md deleted file mode 100644 index bb8c8b2dd..000000000 --- a/source/howto_edit_single_submissions.md +++ /dev/null @@ -1,23 +0,0 @@ -# Editing or Deleting a Single Submission -**Last updated:** 24 Sep 2025 - - -To edit or delete a submitted questionnaire, please follow the steps below. - -Please note that if you are collecting data with the [KoboCollect app](https://support.kobotoolbox.org/data_collection_kobocollect.html), once a form has been - submitted to the server it is **not possible** to edit or delete a - submission from KoboCollect. - -1. Open the _DATA_ tab of your project, and then click on _Table_ on the left. - You will see two icon options to either **Open** or **Edit** a record in the - first column of the data table. - -  - -2. You can view, validate, edit, or delete submissions by clicking the **OPEN** - icon to open the _Submission Record_ modal. Or you can click the **EDIT** - icon to go directly to editing the submitted form. - - **NOTE: DELETING IS NOT REVERSIBLE.** - -  diff --git a/source/images/kobotoolbox_interface/data.png b/source/images/kobotoolbox_interface/data.png new file mode 100644 index 000000000..ae1c6be52 Binary files /dev/null and b/source/images/kobotoolbox_interface/data.png differ diff --git a/source/images/kobotoolbox_interface/form.png b/source/images/kobotoolbox_interface/form.png new file mode 100644 index 000000000..c5565b976 Binary files /dev/null and b/source/images/kobotoolbox_interface/form.png differ diff --git a/source/images/kobotoolbox_interface/projects.png b/source/images/kobotoolbox_interface/projects.png new file mode 100644 index 000000000..710d0f7ec Binary files /dev/null and b/source/images/kobotoolbox_interface/projects.png differ diff --git a/source/images/kobotoolbox_interface/settings.png b/source/images/kobotoolbox_interface/settings.png new file mode 100644 index 000000000..7ceea56ce Binary files /dev/null and b/source/images/kobotoolbox_interface/settings.png differ diff --git a/source/images/kobotoolbox_interface/summary.png b/source/images/kobotoolbox_interface/summary.png new file mode 100644 index 000000000..d4f1d472b Binary files /dev/null and b/source/images/kobotoolbox_interface/summary.png differ diff --git a/source/images/managing_projects/archive_home.png b/source/images/managing_projects/archive_home.png new file mode 100644 index 000000000..1bec50bfe Binary files /dev/null and b/source/images/managing_projects/archive_home.png differ diff --git a/source/images/managing_projects/archive_settings.png b/source/images/managing_projects/archive_settings.png new file mode 100644 index 000000000..f8163ab9b Binary files /dev/null and b/source/images/managing_projects/archive_settings.png differ diff --git a/source/images/managing_projects/create.png b/source/images/managing_projects/create.png new file mode 100644 index 000000000..6399c2672 Binary files /dev/null and b/source/images/managing_projects/create.png differ diff --git a/source/images/managing_projects/delete_home.png b/source/images/managing_projects/delete_home.png new file mode 100644 index 000000000..81e6d0058 Binary files /dev/null and b/source/images/managing_projects/delete_home.png differ diff --git a/source/images/managing_projects/delete_settings.png b/source/images/managing_projects/delete_settings.png new file mode 100644 index 000000000..6fc23b344 Binary files /dev/null and b/source/images/managing_projects/delete_settings.png differ diff --git a/source/index.rst b/source/index.rst index 047f512a1..d5a0490bf 100644 --- a/source/index.rst +++ b/source/index.rst @@ -169,22 +169,19 @@ Search the knowledge base, browse our resources, and visit our forum for more de :caption: Managing Projects & Data :name: home-page-toc-managing-projects - project_summary - record_validation - delete_project + kobotoolbox_interface.md + managing_projects.md + viewing_validating_data.md + editing_deleting_data.md export_download advanced_export managing_repeat_groups - archiving_projects project_sharing_settings managing_permissions - export_gps - howto_edit_single_submissions - howto_edit_multiple_submissions - photo_download + managing_files_media.md deleting_media - getting_started_organization_feature activity_logs + getting_started_organization_feature .. raw:: html diff --git a/source/kobotoolbox_interface.md b/source/kobotoolbox_interface.md new file mode 100644 index 000000000..af4be66c6 --- /dev/null +++ b/source/kobotoolbox_interface.md @@ -0,0 +1,80 @@ +# Overview of the KoboToolbox interface + +This article provides an overview of the KoboToolbox interface and explains how to navigate the main pages where you create forms, manage data, and configure project settings. It introduces the **Projects home page** and the four main pages within each project: **SUMMARY**, **FORM**, **DATA**, and **SETTINGS**. + +## Navigating the Projects home page +When you sign in to your KoboToolbox account, you land on the **Projects home page**. The **Projects home page** displays all projects that you own or that have been shared with your account. From there, you can also access key features and account-level settings. + +The **Projects home page** includes the following: +* A list of all projects owned by or shared with your account. +* Access to the **Library** from the left side menu. +* The **NEW** button to create a new project. +* Tabs to view **Deployed**, **Draft**, or **Archived** forms. +* A **Search** bar to find projects in your project list. +* A **profile icon** in the top right corner to access [account settings](https://support.kobotoolbox.org/account_settings.html), change the interface language, or log out of your account. + +
+ Note: From any page in your KoboToolbox account, click Help for quick links to the Help Center, Community Forum, KoboToolbox Academy, and to view in-app notifications. Click Source to access the KoboToolbox source code. +
+ + + + +## Working within a project +To open a project, click on its name in the **My Projects** table. Each project contains four main pages: **SUMMARY**, **FORM**, **DATA**, and **SETTINGS**. + +### SUMMARY page +The **SUMMARY** page provides an overview of your project, including: +* **Project information** such as the description, status, owner, and dates last modified and deployed. +* **Submission statistics** for the past seven days, 31 days, three months, 12 months, and the total number of submissions. +* **Quick links** to key project functionalities (e.g., edit or preview form). +* **Sharing permissions** and users the project is shared with. + + + +### FORM page +The **FORM** page contains tools for building, updating, and deploying your project. It is divided into sections. + +In the **Current version** section, you can: +* **Preview** the current form version. +* **Edit** the form in the [Formbuilder](https://support.kobotoolbox.org/formbuilder.html). +* **Replace** the form with an [XLSForm](https://support.kobotoolbox.org/getting_started_xlsform.html) or [template](https://support.kobotoolbox.org/question_library.html). +* Open the **More actions** menu to download the XLSForm or XML file, [share the project](https://support.kobotoolbox.org/managing_permissions.html), clone the project, or create a template. +* **Manage translations** for forms with [multiple languages](https://support.kobotoolbox.org/language_dashboard.html). +* **DEPLOY** or **REDEPLOY** the form. + +In the **Form history** section, you can: +* View past versions of the form and their deployment dates. +* Clone previous form versions. + +In the **Collect data** section, you can: +* Choose a [data collection method](https://support.kobotoolbox.org/data_through_webforms.html). +* Click **Copy** to copy the link or **Open** to open the form in your browser. +* Allow submissions [without requiring a username and password](https://support.kobotoolbox.org/project_sharing_settings.html#allowing-submissions-without-authentication). + + + +### DATA page +The **DATA** page provides access to all collected data and includes a data **Table**, custom **Reports**, a photo **Gallery**, a **Download** tab to export data, and a **Map** view for GPS data. + ++ To learn more about managing your data in KoboToolbox, see Viewing and validating your data and Editing and deleting your data. +
+ + + + +### SETTINGS page +The **SETTINGS** page contains configuration options for your project. It is divided into multiple tabs: +* **General:** Update the project name and description, [archive](https://support.kobotoolbox.org/glossary.html#archived-projects) or delete the project. +* **Media:** Upload media files and [manage uploaded files](https://support.kobotoolbox.org/managing_files_media.html). +* **Sharing:** Update [sharing permissions](https://support.kobotoolbox.org/managing_permissions.html) for other users. +* **Connect Projects:** Set up connections for [dynamic data attachments](https://support.kobotoolbox.org/dynamic_data_attachment.html). +* **REST Services:** Configure [REST services](https://support.kobotoolbox.org/rest_services.html) to automatically send submissions to third-party applications. +* **Activity:** View and export the [project history logs](https://support.kobotoolbox.org/activity_logs.html#project-history-logs), including changes made by other users. + + + ++ To learn more about managing projects, see Managing projects in KoboToolbox. +
diff --git a/source/managing_permissions.md b/source/managing_permissions.md index c87889ace..f7d78f38d 100644 --- a/source/managing_permissions.md +++ b/source/managing_permissions.md @@ -33,7 +33,7 @@ The following permissions are available: | View submissions | User can view submitted data. | | Add submissions | User can submit data using the form. | | Edit submissions | User can edit submitted data. | -| Validate submissions | User can [approve or reject](https://support.kobotoolbox.org/record_validation.html) submitted data. | +| Validate submissions | User can [approve or reject](https://support.kobotoolbox.org/viewing_validating_data.html#validating-your-data) submitted data. | | Delete submissions | User can delete submitted data. | | Manage project | User can do all of the above and manage project settings. | @@ -99,7 +99,7 @@ To copy team permissions from another project:+ To learn more about managing your data in KoboToolbox, see Viewing and validating your data and Editing and deleting your data. +
+ + +## Archiving and deleting projects +As projects become outdated or no longer needed, you can remove them from active use by **archiving** or **deleting** them. Archiving stops new submissions while keeping the form and existing data available. Deleting permanently removes the project and all of its data from your account. + ++ Note: Because deleted projects cannot be recovered, delete a project only when you are certain that neither the form nor its data will be needed. Before deleting a project, we recommend downloading the form as an XLSForm and exporting all project data. +
+ +### Archiving projects +Archiving is recommended for forms that should no longer accept submissions but need to remain available for reference. + +There are two ways to archive a project. To archive a project from the **Projects home page**: +1. In the **Projects home page**, select the project checkbox. +2. Click **Archive project** in the top right corner. +3. You will be asked to confirm that your form will not accept submissions while it is archived. Click **ARCHIVE** to confirm. + + + +To archive a project from the project **SETTINGS**: +1. Open the project and go to the **SETTINGS** page. +2. In the **General** tab, click **Archive Project**. +3. You will be asked to confirm that your form will not accept submissions while it is archived. Click **ARCHIVE** to confirm. + + + +To unarchive a project, follow the same steps and click **Unarchive Project**. + +### Deleting projects +Deleting a project permanently removes the form and all associated data. This action cannot be reversed. + +There are two ways to delete a project. To delete a project from the **Projects home page**: +1. In the **Projects home page**, select the checkbox next to the project. +2. Click **Delete 1 project** in the top right corner. +3. A confirmation dialog will require you to acknowledge the following: + * You are about to permanently delete this form. + * All data gathered for this form will be deleted. + * The form associated with this project will be deleted. + + + +To delete a project from the project **SETTINGS**: +1. Open the project and go to the **SETTINGS** page. +2. In the **General** tab, click **Delete Project and Data**. +3. A confirmation dialog will require you to acknowledge the following: + * You are about to permanently delete this form. + * All data gathered for this form will be deleted. + * The form associated with this project will be deleted. + + + + diff --git a/source/managing_repeat_groups.md b/source/managing_repeat_groups.md index 014cd1d49..25db950f9 100644 --- a/source/managing_repeat_groups.md +++ b/source/managing_repeat_groups.md @@ -15,7 +15,7 @@ You can view repeated data in the data table, which you can find in the **Table* You can also view the complete data for any given submission, including each repetition of repeat groups, by clicking the **Open** button to the left of each submission. -To edit repeat group data, click the **Edit** button. This will open up the form and allow you to [edit the form data](https://support.kobotoolbox.org/howto_edit_single_submissions.html) before resubmitting. [Bulk editing](https://support.kobotoolbox.org/howto_edit_multiple_submissions.html) repeat group data is not currently supported. +To edit repeat group data, click the **Edit** button. This will open up the form and allow you to [edit the form data](https://support.kobotoolbox.org/editing_deleting_data.html) before resubmitting. [Bulk editing](https://support.kobotoolbox.org/editing_deleting_data.html#editing-multiple-submissions-in-bulk) repeat group data is not currently supported.Note: Repeat group data cannot be displayed in the Reports or Map views due to the data structure of repeat groups. diff --git a/source/project_summary.md b/source/project_summary.md deleted file mode 100644 index 12f65301c..000000000 --- a/source/project_summary.md +++ /dev/null @@ -1,14 +0,0 @@ -# Project Summary -**Last updated:** 28 May 2020 - - -The Project Summary tab gives you a visual display of all the high-level information related to your project. Depending on whether you're the project owner or a user with restricted permissions, different information will be shown to you. The Project Summary includes: - - 1. **Description**: Includes all project metadata. - 2. **Submissions**: A tally and graph of the submissions (up to the past 31 days). - 3. **Form details**: Includes last modified, last submission, and number of questions. - 4. **Quick links**: Useful links related to data collection for the project. - 5. **Data**: Useful links to information related to submitted data. - 6. **Team members**: List of users that have access to the project. - - diff --git a/source/record_validation.md b/source/record_validation.md deleted file mode 100644 index 4b4066c97..000000000 --- a/source/record_validation.md +++ /dev/null @@ -1,31 +0,0 @@ -# Record Validation -**Last updated:** 19 Jun 2020 - - -A Project owner can now give a “Can Validate” permission to other users. Users with this permission can view a record, edit it if necessary, and assign a status to the record in question. Assigning a status to a particular record/submission raises data collection standards for teams with more than one enumerator. - -## What are the statuses that you can assign to a record? - -The validation status labels available include: - -* **On Hold**: Record is under review. -* **Approved**: The data within this record is accurate. -* **Flagged for Removal**: The data within this record should be removed from the data set. - -## Functionality Overview - -* This new permission adds a “Validated” column to your project's data table. - -  - -* Users can filter the table view based on the validation status or any other select-one question. For example, you can use these filters to view the submissions associated with a particular enumerator, in District X. It is possible to use more than one filter at a time. - -  - -* Set a validation status for multiple - or all - records at once. - - To update multiple records, simply select the records by clicking on the checkbox to the left of the record, and then click on "Update Selected" to select the new status. - - To update all the records on the page, select the checkbox on the top left; or to update all the records in your dataset, select the blue text that says "Select all XXX". Then, click on "Update Selected" to select the new status. - -  diff --git a/source/welcome.md b/source/welcome.md index 5929c27b4..e9556be44 100644 --- a/source/welcome.md +++ b/source/welcome.md @@ -22,7 +22,6 @@ To get started with form building in KoboToolbox, see our