Properties
The OPC module has the following properties:
Standard properties
| Name | Description | ID | Flags |
|---|---|---|---|
| Computer | The computer hosting the OPC server. | 1000 | Persisted, Computer |
| DataSource | This property tells the OPC server how to retrieve its data. 'Cache' means that the OPC server should use any internal cached data, 'Device' means that the OPC server should refresh the data from any underlying device (ie. PLC) | 1019 | Persisted, Enumerated |
| Deadband | Percent deadband for item updates, when ReadMode is subscribe. | 1022 | Persisted |
| ExchangeRate | The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values. | 100 | Persisted |
| ReadMode | How items are beeing read from the server. | 1020 | Persisted, Enumerated |
| Server | The ProgID of the OPC server. Can also use a class ID directly, eg. if the class id is known and server browsing is unavailable. | 1001 | Persisted, Enumerated, ProgID |
| Updaterate | Updaterate in milli-seconds for the items, when ReadMode is Subscribe x.0. When ReadMode is Asynch I/O, the intervall between each issued Refresh call. When ReadMode is Synch I/O, the intervall betweean each Read call. | 1021 | Persisted |
| WriteMode | How items are being written to the server. | 1030 | Persisted, Enumerated |
Advanced properties
| Name | Description | ID | Flags |
|---|---|---|---|
| CmnItemIDPrefix | Common source ItemId prefix. This string will prefix each item's 'ItemID' when communicating with the OPC server. Items in this module will have names without this prefix in the Apis namespace. | 1012 | Persisted, ExpertPage |
| DelayServerConnect | Delay server connect on startup, connection will be performed when all modules are fully initialized. | 1045 | Persisted, ExpertPage |
| ForceOutOfProc | Prevent the opc server from beeing loadad into the memory space of Apis. | 1010 | Persisted, ExpertPage |
| ForceRefreshOnConnect | By enabling this with subscription (1.0 or 2.0), the client will request a distinct refresh of all items from the server after a connect. Note that the OPC server should refresh all items afer an Advise, this is a feature for working with OPC servers that do not meet the specifiaction regarding this. | 1007 | Persisted, ExpertPage |
| GroupActive | Active flag for the group. Automatic item activation will cause this flag to change dynamically when needed. | 1033 | ExpertPage |
| ItemActivation | Item activation strategy. | 1034 | Persisted, Enumerated, ExpertPage |
| ItemActiveTimeout | The interval in seconds to wait before an item is deactivated when there has been no reads from the item. (Only for 'ItemActivation' = 'automatic with timeout') | 1036 | Persisted, ExpertPage |
| ItemPropSync | When to synchronize OPC DA properties with Apis item attributes | 1038 | Persisted, Enumerated, ExpertPage |
| NumberOfRedundantServers | The maximum number of redundant servers for this instance, valid range is 0-5. | 2000 | Persisted, ExpertPage |
| ReconnectSrvShutdown | Reconnect after an intended OPC server shutdown. This might cause problems when administering the OPC server. | 1008 | Persisted, ExpertPage |
| ReconnectTime | The time to wait before attempting to reconnect the server after an RPC failure, or time interval for watchdog evaluation if watchdog is configured. | 1006 | Persisted, Enumerated, ExpertPage |
| RedundantCmnItemIDPrefix_x | Common source ItemId prefix for the redundant server 'x'. This string will prefix each item's 'ItemID' when communicating with the OPC server. Items in this module will have names without this prefix in the Apis namespace. | 20x2 | Persisted, ExpertPage |
| RedundantComputer_x | The computer hosting the redundant OPC server 'x', if configured. | 20x0 | Persisted, Computer, ExpertPage |
| RedundantServer_x | The ProgID of the redundant OPC server 'x', if configured. | 20x1 | Persisted, Enumerated, ProgID, ExpertPage |
| SerializeCallsToOPCServer | Set this property to <true> if the OPC Server is not handling simultaneous calls properly. | 1042 | Persisted, ExpertPage |
| ServerWatchdog | A strategy for server communication monitoring. This can be useful when dealing with erronous servers that stop to operate correctly. Values are:
| 1039 | Persisted, Enumerated, ExpertPage |
| ServerWatchdogItems | Set to one or more local items, when using a ServerWatchdog utilizing watchdog item(s) | 1043 | Persisted, ApisLocalItem, ExpertPage |
| SrvConfigFile | The configuration file of the server. This file is used with the optional IPersistFile implementation of the OPC server. | 1004 | DSN, ExpertPage |
| 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) | 1018 | Persisted, ExpertPage |
| SrvPassword | The password used to connect to the OPC server object (if needed) | 1003 | Persisted, Password, ExpertPage |
| SrvUser | The username used to connect to the OPC server object (if needed) | 1002 | Persisted, User, ExpertPage |
| SuppressVendorQuality | When true, any vendor specific item quality will be suppressed, only the standard OPC Foundation bits of the quality flag, will be set for item qualities | 1025 | Persisted, 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 |
| TraceOPCServer | Report specific OPC calls, return from those calls, as well as callbacks to the log files for log view in Apis Management Studio. | 1040 | Persisted, Enumerated, ExpertPage |
| TraceToFile | If set, all OPC calls and callbacks will be traced to this file. Should only be used for short time periods and for verbose troubleshooting of communication. | 1041 | Persisted, File, ExpertPage |
| UseApisTime | Use Apis timestamps instead of the timestamps given by the OPC server. | 1023 | Persisted, ExpertPage |
Information properties
| Name | Description | ID | Flags |
|---|---|---|---|
| DebugInfo | Debug information for advanced troubleshooting | 1058 | ReadOnly, InfoPage |
| Description | This module connects to an OPC server, and provides access to OPC items. | ||
| ExternalItem report | A status-report for the External Item manager of this module | 110 | InfoPage |
| RedundantSrvCLSID_x | The CLSID of the redundant OPC server 'x', if configured. | 20x3 | Persisted, ReadOnly, InfoPage |
| SrvActive | Currently active server, when using redundant severs, this tells which of the two that is currently set as active server (Primary / Redundant). | 1046 | ReadOnly, InfoPage |
| SrvBandWidth | The approximate percent of bandwith in use by the OPC server | 1055 | ReadOnly, InfoPage |
| SrvCapabilities | The capabilities of the OPC server. | 1048 | Persisted, ReadOnly, InfoPage |
| SrvCLSID | The CLSID of the OPC server. | 1005 | Persisted, ReadOnly, InfoPage |
| SrvCurrentTime | The current time (UTC) as known by the OPC server. | 1051 | ReadOnly, InfoPage |
| SrvGroupCount | The total number of groups (all public and private) being managed by the OPC server | 1054 | ReadOnly, InfoPage |
| SrvStartTime | The time (UTC) the OPC server was started. | 1050 | ReadOnly, InfoPage |
| SrvState | The current status of the OPC server | 1053 | ReadOnly, Enumerated, InfoPage |
| SrvVendorInfo | Vendor specific information about the OPC server | 1057 | Persisted, ReadOnly, InfoPage |
| SrvVersion | The version number of the OPC server (major-minor-build) | 1056 | Persisted, ReadOnly, InfoPage |
| Version | Version of this module |
Performance
| Name | Description | ID | Flags |
|---|---|---|---|
| SrvAvgItemsPerCall | The average number of items in each update call. | 1064 | ReadOnly, PerformancePage |
| SrvLastPendWCTID | The last pending write complete transaction ID. | 1092 | ReadOnly, PerformancePage |
| SrvLastUpdateInterval | When ReadMode is Subscribe or Asynch I/O, the time in seconds between the last two updates. When ReadMode is Sync I/O, the time interval between the last successful Reads. | 1061 | ReadOnly, PerformancePage |
| SrvLastUpdateTID | The last update or read transaction ID that was received. | 1072 | ReadOnly, PerformancePage |
| SrvLastWCTID | The last received write complete transaction ID. | 1094 | ReadOnly, PerformancePage |
| SrvPercentUpdateInvalid | The percentage of all updated items that was invalid (e.g. unknown item handles). | 1070 | ReadOnly, PerformancePage |
| SrvPercentUpdateSuccess | The percentage of all updated items that have been updated with success. | 1066 | ReadOnly, PerformancePage |
| SrvPercentUpdateUnneccessary | The percentage of all updated items that was unneccessary (neither value nor quality had changed). | 1068 | ReadOnly, PerformancePage |
| SrvPercentWriteCmplFail | The percentage of all write complete items that have failed. | 1088 | ReadOnly, PerformancePage |
| SrvPercentWriteCmplInvalid | The percentage of all write complete items that was invalid (e.g. unknown item handles). | 1090 | ReadOnly, PerformancePage |
| SrvPercentWriteCmplSuccess | The percentage of all write complete items that have succeded. | 1086 | ReadOnly, PerformancePage |
| SrvUpdateCalls | The number of times the OPC server has called back to this client with updated item values. | 1062 | PerformancePage |
| SrvUpdateTime | The time the OPC server sent the last data value update to this client, as known by the server. | 1052 | ReadOnly, PerformancePage |
| SrvUpdateTimeClient | When ReadMode is Subscribe or Asynch I/O, the time when this client received the last update, as known by the client. When ReadMode is Synch I/O, the time of the last successful Read. | 1060 | ReadOnly, PerformancePage |
| SrvWriteCmplCalls | The number of times the OPC server has called back to this client with updated item values. | 1082 | PerformancePage |
| SrvWriteCmplTimeClient | The time when this client received the last write complete call, as known by the client. | 1080 | ReadOnly, PerformancePage |
| SuppressVendorQuality | When true, any vendor specific item quality will be suppressed, only the standard OPC Foundation bits of the quality flag, will be set for item qualities | 1025 | Persisted, ExpertPage |