Revenue protection analysis task
Use the following procedure to configure a task template:
-
Go to System Operations > Task Management > Task Templates.
-
Use the dropdown menu to select the Task Type and Task Template. (Click Add to create a new task template. For more information, see Adding task templates.)
-
Configure the Task specific parameters. These parameters are defined after step 5 of this procedure.
-
Configure the Common task template parameters. For more information, see Task template parameters.
-
Click Save.
Task specific parameters:
SubTask
Defines whether to filter by all data or a subset of data. Subtask filters the data used in the task. Select Run All to include all data, or select a subset of data.
Full ETL
Defines whether the ETL task runs in full (True) or incremental (False) mode.
Caution: Do not set Full ETL to True except during initial system configuration or to perform a complete rebuild of the ETL tables. When set to True, define the Start Date parameter to prevent the ETL from re-running for readings already within the system.
Set to False for any task template that runs on a recurring basis. False indicates that the ETL runs in incremental mode. The ETL queries the ConfigChange table to identify service points that have changed since the last time the ETL ran. Only the readings created since the last execution of the task are added to the ETL tables (such as DailyReadingSummary and LikeDayAlgorithm).
Baseline End Date
Defines the end date for the baseline.
Task Chunk Size
Defines the maximum file size for each chunk. When this file size is reached, IEE creates a new chunk. The task system separates data into chunks that can be simultaneously processed by concurrent child tasks.
The higher the chunk size value, the greater the portion of the total available work each IEE task runner or task service performs. Smaller values mean the work is divided between more concurrent task runners or services.
Chunk sizes that are too large will result in single tasks reserving more work for themselves than they can process within the desired time period while other task runners sit idle. In extreme cases, overly large chunk sizes could also result in system failure due to lack of available, allocated memory. Chunk sizes that are too small will result in many tasks with little work to do accessing the IEE database more often than is optimal. Both conditions could lead to delays in processing.
The determination of optimal values will need to include database resources and other hardware considerations, as well as expected daily processing levels and time frames. Adjustments to values over time should be expected as hardware and networking conditions change.
Processing Chunk Size
Defines the number of configuration entities processed by sub-tasks. IEE groups the data that was processed by the task into separate batches of the size you designate here. IEE considers the task completed when all child tasks are finished, and each has reported back to the parent tasks.
Chunk size is a parameter common to several task templates. The higher the chunk size value, the greater the portion of the total available work each IEE task runner performs. A smaller value means dividing the work between more concurrent task runners.
Chunk sizes that are too large overburden a few task runners, while other task runners sit idle. In extreme cases, overly large chunk sizes could result in system failure due to lack of available, allocated memory. Chunk sizes that are too small spawn many task runners that perform more initialization and shutdown than actual work. Both large and small extremes will cause delays in export processing.
When fine tuning chunk sizes, consider database resources, hardware requirements, daily processing levels, and processing windows. Adjust values over time, as hardware and networking conditions change.
File Type
Define the file type for the task by selecting a type from the dropdown list. These are the types of files available for this task. For example, the task may be able to create or import file types such as CSV, XML, XLS, and others.
Export File Name
Defines the export file name. You can enter a unique file name or accept the default. This parameter supports the standard IEE macros.
Export Directory
Defines the directory where IEE places the file containing exported data. Accept the IEE default file path or click Search to browse to a directory. This parameter supports the standard IEE macros. Reference as ($ExportDirectory)
when configuring a task. Exported data is generated by an export task template or an export API.
Tamper Filter
Defines which service points are included in the exported report. Required only when Subtask is set to Run All or Export. Leave it blank to include all tamper types, or select a tamper type from the dropdown list. If you select a filter, you cannot return this parameter to blank for all. If the subtask is not set to Run All or Export, IEE ignores this parameter.
Tamper View
Defines which fields are displayed in the exported report. The order of the properties in the report header is also defined by the selected view. Select a pre-set view from the dropdown list. Required when Subtask is set to Run All or Export. If the subtask is not set to Run All or Export, IEE ignores this parameter.
Retune Interval in Months
Defines the interval at which IEE re-calculates the baseline.
Tamper Report Years
Defines the number of years to include in the report.