Skip to content

Commit

Permalink
deploy: 6ad3715
Browse files Browse the repository at this point in the history
  • Loading branch information
maedelange committed May 3, 2024
1 parent df048c9 commit 6a3dc4a
Show file tree
Hide file tree
Showing 8 changed files with 35 additions and 23 deletions.
15 changes: 5 additions & 10 deletions _sources/row_level_permissions.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Once you have saved your permissions, the user you have shared the project with

### User-based row-level permissions example

In the example below, the user **kobocourses** is sharing project data with the user **alex**. User-based permissions have been created so user **alex** can only access project data submitted by **alex** and by the user mario. These permissions allow **alex** to view, edit, and validate only the data submitted by **alex** and **mario**.
In the example below, the user **kobocourses** is sharing project data with the user **alex**. User-based permissions have been created so user **alex** can only access project data submitted by **alex** and by the user **mario**. These permissions allow **alex** to view, edit, and validate only the data submitted by **alex** and **mario**.

![image](/images/row_level_permissions/user-based-permission-example.png)

Expand Down Expand Up @@ -105,12 +105,9 @@ This can be useful for managing access to data in shared projects. A condition-b

Once you have saved your permissions, the user you have shared the project with will be able to view, edit, validate, or delete project data submissions that have the required response to the specified question, depending on which permissions you selected.

<p class="note">
For Date questions, the response value must be written in the format `YYYY-MM-DD` (e.g., `1974-12-31`).


For Select One and Select Many questions, the response value must be written using the unique XML value, not the label (e.g., `first_grade` rather than `First grade`).
</p>
#### Important note:
- For [Date](date_time.md) questions, the response value must be written in the format `YYYY-MM-DD` (e.g., `1974-12-31`).
- For [Select One](select_one_and_select_many.md) and [Select Many](select_one_and_select_many.md) questions, the response value must be written using the unique XML value, not the label (e.g., `first_grade` rather than `First grade`).

### Condition-based row-level permissions example

Expand All @@ -132,8 +129,6 @@ Enter your KoboToolbox username and password. You will be able to submit data to

<p class="note">To ensure data security, it is not advised to share your administrator sign in credentials with other users when managing your project. You can create multiple enumerator accounts and share those credentials with your team.</p>

2. If your user-based permissions are not functioning as expected, confirm that the form authentication requirement is active. To confirm this setting is active, open the project and navigate to the **FORM** tab. Under the **Collect data** section, ensure that the “Allow submissions to this form without a username and password” setting is turned off.

User-based permissions will not apply to any submissions collected before the “Allow submissions to this form without a username and password” setting was turned off, because these submissions would not be associated with a username.
2. If your user-based permissions are not functioning as expected, confirm that the form authentication requirement is active. To confirm this setting is active, open the project and navigate to the **FORM** tab. Under the **Collect data** section, ensure that the “Allow submissions to this form without a username and password” setting is turned off. User-based permissions will not apply to any submissions collected before the “Allow submissions to this form without a username and password” setting was turned off, because these submissions would not be associated with a username.

