You can configure Records Retention for XML from the Admin Console.
Once you enable the
Records Retention plugin, you can configure it for your environment from the
Records Retention tab. This tab contains a list of configurable
settings. After you change any settings, click the Save Settings button
at the bottom of the page for the settings to take effect.
Properties That Need to Be Configured
The following properties must be changed in order to set up Records Retention for
XML:
- retention.xml.output.file.directory.name: The directory where the retention
files will be saved.
- retention.xml.output.file.filename.prefix: The filename prefix for the
retention files. The remainder of the filename includes a timestamp to uniquely identify
it.
Other Useful Properties
The following properties may be changed, as desired:
- jive.retention.email.subject.format:
How the email subject is formatted. The default is {regardsTo}[JIVE JOURNAL] -
{subject}, however this may be replaced with any hard-coded strings, along
with the following replacement keys:
- {regardsTo} — includes "Re:" on comments, replies and other
non-root entries
- {subject} — includes the raw subject or title of the root entry
- {contentType} — includes the content type of the event
- {actionType} — includes the action type of the event
- {objectId} — includes the ID of the item affected by the event
- {objectType} — includes the type of the item affected by the
event
- {rootId} — includes the id of the root entry of the affected
conversation
- {rootType} — includes the type of the root entry of the affected
conversation
For example, set this property to {subject} to include only the
raw title of the conversation with no additional formatting.
- retention.comma.separated.emails.for.error.reporting: A list of comma-separated
email addresses used for error reporting. If the XML creation fails (and is
recoverable), an email is sent to each email address listed in this setting.
- retention.deletes.processing.on: Whether
to capture delete events. Defaults to false. Note that delete records
have very little information about the content that was deleted.
- retention.error.reporting.email.subject: Subject string for the error reporting
email. If the XML creation fails (and is recoverable), an email is sent with this value
as the subject.
- retention.include.author.details: Whether
to include author details in the header. Defaults to false. Set this to
true to add a X-AuthorUsername header with the
author's username as the value.
- retention.reaper.actiancefile.number.of.days.to.keep: The number of days for
which completed XML files are kept.
- retention.reaper.messagearchive.number.of.days.to.keep: The number of days for
which records are retained after they are sent. Records can be saved for a period of
time so you can replay events. Defaults to 30.
- retention.reaper.capturedbinary.number.of.days.to.keep: The number of days for
which records are kept. Once a record is sent, it is considered "done" by the retention
module. However, records can be saved for a period of time so you can "replay" events.
This setting refers to binaries, including attachments, images and uploaded files.
- retention.resolve.and.store.cclists.for.spaces: Whether to send activity to
emails specified in the settings for a given space. Defaults to true.
This feature can be turned off in order to improve performance.
- retention.xml.directory.to.put.final.file: Directory where completed retention
files are copied.