Setting Job Descriptions
When a task is initialized by the Services Framework, it is the responsibility of the task to set its job description, which provides a detailed description of the job being performed. At task initialization, the status of the activity record is set to pending. When a task updates the job description, it changes the status of the task activity record to running.
It is recommended to set the job description as early as possible to show when processing starts.
To update the job description of a task, the BaseIPDTask uses the
updateJobDescription() method.
protected boolean updateJobDescription(String description)For example:
updateJobDescription("Purging task activity records older than "
+ keepDays + " day(s) old.");It is required for all tasks to update their job descriptions in
the following methods called by the Services Framework:
public CompleteStatus runTask() throws TaskProcessingExceptionpublic boolean endOfDayExec(long businessDayId) throws EndOfDayExceptionpublic boolean cleanup(long businessDayId) throws CleanupException
Refer to the Javadoc information for additional information about methods and signatures.