Configuring Task Alerts

You can configure options for tasks that are due (but not yet completed) and tasks requiring escalation notification. This feature requires a timer servlet, which is installed with the 3DSpace Service but is commented out.

Note: The API method job.getInstance() is used to instantiate the monitor task and return the job instance, which is used to monitor and update the job status in the database based on TimerServlet configuration. It is not used for job instantiation. For more information, see the Javadoc provided for this method.

See Also
Configuring Notification Spooling
  1. Open the web.xml file located in the warutil directory.
  2. Add the following lines.

    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></param-value>
</context-param>

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

    Parameters for task escalation notifications:

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

    <context-param id="ContextParam_18">
<param-name>ematrix.timer.command</param-name>
<param-value>execute program emxRouteTimer -method performTaskEscalation</param-value>
</context-param>

    Make sure there is not already a servlet id="ContextParam_n" in the web.xml file. If there is, use the next number available for each id. These numbers are simply identifiers, so it does not matter what numbers are assigned, but they cannot be duplicated in the file.

  3. Edit the following parameters:

    • For the ematrix.timer.agent parameter, enter the username the servlet should use to set context in MQL. This can be any user who has privileges to run the program emxWorkspaceTimer.
    • For the ematrix.timer.agent.key parameter, enter the password for the username, if any.
    • For the ematrix.timer.interval parameter, specify how often you want the system to check to see if task due notifications need to be sent. The interval is in seconds, so to have the system check every hour, enter 3600; for every 6 hours, leave the default of 21600.
    • Leave the ematrix.timer.command with the default setting. The servlet runs this command, which executes the JPO program and method to perform the task notifications.

    Keep in mind that the Bookmark Root owner specifies how long before or after the task due times that the system should send the notifications. The length can be set in days and hours, and the timing works with the timer interval. For example, if the Bookmark Root owner sets up the notifications to be sent 1 day and 6 hours before the task due time and the timer interval is configured to check every 6 hours, the notifications might be sent up to 6 hours after the 1 day 6 hour point. If it is important that the notifications be sent at the time set up by the Bookmark Root owner, set the timer interval to a short interval, such as 3600 (1 hour).

    Each timer command must have an interval and command parameter defined. To configure multiple timer commands (one for Project Management alerts and the other for Collaboration and Approvals notifications) use these lines (with appropriate values for your business needs): 

    ematrix.timer.interval=84600 
ematrix.timer.command=execute program emxProjectSpace -method performTaskEscalation 
ematrix.timer.interval1=21600 
ematrix.timer.command1=execute program emxWorkspaceTimer -method performTaskEscalation

  4. Save the web.xml file.
  5. Run the warutil to create the archive files with the updated file included.