Archive Rule Tab

The Archive Rules Tab allows the user to configure an Archive Rule and specify its parameters. The list of Archive Rules can be expanded to view the Archive Rule contributors. Archive Rule contributors are the data series which are stored when an archive rule is executed. Contributors are managed by using theInsert Contributor and Remove Contributor buttons on the toolbar. The contributor data source may be a Meter, Meter Group, DER Model, Model, Portfolio, Five-Minute Model, Schedule, Weather Station, Weather Zone, or Forecast Monitor Zone.

Example

Configuring an archive rule requires adding a rule, setting the Archive Rule fields, and adding contributors. An example of configuring an archive rule is provided in Archive Example.

Archive Rule Fields

Fields in the Archive Rule List describe the Archive Rule and identify the archive properties. Fields displayed on the Archive Rules Tab are as follows.

• Archive Rule ID. User defined name to identify the Archive Rule.

• Description. Archive Rule description.

• Event. The MetrixIDR Event that triggers the Archive Rule. When the event occurs, the archive rule is executed. The standard event options are Manual, On Forecast, On Publish, and On Export Forecast to XML. Non-standard events may be created in the Manage Tasks dialog and the Forecast Monitor Configuration.

• Manual. When this option is selected, the archive is executed when the user selects the Archive button from the Actions menu, or the Archive is executed as a scheduled task. The manual setting should also be used to trigger the archive using an external scheduled task.

  • On Forecast. When this option is selected, the archive is executed when the Generate System Forecast command is executed from the Tools menu or as a scheduled task.

  • On Publish. When this option is selected, the archive is executed when the Publish All Schedules command is executed from the Tools menu or as a scheduled task.

  • On Export Forecast to XML. When this option is selected, the archive is executed when the Export Forecast to XML command is executed from the Tools menu or as a scheduled task.

  • Manage Task Events. Any event created in Manage Tasks dialog will appear as an event option. The Manage Tasks are user created tasks. When selected, the archive is executed when the task is executed, or as a scheduled task.

  • Forecast Monitor Events. Tasks created in the Forecast Monitor Configuration will be named “On Monitor Publish” followed by the FcstTypeID. For example, when the FcstTyepID = “Test”, the task will appear as “On Monitor Publish Test”. When selected, the archive is executed when the task is executed.

• Type. The type determines the meaning of the values in the Start Offset and Duration fields. The options for this field are Daily, Hourly, Interval, and Gas Day.

• Start Offset. The Start Offset is applied to the time the archive is initiated and determines which day or hour to use for the beginning of the archive. If Type is specified as Daily, then the Start Offset is measured in terms of days. If Type is specified as Hourly, then the Start Offset is measured in terms of hours. If Type is specified as Interval, then the Start Offset is measured in terms of intervals. If the Type is specified as Gas Day, then the Start Offset is measured in terms of days based on the Gas Day definition.

• Duration. The Duration determines how many days, hours, or intervals to archive when the Rule is triggered. The determination of days, hours, and intervals is based on the Type definition.

• Active. Checking the Active Box indicates an active archive rule. Inactive rules are not triggered by events or by external scheduled tasks. For example, if the Event field is On Publish, but the Active box is not checked, this rule will not be executed when a publish action is executed.

• Custom1 – Custom20. Twenty user-defined custom fields are available for identifying notes, sorting, or comments.

Contributor Fields

The Archive Rule operates on the inserted Contributors. The following is a list of fields in the contributor’s grid. Several contributor properties cannot be edited because they are obtained from the underlying object. Fields displayed in the contributors list are described below. Editable fields are indicated.

• Source Node Type. This field denotes the object Type to be archived. Object types in the MetrixIDR system include meters, meter groups, models, portfolios, five-minute models, schedules, weather stations, weather zones, and monitor.
• Source Node ID. The Source Node ID specifies the source node and the contributor data.
• Description. The description associated with the contributor.
• Weather Concept ID (Edit). When the Source Node Type is a Weather Zone or Weather Station, the Weather Concept ID must be added. This field identifies the weather concept to archive for the weather zone or station.
• WthrFcstID (Edit). When the Source Node Type is a Weather Zone or Weather Station, the WthrFcstID must be added. This field identifies the weather forecast for the station and zone to be archived.
• Mtr Fcst Type (Edit). When the Source Node Type is Monitor, the Mtr Fcst Type must be entered. This field identifies the meter type to be archived.
• MPI. This field indicates the minutes per interval for the contributor.
• UOM. This field indicates the unit of measure for the contributor (e.g., kWh or KW).
• Active. Active status of the contributor. When the active flag is set and the archive rule is executed, data will be archived for this member. When the active flag is not set and the archive rule is executed, data will not be archived for this member. The active flag for the contributor must be changed in the member’s source, not in the archive list.
• Dest Node Type. The node type for the destination. The destination is set when the Dest Node ID is defined. Data can be archived to a Meter, XDriver or Archive.
• Dest Node ID (Edit). This field identifies the archive location. The destination is the assigned location for storing the archive data. The archive data may be stored in the Archive, XDriver or Meter lists. When creating a new archive member, the "(New Archive)" label directs the archive rule to create a new archive in the Archive List. The user may change the location to an existing meter or XDriver by selecting and browsing for the location.

Actions

The following common actions are available on the Archive Rules Tab:

• Add.
• Delete.
• Duplicate.
• Insert Contributor.
• Remove Contributor.
• Filter Editor.
• Filter by Selection.
• Apply Filter.
• Clear Filter.
• Show Auto Filter Row.
• Column Chooser.
• Export Grid to Excel.
• Show Dependents.

The following action is only located on the Archive Rules tab in the Rules Configuration Dialog

• Archive. This action is available on the Archive Rules tab of the Rules Configuration dialog and allows the user to execute an Archive Rule manually. The Archive Rule will be executed even if the Active flag is not checked. To run an archive rule, select the rule and then select the archive button.