DOC Correct title for userhelp

This commit is contained in:
Maxime Rainville 2022-08-20 21:03:34 +12:00
parent 4ea877c7e3
commit 0a53cef94f
5 changed files with 52 additions and 34 deletions

View File

@ -1,3 +1,7 @@
---
title: Creating and editing forms
---
# Creating and editing forms # Creating and editing forms
To create a new form, first decide where in the site you want your form to be. If you To create a new form, first decide where in the site you want your form to be. If you

View File

@ -1,3 +1,7 @@
---
title: Field types
---
# Field types # Field types
## Checkbox Field ## Checkbox Field

View File

@ -1,3 +1,7 @@
---
title: Form submissions
---
# Form submissions # Form submissions
## Viewing form submissions in the CMS ## Viewing form submissions in the CMS
@ -52,7 +56,7 @@ You can check this if you do not wish for the email recipient to see the form su
#### Hide invisible fields from email? #### Hide invisible fields from email?
You can check this if you want to hide the fields from the email that were invisible to the user according to the display rules set up for the form fields. You can check this if you want to hide the fields from the email that were invisible to the user according to the display rules set up for the form fields.
#### Send email as plain text? #### Send email as plain text?
@ -93,21 +97,21 @@ This decides whether to send the email based on two options
## File Upload Field ## File Upload Field
[note] [note]
This functionality is specifically included in Silverstripe core functionality 4.6 and above, This functionality is specifically included in Silverstripe core functionality 4.6 and above,
[silverstripe-userforms](https://github.com/silverstripe/silverstripe-userforms/) 5.3 and above and is also included in [silverstripe-userforms](https://github.com/silverstripe/silverstripe-userforms/) 5.3 and above and is also included in
the module [silverstripe-elemental-userforms](https://github.com/dnadesign/silverstripe-elemental-userforms). the module [silverstripe-elemental-userforms](https://github.com/dnadesign/silverstripe-elemental-userforms).
[/note] [/note]
Files and other data that is uploaded by your website visitors should be handled with care to reduce the risk of exposing sensitive data. Files and other data that is uploaded by your website visitors should be handled with care to reduce the risk of exposing sensitive data.
Files which are uploaded through a form inherit the permissions of the folder they are being placed into, so it's important that you Files which are uploaded through a form inherit the permissions of the folder they are being placed into, so it's important that you
ensure the folder you select can only be viewed by appropriate parties. Folder permissions can be managed within the Files area. ensure the folder you select can only be viewed by appropriate parties. Folder permissions can be managed within the Files area.
File permissions do not affect the Draft/Modified/Published state of files. Use both file permissions and Draft states File permissions do not affect the Draft/Modified/Published state of files. Use both file permissions and Draft states
together to ensure your files remain safe. For example, in case they are accidentally published. together to ensure your files remain safe. For example, in case they are accidentally published.
## File indicators ## File indicators
Files have a number of icons which can help to identify the original source of a file and whether caution should be taken when using it. Files have a number of icons which can help to identify the original source of a file and whether caution should be taken when using it.
**Form submission:** ![Address card icon](_images/address-card.png) **Form submission:** ![Address card icon](_images/address-card.png)
@ -115,12 +119,12 @@ This indicates a file is associated with a form submission. This file has not be
**Form submission with warning:** ![Address card with warning icon](_images/address-card-warning.png) **Form submission with warning:** ![Address card with warning icon](_images/address-card-warning.png)
This indicates that a file associated with a form submission does not have the recommended permissions applied to it. This indicates that a file associated with a form submission does not have the recommended permissions applied to it.
A caution symbol is added to the form submission icon because it has a higher risk of being publicly accessible if it is published. A caution symbol is added to the form submission icon because it has a higher risk of being publicly accessible if it is published.
**Restricted access:** ![User with lock icon](_images/user-lock.png) **Restricted access:** ![User with lock icon](_images/user-lock.png)
Indicates that a file/folder has restricted access and will only be visible to certain users or groups. To learn more about the usage of this particular icon refer to Indicates that a file/folder has restricted access and will only be visible to certain users or groups. To learn more about the usage of this particular icon refer to
[File Permissions](https://userhelp.silverstripe.org/en/4/creating_pages_and_content/creating_and_editing_content/images_and_documents/file_permissions). [File Permissions](https://userhelp.silverstripe.org/en/4/creating_pages_and_content/creating_and_editing_content/images_and_documents/file_permissions).
## Overview of files with custom permissions ## Overview of files with custom permissions
@ -132,34 +136,34 @@ Folder with restricted access containing files with custom permissions and their
* FS - Form submission * FS - Form submission
[/note] [/note]
To get started, create a new **User Defined Form** page in the CMS. See [Creating and editing forms](creating-and-editing-forms) To get started, create a new **User Defined Form** page in the CMS. See [Creating and editing forms](creating-and-editing-forms)
to learn more. To add a File Upload field to the form, click on the ***Form Fields*** tab in the page editing view. to learn more. To add a File Upload field to the form, click on the ***Form Fields*** tab in the page editing view.
Click the ***Add Field*** button then select **File Upload Field** from the dropdown. Click the ***Add Field*** button then select **File Upload Field** from the dropdown.
![Adding a File Upload Field](_images/userforms-creation.png) ![Adding a File Upload Field](_images/userforms-creation.png)
### Setting up a folder to store file uploads for your form ### Setting up a folder to store file uploads for your form
When setting up an Upload Field on a form for the first time you will receive a prompt to select an appropriate folder to store files for this form. When setting up an Upload Field on a form for the first time you will receive a prompt to select an appropriate folder to store files for this form.
You can either create a new folder or use an existing folder to store your file submissions. You can either create a new folder or use an existing folder to store your file submissions.
The folder you select will become the default folder for this form and any additional Upload Fields which are added. The folder you select will become the default folder for this form and any additional Upload Fields which are added.
Each File Upload Field can use different folders for storing its files, this can be managed by editing the folder location on each individual field. Each File Upload Field can use different folders for storing its files, this can be managed by editing the folder location on each individual field.
#### Option 1, create a new folder (recommended): #### Option 1, create a new folder (recommended):
This option is only available the first time you add an upload field to your form. Once the first upload folder for the form has been established, This option is only available the first time you add an upload field to your form. Once the first upload folder for the form has been established,
all subsequent file uploads from the same form will use this folder by default. all subsequent file uploads from the same form will use this folder by default.
By default this option will store file submissions in a folder with restricted access suitable for dealing with personal/sensitive data. By default this option will store file submissions in a folder with restricted access suitable for dealing with personal/sensitive data.
A folder will automatically be created with the same name as the form name. A folder will automatically be created with the same name as the form name.
It will be recommended for this folder (and the submission files) to be placed within a top level folder named /Form-submissions. It will be recommended for this folder (and the submission files) to be placed within a top level folder named /Form-submissions.
You can either use the suggested folder name or create your own by altering the folder name. You can also manually add deeper folder levels You can either use the suggested folder name or create your own by altering the folder name. You can also manually add deeper folder levels
by adding / in the text field provided e.g Competition-entries/May-2020. by adding / in the text field provided e.g Competition-entries/May-2020.
By default the /Form-submissions folder is set so only [Admins](https://userhelp.silverstripe.org/en/4/managing_your_website/managing_roles_and_permissions/#using-roles) By default the /Form-submissions folder is set so only [Admins](https://userhelp.silverstripe.org/en/4/managing_your_website/managing_roles_and_permissions/#using-roles)
have permissions to access it (restricted access), any files or folders in this folder will inherit these permissions. have permissions to access it (restricted access), any files or folders in this folder will inherit these permissions.
This can be changed manually on a per file/folder basis from the **Files** area. This can be changed manually on a per file/folder basis from the **Files** area.
Click **Save and continue** to continue editing your form. Click **Save and continue** to continue editing your form.
@ -168,10 +172,10 @@ Click **Save and continue** to continue editing your form.
#### Option 2, use an existing folder: #### Option 2, use an existing folder:
If you choose to use a folder that already exists you can select the folder from the **Select folder** dropdown. Once you select a folder, If you choose to use a folder that already exists you can select the folder from the **Select folder** dropdown. Once you select a folder,
an icon will indicate whether or not the folder has restricted access and provide information for who the file uploads will be visible to. an icon will indicate whether or not the folder has restricted access and provide information for who the file uploads will be visible to.
If the form deals with personal data you will want to select a folder which has Restricted Access. If the form deals with personal data you will want to select a folder which has Restricted Access.
It will display some information about the groups who can access files in this folder. It will display some information about the groups who can access files in this folder.
Click **Save and continue** to continue editing your form. Click **Save and continue** to continue editing your form.
@ -180,23 +184,23 @@ Click **Save and continue** to continue editing your form.
## Changing folders for individual fields ## Changing folders for individual fields
If the folder you have selected for storing files does not have the recommended view restrictions applied, files uploaded to that folder If the folder you have selected for storing files does not have the recommended view restrictions applied, files uploaded to that folder
which have a published state will be visible to anyone who views them, or that can guess the URL. which have a published state will be visible to anyone who views them, or that can guess the URL.
You can change the folder associated with an Upload Field at any time. You can change the folder associated with an Upload Field at any time.
![Changing a File Upload Fields folder location on an individual field](_images/userforms-documents.png) ![Changing a File Upload Fields folder location on an individual field](_images/userforms-documents.png)
When viewing/selecting folder locations from the form you will see an icon indicating its permission status. When viewing/selecting folder locations from the form you will see an icon indicating its permission status.
You will either see a **restricted access** icon, or a **warning** icon. You will either see a **restricted access** icon, or a **warning** icon.
To store your files in a safer manor you can do one of several things: To store your files in a safer manor you can do one of several things:
* Create a new folder from the Files area, or if this is your first time setting up an Upload Field for this form you will * Create a new folder from the Files area, or if this is your first time setting up an Upload Field for this form you will
be guided through the process, for more information see [Setting up a folder to store file uploads for your form](#Setting-up-a-folder-to-store-file-uploads-for-your-form). be guided through the process, for more information see [Setting up a folder to store file uploads for your form](#Setting-up-a-folder-to-store-file-uploads-for-your-form).
* Change the upload folder to one which already has restricted access. Edit the Upload Field and select a folder from the **Select a folder** dropdown. * Change the upload folder to one which already has restricted access. Edit the Upload Field and select a folder from the **Select a folder** dropdown.
* Change the view access permissions of the current folder in the Files area to restrict access to the file. * Change the view access permissions of the current folder in the Files area to restrict access to the file.
You can manage your folder permissions by navigating to the Files section in the CMS menu and edit the folders details. You can manage your folder permissions by navigating to the Files section in the CMS menu and edit the folders details.
See [File Permissions](https://userhelp.silverstripe.org/en/4/creating_pages_and_content/creating_and_editing_content/images_and_documents/file_permissions) See [File Permissions](https://userhelp.silverstripe.org/en/4/creating_pages_and_content/creating_and_editing_content/images_and_documents/file_permissions)
for more information and [Roles and permissions](https://userhelp.silverstripe.org/en/4/managing_your_website/managing_roles_and_permissions/) to learn more. for more information and [Roles and permissions](https://userhelp.silverstripe.org/en/4/managing_your_website/managing_roles_and_permissions/) to learn more.
For more information on the usage of these icons in the files area, please refer to [File Indicators](https://userhelp.silverstripe.org/en/4/creating_pages_and_content/creating_and_editing_content/images_and_documents/file_permissions/#file-indicators). For more information on the usage of these icons in the files area, please refer to [File Indicators](https://userhelp.silverstripe.org/en/4/creating_pages_and_content/creating_and_editing_content/images_and_documents/file_permissions/#file-indicators).

View File

@ -1,5 +1,7 @@
title: Creating forms in the CMS ---
title: Creating forms in the CMS
summary: How to use the UserForms module to create forms via the CMS. summary: How to use the UserForms module to create forms via the CMS.
---
# Creating forms in the CMS # Creating forms in the CMS
@ -18,13 +20,13 @@ you should ensure processes and safeguards are in place to perform these actions
This is your responsibility, but here are a few tips to get you started: This is your responsibility, but here are a few tips to get you started:
* Ensure you have the necessary consents for processing and storing data according to your legislation (e.g. GDPR) * Ensure you have the necessary consents for processing and storing data according to your legislation (e.g. GDPR)
* Only accept form submissions via encrypted transfers (HTTPS) - check our [Secure Coding](https://docs.silverstripe.org/en/4/developer_guides/security/secure_coding/) guidelines * Only accept form submissions via encrypted transfers (HTTPS) - check our [Secure Coding](https://docs.silverstripe.org/en/4/developer_guides/security/secure_coding/) guidelines
* Control access to form submissions (via CMS page access controls) * Control access to form submissions (via CMS page access controls)
* Control access to files uploaded with submissions (via [folder access controls](field-types.md#file-upload-field)) * Control access to files uploaded with submissions (via [folder access controls](field-types.md#file-upload-field))
* Create a process to limit the types of data you are allowed to collect via this feature (e.g. no payment information or health data) * Create a process to limit the types of data you are allowed to collect via this feature (e.g. no payment information or health data)
* Create a process for limiting submission storage duration (manual deletion) * Create a process for limiting submission storage duration (manual deletion)
* Consider further safeguards such as at-rest encryption (check [encryption related addons](https://addons.silverstripe.org/add-ons?search=encrypt)) * Consider further safeguards such as at-rest encryption (check [encryption related addons](https://addons.silverstripe.org/add-ons?search=encrypt))
## Features ## Features

View File

@ -1,6 +1,10 @@
---
title: Creating a multi-page form
---
## Creating a multi-page form ## Creating a multi-page form
To create a multi-page form, simply click the 'Add Page Break' button. To create a multi-page form, simply click the 'Add Page Break' button.
This will create a page break field which is used to create a new page in the form. You can drag and drop this page break to separate form fields at the desired location. This will create a page break field which is used to create a new page in the form. You can drag and drop this page break to separate form fields at the desired location.
![Multi-page forms](_images/multi-page-forms.png) ![Multi-page forms](_images/multi-page-forms.png)