Guide

The end-user 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. projectDefault.properties
  2. [customFolder]/config/project.properties
  3. groupDefault.properties
  4. group.properties
  5. project.properties
  6. Group Properties Page

 

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 data type 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
 emailFooterEnd

The 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.


/page/nogroup/preferences/mygroups,
Change my notification preferences
 mailNewThreadByTitle

A boolean data type 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.


http://www.pageseeder.com

 helpUrl

The URL of the Help documentation.


/psdoc/ReadMeFirst

 customCss

A boolean data type indicating whether the group uses custom CSS.


false

 styleViews

Deprecated, see Project Properties.

 defaultStyleView

Deprecated, see Project Properties.

 shareDocumentEdits

A Boolean data type indicating whether document edits shared from the default folder of the group (/ps/[group name]/), are visible to all groups.

false

shareXrefsWithTarget

A Boolean data type 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.

false

inlineContentLabels

List of inline labels available in a document fragment.
 

paraContentLabels

List of block labels (formerly para labels) available in a document fragment.

xrefContentLabels

List of labels for use on cross references.

generalLabels

List of labels for general use (documents, comments, folder, etc...)

statusApprover

List of statuses that approvers can use for a task. The order should reflect the lifecycle of a task.

Open,Resolved,Closed

(comma separated, no spaces)

statusManager

List of statuses that managers can use for a task. The order should reflect the lifecycle of a task.

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.

Open,Resolved

statusReviewer

List of statuses that reviewers can use for a task. The order should reflect the lifecycle of a task.

Open

statusActive

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

Open,Initiated, In Progress,Complete 

(comma separated, no spaces)

statusBroadcastApprovers

List of statuses that will trigger an email notification to approvers.

This property does not apply to changes made through the 'bulk' interface.

statusChangeBroadcast

A Boolean data type 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 changes made through the 'bulk' interface.

false

documentStatusApprover

Statuses that Approvers can set for a document. The order should reflect the lifecycle of a document.

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

(comma separated, no spaces between values)

documentStatusManager

Statuses that Managers can set for a document. The order should reflect the lifecycle of a document.

Initiated,In Progress,Complete, Suspended,Terminated

(comma separated, no spaces between values)

documentStatusContributor

Statuses that Contributors can use for a document. The order should reflect the lifecycle of a document.

In Progress,Complete

(comma separated, no spaces between values)

documentStatusReviewer

The status values available for selection by a Member with the role of Reviewer.  The order should reflect the lifecycle of a document. 

In Progress,Complete

(comma separated, no spaces between values)

documentStatusLocked

The status values for which editing via the user interface is disabled.

documentStatusInitial

deprecated

priority

The list of priorities ordered from highest to lowest.

High,Medium,Low

(comma separated, no spaces between values)

documentTimeVersionStatic

A comma separated list of workflow 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 data type indicating whether document versions should be indexed.

Note: enabling this can create redundant information in the index.  

false

disableIndexing

A Boolean data type indicating if indexing in the group should be disabled. CAUTION: Should be used with care as many features rely on indexing.

false

contentEditorName

deprecated

 

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

Created on , last edited on