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 given to various stages in the document lifecycle, see version.
  • the names and stages of a task.
  • which document fields (content labels) are available to search.

Where a specific property is not defined by an Individual Group, PageSeeder uses the value from the default group properties.

Individual Group Properties

These can be edited via the standard user interface by anyone with a role of manager. Individual group properties are stored in the database, not the properties file.

Default Group Properties

Located in the /WEB-INF/config folder of the PageSeeder Web application, these apply to all Groups on the Server. They are stored and processed in the same way as Java Properties .

To edit the default properties, insert the appropriate name / value pairs in the 'group.properties' file.

The 'groupDefault.properties' located in the


/WEB-INF/sysconfig

folder contain PageSeeder's fallback values and must never be modified.

The order in which group and project properties override each other is as follows (higher number overrides lower):

  1. sysconfig/projectDefault.properties
  2. template/[customFolder]/config/project.properties
  3. sysconfig/groupDefault.properties
  4. config/group.properties
  5. template/[current top level project template]/config/project.properties
  6. Group Properties Page (inherits from parent projects)

 

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:

  • user – the email address bound to the account of the author of the message.
  • 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] (see the 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
ignoreEmbeddedAttachmentSize

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 shared from the default folder of the group (/ps/[group name]/), are visible to all groups.

true

shareXrefsWithTarget

A Boolean datatype indicating whether a cross references from the default folder of the group (/ps/[group name]/) should display a reverse cross reference on the document in the target group.

true

statusApprover

List of statuses that approvers can use for a task. The order should reflect the lifecycle of a task (comma separated, no spaces between values).

Open,Resolved,Closed

statusManager

List of statuses that managers can use for a task. The order should reflect the lifecycle of a task (comma separated, no spaces between values).

Open,Resolved

(comma separated, no spaces)

statusContributor

List of statuses that contributors can use for a task. The order should reflect the lifecycle of a task (comma separated, no spaces between values).

Open,Resolved

statusReviewer

List of statuses that reviewers can use for a task. The order should reflect the lifecycle of a task (comma separated, no spaces between values).

Open

statusActive

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

statusBroadcastApprovers

List of statuses that will trigger an email notification to approvers (comma separated, no spaces between values).

This property does not apply to document status.

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.

false

documentStatusApprover

Statuses that Approvers can set for a document. The order should reflect the lifecycle of a document (comma separated, no spaces between values).

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

documentStatusManager

Statuses that Managers can set for a document. The order should reflect the lifecycle of a document (comma separated, no spaces between values).

Initiated,In Progress,Complete, Suspended,Terminated

documentStatusContributor

Statuses that Contributors can use for a document. The order should reflect the lifecycle of a document (comma separated, no spaces between values).

In Progress,Complete

documentStatusReviewer

The status values available for selection by a Member with the role of Reviewer.  The order should reflect the lifecycle of a document (comma separated, no spaces between values). 

In Progress,Complete

documentStatusLocked

The status values for which editing via the user interface is disabled (comma separated, no spaces between values).

priority

The list of priorities ordered from highest to lowest (comma separated, no spaces between values).

High,Medium,Low

documentTimeVersionStatic

A comma separated list of version values where document version identifiers are fixed rather than free text .

documentTimeVersionIncrementing

The default value by which document versions should increment.

0.01

indexIgnoreFolders

A comma separated list of root 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. CAUTION: Should be used with care as many features rely on indexing.

false

indexXFieldsA 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 value: 'true' or 'false'
  • Default values provided for convenience; 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

Created on , last edited on