Enables notification of expiration (NOE) of content items. This provides email notification to authors and administrators for documents that will be expired in a short time.
After enabling the NOE and restarting, an entry is included in the ScheduledEvents DomainHome/ucm/cs/config/activestate.hda file.
The include that controls when the NOE runs is set_doevent_for_notification_of_expiration. The NotifyTime parameter described below is used in this include.
Note that in the following parameters, NotificationQuery can be set to 30 (not 7, as is the default) and NotificationIntervalInDays can be set to 7; this provides weekly emails about what will expire within the month.
The table that defines scheduled events is in the IdcHomeDir/resources/core/tables/std_resources.htm file. The table is named IdcScheduledSystemEvents and the row is named NotificationOfExpiration.
To obtain debugging information for the NOE, set the following variables in the config.cfg file and restart the Content Server. Logging goes to the server output:
TraceSectionsList=system,scheduledevents TraceIsVerbose=true
IntradocDir/config/config.cfg
Takes the following optional parameters:
Parameter | Description |
---|---|
NotificationQuery | Specifies the query to be run to find the expired documents for the notification. The default is the following:
dOutDate > <$dateCurrent()$> <AND> dOutDate < <$dateCurrent(7)$> |
NotificationMaximum | Specifies the maximum number of documents returned from the query. Default: 1000. |
NotifyExtras | Denotes the administration users who receive the notification emails. If this entry is not used, the default is sysadmin . If left blank, no extra notification is sent. |
NotifyTime | The time of day to send the notification. Default: 00:01. Specified in 24-hour clock notation. |
NotificationFieldNames | Specifies the field names to include in the notification. Default: dDocAuthor, dOutDate, dDocTitle, dDocName, dDocType, dID, dInDate, dRevLabel, dSecurityGroup |
NOEUsePlainTextEmail | Allows the use of plain text email for the notification. Default: false. The email template is named QUERY_NOTIFICATION. If NOEUsePlainTextEmail=true , emailFormat=text . |
NotificationIntervalInDays | Specifies the interval in days. Default: 1. |
Used as a configuration entry:
EnableExpirationNotifier=true