<p class="note">By default, project settings now require users to sign in to collect submissions. Learn more about <a class="reference" href="managing_permissions.html#requiring-passwords-for-accessing-enketo-web-forms">requiring passwords for accessing Enketo web forms</a>.</p>
5 changes: 4 additions & 1 deletion collecting-data.html
Original file line number Diff line number Diff line change
Expand Up @@ -792,7 +792,10 @@ <h1 class="main-search__header">What do you need help with?</h1>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="row_level_permissions.html#condition-based-row-level-permissions">Condition-based row-level permissions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#to-add-condition-based-permissions">To add condition-based permissions:</a></li>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#to-add-condition-based-permissions">To add condition-based permissions:</a><ul>
<li class="toctree-l4"><a class="reference internal" href="row_level_permissions.html#important-note">Important note:</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#condition-based-row-level-permissions-example">Condition-based row-level permissions example</a></li>
</ul>
</li>
Expand Down
5 changes: 4 additions & 1 deletion computer-server.html
Original file line number Diff line number Diff line change
Expand Up @@ -792,7 +792,10 @@ <h1 class="main-search__header">What do you need help with?</h1>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="row_level_permissions.html#condition-based-row-level-permissions">Condition-based row-level permissions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#to-add-condition-based-permissions">To add condition-based permissions:</a></li>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#to-add-condition-based-permissions">To add condition-based permissions:</a><ul>
<li class="toctree-l4"><a class="reference internal" href="row_level_permissions.html#important-note">Important note:</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#condition-based-row-level-permissions-example">Condition-based row-level permissions example</a></li>
</ul>
</li>
Expand Down
5 changes: 4 additions & 1 deletion creating-forms.html
Original file line number Diff line number Diff line change
Expand Up @@ -792,7 +792,10 @@ <h1 class="main-search__header">What do you need help with?</h1>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="row_level_permissions.html#condition-based-row-level-permissions">Condition-based row-level permissions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#to-add-condition-based-permissions">To add condition-based permissions:</a></li>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#to-add-condition-based-permissions">To add condition-based permissions:</a><ul>
<li class="toctree-l4"><a class="reference internal" href="row_level_permissions.html#important-note">Important note:</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#condition-based-row-level-permissions-example">Condition-based row-level permissions example</a></li>
</ul>
</li>
Expand Down
5 changes: 4 additions & 1 deletion getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -792,7 +792,10 @@ <h1 class="main-search__header">What do you need help with?</h1>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="row_level_permissions.html#condition-based-row-level-permissions">Condition-based row-level permissions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#to-add-condition-based-permissions">To add condition-based permissions:</a></li>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#to-add-condition-based-permissions">To add condition-based permissions:</a><ul>
<li class="toctree-l4"><a class="reference internal" href="row_level_permissions.html#important-note">Important note:</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#condition-based-row-level-permissions-example">Condition-based row-level permissions example</a></li>
</ul>
</li>
Expand Down
5 changes: 4 additions & 1 deletion managing-projects.html
Original file line number Diff line number Diff line change
Expand Up @@ -792,7 +792,10 @@ <h1 class="main-search__header">What do you need help with?</h1>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="row_level_permissions.html#condition-based-row-level-permissions">Condition-based row-level permissions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#to-add-condition-based-permissions">To add condition-based permissions:</a></li>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#to-add-condition-based-permissions">To add condition-based permissions:</a><ul>
<li class="toctree-l4"><a class="reference internal" href="row_level_permissions.html#important-note">Important note:</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="row_level_permissions.html#condition-based-row-level-permissions-example">Condition-based row-level permissions example</a></li>
</ul>
</li>
Expand Down
16 changes: 9 additions & 7 deletions row_level_permissions.html
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ <h3>To add user-based row-level permissions:<a class="headerlink" href="#to-add-
</section>
<section id="user-based-row-level-permissions-example">
<h3>User-based row-level permissions example<a class="headerlink" href="#user-based-row-level-permissions-example" title="Permalink to this heading"></a></h3>
<p>In the example below, the user <strong>kobocourses</strong> is sharing project data with the user <strong>alex</strong>. User-based permissions have been created so user <strong>alex</strong> can only access project data submitted by <strong>alex</strong> and by the user mario. These permissions allow <strong>alex</strong> to view, edit, and validate only the data submitted by <strong>alex</strong> and <strong>mario</strong>.</p>
<p>In the example below, the user <strong>kobocourses</strong> is sharing project data with the user <strong>alex</strong>. User-based permissions have been created so user <strong>alex</strong> can only access project data submitted by <strong>alex</strong> and by the user <strong>mario</strong>. These permissions allow <strong>alex</strong> to view, edit, and validate only the data submitted by <strong>alex</strong> and <strong>mario</strong>.</p>
<p><img alt="image" src="_images/user-based-permission-example.png" /></p>
</section>
</section>
Expand Down Expand Up @@ -244,10 +244,13 @@ <h3>To add condition-based permissions:<a class="headerlink" href="#to-add-condi
<li><p>Click <strong>Grant permissions</strong> to save your row-level permissions settings</p></li>
</ul>
<p>Once you have saved your permissions, the user you have shared the project with will be able to view, edit, validate, or delete project data submissions that have the required response to the specified question, depending on which permissions you selected.</p>
<p class="note">
For Date questions, the response value must be written in the format `YYYY-MM-DD` (e.g., `1974-12-31`).
<p>For Select One and Select Many questions, the response value must be written using the unique XML value, not the label (e.g., <code class="docutils literal notranslate"><span class="pre">first_grade</span></code> rather than <code class="docutils literal notranslate"><span class="pre">First</span> <span class="pre">grade</span></code>).</p>
</p>
<section id="important-note">
<h4>Important note:<a class="headerlink" href="#important-note" title="Permalink to this heading"></a></h4>
<ul class="simple">
<li><p>For <a class="reference internal" href="date_time.html"><span class="std std-doc">Date</span></a> questions, the response value must be written in the format <code class="docutils literal notranslate"><span class="pre">YYYY-MM-DD</span></code> (e.g., <code class="docutils literal notranslate"><span class="pre">1974-12-31</span></code>).</p></li>
<li><p>For <a class="reference internal" href="select_one_and_select_many.html"><span class="std std-doc">Select One</span></a> and <a class="reference internal" href="select_one_and_select_many.html"><span class="std std-doc">Select Many</span></a> questions, the response value must be written using the unique XML value, not the label (e.g., <code class="docutils literal notranslate"><span class="pre">first_grade</span></code> rather than <code class="docutils literal notranslate"><span class="pre">First</span> <span class="pre">grade</span></code>).</p></li>
</ul>
</section>
</section>
<section id="condition-based-row-level-permissions-example">
<h3>Condition-based row-level permissions example<a class="headerlink" href="#condition-based-row-level-permissions-example" title="Permalink to this heading"></a></h3>
Expand All @@ -266,9 +269,8 @@ <h2>Troubleshooting:<a class="headerlink" href="#troubleshooting" title="Permali
<p><img alt="image" src="_images/user_authentication.png" /></p>
<p class="note">To ensure data security, it is not advised to share your administrator sign in credentials with other users when managing your project. You can create multiple enumerator accounts and share those credentials with your team.</p>
<ol class="arabic simple" start="2">
<li><p>If your user-based permissions are not functioning as expected, confirm that the form authentication requirement is active. To confirm this setting is active, open the project and navigate to the <strong>FORM</strong> tab. Under the <strong>Collect data</strong> section, ensure that the “Allow submissions to this form without a username and password” setting is turned off.</p></li>
<li><p>If your user-based permissions are not functioning as expected, confirm that the form authentication requirement is active. To confirm this setting is active, open the project and navigate to the <strong>FORM</strong> tab. Under the <strong>Collect data</strong> section, ensure that the “Allow submissions to this form without a username and password” setting is turned off. User-based permissions will not apply to any submissions collected before the “Allow submissions to this form without a username and password” setting was turned off, because these submissions would not be associated with a username.</p></li>
</ol>
<p>User-based permissions will not apply to any submissions collected before the “Allow submissions to this form without a username and password” setting was turned off, because these submissions would not be associated with a username.</p>
<p class="note">By default, project settings now require users to sign in to collect submissions. Learn more about <a class="reference" href="managing_permissions.html#requiring-passwords-for-accessing-enketo-web-forms">requiring passwords for accessing Enketo web forms</a>.</p>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 6a3dc4a

Please sign in to comment.