How to include a privacy policy
Skills required | XML, Markdown |
---|---|
Time required (minutes) | 15 |
Intended audience | Developer |
Difficulty | Easy |
Category | Document |
Objective
In this tutorial, you’ll learn how to configure PageSeeder to display your privacy policy both in the user interface and during the sign-up process.
Many organizations require users to be informed about how their personal data is handled. This is typically achieved through a privacy agreement or policy that users must review, and it should be readily accessible within the application.
Prerequisite
- You are a system administrator
- You have a PageSeeder developer license or a service provider licence
- PageSeeder is configured to use a global template – See How to set up a global template
- You have a copy of the privacy policy in electronic format if you want to use your own policy
Tutorial
In the following steps, we modify the organization config in the global template to include a privacy policy and configure it to ensure it is available on sign up.
Pages in this tutorial
You will need to go to the Organization settings page:
- Go to the
Administration dashboard - Select to the
System configuration > Organization settings from the side-menu
You can reach the Templates file page from the Organization settings page, or by going to
- Go to the
Project administration - Select the
Template > Template files from the side-menu
Upload your privacy policy
In this step, we add the privacy policy document as a markdown file.
From the Template files page of the global template.
- Create the
organization
folder if it does not already exist. - Create a
privacy_policy.md
document in the organization folder - Click the
privacy_policy.xml
document to open the Code editor panel - You can either
- Paste the contents of your privacy policy in the editor
- OR use the following content
Privacy policy === Your personal data is collected and used only to improve your experience and provide necessary services. We do not share your information with third parties without your consent.
- Save the content
PageSeeder uses markdown for these documents, you can use the Preview option in the editor to check how the content is displayed to end-users.
Configure the organization
In this step, we update the organization config to use our privacy policy so that it is available in the user interface and displayed during the sign-in process
From the Organization settings page or the Template files page:
- Open the
organization-config.xml
file in the code editor panel. - Add the
<legal>
element inside the<ui>
element
<ui> + <legal> + <document name="privacy_policy" title="Privacy policy" /> + </legal> </ui>
- To display the privacy policy during the sign up process, add the
agree-on
attribute
<ui> <legal> - <document name="privacy_policy" title="Privacy policy"/> + <document name="privacy_policy" title="Privacy policy" agree-on="signup"/> </legal> </ui>
- Save the organization config
Enable changes
In this step, we reload the organization config changes don't take effect immediately.
From the Organization settings page
- Click Reload button for the changes to take appear
- Check that your policy appears correctly under the Legal documents section
- Check that the ‘Privacy policy’ link is also available in your account menu
Notes
The process is the same for other legal documents such as an acceptable use policy, terms and condition, a cookie policy, or GDPR compliance.