Configuration

Configuration manual for PageSeeder

Group Properties

The group properties are a set of name / value pairs that define much of the behavior for a PageSeeder group, including:

  • the names assigned to the stages of a document lifecycle, see workflow.
  • the names of the and stages of a task.
  • how email messages generated from comments or tasks is handled

Where an individual group does not specify a property,  a value is inherited from the default group properties stored in the locations below.

Individual group properties

These values are stored in the database and editable via the user interface by anyone with a role of manager

Configurable default group properties

These properties apply to all groups on the server. Stored and processed in the same way as Java Properties ,  to update the properties, simply insert the correct name/value pair in the following file:

/WEB-INF/config/group.properties

System default group properties

The following files contain the default values for PageSeeder. These are the system-level, fallback values and must never be modified:

/WEB-INF/sysconfig/groupDefault.properties
/WEB-INF/sysconfig/projectDefault.properties

Processing order

The order that group and project properties override each other is as follows (high number overrides low number – or 6 overrides 5, 5 overrides 4, etc):

Group Properties (that are inherited from the parent project)

template/[current top level project template]
   /config/project.properties

config/group.properties

sysconfig/groupDefault.properties

template/[customFolder]/config/project.properties

sysconfig/projectDefault.properties

Warning!

Any reference to 'list of values' should be interpreted as comma separated with no spaces between values.

The table below describes all the group properties currently in use.

PropertyDescriptionDefault Value
notifyFromAddress

The value for the 'From:' field in email messages sent from this group:

  • groupReturned – the group  email address using this value will send all returned messages generated by the group to this address 
[group-name]//returned@[server
                      email domain]

also see mailReturnedAddress option below

  • group – using this value will send returned messages to the whole group. 
[group-name]@[server email domain]
  • suppressed: – the From: field will display this value for all messages.
 email_suppressed@[server
                    email domain]
  • noreply: – the From: field will display the following where hash should be unique to the sender
[hash]--noreply@[server
                  email domain]
noreply
mailReturnedAddress

When notifyFromAddress is set to groupReturned (see above),  any returned messages generated from members accounts, will be sent to this address. 

a valid email address

mailRejectedAddress

Tracking messages that have been sent to the group but rejected helps to manage a common source of support incidents – when a member posts from an email accounts other than the one they are registered with. 

a valid email address

stripHtmlEmailFooter

A Boolean datatype that determines whether the footer from PageSeeder's HTML emails should be stripped. 

true
emailFooterStart

The character strings that signal where the email footer begins. Where group messages have been configured with more than one type of footer, this value can be a comma-separated list of character strings. 

----------------------,
Type response above
ignoreEmbeddedAttach
mentSize

Embedded files in incoming emails below this number of bytes will be ignored.

20000
mailNewThreadByTitle

A Boolean datatype that will spawn a new thread if the subject line of a reply is different from the subject line originally sent by the group. 

false

headerLogoUrl

The link for the logo on the top left corner of the interface. If blank use:

/ps

 

helpUrl

The URL of the Help documentation. If blank use:

https://user.pageseeder.com.

 

shareDocumentEdits

A Boolean datatype indicating whether document edits should be visible to all groups if shared from the group default folder:

/ps/[group name]/
true
shareXrefsWithTarget

A Boolean datatype indicating whether to display a reverse cross reference on the document in the target group when XRefs are shared.

/ps/[group name]/
true
statusApprover

A list of task status values available to approvers.

(comma separated, no spaces between values, in order of lifecycle).

Open,Resolved,Closed
statusManager

A list of task status values available to managers.

(comma separated, no spaces between values, in order of lifecycle).

Open,Resolved

 

statusContributor

A list of task status values available to contributors.

(comma separated, no spaces between values, in order of lifecycle).

Open,Resolved
statusReviewer

A list of task status values available to reviewers.

(comma separated, no spaces between values, in order of lifecycle).

Open
statusActive

A list of statuses considered active. Each status must be defined in one of the 'status' or 'documentStatus' properties

(comma separated, no spaces between values).

Open,
Initiated,
In Progress,
Complete
statusBroadcastApp
rovers

List of status values that will trigger an email notification to approvers

(comma separated, no spaces between values).

This property does not apply to workflow status.

documentStatusApprover

A list of workflow status values available to Approvers. 

(comma separated, no spaces between values, in order of lifecycle)

Initiated,
In Progress,
Complete,
Approved,
Suspended,
Terminated
documentStatusManager

A list of workflow status values available to Managers.

(comma separated, no spaces between values, in order of lifecycle)

Initiated,
In Progress,
Complete,
Suspended,
Terminated
documentStatusCon
tributor

A list of workflow status values available to Contributors.

(comma separated, no spaces between values, in order of lifecycle)

In Progress,
Complete
documentStatusReviewer

A list of workflow status values available to Reviewers.

(comma separated, no spaces between values, in order of lifecycle)

In Progress,
Complete
documentStatusLocked

A list of workflow status values that will disable the editing interface.

(comma separated, no spaces between values).

priority

A list of priority values ordered from highest to lowest.

(comma separated, no spaces between values).

High,Medium,Low
documentTimeVers
ionStatic

A list of fixed version values rather than free text .

documentTimeVers
ionIncrementing

The default value by which document versions should increment.

0.01
indexIgnoreFolders

A list of folders to be ignored when indexing the group.

indexVersions

A Boolean datatype indicating whether document versions should be indexed.

Note

Enabling this can create redundant information in the index.  

false
disableIndexing

A Boolean datatype indicating if indexing in the group should be disabled.

Warning!

Use with care as many features rely on the index.

false
indexXFields
A Boolean which if `true` will index all fields extracted from documents by Tika and prefix their name with `x-`
false

Notes

  • Wherever multiple values are allowed, the list syntax is comma separated.
  • Lists must not include spaces before or after commas
  • Valid Boolean values are 'true' or 'false'.
  • Default values provided for convenience; for the latest values check the 'groupDefault.properties' on the PageSeeder installation

Deprecated properties

Deprecation warning!

The following properties have been deprecated and are no longer used in the latest version of PageSeeder.

PropertyDescriptionSince Version
styleViewsDeprecated, see Project Properties.4.95
defaultStyleViewDeprecated, see Project Properties.4.95
documentStatusInitialThe initial document status.4.95
contentEditorNameThe name of the default content editor.4.95
customCssA Boolean datatype indicating whether the group uses custom CSS.4.95
inlineContentLabelsList of inline labels available in a document fragment.5.3
paraContentLabelsList of block labels (formerly para labels) available in a document fragment.5.3
xrefContentLabelsList of labels for use on cross references.5.3
generalLabelsList of labels for general use (documents, comments, folder, etc.)5.3
emailFooterEndThe character string that signals the end of the email footer ends. Where group messages have been configured with more than one type of footer, this value can be a comma-separated list of character strings.5.9
statusChangeBroadcast

A Boolean datatype flagging whether a change to assigned to, priority or due date should trigger a notification to all authors or members assigned to a task thread. This property does not apply to document status.

5.93
headerLogoUrl

The link for the logo on the top left corner of the interface. If blank use /ps.

5.93
helpUrl

The URL of the Help documentation. If blank use https://user.pageseeder.com.

5.93

Created on , last edited on