Skip to content

Commit

Permalink
Update XLSForm Content: Settings Worksheet (#273)
Browse files Browse the repository at this point in the history
  • Loading branch information
jenn-karuri authored Mar 9, 2024
1 parent 216f34e commit 0dc75fa
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions _sections/home-english.md
Original file line number Diff line number Diff line change
Expand Up @@ -957,19 +957,19 @@ An example **settings** worksheet is below:
The settings column headings available are:

* **form_title**: The title of the form that is shown to users. The form title is pulled from **form_id** if **form_title** is blank or missing.
* **form_id**: The name used to uniquely identify the form on the server. The form id is pulled from the XLS file name if **form_id** is blank or missing.
* **form_id**: The name used to uniquely identify the form on the server. The form ID is pulled from the XLS file name if **form_id** is blank or missing.
* **version**: String that represents this version. A common convention is to use strings of the form 'yyyymmddrr'. For example, 2017021501 is the 1st revision from Feb 15th, 2017.
* **instance_name**: Expression using form fields to identify for each form submission. [Learn more](#specify-form-submission-name).
* **instance_name**: Expression using form fields to identify each form submission. [Learn more](#specify-form-submission-name).
* **default_language**: In localized forms, this sets which language should be used as the default. The same format as described for [adding translations](#multiple-language-support) should be used, including the language code.
* **public_key**: For encryption-enabled forms, this is where the public key is copied and pasted. [Learn more](#encrypted-forms).
* **submission_url**: This url can be used to override the default server where finalized records are submitted to. [Learn more](#specify-alternative-server).
* **submission_url**: This url can be used to override the default server where finalized records are submitted. [Learn more](#specify-alternative-server).
* **style**: For web forms, specify the form style. [Learn more](#multiple-webpage-forms).
* **name**: XForms root node name. This is rarely needed, [learn more](#specify-xforms-root-node-name).
* **clean_text_values**: This column can be used with values `yes` or `no` to control whether whitespace in the Survey sheet is collapsed (defaults to `yes`).

### Encrypted forms

Encryption-enabled forms provide a mechanism to keep _finalized_ records private at all times. This includes the time _after a record is marked as final_ that it is stored on the device and server as well as during transport, even when http is used for communication. Encrypted records including their uploaded files, such as photos, are completely inaccessible to anyone not possessing the private key.
Encryption-enabled forms provide a mechanism to keep _finalized_ records private at all times. This includes the time _after a record is marked as final_ that it is stored on the device and server as well as during transport, even when HTTP is used for communication. Encrypted records including their uploaded files, such as photos, are completely inaccessible to anyone not possessing the private key.

To encrypt XLS forms, add the **public_key** column to the **settings** worksheet and paste the base64-encoded public RSA key as its value.

Expand Down

0 comments on commit 0dc75fa

Please sign in to comment.