Modifying trigger configuration of scheduled jobs

You can modify the configuration of a scheduled job trigger to change the schedule for a job. To update the trigger configuration of scheduled jobs, you can use the schedulerConfigUtility script.

You must be a Global Mailbox administrator to run the schedulerConfigUtility script and modify the trigger configuration of scheduled jobs.
Important: Modifying the default settings might result in reduced Global Mailbox system performance.

To update trigger configuration with the scheduler jobs utility script:

  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. To update the trigger configuration of a scheduled job, type ./schedulerConfigUtility.sh updateTriggerConfig (UNIX/Linux) or schedulerConfigUtility.bat updateTriggerConfig (Windows) and specify appropriate values for the options when prompted.
    Important: You must specify a value for the triggerName parameter.
    triggerName
    The name of the job. Specifying a value for this parameter is required. You can update the configuration of the following list of scheduled jobs:
    MessagePurgeTrigger
    The trigger name for the MessagePurgeJob.
    ResendFilteredEventsTrigger
    The trigger name for the ResendFilteredEventsJob.
    ReEvaluateEventRuleTrigger
    The trigger name for the ReEvaluateEventRuleJob.
    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 applies. Valid values for this option are integers that are specified in the format:yyyy-MM-dd HH:mm:ss
    yyyy
    Integer value for the year.
    MM
    Integer value for the month.
    dd
    Integer value for the day.
    HH
    Integer value for the hour.
    mm
    Integer value for the minutes.
    ss
    Integer value for the seconds.
    .
    triggerEndTime
    Specifies a time, after which the trigger does not apply. Valid values for this option are integers that are specified in the format: yyyy-MM-dd HH:mm:ss
    yyyy
    Integer value for the year.
    MM
    Integer value for the month.
    dd
    Integer value for the day.
    HH
    Integer value for the hour.
    mm
    Integer value for the minutes.
    ss
    Integer value for the seconds.
    triggerRepeatInterval
    Specifies a time interval, specified in triggerCalendarName, for the frequency that a trigger is run. Valid values are integers that are greater than 0.
    triggerCalendarName
    Specifies a time interval to determine the frequency that a trigger is ran. Valid values are:
    • EVERY_N_SECONDS - triggers fire repeatedly every interval number of seconds. A start time and end time can be optionally specified. If a start time is specified, the trigger fires only at or after the start time. If an end time is specified, the trigger stops firing at or after the end time. Examples:
      • interval=10, startTime=null, endTime=null - The trigger fires every 10 seconds. The following statement is entered:
        ./schedulerConfigUtility.sh updateTriggerConfig --triggerName=UserPurgeTrigger 
--triggerCalendarName=EVERY_N_SECONDS --triggerRepeatInterval=10
      • interval=10, startTime=5:00PM - The trigger fires every 10 seconds after 5:00PM until midnight. The following statement is entered:
        ./schedulerConfigUtility.sh updateTriggerConfig  --triggerName=UserPurgeTrigger 
--triggerCalendarName=EVERY_N_SECONDS --triggerRepeatInterval=10 
--triggerStartTime="2000-01-01 05:00:00" --triggerEndTime="2000-01-01 24:00:00"
        Tip: A date must be entered as part of --triggerStartTime and --triggerEndTime, but is ignored when --triggerCalendarName=EVERY_N_SECONDS
      • interval=10, startTime=5:00PM, endTime=6:00PM - The trigger fires every 10 seconds between 5:00PM and 6:00PM. The following statement is entered:
        ./schedulerConfigUtility.sh updateTriggerConfig --triggerName=UserPurgeTrigger 
--triggerCalendarName=EVERY_N_SECONDS --triggerRepeatInterval=10 
--triggerStartTime="2000-01-01 05:00:00" --triggerEndTime="2000-01-01 6:00:00"
        Tip: A date must be entered as part of --triggerStartTime and --triggerEndTime, but is ignored when --triggerCalendarName=EVERY_N_SECONDS
      • interval=10, startTime=null, endTime=6:00PM - The trigger fires every 10 seconds between midnight and 6:00PM. The following statement is entered:
        ./schedulerConfigUtility.sh updateTriggerConfig --triggerName=UserPurgeTrigger 
--triggerCalendarName=EVERY_N_SECONDS --triggerRepeatInterval=10 --triggerEndTime="2000-01-01 18:00:00"
        Tip: A date must be entered as part of --triggerStartTime and --triggerEndTime, but is ignored when --triggerCalendarName=EVERY_N_SECONDS
    • EVERY_N_DAYS - triggers fire one time every interval number of days. A start time (but not an end time) can be optionally specified. If a start time is specified, the trigger fires one time every interval number of days, at or after the start time. If no start time is specified, the trigger fires one time every interval number of days, at the same time that the trigger fired last. Examples:
      • interval=1, startTime=null - The trigger fires every day at the time of day that the trigger fired last
      • interval=1, startTime=5:00PM - The trigger fires every day at 5:00PM
    • MANUAL - triggers fire one time when manually scheduled by the administrator.
    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 a scheduled job trigger:
    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 following list of triggers:
    • UserPurgeTrigger
    • UnprocessedEventPurgeTrigger
    • ProcessingEventPurgeTrigger
    • CompletedEventPurgeTrigger
    • FailedEventPurgeTrigger
    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
    Remember: If the system is offline when a job is scheduled, the job starts immediately when EACH_QUORUM consistency is achieved.