Enabling the Timer Servlet for Record Retention

IP Classification lets Record Retention Managers set up alert notifications whenever an event is performed for a Retention Record or a Retention Hold that is in the Scheduled or Purged state.

If you are the owner of a document connected to or contained in a record, you can subscribe to this feature and request to be notified whenever a retention date is reached or when a document is ready for purge.

This feature requires a timer servlet that is installed with the Collaboration Server but is commented out. Follow these steps to add the servlet and the properties that it uses.

  1. Make changes to the J2EE Settings. For details on how to make changes to the J2EE Settings see, Installation and Administration | 3DEXPERIENCE platform | 3DEXPERIENCE platform - Installation | Web Apps Deployment | Modifying J2EE Settings | web.xml Parameters | Timer Servlet.
  2. Add the following lines by removing the <!-- and --> from the beginning and end. If these lines are not in the file, add them.

    Servlet Definition 

    <servlet id="Servlet_20">
<servlet-name>TimerServlet</servlet-name>
<servlet-class>com.matrixone.servlet.TimerServlet</servlet-class>
<load-on-startup>2</load-on-startup>
</servlet>

    Servlet Mapping 

    <servlet-mapping id="ServletMapping_17">
<servlet-name>TimerServlet</servlet-name>
<url-pattern>/servlet/timer/*</url-pattern>
</servlet-mapping>

    Parameters 

    <context-param id="ContextParam_15">
<param-name>ematrix.timer.agent</param-name>
<param-value>creator</param-value>
</context-param>

<context-param id="ContextParam_16">
<param-name>ematrix.timer.agent.key</param-name>
<param-value></param-value>
</context-param>

<context-param id="ContextParam_17">
<param-name>ematrix.timer.interval</param-name>
<param-value>86400</param-value>
</context-param>

<context-param id="ContextParam_18">
<param-name>ematrix.timer.command</param-name>
<param-value> execute program emxRetentionRecord -method notifyOriginator</param-value>
    Note: If you had to enter the lines manually, make sure that there is no servlet id="Servlet_21" or "ServletMapping_17" in the web.xml file. If there are, use the next number available for each id. These numbers are identifiers, so it does not matter what they are but they cannot be duplicated in the file.

  3. Enter username, password, and timer interval values between <param-value> and <param-value> tags in the added code in web.xml.

    For the ematrix.timer.agent property, enter the username that the servlet must use to define the context in MQL. This must be a creator who has privileges to run the Program emxRetention Record JPO.

    For the ematrix.timer.agent property, enter the password for the Username, if there is any. For the creator, for example, there is no password.

    For the ematrix.timer.interval property, specify how often you want the system to check to see if task due notifications need to be sent. The interval is in seconds. Preferred setting for the timer interval is one day - 86400 - because this program must be kicked off on a daily basis.

    Keep the ematrix.timer.command with the default settings.

    Keep in mind that the Record Retention Manager specifies how long before or after the task due times that the system must send the notification. The length can be set in days and so this timing works in conjunction with the timer interval. For example, if the Record Retention Manager sets up the notifications to be sent one day before the task due time and the timer interval is configured to check every day, the notifications must be sent when one day before due date has been reached. The Recurrence Interval value set in Project Alert Preferences tells the system whether to send additional notifications.

  4. To complete the changes to the J2EE Settings, refer to the instructions referenced in Step 1 above.