publish

Specifies the real-time data to be published to the target. Multiple points can be published by creating custom filter rules. The CVS endpoint contains properties that describe the following:

• pointTag
• historicalRollup
• pollingFreq
• facilityFilter
• pointFilter
• qualityOfService

yes

pointTag

Specifies the point for which real-time data will be published. For the CVS endpoint, pointTag values take the form of "FACILITY.UDC".

Wildcards are not supported in the pointTag member.

no

historicalRollup

Specifies if an historical rollup will be performed for the published point, allowing you to publish only the data that interest you, and publish less often at longer intervals. A rollup refers to the process of taking the raw data from the VHS and condensing it using a calculation or by thinning. The VHS uses an iterator to traverse a list of entries in a VHS and "roll" the values up, effectively compressing the data retrieved in a manner indicated by the rollup type chosen. The historicalRollup object contains the following members:

• type
• unit
• period
• topOfUnit

See History Rollups in the History chapter for more information.

no

type

Specifies the type by which to roll up data for a selected point. Rollup type options are as follows:

• None (RawData) — Returns all values. This is the default option.
• ThinMedian — The center entry out of a collection of entries. When the number of entries is even, there are two center entries. In this case, the returned entry is the first entry by timestamp.
• ThinMinMax — If there are two or more entries in the time period, the minimum and maximum value entries are returned with corresponding timestamps. If there is one entry in the time period, this entry is returned (just once).
• ThinLast — The last value recorded for a time period.

unit

Specifies the time units by which a rollup takes place. This refers to time increments, such as seconds, minutes, hours, or days. Rollup unit options are as follows:

• None
• Minutes
• Hours
• Days
• Seconds

period

Specifies the time interval by which a rollup type takes place. The rollup period refers to the quantity of units in a period. For example, to rollup 30 days, the RollupPeriod is 30 and the RollupUnit is "days."

topofUnit

Specifies the offset value to use if the subunit to the major unit does not start at the time unit expected. Subunit means whatever unit of time is the next smaller than that defined in RollupUnits.(i.e. hours to a day, minutes to an hour). This provides a method to allow for differences in start of day, time zone, or scheduling.

For example, to accommodate contract days starting at 5 AM, the TopOfDayHour would be 5 (indicating 5 hours from midnight).

pollingFreq

The frequency (in ms) used to poll the data specified in this publish object. If none is specified, the defaultPollingFreq is used. Minimum value is 200 ms.

facilityFilter

Specify custom filter rules to limit or expand the data published.

Wildcards are supported anywhere in a point configuration in the facilityFilter and pointFilter members so that you can target multiple points in a single line and publish all points that match the string.

For example, (facility_id='RPOC*' and facility_desc='RTU*'). Wildcards are not supported in the pointTag member.

no

pointFilter

Specify custom filter rules to limit or expand the data published.

Wildcards are supported anywhere in a point configuration in the facilityFilter and pointFilter members so that you can target multiple points in a single line and publish all points that match the string.

For example, (facility_id='RPOC*' and facility_desc='RTU*'). Wildcards are not supported in the pointTag member.

no