How to set up a global template
| Skills required | XML |
|---|---|
| Time required (minutes) | 15 |
| Intended audience | Developer |
| Difficulty | Easy |
| Category | Document |
Objective
In this tutorial, you’ll learn to set up PageSeeder so that it uses a global template.
A global template lets you provide common customisations such as document templates and organization configuration.
Prerequisites
- You are an administrator
- You have privileged access to the PageSeeder host machine
- You have a PageSeeder developer license or a service provider licence
Tutorial
Create global project
In this step, you create a PageSeeder project called ‘config’ for use as a global template.
- Go the Administration dashboard (click the
icon) - Go to the New project page (Under Project & groups in the side menu)
- Enter the Title, Name and Description on the form
- In this tutorial, we can enter "Config", "config", "Global configuration template"
- Click Submit to create the project
You can use any name of the project that you use as a global template. Typically, the name 'global' or ‘config’ is used. You cannot use ‘default’ as it is reserved by PageSeeder for PageSeeder default template.
Update global properties
In this step, you change the global properties file.
- Sign in to the host machine where PageSeeder is installed
- Go to the config folder
- On Linux:
/opt/pageseeder/webapp/WEB-INF/config - On Windows
[PageSeeder install dir]/webapp/WEB-INF/config - Open the
global.propertiesfile in the text file editor - Add the following line
globalTemplate=config
Check that the line does not already exist, if that is the case, your system already has a global template.
Reload server properties
In this step, we enable the changes
- Go the Administration dashboard (click the
icon) - Go to the Server properties page (Under System configuration in the left menu)
- Click Reload
- Check that the globalTemplate property is set to the name of your project
You can check that the global template is set up correctly by going to the Project templates page. The global template should appear is a list with a different coloured icon and the “global template” pill text next to it.