Analytics Jobs dialog

Use the Analytics Job dialog to set retention times for the Enterprise Cleanup and to schedule the Analytics Load job. See Managing analytics jobs.

To open this dialog, locate the System Configuration tasks in the Action pane's Configuration panel and click Manage analytics jobs.

Here you set the retention time (i.e., the number of days data is retained) for each of the tables in the Enterprise database. This retention time defines how long data will be retained in a given table before being cleaned up.

There is no one "recipe" for how to set the number of retention days. It will all depend on the usage profile of the QIDM system as deployed in your organization. Although a default "age of data" value (in days) will have already been entered for each table, you can change – and in fact should change – the times to meet your requirements. Be sure to study the Best Practice below.

Field

Description

Loaded into Analytics database

Table Name

A2B_SITE_VISIT - The meta data for a Software Courier site visit operation.

Yes

A2B_ALARM_EVENT - The alarm events that are generated by the system (faults from devices, alarms from monitoring rules, etc.)

Yes

A2B_ALERT_ACKNOWLEDGEMENT - The acknowledgements to alert requests.

Yes

A2B_ALERT_NOTIFICATION - The notifications of alert request. Includes email notifications as well as notifications of other business systems.

Yes

A2B_ALERT_REQUEST - The alert events that are generated by the system based on the alarm/alert configuration.

Yes

A2B_ASYNC_REF - The asynchronous reference number for device communications. It is recommended that you not change this table’s default.

A2B_AUTH_TOKEN-The authentication tokens generated when users and devices log in.

A2B_DIAG_REQUEST - Information requested from the Control panel and Run command task.

Yes

A2B_MEMBER_AUDIT – Stored member audit information.

A2B_METER_READING - Meter readings.

Yes

A2B_MONITOR_READING - Monitoring readings. This is a high-volume table that should be watched carefully! See the Best Practice below.

Yes

A2B_SYSEVENT_INFO - The system operational log. This is a high-volume table that should be watched carefully! See the Best Practice below.

A2B_WEB_SERVICE_CONTACTED_INFO - The history of communication types from the device. This is a high-volume table that should be watched carefully! It is recommended that you adjust the setting based on system usage profile, depending on poll rate. See the Best Practice below.

A2B_CLEANUP_LOG - The event log of the Enterprise Cleanup job.

A2B_ALERT_REQUEST_ASSOC – Associated alert requests.

A2B_DOCUMENT - The meta data for the Enterprise system files.

Yes

A2B_SOFTWARE_DIST_PACKAGE - The meta data for the Software Director update packages.

Yes

A2B_USAGE_JOB - Usage job information.

Yes

A2B_FAULT - Fault information as received from devices.

Yes

A2B_ACTUAL_CONF - The actual configuration of devices.

Yes

A2B_AUDIT – Stored audit information for important user and device activity and operations.

Yes

Age of Data (Days)

Type the number of days for which data will be retained in the table in the Enterprise database. Partial days are allowed. Do not enter zero for the number of days.

Best Practice for

setting retention times for Enterprise data

Some of the Enterprise database tables can grow too large if their Age of Data (Days) value is not properly set. As a general guideline, retention times should be set such that only the data required to be viewed in real-time is retained in the Enterprise database. Data not needed for real-time viewing is moved to the Analytics database, where it is available for historical reporting purposes.

Be sure to periodically monitor the tables, especially if there is an increase in system usage, which might necessitate changes to the retention time. Increased usage may occur as devices are added or as more activity is performed for each device. If you see that a table has a million or more rows, you should lower its Age of Data (Days) value.

Given that each deployment of the QIDM system collects data at a different rate, there is no typical number of retention days for the various database tables. The following tables are prone to growing large over time and should be periodically checked:

A2B_MONITOR_READING
A2B_SYSEVENT_INFO — If this table becomes very large, it may be caused by errors occurring at a rapid rate. The cause of the errors will need to be determined in order to alleviate the problem
A2B_WEB_SERVICE_CONTACTED_INFO.

Here you manage the settings of the predefined scheduled task that runs the processes. You can edit this schedule, but cannot otherwise delete it or add another schedule.

By default, the predefined schedule is disabled. You will need to enable it to have it take effect.

NOTE: The Enterprise Cleanup process is run automatically after the Analytics Load process, so there is no need to schedule it separately.

Name	Type a name for the scheduled task (up to 50 characters).
Description	Type a description of the scheduled task (up to 200 characters).
Recurrence	Select the task's frequency, such as Daily or Weekly, and then set the specific recurrence details, such the task's interval (e.g., every 2 days) or its set day (e.g., Sunday).
Start	Type the starting date, or select it from the popup calendar.
Disabled	Clear this check box to enable the scheduled task.