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 so it doesn't republish or skip records.. 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.
| Page Tree | ||
|---|---|---|
|
| Info | ||
|---|---|---|
| ||
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 or folder locations.
- Devices When selected the filter will apply to device object and device name.
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. A value of 0 means no limit.
Continue on Error
Default = Unchecked. If checked, the Publisher will continue publishing if an error occurs.
| Info | ||
|---|---|---|
| ||
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. |
Batch Size (Default = 5000). The maximum number of records to query from the internal database for each publish operation.
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 the publisher's progress through the database. It will show what range of records it's processing or whether it is caught up.
Commands
See Object Commands for how to locate and execute a command.
| Command | Description | Parameters |
|---|---|---|
Reset Publish Position | Move the publish position back to the oldest record in the archive. All archive records handled by this publisher will be re-published. | None |
| Reset Publish Position to First Collection of Device/Meter | Move the publish position back to the oldest record collection for selected Device or Meter. All archive records after this date will be reprocessed by this publisher. | Device ID. Provide the object id of the device, or leave blank for all devices or to a use a meter. Meter ID. Provide the object id of a meter, or leave blank for all meters. |
| Reset Publish Position to a Specific Date | Move the publish position back to the chosen date in the archive. All archive records after this date will be reprocessed by this publisher. | Date/Time. Provide a specific Date/Time. |
| Reset Publish Position to the Oldest collection in Filter List | Move the publish position back to the oldest record for the Publisher Filter list. All archive records after this date will be reprocessed by this publisher. | None |
| 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. | None |
| Refresh Published Records | Removes all meters that are no longer associated to this publisher in the published records table. | None |
| Publish A Device | Publishes the supplied device's historical records from supplied start date. This will only publish a max of 5000, starting with the oldest record first | Device ID. Provide the object id of the device. Date/Time. Provide a specific Date/Time. |
On this page
| Table of Contents | ||||||||
|---|---|---|---|---|---|---|---|---|
|