Properties
The Replay module has the following properties:
| Name | Description | ID | Flags |
|---|---|---|---|
| ActiveBuffer | The buffer which data is replayed | 13000 | ReadOnly, PerformancePage |
| ActiveBuffer1 | Status if the buffer is active | 11900 | ReadOnly, InfoPage |
| ActiveBuffer2 | Status if the buffer is active | 12400 | ReadOnly, InfoPage |
| CmnItemIDPrefix | Common source ItemId prefix. This string will prefix each item's 'ItemID' when communicating with the OPC HDA server, and used as a filter when browsing this server's items. | 1030 | Persisted |
| CmnItemIDPrefix item | Common source ItemId prefix. This string will prefix each item's 'ItemID' when communicating with the OPC HDA server, and used as a filter when browsing this server's items. | 1031 | Persisted, ApisItem, ExpertPage |
| Computer | The computer hosting the OPC HDA server. | 1010 | Persisted, Computer |
| CurrentPlayIndex | The index of the active buffer | 12900 | ReadOnly, PerformancePage |
| EndTime | The latest time (UTC) of the history to be read. | 1065 | Persisted |
| EndTimeBuffer1 | The end time of the buffer | 12300 | ReadOnly, InfoPage |
| EndTimeBuffer2 | The end time of the buffer | 12800 | ReadOnly, InfoPage |
| ExchangeRate | The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values. | 100 | Persisted |
| ItemCountBuffer1 | The count of values in the buffer | 12000 | ReadOnly, InfoPage |
| ItemCountBuffer2 | The count of values in the buffer | 12500 | ReadOnly, InfoPage |
| ItemPropSync | How to synchronize item attributes from historian HDA attributes | 1095 | Persisted, Enumerated, ExpertPage |
| PrefetchStrategy | PrefetchStrategy | 11700 | Persisted, Enumerated |
| Realtime | Fetches the freshest HDA value, ignoring start/end time | 1082 | Persisted, ExpertPage |
| ReportBufferStatus | Reports buffer status to the log files for log view in Apis Management Studio | 11800 | Hidden, InfoPage |
| Resolution | The time between updates [seconds] | 1075 | Persisted |
| Server | The ProgID of the OPC HDA server. | 1020 | Persisted, Enumerated, ProgID |
| ServerCLSID | The CLSID of the specified OPC HDA server | 10000 | Persisted, ReadOnly, InfoPage |
| SrvCurrentTime | The current time (UTC) as known by the OPC server. | 11100 | ReadOnly, InfoPage |
| SrvLCID | Locale ID of values coming from the server. You might need to specify this property if the OPC server provides string values that is converted to another type in your client (e.g. DDE bridges) | 1040 | Persisted, ExpertPage |
| SrvMaxRetVals | The maximum number of return values supported by the server. | 11200 | ReadOnly, InfoPage |
| SrvPassword | The password used to connect to the OPC HDA server object (if needed) | 1024 | Persisted, Password, ExpertPage |
| SrvStartTime | The time (UTC) the OPC server was started. | 11000 | ReadOnly, InfoPage |
| SrvState | The current status of the OPC HDA server | 11300 | ReadOnly, Enumerated, InfoPage |
| SrvStatusString | Status string in the OPC HDA server. | 11400 | ReadOnly, InfoPage |
| SrvUser | The username used to connect to the OPC HDA server object (if needed) | 1022 | Persisted, User, ExpertPage |
| SrvVendorInfo | Vendor specific information about the OPC HDA server | 11600 | ReadOnly, InfoPage |
| SrvVersion | The version number of the OPC HDA server (major-minor-build) | 11500 | ReadOnly, InfoPage |
| Start on load | If true replay starts when module starts | 1088 | Persisted, ExpertPage |
| StartTime | The earliest time (UTC) of the history to be read. | 1060 | Persisted |
| StartTimeBuffer1 | The start time of the buffer | 12200 | ReadOnly, InfoPage |
| StartTimeBuffer2 | The start time of the buffer | 12700 | ReadOnly, InfoPage |
| Step on NextTime | Perform step when NextTime is set | 1083 | Persisted, ExpertPage |
| SynchronousReadAggregate | The aggregate to read from the OPC HDA server when using synchronous replay. Applies to data returned for SynchronousItems only. | 1087 | Persisted, DynamicEnumeration |
| SynchronousReadDelay | A delay in milliseconds inserted before the ReadSynch command, 0 to disable delay. | 1085 | Persisted |
| TimeMode | The time mode used to timestamp items. | 1050 | Persisted, Enumerated, ExpertPage |
| TimeReferenceItem | An item who's value will be used as the time reference for this module instead of the system time, when timestamping items. | 200 | Persisted, ApisItem, ExpertPage |
| TracefileMaxSize | The max size of the trace file before the file is truncated in bytes. Default is 50 MB => 50 * 1024 * 1024 | 15000 | Persisted, ExpertPage |
| TraceServerState | This is used to trace detail information about internal steps of a replay sequence. Note: Be care full of enabling 'PlayBackValues' and 'All Calls' since this can result in mutch disk activity.Disabled - Trace not activeTraceCall - The different function calls which are called during replayWaitForData - The request for dataStatusChange - On status changeReadServer - When data is read from serverCurrentIndex - Current index being replayedFireBrokerEvent - When broker event is sendPlayBackValues - The values being replayedCommands - Commands being sentStartupSequence - The startup sequence of replay beeRequestMoreData - Not used at the momentActivatedItems - When items are set active for replayAll Calls - Trace active for all types | 15020 | Persisted, Enumerated, ExpertPage |
| TraceToFile | This is used to trace detail information about the internal status of the replay session. The type of status to trace is given by the property 'TraceServerState' | 15010 | Persisted, File, ExpertPage |
| UseHDATimestamp | Use HDA Timestamp for each interval, if false the item timestamp is used. Applies to data returned for SynchronousItems only when aggregate is Interpolative zero-order | 2000 | Persisted, ExpertPage |
| UseRelativeTime | Use relative Start and End time, valid only for aggregate data. | 1072 | Persisted, ExpertPage |
| ValueCountBuffer1 | The count of values in the buffer | 12100 | ReadOnly, InfoPage |
| ValueCountBuffer2 | The count of values in the buffer | 12600 | ReadOnly, InfoPage |
See also Module Properties