...
| title | Table Of Contents |
|---|
...
| Table of Contents | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Overview
This guide will cover setting up a new device to collect EFM in ACM, including creation and configuration of all objects required. In this example, the ROC protocol is used.
| Info | ||
|---|---|---|
| ||
This guide assumes the ROC device has already been configured using ROCLink. |
Step 1: Create a Device
See the Creating a Device page. For our example, select the ROC protocol and assign a unique name.
| Info | ||
|---|---|---|
| ||
Folders allow objects to be organized together in a logical manner. See Creating Objects for further information about creating the Folder object. |
Step 2: Create a port object for the Primary Connection
ACM offers a number of different port types, such as the TCP/IP Connection and the TCP Listen Connection. (See Connections for a full list of available port types).
For our example, the ROC uses TCP/IP communication. Create a TCP/IP Connection object. See Creating Objects for further information about creating the TCP/IP object.
Refer to the TCP/IP Connection page for more information about configuring this object type.
Assign the new object to the Primary Connection property on the device Connection tab. Refer to Common Device Configuration for more information on how to configure the Connection tab for a device.
Step 3: Create a Schedule
Scheduled history collection is performed according to the assigned Schedule configuration. This schedule object is assigned to the device on the Device Configuration Tab.
Step 4: Create Meter Objects
Meters are created by the same method as other objects. See Creating Objects. Meters are assigned to run numbers in a device configuration. See Meters for more information about configuring the meter object.
For our ROC example, the order of the meter assignments is significant. Assignment of meters in the ROC is covered on the ROC Configuration page including notes on assignments.
| Info | ||
|---|---|---|
| ||
Historical collection types such as events, alarms and periodic record data is often tied to a specific meter run number in the device. When data does not tie to a specific run it is often referred to as station level. In our example for the ROC, the Station Meter object is assigned a Meter object to allow publication of data that does not belong to a specific meter run number in the ROC device. |
Step 5: Create Archive Objects
Archive objects facilitate historical collection from devices to the publishing features of ACM. ACM has several types including Configurable Archives and Archive Limits. See Creating Objects for how to create an archive object.
For our ROC example, Archive Limit objects are used and assigned on the Archive Collection Tab of the device configuration.
Step 6: Archive Mapping (Present on Some Device Protocols)
Archive mapping is used by some device protocols in ACM to further direct how historical data items are to be retrieved and stored in archive objects for later publishing.
...
| title | ROC Archive Mapping |
|---|
...
provides recommendations for SQL Merge Replication to keep ACM working in case of a fail-over. However, more can be done using replication. Below is an outline of the core tables to help guide you in setting up your system.
Temporary/Data Tables
The following tables are treated as temporary tables and the data is constantly changing. Table data is used only for calculation and/or movement which is re-generated on demand. These tables should NOT be replicated.
- JobSchedules
- ScheduledJobs
- ScheduledJobSteps
- tblArchiveStaging
- tblCommStatsStaging
- tblDailyRecs
- tblDailySummary
- tblHourlyRecs
- tblHourlySummary
- tblGcWritePending
- tblItemStaging
- tblObjectId
- tblPubStaging
Required Data Tables
This set of tables contain the data that is necessary for ACM configuration, history collection sequence positions and item persistence. If you want a fail-over ACM system that starts up with current data and last known item data, then these are REQUIRED.
- tblArchivePosition
- tblItems
- tblObjects
- tblProperties
- *tblServerDirectory : this is only required if you are using the Server Directory function
Historical EFM Data Tables
Historical EFM data is stored in multiple tables. If you replicate your EFM data, you should also replicate the publisher position pointers to prevent accidental republishing of your data on fail-over.
- tblArchiveRecords
- tblCommStats
- tblLiquidRecords
- tblMeterRecords
- tblMeterRecordsHistory
- tblPublishedRecord
- tblPublishPosition
History Tables
These history tables contain no EFM records. They log changes, actions, and errors. Replicating them is optional.
- ErrorLog
- ScheduledJobsHistory
- tblArchiveExec
- tblCommandLog
- *tblChanges : note this table is auto-populate on a trigger from tblObjects and tblProperties
- tblGcWritePendingAudit
- SchedulingErrors
Lookup Tables
This set of tables contain information to help decode records and store the database version information. They do not change between builds, so replication is optional.
- tblDbVersion
- tblGcWriteResultLookup
- tblLookupCommType
- tblLookupPeriod
- tblLookupPollFailCode
- tblLookupPollStatus
- tblLookupRefProp
- tblLookUpTypeID