Alerts Service Jobs Configuration
The Analysis Server comes with an alerts service handling the execution of scheduled jobs for sending email alerts and updating data for the real-time dashboard. All the jobs included in the service are predefined, but all are configurable.
Job Name | Description | Cron expression | Alert Trigger Description |
---|---|---|---|
SyncLicenseStatus | Synchronize license-status data from Core Server for real-time dashboard. | 5 */5 * * * ? | Triggers every 5 minutes and 5 seconds |
ArchiveDataMonitor | Monitor Archive data loss based in archive file count. | 10 0 7 * * ? | Triggers every 7:10 AM |
MaxUtilization | Applications that has reached certain percentage of utilization. | 10 */5 * * * ? | Triggers every 5 minutes and 10 seconds |
LongCheckout | Users that reached certain number of license checkout hours. | 10 0 * * * ? | Triggers every top of the hour and 10 seconds |
SustainedMax | Application running in maximum utilization for certain number of hours. | 10 0 * * * ? | Triggers every top of the hour and 10 seconds |
LicenseExpiration | Features which are about to expire in a certain number of days. | 10 0 7 * * ? | Triggers every 7:10 AM |
LicenseHogs | Users with more than a certain number of concurrent licenses used. | 10 */5 * * * ? | Triggers every 5 minutes and 10 seconds |
LicenseDaemonDown | Daemons which are on or have not communicated with Open iT server for the last certain number of minutes. | 10 */5 * * * ? | Triggers every 5 minutes and 10 seconds |
LicenseServerDown | Servers which have not communicated with Open iT server for the last certain number of minutes. | 10 */5 * * * ? | Triggers every 5 minutes and 10 seconds |
LicenseStatus | Get if the Open iT License is expiring in less than 30 days. | 0 0 7 * * ? | Triggers every 7:00 AM |
RunEtlCheckerJob | Check the Analysis Server ETL background process if still running or has errors. | 0 0 12 * * ? | Triggers every 12:00 PM |
These default schedules are initially loaded into the Quartz table (AdoJobStore) in the Open iT database during the deployment (deploysql). These schedules can be rescheduled to suffice with the needs of the organization.
To reschedule the jobs and configure the properties, follow these instructions:
-
Go to the configuration directory,
C:\Program Files\OpeniT\Analysis Server\Configuration\
. -
Make a copy of the
alertJobs.config
file and name it asalertJobs.custom.config
. -
Open the
alertJobs.custom.config
file.The file contains all the scheduled jobs and triggers information.
Use the information provided in the section Alerts Configuration File to properly configure the Alerts Service.
-
Save the changes.
-
Follow the instructions in the section ResetSchedules to successfully redeploy the schedules and properties
-
Restart the Open iT Alert Service by following these instructions:
a. Open the command prompt as an Administrator.
b. Run this command to stop the Open iT Alerts service:
Command Syntaxnet stop openitalerts
Allow the process to finish.
c. Run this command to start the Open iT Alerts service:
Command Syntaxnet start openitalerts
Allow the process to finish.
Alerts Job Configuration File
Use this information to manually modify the alertJobs.config
configuration file.
Tag | Value | Description |
---|---|---|
name | String | The name of the job scheduled job. |
group | String (Job or Alerts) Job is for scheduled jobs that only execute a specific task or command. Alerts is for scheduled jobs that use the email alert functionality and send email notification. | The group assigned to the scheduled job. |
description | String | The descriptive information of the scheduled job. |
job-type | String | The task or class executed by the job. |
durable | Boolean | The life span of a job. Non-durable jobs have a life span bounded by the existence of its triggers. |
recover | Boolean | The behavior of the job after the process or machine in which it is running either shuts down or crashes. |
job-data-map | key is the string name that identifies the entry value is the value used as argument | The keys used as arguments in executing a job. |
Tag | Value | Description |
---|---|---|
name | String | The name of the job scheduled cron. |
group | String (Job or Alerts) JobTriggers is for crons that only execute a specific task or command. AlertTriggers is for crons that use the email alert functionality and sends email notification. | The group assigned to the scheduled cron. |
description | String | The descriptive information of the scheduled cron. |
job-name | String | The name of the job executed by the trigger. This should be the same with the corresponding job name. |
job-group | String | The group of the job to be triggered. |
misfire-instructions | String | A policy used when a persistent trigger misses its execution time because the scheduler shuts down or there are no available threads. This is by default SmartPolicy. |
cron-expression | cron expression | A string comprised of 6 or 7 fields separated by white space(s). The fields can contain any of the values allowed, along with various combination of the special characters allowed for that field. |
Cron Expression Format
Use this information to properly configure the cron-expression attribute of the configuration file.
Field Name | Mandatory | Allowed Values | Allowed Special Characters |
---|---|---|---|
Seconds | YES | 0 - 59 | , - * / |
Minutes | YES | 0 - 59 | , - * / |
Hours | YES | 0 - 23 | , - * / |
Day of Month | YES | 0 - 31 | , - * ? / L W |
Month | YES | 1 - 12 or JAN - DEC | , - * / |
Day of Week | YES | 1 - 7 or SUN - SAT | , - * ? / L # |
Year | NO | empty or 1970 - 2099 | , - * / |
Cron expression can be as simple as * * * * ? *
Special Characters
Use this information to provide a valid cron expression.
Special Character | Description |
---|---|
* ("all values") | Used to select all values within a field. For example, an asterisk (*) in the minute field means "every minute." |
? ("no specific value") | Used to input no specific value in a field. This is used when it is needed to specify something in one of the two fields in which the character is allowed, but not the other. |
- ("dash") | Used to specify ranges. |
("comma") | Used to specify additional values. |
/ ("slash") | Used to specify increments. The first number is where the counting starts and the second number is the interval. For example, 0/15 in the seconds field means the seconds 0. 15. 30 and 45. |
L ("last") | This has a different meaning in each of the two fields where it is allowed. When used in the day-of-month field, it means "the last day of the month." When used in the day-of-week field by itself, it simply means "7" or "SAT." But if used in the day-of-week field after another value, it means "the last specified day of the month" - for example, "6L" means "the last Friday of the month." It's allowed to specify an offset from the last day of the month, such as "L-3," which would mean "the third to last day of the calendar month." |
W ("weekday") | Used to specify the weekday (Monday-Friday) nearest to the specified day. For example, "15W" specified in the day-of-month field means "the nearest weekday to the 15th of the month." So, if the 15th is a Sunday, the trigger will fire on Friday the 14th. |
# ("hash tag") | Used to specify "the nth day of the month." For example, the value of "6#3" in the day-of-week field means "the third Friday of the month." |
When using the "L" option, it is important not to specify lists or ranges or values to avoid confusing or unexpected results.
The "L" and "W" characters can also be combined in the day-of-month field to yield "LW" which translates to "last weekday of the month".
The legal characters and the names of the months and days of the week are NOT case sensitive. MON is the same as mon.
Cron Expression Examples
Use this information as a guide in providing cron expressions.
Expression | Meaning |
---|---|
0 0 12 * * ? | Fire at 12pm (noon) every day |
0 15 10 ? * * | Fire at 10:15am every day |
0 15 10 * * ? 2005 | Fire at 10:15am every day during the year 2005 |
0 0/5 14 * * ? | Fire every 5 minutes starting at 2pm and ending at 2:55pm, every day |
0 10,44 14 ? 3 WED | Fire at 2:10pm and at 2:44pm every Wednesday in the month of March |
0 15 10 ? * 6L | Fire at 10:15am on the last Friday of every month |
0 15 10 ? * 6#3 | Fire at 10:15am on the third Friday of every month |