Modifying purge triggers

You can modify the trigger configuration of purge jobs, such as the schedule for a purge job, to meet your system requirements.

Before you begin

You must be a Global Mailbox administrator to run the schedulerConfigUtility script and modify the configuration of scheduled purge jobs.

About this task

Important: Modifying the default settings might result in reduced Global Mailbox system performance.

To modify the trigger configuration of purge jobs:

Procedure

  1. Open the /<install_dir>/MailboxUtilities/admin/bin (UNIX/Linux) directory or \<install_dir>\MailboxUtilities\admin\bin (Windows) directory.
    Tip: Replace <install_dir> with the directory where Global Mailbox is installed.
  2. Type ./schedulerConfigUtility.sh (UNIX/Linux) or schedulerConfigUtility.bat (Windows) in the command line and log in as the Global Mailbox administrator.
  3. Type ./schedulerConfigUtility.sh updateTriggerConfig (UNIX/Linux) or schedulerConfigUtility.bat updateTriggerConfig (Windows) in the command line, specifying the trigger name and the parameters that you want to update:
    Important: You must specify a value for the triggerName parameter.
    triggerName
    The name of the job. You must specify a value for this parameter. You can update the configuration of the following list of scheduled jobs:
    MessagePurgeTrigger
    The trigger name for the MessagePurgeJob.
    PayloadPurgeTrigger
    The trigger name for the PayloadPurgeJob.
    UserPurgeTrigger
    The trigger name for the UserPurgeJob.
    UnprocessedEventPurgeTrigger
    The trigger name for the UnprocessedEventPurgeJob.
    ProcessingEventPurgeTrigger
    The trigger name for the ProcessingEventPurgeJob.
    CompletedEventPurgeTrigger
    The trigger name for the CompletedEventPurgeJob
    FailedEventPurgeTrigger
    The trigger name for the FailedEventPurgeJob.
    triggerDescription
    A description of the trigger.
    triggerStartTime
    Specifies the time that the trigger runs. Valid values for this option are integers that are specified in the format:yyyy-MM-dd HH:mm:ss
    y
    Single integer value for a year.
    M
    Single integer value for a month.
    d
    Single integer value for a day.
    H
    Single integer value for an hour.
    m
    Single integer value for minutes.
    s
    Single integer value for seconds.
    .
    triggerEndTime
    Specifies a time, after which the trigger does not run. Valid values for this option are integers that are specified in the format: yyyy-MM-dd HH:mm:ss
    y
    Single integer value for a year.
    M
    Single integer value for a month.
    d
    Single integer value for a day.
    H
    Single integer value for an hour.
    m
    Single integer value for minutes.
    s
    Single integer value for seconds.
    triggerRepeatCount
    Specifies the number of trigger executions in one calendar day. Valid values are integers greater than zero.
    triggerRepeatInterval
    Specifies a time interval to determine the frequency that a trigger is executed. Valid values are integers that are greater than zero.
    triggerState
    Specifies the state of the trigger for a scheduled job:
    UNSCHEDULED
    A schedule is not specified for the trigger.
    SCHEDULED
    A schedule is specified for the trigger.
    NEW
    The trigger is created but is not triggered to run.
    TRIGGERED
    The trigger is initiated to begin running.
    RUNNING
    The trigger is running.
    DONE
    The trigger completes the scheduled execution.
    P
    Specifies individual criteria for scheduled jobs:
    RECORD_FETCH_SIZE
    Specifies the maximum number of records that the job retrieves each time that the job runs. Valid values are integers. The default value for this parameter is 1000 records.
    Restriction: You can specify this option only for the UserPurgeTrigger.
    PAYLOAD_PURGE_WAIT_TIME_IN_HOURS
    Specifies how much time elapses before payloads are purged.
    Restriction: You can specify this option only for the PayloadPurgeTrigger.
    STATUS
    Specifies the events that a scheduled job purges from the database based on the event processing status. The following list contains valid values for the STATUS parameter:
    • UNPROCESSED
    • PROCESSING
    • COMPLETE
    • FAILED
    Restriction: You can specify this option only for the following list of triggers:
    • UnprocessedEventPurgeTrigger
    • ProcessingEventPurgeTrigger
    • CompletedEventPurgeTrigger
    • FailedEventPurgeTrigger
    PURGE_INTERVAL_IN_MONTHS
    Specifies the frequency that a scheduled job runs in units of months. The default value is 6 months. Valid values are integers greater than zero.
    Restriction: You can specify this option only for the following list of triggers:
    • UnprocessedEventPurgeTrigger
    • ProcessingEventPurgeTrigger
    • CompletedEventPurgeTrigger
    • FailedEventPurgeTrigger