Publisher

Overview

A Publisher facilitates the creation of historical outputs from records collected by devices. Each Publisher instance manages its own index marker for device records collected. Following any filter rules, the Publisher operates on batches of records controlled by the index marker that are then processed by the desired output type.

Creating A Publisher

A Publisher can be created using any one of several methods. See Creating Objects.

Configuration

General Tab

This tab is common to all objects in ACM. See General Configuration.

Publisher Tab

Output Type

The object assigned that defines the format to be used to publish. Click the button to select or create the output type. Output types are listed below.

Tip

To restrict what is published, Select Publish Filtered objects for the Publish Objects property. Then select a Publish Filter and select the Object Type To Publish.

Publish Objects

Publish all objects (Default) if you want to publish everything.
Publish Filtered objects to only publish objects as defined in the selected Publish Filter object.

Object Type To Publish

Meters (Default) This is only required if using the Publish Filter, and is used to filter on names.
Devices (Default) This is only required if using the Publish Filter, and is used to filter on names.

Publish Filter

The object assigned that defines the filtering to be applied. Click the button to select or create the Filter.

See Publish Filters.

Oldest Record

Default = 0. The age (in days) of the oldest record that should be published by this publisher.

Continue on Error

Default = Unchecked. If checked, the Publisher will continue publishing if an error occurs.

Note

This option is beneficial so that ACM can continue publishing in the event a single meter or device fails.

Warning

If Continue on Error is checked, gaps in published data can result.

Query Options

Batch Size (Default = 5000)
Query Timeout (Default = 30) Time (in seconds) for database query to time out while loading records to publish.

Logging Tab

Query Details

Select this option to have the publisher log additional details about what is published.

Commands

Command Listing

Reset Publish Position. Deletes the index marker currently saved for this Publisher.
Reset Publish Position to First Collection of Device/Meter. Moves the index marker currently saved for this Publisher.
- Specify the Device Object ID or the Meter Object ID
Reset Publish Position to a Specific Date. Moves the index marker currently saved for this Publisher.
Reset Publish Position to the Oldest collection in Filter List. Moves the index marker currently saved for this Publisher.
Remove Published Records
- Removes all meters tied to this publisher from the published records table. Meters will be re-added to the table the next time they are published by the publisher.
Refresh Published Records
- Removes all meters that are no longer associated to this publisher from the published records table.

Executing a Command

Once a command has been selected and any parameters entered, Click the Execute button.