Skip to main content

 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 following:

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

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

Individual group properties

These values are stored in the database and are editable through 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, insert the correct name/value pair in the following file:

/WEB-INF/config/group.properties

As of PageSeeder v6, only the following property names can be used for group properties. Custom group property names are not supported.

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

template/[globalTemplate]/config/project.properties

config/group.properties

sysconfig/groupDefault.properties

sysconfig/projectDefault.properties

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

The following table 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 sends 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 sends returned messages to the whole group. 

[group-name]@[server email domain]

  • suppressed: – the From: field displays this value for all messages.

email_suppressed@[server email domain]

  • noreply: – the From: field displays the following where hash should be unique to the sender.

[hash]--noreply@[server email domain]

noreply
mailReturnedAddressWhen notifyFromAddress is set to groupReturned (see above),  any returned messages generated from members accounts are sent to this address. a valid email address
mailRejectedAddressTracking 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 account other than the one they are registered with. a valid email address
stripHtmlEmailFooterA Boolean datatype that determines whether the footer from PageSeeder’s HTML emails should be stripped. true
emailFooterStartThe 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

errorReportAddressThe email address that PageSeeder error reports are sent to[PageSeeder support email address]
ignoreEmbeddedAttach mentSizeEmbedded files in incoming emails below this number of bytes are ignored.20000
mailNewThreadByTitleA Boolean datatype that spawns a new thread if the subject line of a reply is different from the subject line originally sent by the group. false
headerLogoUrlThe link for the logo on the top left corner of the interface. If blank, use:
/ps
helpUrlThe URL of the Help documentation. If blank, use:

https://user.pageseeder.com
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 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 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 ionStaticA list of fixed version values rather than free text
documentTimeVers ionIncrementingThe default value by which document versions should increment0.01
indexIgnoreFoldersA list of folders to be ignored when indexing the group
indexVersions

A Boolean datatype indicating whether document versions should be indexed.

Enabling this can create redundant information in the index.  

false
disableIndexing

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

Use with care as many features rely on the index.

false
indexXFieldsA Boolean, which if true, indexes all fields extracted from documents by Tika and prefix their name with “x-” – see Index fields for further details on X-Fields.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

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

PropertyDescriptionSince Version
styleViewsDeprecated, see Project Properties4.95
defaultStyleViewDeprecated, see Project Properties4.95
documentStatusInitialThe initial document status4.95
contentEditorNameThe name of the default content editor4.95
customCssA Boolean datatype indicating whether the group uses custom CSS4.95
inlineContentLabelsList of inline labels available in a document fragment5.3
paraContentLabelsList of block labels (formerly para labels) available in a document fragment5.3
xrefContentLabelsList of labels for use on cross references5.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
statusChangeBroadcastA 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
headerLogoUrlThe link for the logo on the top left corner of the interface. If blank, use: /ps5.93
helpUrlThe URL of the Help documentation. If blank, use:
https://user.pageseeder.com
5.93
shareDocumentEdits

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

/ps/[group name]/
5.99
shareXrefsWithTargetA Boolean datatype indicating whether to display a reverse cross reference on the document in the target group when xrefs are shared.
/ps/[group name]/
5.99
Created on , last edited on