Apis Foundation 8

5673

DvLoRange

The low limit for DV range check.

5674

DvMaxRoc

The maximum rate of change for DV rate of change check.

5676

DvWdTime

The time limit in seconds for DV watch dog check.

5677

DvCompareItem

An external item used by data-validation methods DF and/or ADF, when comparing values.

5678

DvCompareValue

The value to compare the difference with, when using data-validation methods DF and/or ADF

5680

DvSPCUCL

The upper control limit in SPC.

5681

DvSPCLCL

The lower control limit in SPC.

5682

DvSPCTest

The assignable causes tests to perform (multiple selects possible, e.g. 1;3;4).

1 - 1BEYZA,
2 - 9BEYCENT,
3 - 6INCDEC,
4 - 14ALTUPDO,
5 - 2OF3INZA,
6 - 4OF5INZB,
7 - 15INZC,
8 - 8OUTZC.

string

5690

DvSubstMethod

The method that decides which data validation substitute value to use. One of the following may be selected:

Name	Meaning	Value
last good	Substitute with last good value when data validation fails	1
InitVal	Substitute with InitVal attribute when data validation fails.* If no InitVal is associated with the item, it uses the last good value	2
AltExtItem	Substitute with an alternative external item (DvAltExtItem). If no alternative external item can be obtained, it uses the last good value	3
PassThrough	No substitution occurs, external item is passed through as if no validation failed	4
Follow ROC	Substitute with a value that increases/decreases with a rate of change limitation according to the maximum rate of change (DvMaxRoc).	5
Default	First, value is substituted after a Follow ROC strategy, if DvMethod specifies ROC. Then, if DvMethod specifies Range, a range check validation is performed. If Range-chack fails, an AltExtItem substitution is performed if an DvAltExtItem is specifed. If none of the above mentioned substitution occurs, the default substitution is last good..	255

2 byte unsigned integer

5691

DvSubstQuality

The quality to use when data validation substitution takes place. This attribute lets the user control the quality for item values when Data Validation substitution takes place, the quality can be overridden to bad, uncertain or good, by specifying the desired quality using the DvSubstQuality attribute.

The APIS Vendor specific quality bits, telling what violation is broken, will still be added to the quality.
I.e. when using Range validation, the quality of the item during a violated state is decided according to the table below, but with APIS Vendor quality range added to the quality.

Name	Meaning	Value
Default	The quality follows the quality of the source item, with any with APIS Vendor quality violation state added to it.	255
Bad	The quality is always set to bad, with any with APIS Vendor quality violation state added to it.	0
Uncertain	The quality is always set to uncertain, with any with APIS Vendor quality violation state added to it.	64
Good	The quality is always set to good, with any with APIS Vendor quality violation state added to it.	192

unsigned character

5692

DvAltExtItem

An alternative external item to fetch a DV substitute value from. Used when 'DvSubstMethod'='AltExtItem'.

string

Note:

The module property ExtItemCalculationSequence is important in data validation and transfer. It decides whether data validation or data transfer will be performed first in the external item manager.

Available values:

TransferBeforeValidation
ValidationBeforeTransfer

Data-validation alarms

Data validation will generate alarms into the Alarms & Event server of APIS, and OPC clients can retrieve these alarms over OPC UA and OPC AE. Further, data-validation alarms & events can be written to an APIS event database, configuration of this is described in Advanced Event Configuration.

External Item Monitoring - Pulse Trigger

This feature makes it possible to monitor an external item and create a pulse value in an Apis item depending on the value in the external item and a set of predefined rules for monitoring.

The following item attributes must be specified:

ID	Name	Description	Type
5970	MonMethod	The method that decides how external items are monitored. Available methods: None, ValueChanged, ValueChangedAutoReset.	2 byte unsigned integer
5971	MonTrueValue	The value to be set on the destination item if the external (source) item behave in a manner that should produce a pulse value.	Variant
5972	MonFalseValue	The value to be set on the destination item if the external (source) item behave in a manner that should not produce a pulse value.	Variant

How to set up a monitoring:

Create an item (DestinationItem), add the three attributes (Add attributes) described above and set the appropriate values. Make the item you want to monitor (SourceItem) an external item to the DestinationItem (Set external item).

Note: Monitoring is always carried out after potential data transfer and data validation operations.

At the time of writing, ValueChanged and ValueChangedAutoReset are the only monitoring methods that are implemented. The pulse production for these methods is described in the figure below.

Commands And Events

To specify the processing order of specific tasks in Apis modules, you can use "Events and Commands". An "Event" is an outgoing notification from an Apis module. For example, a notification could be sent when a calculation has finished. A "Command" is an incoming notification to an Apis module, telling the module to perform a specific task. For example, this could be to calculate new values based on the present data values.

The Apis Event Broker controls the relationship between events and commands. An "Event" can be configured to trigger a series of "Commands". The commands will then be executed in the order specified when an event notification is sent from an Apis module to the event broker.

The events and commands are specific to each type of Apis module. For the modules handling external items, the event "ExternalItems", and the command "HandleExternalItems", are common. The "ExternalItems" event is a timer event handling exchange of external items. The period of the timer is specified in the "ExchangeRate" attribute of the module. The timer is only running if the module has configured external items. The "HandleExternalItems" command handles the updating of the items connected to external items.

Event broking

In order to specify the processing order of specific tasks in the Apis modules, the concept of Events and Commands has been introduced together with a so-called Event Broker. An Event is an outgoing notification from an Apis module. The notification could e.g. be sent when a calculation has finished. A Command is an in-coming notification to an Apis module, telling the module to perform a specific task. This could be e.g. to calculate new values based on the present data values.

The Apis Event Broker controls the relationship between events and commands. An Event can be configured to trigger a series of Commands. The Commands will then be executed in the order specified when an event notification is sent from an Apis module to the event broker.

The Events and Commands are specific for each type of Apis module. Common for the modules handling external items, are the event named ExternalItems, and the command named HandleExternalItems. The ExternalItems event is a timer event handling exchange of external items. The period of the timer is specified in the ExchangeRate attribute of the module. The timer is only running if the module has configured external items. The HandleExternalItems command handles the updating of the items connected to external items.

Commands And Events

Setting Event Broker Priorities

To ensure the Event Broker executes as expected, you can increase its priority on systems running heavy tasks. Do this by setting the following registry entries.


[HKEY_LOCAL_MACHINE\SOFTWARE\Prediktor\Apis\ApisHive\ApisEventBroker]

"MainThreadPriority"="2"

"ExecutionThreadPriority"="2"

The supported values of these entries, are:

Priority	Meaning
1	ABOVE_NORMAL: Priority 1 point above the priority class
-1	BELOW_NORMAL: Priority 1 point below the priority class
2	HIGHEST: Priority 2 points above the priority class
-15	IDLE : Base priority of 1 for IDLE_PRIORITY_CLASS, BELOW_NORMAL_PRIORITY_CLASS, NORMAL_PRIORITY_CLASS, ABOVE_NORMAL_PRIORITY_CLASS, or HIGH_PRIORITY_CLASS processes, and a base priority of 16 for REALTIME_PRIORITY_CLASS processes
-2	LOWEST: Priority 2 points below the priority class
0	NORMAL: Normal priority for the priority class
15	TIME_CRITICAL: Base priority of 15 for IDLE_PRIORITY_CLASS, BELOW_NORMAL_PRIORITY_CLASS, NORMAL_PRIORITY_CLASS, ABOVE_NORMAL_PRIORITY_CLASS, or HIGH_PRIORITY_CLASS processes, and a base priority of 31 for REALTIME_PRIORITY_CLASS processes

The MainThreadPriority is the priority of the main-loop or event delegator thread of the Event Broker.

The ExecutionThreadPriority is the priority of the worker or execution threads of the Event Broker.

Apis Hive Modules

An Apis Hive Module is a component living inside of Apis Hive.

Several different types of modules exist, and among the tasks they perform are:

Communication with external systems
Calculation
Analysing data
Logging to a database

New module types are made all the time, adding new functionality to the Apis ecosystem.

Shared Module Properties

Covered Topics:

General Module Properties

The properties of a module depend on the module type. There are, however, some properties common to all modules, which may or may not be exposed by a specific module type.

Common module properties

The following properties may apply to any modules in Apis Hive.

Standard properties

Name	Description	Type	ID
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	4 byte integer	100

Advanced properties

Name	Description	Type	ID
ExtItem full refresh	When true, the external items manager will force a full refresh initially on start/reset when reading items. I.e. items not yet initialized in their source, will also trigger an external item update. Default is true.	bool	150
TimeReferenceItem	An item who's value will be used as a time reference for this module instead of the system time.	string	200
ExtItemCalculationSequence	Decides whether data validation or data transfer will be performed first in the external item manager.	4 byte unsigned integer	300
ExtItem pass-through quality	Specifies the quality of external item values that will pass through external item transfers. Default is 'Good and Uncertain qualities'.	enum, 2 byte signed integer	400

Information properties

Name	Description	Type	ID
ExternalItem report	A status-report for the External Item Manager of this module.	string	110

Performance properties

Nearly all modules have some common performance properties. These properties relate to the performance of the reading and writing of items from and to the modules.

In rare cases, a module may not have it own items. These modules won't have any common performance properties at all. For example: the ApisLoggerBee module.

Read performance

Item value read considerations:

Name	Description
Justified	The number of item reads that were justified on this module. I.e. the item had changed since the last time the same item was read by the same reader.
Needless	The number of item reads that were needless on this module. I.e. the item had not changed since the last time the same item was read by the same reader.
Invalid	The number of item reads that requested items not belonging to this module.
Failed	The number of item reads in this module that failed for some reason.

Read-call considerations:

Name	Description
Mean time	The average time in milliseconds it takes to read the specified number of items.
Peak time	The maximum time in milliseconds it has taken to read the specified number of items.

Write performance

Item value write considerations:

Name	Description
Justified	The number of item writes that were justified on this module. I.e. the value or timestamp of the item had changed since the last time the item was written.
Needless	The number of item writes that were needless on this module. I.e. the item value or timestamp written was the same as the value or timestamp the item already had.
Invalid	The number of item writes that requested items not belonging to this module.
Failed	The number of item writes to this module that failed for some reason.

Write-call considerations:

Name	Description
Mean time	The average time in milliseconds it takes to write the specified number of items
Peak time	The maximum time in milliseconds it has taken to write the specified number of items.

Additionally, modules may have several custom performance properties listed. To get help on these properties you must look in the help for that specific module.

Advanced module configuration

Changing default number of items per module

By default, the namespace in a single ApisHive instance, can have a maximum of 4096 modules, with a maximum of 1048575 items in each module.

If you for some reason want to change this, ie. to allow for more than 4096 modules in an instance or more than 1048575 items in a module, you must add/change an entry in the Windows registry.

Eg. to have a maximum of 65536 modules, with a maximum of 65536 items in each module, add/change the following registry entry:

[HKEY_LOCAL_MACHINE\SOFTWARE\Prediktor\Apis\ApisHive\Modules\]
"MaxItemsInModule"=dword:0000ffff

The upper and lower limits for the MaxItemsInModule value, are:

Minimum (256 items/16777215 modules): "MaxItemsInModule"=dword:000000ff
Maximum (16777215 items/256 modules): "MaxItemsInModule"=dword:00ffffff

Please note that when changing this value for a named instance, modify the path of the registry key to reflect the name of the instance. Eg.:
[HKEY_LOCAL_MACHINE\SOFTWARE\Prediktor\Apis\_MyInstanceName_\Modules\]

Please note that the registry entry is not present by default, and must be added if not used before. Also, if changing this value, the Hive instance must be restarted to take effect.

Disable automatic resolution of external items when using ExternalItem filter attributes

When adding, deleteing or renaming items or modules in an ApisHive instance using ExternalItem filters, external items are by default automatically resolved at runtime. On huge configurations this might be time consuming, as all item connections potentially needs to be resolved again.
So, if you perform the add/delete/rename operation(s) at a time you can restart your Hive configutration, you can add/change the following registry entry:

[HKEY_LOCAL_MACHINE\SOFTWARE\Prediktor\Apis\ApisHive\Modules] "AutoResolveExternalItemFilters"=dword:0

Then restart your Hive instance, perform your desired add/delete/rename operation(s), stop your Hive instance, and revert the following registry entry:

[HKEY_LOCAL_MACHINE\SOFTWARE\Prediktor\Apis\ApisHive\Modules] "AutoResolveExternalItemFilters"=dword:1

and finally restart your Hive instance. All external item connections caused by using ExternalItem filters, have now been updated according to the new names.

Temporarily Disabling Modules

You can disable a module from being loaded into the Apis Hive configuration.

Disabling a module

Locate the registry for your Apis configuration:

HKEY_LOCAL_MACHINE\SOFTWARE\Prediktor\Apis\ApisHive\Modules

Here, each of your configured modules has its own registry key. Open the key of the module to disable. Underneath this key, e.g. for a module named OPC;

HKEY_LOCAL_MACHINE\SOFTWARE\Prediktor\Apis\ApisHive\Modules\OPC

create a DWORD value named Disabled. To disable this module, set value to 1, to enable module set value to 0.

Note! You have to restart Apis for this to take effect!

Apis AEClient

This module can subscribe to an OPC Alarm & Event from an external OPC AE server according the OPC AE specification. The alarms received can be displayed as items in the namespace and/or registered in the local Apis Alarms & Events server.

Provider: Prediktor

The AEClient module has the following item types

OPC AEItem

HiddenItem

StatusItem

Properties

The AEClient module has the following properties:

Name	Description	ID	Flags
Active	FALSE, if the Event Subscription is to be created inactive.	1050	Persisted
BufferMax Size	The requested maximum number of events that will be sent in a single callback. A value of 0 means that there is no limit to the number of events that will be sent in a single callback.	1031	Persisted, ExpertPage
BufferTime	The buffer time (in milliseconds) tells the server how often to send event notifications. A value of 0 means that the server should send event notifications as soon as it gets them.	1030	Persisted, ExpertPage
CmnItemIDPrefix	Common source ItemId prefix. This string will prefix each item's 'ItemID' when communicating with the OPC AE server. Items in this module will have names without this prefix in the Apis namespace.	1011	Persisted, ExpertPage
Computer	The computer hosting the OPC server. Leaving it blank, the localhost will be used.	1001	Persisted, Computer
FilterArea	Events and conditions available in the server are organized within one or more process areas. An Area is a grouping of the plant.	1044	Persisted, ExpertPage
FilterCategory	The categories supported by a given event type	1041	Persisted, ExpertPage
FilterEventType	The filter criteria supported by the connected event server.	1040	Persisted, Enumerated
FilterSeverityHigh	The severity high, indicates the highest severity of interest. This is also commonly called 'priority', especially in relation to process alarms.	1043	Persisted, ExpertPage
FilterSeverityLow	The severity is low, indicating the lowest severity of interest. This is also commonly called 'priority', especially in relation to process alarms.	1042	Persisted, ExpertPage
FilterSource	The source of the event in the OPC AE Server	1045	Persisted, ExpertPage
Operation Mode	The type of mode of the Bee.	1010	Persisted, Enumerated
PDS Area	The PDS area which an event subscription should be linked to.	1032	Persisted, ExpertPage
PDS ProcessUnit	The PDS Process Unit associated with this subscription.	1033	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.	1007	Persisted, ExpertPage
Server	The ProgID of the OPC server.	1002	Persisted, Enumerated, ProgID
SrvApisEventProcessingInterval	The time in seconds Apis uses for processing an event.	1092	PerformancePage
SrvCLSID	The CLSID of the OPC server.	1006	InfoPage
SrvCurrentTime	The current time (UTC) as known by the OPC server.	1071	InfoPage
SrvEventSubscribtion	Status of the event subscription.	1093	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)	1009	Persisted, ExpertPage
SrvStartTime	The time (UTC) the OPC server was started.	1070	InfoPage
SrvState	The current status of the OPC server.	1073	Enumerated, InfoPage
SrvSupportBrowsing	The status of server support browsing	1077	InfoPage
SrvUpdateCalls	The number of times the OPC server has called back to this client with updated item values.	1094	PerformancePage
SrvUpdateCallsFailure	The number of times the module has failed to process an event.	1096	PerformancePage
SrvUpdateCallsNotHandled	Number of update calls not handled due to manually creation mode.	1097	PerformancePage
SrvUpdateCallsOK	The number of times the module has successfully processed an event.	1095	PerformancePage
SrvUpdateTime	The time the OPC server sent the last data value update to this client, as known by the server.	1072	PerformancePage
SrvUpdateTimeClient	The time when this client received the last update, as known by the client.	1090	PerformancePage
SrvUpdateTimeInterval	The time in seconds between the last two updates.	1091	PerformancePage
SrvVendorInfo	Vendor specific information about the OPC server.	1075	InfoPage
SrvVersion	The version number of the OPC server (major-minor-build).	1074	InfoPage
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
TraceEventMessages	If this is 'true', the module writes to the log files for log view in Apis Management Studio the information received on IOPCEventSink::OnEvent	1061	Persisted, 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.	1060	Persisted, Enumerated, ExpertPage

See also Module Properties

Commands And Events

The AEClient module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS AEClient Item Types

Covered Topics:

Properties

External source item from an OPC AE Server

The OPCAEItem item type has the following properties:

Name	Description	ID	Flags
AlarmArea	The default alarm area for the item.	10100	Persisted
ProcessUnit	The PDS process unit associated with this item. A process unit can be a piece of equipment or location, among other things.	5716	Persisted, ReadOnly
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly
ValueAssignment	Assign the item to one of the OPC Event data.	10200	Persisted, Enumerated

Properties

HiddenItem

The HiddenItem item type has the following properties:

Name	Description	ID	Flags
AlarmArea	The default alarm area for the item.	10100	Persisted
ProcessUnit	The PDS process unit associated with this item. A process unit can be a piece of equipment or location, among other things.	5716	Persisted, ReadOnly
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly
ValueAssignment	Assign the item to one of the OPC Event data.	10200	Persisted, Enumerated

Properties

The StatusItem item type has the following properties:

Name	Description	ID	Flags
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Apis AISXmlBee

TCP/IP XML communication to AIS Xml Equipment(s)

Provider: Prediktor

The AISXmlBee module has the following item types

Properties

The AISXmlBee module has the following properties:

Name	Description	ID	Flags
ArticleConfig	Used to set which element is contains article information	1015	Persisted
Connected	Status if Apis is connected to server.	1005	InfoPage
DataConfig	Used to filter which elements should be registered as data value. Default (empty) register all elements as data. Each name is separeated by ';'	1017	Persisted
EnableReconnect	If true the module will reconnect when a disconnect is received.	1009	Persisted
EquipmentHeartbeatTime	Last time equipment heartbeat was sent to the server.	1050	InfoPage
EquipmentReconectTime	Last time equipment reconnect was run.	1060	InfoPage
EquipmentStateLocation	The equipment location of where to register equipment states.	1018	Persisted
EquipmentTimeAsUtc	Is equipment time represented in UTC.	1011	Persisted
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' event. By default used for updating external items values.	100	Persisted
HeartbeatRestart	Restart connection if missing heartbeat is greater that the value specified. If the heartbeat is missed in a continous sequence compared to the value specified, the connection will be restarted. Only valus greater than '1' is allowed (DefaultValue: 5).	1024	Persisted, ExpertPage
HeartbeatTimeout	The timeout for when to send a heartbeat. The unit is in milliseconds [ms] and must be > 1000.	1003	Persisted
IP-Address	The IP address of the server. You can not specify host name.	1001	Persisted, TcpIpAddr
LogFile	Reference to the log file name to log input received on the socket.	1008	Persisted, File
MaterialAttributeLocation	The equipment location of where to register material attribute.	1019	Persisted
MaxLogFileSize	The max size of the log file before it get recycled. The value must be > 1000 [bytes]	1080	Persisted, ExpertPage
MaxXmlHistoryFiles	The maximum numbers of history files in the 'XmlHistoryDirectory'. If the numbers of files gets above this size the oldest file is deleted. The value selected must be between 10 and 500. Default value is 100	1021	Persisted, ExpertPage
MessageBrokerKeepAlive	Last time MessageBroker.GetMessages was called.	1070	InfoPage
MessageType	Used to define if the material should be registerd with message 'RegisterMaterialAttributes' or 'RegisterInterimMaterialAttributes'.	1012	Persisted, Enumerated
NumberDecimalSeparator	Use this property to set the type of NumberDecimalSeparator	1120	Persisted, Enumerated, ExpertPage
Port-Number	The listening port of the server.	1002	Persisted
QualityConfig	Used to set which element is contains quality information	1016	Persisted
ReconnectInSeparateThread	Used to run connection in a separate thread when the timer kick inn.	1350	Persisted
ReconnectTime	The time for reconnect equipment after a connection loss. The unit is in milliseconds [ms] and must be > 1000	1004	Persisted
ReuseLogFile	Set this value to 'true' if the log file should be keeped open between each log write operation. Default value is 'true'	1090	Persisted, ExpertPage
TcpBufferSize	The size in bytes of the TCP socket buffer. The value must be > 8 [bytes]	1110	Persisted, ExpertPage
TimeFormat	The format of the time received from the equipment.	1010	Persisted
UseApisTime	Use Apis time as time reference.	1006	Persisted
UseLogSynchEvent	By setting this propery to 'true' no new XML document received will be handled before the logger has reported logger event 'LogDone' (default=false).	1115	Persisted, ExpertPage
WaferIdMask	This property is used to mask out any '0' (zero) in the beginging of the waferid used in constructing the Apis message. Ex '0000234232' --> '234232'.	1022	Persisted, ExpertPage
XmlHistoryDirectory	The directory of where to put the files after read.	1020	Persisted, Folder, ExpertPage

See also Module Properties

Commands And Events

The AISXmlBee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
OnNamespaceUpdated	Blank	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
OnLoggerReady	Blank	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS AISXmlBee Item Types

Covered Topics:

Properties

This item is used to trigg command on equipment. The type of command is specified by the attribute 'Command Type'

The EquipmentCommand item type has the following properties:

Name	Description	ID	Flags
CommandType	This attribute allows you to select the type of command to use.	10001	Persisted, Enumerated
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. or OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

The raw XML document received from the server

The ReceivedXml item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Reference to an element or attribute in the received XML document. The syntax for accessing element or attribute field in an XML node is by XPath

The XmlItem item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
ItemType	This attribute you can select the type of item to use	10005	Persisted, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
XPath	The XPath syntax is used to access the element or attribute in the recevied XML document.	10004	Persisted

Properties

Used to count selected type defined in the module property

The Counter item type has the following properties:

Name	Description	ID	Flags
CounterMaxValue	The maximum value of the counter. When the maximum value is reached, the counter is reset to '1'.	10007	Persisted
CounterType	The type of counter to use: NewDoc - reports when a new document type received; ValueChange - counts the changes to a specific element or attribute; SpecificValueSet - counts specific values received on a given element or attribute.	10006	Persisted, Enumerated
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
XPath	The XPath syntax is used to access the element or attribute in the recevied XML document.	10004	Persisted

Properties

This item is used to expose internal status information

The StatusItem item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Apis Alarm Area

This module monitors items in Apis Hive, and generates alarms and events based on configurable criteria.

Provider: Prediktor

Properties

The AlarmArea module has the following properties:

Name	Description	ID	Flags
AckRequired	By disabling this property, alarms generated by this module will be sent with acknowledge not required.	3400	Persisted, ExpertPage
AlmSeverityOfInactive	The severity of events when going from active to inactive.	1670	Persisted, Enumerated, ExpertPage
AlmSeverityStep	The step in severity when moving from one subcondition to another e.g. from HI to HIHI.	1650	Persisted, ExpertPage
AreaName	The name of the process area this module represents. Several areas can be listed using ';' (semicolon).	1010	Persisted
AreaPath	The path to the area this module represents. A hierarchical is specified using '.' (dot).	1020	Persisted, ExpertPage
DefaultAlmSeverity	The default value of the AlmSeverity attribute for new alarm items.	1600	Persisted, ExpertPage
DefaultWatchdogPeriods	The default value of the AlmWatchdogPeriods attribute for new watchdog category items.	1700	Persisted, ExpertPage
EnableAlarmEvaluation	This is used to disable alarm evaluation	3300	Persisted, ExpertPage
EnableEvaluationItem	If set, this item's value will enable (true) or disable (false) alarm evaluation.	3310	Persisted, ApisItem, ExpertPage
EnableInitialNormalReport	By default, the first evaluation of an alarm condition is not reported if the alarm is in normal state. This property, when set, makes the AlarmAreaBee always report the result of the initial alarm evaluation.	3330	Persisted, ExpertPage
FreshestValue	When TRUE, all items will be read directly from their physical source to receive the freshest possible values.	2010	Persisted, ExpertPage
GEMAreaID	The SECS GEM alarm ID used to identify the alarm through SECS GEM. The value must be >1000. Value 0 is disable (default)	3600	Persisted, ExpertPage
InhibitAll	Supress all alarm generation from this module.	3200	Persisted
InhibitQuality	Supress alarms when quality is equal or worse than this.	3100	Persisted, Enumerated, ExpertPage
InvertInhibitSignals	Invert the value read from the inhibit signals, so that a 'false' inhibit value will prevent the alarm.	1710	Persisted, ExpertPage
PriorityLevel	Specifies the priority level for the working thread of this ApisAlarmAreaBee instance.	3000	Persisted, Enumerated, ExpertPage
ResetAlarms	By setting this property to true all alarms will be reset if either EnablealarmEvaluation or EnableEvaluationItem is FALSE	3320	Persisted, ExpertPage
ScanPeriod	The scan period in milliseconds for testing the event conditions.	1300	Persisted
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
UseSourceTimestamps	If set to 'true', the timestamps of the monitored items will be used as event timestamps when they occur. If set to 'false', the time the event was detected by this AlarmArea module is used.	1400	Persisted, ExpertPage
WatchdogQualityEvaluation	Set this property to true to include evaluation of the different quality OPC_QUALITY_GOOD	3550	Persisted, Enumerated, ExpertPage

Informational properties:

Name	Description	ID	Flags
AlmAttributeID	The global alarm attribute ID assigned from Apis Hive.	301200	InfoPage
ApisConditionEventSinkCookie	The value of the cookie assigned to this module from the Apis Event Server.	301800	InfoPage
AreaName	The name of the process area this module represents. Several areas can be listed using ';' (semicolon).	1010	Persisted
ConfigObserverCookie	The cookie identifying this module amongst the configuration aware clients of Apis Hive.	301400	InfoPage
Server compatibility	Status about which version of interface supported	301600	InfoPage
TimeSrvEventID	The time client event ID assigned from the Apis time server.	301100	InfoPage

Performance properties:

Name	Description	ID	Flags
AlarmEvalTime	The time in milliseconds used to evaluate alarms.	101007	PerformancePage
HiveLastUpdCount	The number of items reported as updated at the previous request.	101006	PerformancePage
NumAlmItems	Number of items this ApisAlarmArea instance stores to its database.	101000	PerformancePage
UpdSinceQueryTime	The time used when requesting updated items from the Hive.	101005	PerformancePage

See also Module Properties

Commands And Events

The AlarmArea module has the following Commands and Events:

Commands

Name	Description	Command Type
ResetEvents	Reset any active or unacked/ackrequired event in the area	Asynchronous
ResetEventsNotify	Reset any active or unacked/ackrequired event in the area and notify AE clients	Asynchronous
Scan	A command initiating a Scan cycle of the items monitored by this AlarmAreaBee instance.	Synchronous
Scan_DataPush	This command ensure that all items and samples in the data push package, are used for alarm evaluation where applicable. See also: APIS data transfer mechanism; Data Push	Synchronous

See also Commands And Events

Apis AsysBee

TCP/IP XML communication to ASYS equipment.

Provider: Prediktor

The AsysBee module has the following item types

Properties

The AsysBee module has the following properties:

Name	Description	ID	Flags
AlterIdentifierLocation	The value of the XML attribute 'EqLocId' of where to alter the tracker identifier in the receivedXML document MatCmpl.An empty string disable the functionality.	1016	Persisted, ExpertPage
Connected	Status if Apis is connected to server.	1005	InfoPage
EnableReconnect	If true the module will try to reconnect when a disconnect is received on the socket.	1009	Persisted
EqDataReqAll	Used to get actual states and parameter sets of equipment.	1007	Persisted, ExpertPage
EquipmentHeartbeatTime	Last time equipment heartbeat was sent to the server.	1050	InfoPage
EquipmentReconectTime	Last time equipment reconnect was run.	1060	InfoPage
EquipmentTimeInUtc	Is equipment time represented in UTC.	1013	Persisted, ExpertPage
EscapeCharacter (STX/ETX)	If the communication protocool uses STX and ETX to define start and stop of received XML document set this value to true.	1017	Persisted, ExpertPage
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' event. By default used for updating external items values.	100	Persisted
HeartbeatRestart	Restart connection if missing heartbeat is greater that the value specified. If the heartbeat is missed in a continous sequence compared to the value specified, the connection will be restarted. Only valus greater than '1' is allowed (DefaultValue: 5).	1024	Persisted, ExpertPage
HeartbeatTimeout	The timeout for when to send a heartbeat. The unit is in milliseconds [ms] and must be > 1000. To disable the heartbeat functionality set the value equal to '0' (zero). The default value is 10000 (10 sec)	1003	Persisted
IP-Address	The IP address of the server. You can not specify host name.	1001	Persisted, TcpIpAddr
LogFile	A file path name to a log file used for debug purpose only. NB: there will be no watchout of the file size. This is a manual job.	1008	Persisted, File, ExpertPage
MaxLogFileSize	The max size of the log file before it get recycled. The value must be > 1000 [bytes]	1080	Persisted, ExpertPage
MaxXmlHistoryFiles	The maximum numbers of history files in the 'XmlHistoryDirectory'. If the numbers of files gets above this size the oldest file is deleted.The value selected must be between 10 and 500. Default value is 100	1015	Persisted, ExpertPage
MessageBrokerKeepAlive	Last time MessageBroker.GetMessages was called.	1070	InfoPage
Port-Number	The listening port of the server.	1002	Persisted
ReceivedHeartbeatId	Heartbeat ID received from ASYS server.	1012	InfoPage
ReconnectInSeparateThread	Used to run connection in a separate thread when the timer kick inn.	1350	Persisted
ReconnectTime	The time for reconnect equipment after a connection loss. The unit is in milliseconds [ms] and must be > 1000	1004	Persisted
ReuseLogFile	Set this value to 'true' if the log file should be keeped open between each log write operation. Default value is 'true'	1090	Persisted, ExpertPage
SentHeartbeatId	Heartbeat ID sent to ASYS server.	1011	InfoPage
TcpBufferSize	The size in bytes of the TCP socket buffer. The value must be > 8 [bytes]	1110	Persisted, ExpertPage
TimeFormat	The format of the time received from the equipment.	1010	Persisted, ExpertPage
UseLocalTime	Use local time reference to time stamp XML items. If false the dockument time will be used.	1006	Persisted, ExpertPage
UseLogSynchEvent	By setting this propery to 'true' no new XML document received will be handled before the logger has reported logger event 'LogDone' (default=false).	1115	Persisted, ExpertPage
XmlHistoryDirectory	The directory of where to store received XML files from the ASYS server. Leave the property empty to disable it.	1014	Persisted, Folder, ExpertPage

See also Module Properties

Commands And Events

The AsysBee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
OnNamespaceUpdated	Blank	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
OnLoggerReady	Blank	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS AsysBee Item Types

Covered Topics:

Properties

This item is used to trigg command on equipment. The type of command is specified by the attribute 'Command Type'

The EquipmentCommand item type has the following properties:

Name	Description	ID	Flags
CommandType	This attribute allows you to select the type of command to use.	10001	Persisted, Enumerated
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

The raw received XML document from the server

The ReceivedXml item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Reference to an element or attribute in the received XML document. The syntax for accessing element or attribute field in an XML node is by XPath

The XmlItem item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
ItemType	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	10005	Persisted, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
XPath	The XPath syntax is used to access the element or attribute in the recevied XML document.	10004	Persisted

Properties

Used to count selected type defined in the module property

The Counter item type has the following properties:

Name	Description	ID	Flags
CounterMaxValue	The maximum value of the counter. When the maximum value is reached, the counter is reset to '1'.	10007	Persisted
CounterType	The type of counter to use: NewDoc - reports when a new document type received; ValueChange - counts the changes to a specific element or attribute; SpecificValueSet - counts specific values received on a given element or attribute.	10006	Persisted, Enumerated
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
XPath	The XPath syntax is used to access the element or attribute in the recevied XML document.	10004	Persisted

Properties

This item is used to expose internal status information

The StatusItem item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Apis BatchOptimizerBee

Online batch optimization

Provider: Prediktor

The BatchOptimizerBee module has the following item types

Properties

The BatchOptimizerBee module has the following properties:

Name	Description	ID	Flags
Abort time limit	The maximum time spent in an optimization attempt (milliseconds). If the optimization time exceeds this limit, the attempt will be aborted and the results will be marked as not optimal. If this property is 0, no time limit is set	1150	Persisted
Amount limit size	The lookahead maximum amount of material limit [kg]. Feasible solutions beyond this limit will not be searched for.	1140	Persisted
Amount Stepsize	The amount of material to use as step size during the iteration to find the feasibility limit [kg]	1020	Persisted
Custom connection string	Full control over the connection string, you can specify a custom connectionstring here. NOTE! When this property is in use, the other database properties are ignored!	1070	Persisted
Database login	Same as User ID in connection string. If blank, integrated security will be used.	1050	Persisted
Database login password	Used when Database login is other than blank.	1060	Persisted
Database name	The name of the database on given server, used in connection string.	1040	Persisted
Database server	The server machine where the database exists, used in connection string.	1030	Persisted
EventReportLevel	The level of the reported events. (E.g. if Warning is chosen, Warning and Error events will be reported, but the Information events will not.)	1160	Persisted, Enumerated
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
Match material by	Match material by LotName or ArticleID	1130	Persisted, Enumerated
Max. iterations	The maximum number of iterations. If no maximum is found before reaching this count, the search is abandoned	1110	Persisted
Mode	In Normal mode, the batch is tested for feasibility. In Lookahead mode, the limit for feasibility, adding the current article, is found also	1010	Persisted, Enumerated
Persist result	The result of the optimization, if optimal, is persisted to the database if this property is true	1120	Persisted

See also Module Properties

Commands And Events

The BatchOptimizerBee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS BatchOptimizerBee Item Types

Covered Topics:

Properties

The ID of the batch to optimize

The BatchID item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

The ID of the article to optimize

The ArticleID item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Toggle high to start a test

The Trigger item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

The maximum amount of this material that can be added and still get a feasible result

The MaxFeasibleAmount item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

The optimal amount of this material

The OptimalAmount item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

True if optimization problem is feasible, false otherwise.

The Feasible item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

The status of the optimization problem.

The Status item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

The ID of the article

The ArticleID item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

BytePopulator

This module imports and exports content as byte array via file or REST api

Provider: Prediktor

The BytePopulator module has the following item types

RESTItem

FileItem

Properties

The BytePopulator module has the following properties:

Name	Description	ID	Flags
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
ExternalItem report	A status-report for the External Item manager of this module	110	InfoPage
ExtItem full refresh	When true, the external items manager will force a full refresh initially on start/reset when reading items. I.e. items not yet initialized in their source, will also trigger an external item update. Default is true.	150	Persisted, ExpertPage
ExtItem pass-through quality	Specifies the quality of external item values that will pass through external item transfers. If external item qualities has worse quality the this mask, the external item transfer is blocked. Default is 'Any quality'.	400	Persisted, Enumerated, ExpertPage
LogLevel	Specifies the loglevel for diagnostic messages from this module.	500	Persisted, Enumerated

See also Module Properties

Commands And Events

The BytePopulator module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified by user. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
ReadSources	Trigger items with attribute 'OnlyReadWhenTriggered' enabled to read sources	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS BytePopulator Item Types

Covered Topics:

Item type: FileItem

Item which makes it possible to interpret files as byte array or write byte array to file

The FileItem item type has the following properties:

Name	Description	ID	Flags
Enabled	This attribute indicated whether the items operations is enabled or not	10009	Persisted
ExtItemOverrideMethod	This attribute decides what method to use when assigning a value from an external item.	5999	Persisted, Enumerated, BitMask
File Path	This attribute contains the path to the file that should be read or written	10003	Persisted
FileReader status	This attribute indicated whether the file read operation went well or not	10007	Persisted, ReadOnly
FileWrite status	This attributes indicated whether the file write went well or not	10006	Persisted, ReadOnly
NewTimestampEveryReadCycle	This attribute indicated whether the item should get a new timestamp even if the content is the same	10008	Persisted
OnlyReadWhenTriggered	This attribute indicates whether the item should only read source when triggered, and not when it is attempted to be read itself	10010	Persisted
OperatingMode	This attribute selects whether it content is read or should be written	10001	Persisted, Enumerated
Quality	Item quality	3	NormalPage
Rights	Item access rights	5	ReadOnly
Time	Item timestamp	4	NormalPage
Type	Item canonical datatype	1	ReadOnly
Value	Item value	2	NormalPage

Item type: RESTItem

Item which makes it possible to GET content from REST server as byte array or POST byte array to REST server

The RESTItem item type has the following properties:

Name	Description	ID	Flags
Enabled	This attribute indicated whether the items operations is enabled or not	10009	Persisted
ExtItemOverrideMethod	This attribute decides what method to use when assigning a value from an external item.	5999	Persisted, Enumerated, BitMask
GET status	This attribute indicates whether the GET went well or not	10005	Persisted, ReadOnly
NewTimestampEveryReadCycle	This attribute indicated whether the item should get a new timestamp even if the content is the same	10008	Persisted
OnlyReadWhenTriggered	This attribute indicates whether the item should only read source when triggered, and not when it is attempted to be read itself	10010	Persisted
OperatingMode	This attribute selects whether it content is read or should be written	10001	Persisted, Enumerated
POST status	This attribute indicated whether the POST went well or not	10004	Persisted, ReadOnly
Quality	Item quality	3	NormalPage
Rights	Item access rights	5	ReadOnly
Time	Item timestamp	4	NormalPage
Type	Item canonical datatype	1	ReadOnly
URL	URL specifies which URL the item utilises for communication	10002	Persisted, URL
Value	Item value	2	NormalPage

Apis Calculate

This module calculates an expression based on external inputs. An expression is given by mathematical symbols and external items as parameter to an expression. An external item is named in an expression by using the keyword ex1 for the first item in the connection list, ex2 as the second item in the connection list etc.

Provider: Prediktor

The Calculate module has the following item types:

Variable item User defined item, which can be written and read.

Aggregated item An item which keeps the result value based on the item "Expression" property and external item(s).

More information

Type of expressions

There are three types of expression which can be used:

Logical. Example: ex1&ex2
Condition based expressions. Example: (ex1&& ex2) || ((ex1<ex3) && (ex3>ex2))
Arithmetic expressions. Example: ex1+ex2 * sin(ex1-ex2)

Expressions for scalar inputs

Arithmetic equation operators

Operator	Description	Example	Item Type
+	The sum of two values	ex1 + ex2	8 byte float (default) or custom scalar number
-	The subtraction of one value from another	ex1 - ex2	8 byte float (default) or custom scalar number
*	The multiplication of two values	ex1 * ex2	8 byte float (default) or custom scalar number
/	The division of one value by another	ex1 / ex2	8 byte float (default) or custom scalar number

Comparison operators

Operator	Description	Example	Item Type
==	Equality	ex1 == ex2	Boolean (default) or custom scalar number
<	Less than	ex1 < ex2	Boolean (default) or custom scalar number
>	Greater than	ex1 > ex2	Boolean (default) or custom scalar number
<=	Less than or equal	ex1 <= ex2	Boolean (default) or custom scalar number
>=	Greater than or equal	ex1 >= ex2	Boolean (default) or custom scalar number
<>	Not equal	ex1 <> ex2	Boolean (default) or custom scalar number
!=	Not equal	ex1 != ex2	Boolean (default) or custom scalar number

Logical Operators

Operator	Description	Example	Item Type
&&	AND	ex1 && ex2	Boolean (default) or custom scalar number
\|\|	OR	ex1 \|\| ex2	Boolean (default) or custom scalar number
!	NOT	!ex1	Boolean (default) or custom scalar number

Bitvise operations

Operator	Description	Example	Item Type
&	Bitwise AND	ex1 & ex2	UInt64 (default) or custom scalar number
\|	Bitwise OR	ex1 \| ex2	UInt64 (default) or custom scalar number
^	Bitwise XOR	ex1 ^ ex2	UInt64 (default) or custom scalar number
~	Bitwise NOT	~ex1	UInt64 (default) or custom scalar number

Functions

Function	Description	Example	Item Type
abs	The absolute value	abs(ex1)	8 byte float (default) or custom scalar number
sin	The sine of a value, in radians	sin(ex1)	8 byte float (default) or custom scalar number
cos	The cosine of a value, in radians	cos(ex1)	8 byte float (default) or custom scalar number
tan	The tangent of a value, in radians	tan(ex1)	8 byte float (default) or custom scalar number
sqrt	The square root of a value	sqrt(ex1)	8 byte float (default) or custom scalar number
pow	The first value raised to the power of the second value	pow(ex1 , ex2)	8 byte float (default) or custom scalar number
max	The largest of two values	max(ex1 , ex2)	16 byte fixed point (default) or custom scalar number
min	The smallest of two values	min(ex1, ex2)	16 byte fixed point (default) or custom scalar number
neg	Invert sign	neg(ex1)	8 byte float (default) or custom scalar number
floor	Rounds the value to nearest integer towards minus infinity	floor(ex1)	16 byte fixed point (default) or custom scalar number
arcsin	Returns the angle, θ, measured in radians, such that -π/2 ≤θ≤π/2 .The argument is a number must be greater than or equal to -1, but less than or equal to 1 Remarks:A positive return value represents a counterclockwise angle from the x-axis; a negative return value represents a clockwise angle.Multiply the return value by 180/Math.PI to convert from radians to degrees	arcsin(ex1)	8 byte float (default) or custom scalar number
arccos	Returns the angle, θ, measured in radians, such that 0 ≤θ≤π.The argument is a number must be greater than or equal to -1, but less than or equal to 1 Remarks:Multiply the return value by 180/Math.PI to convert from radians to degrees.	arccos(ex1)	8 byte float (default) or custom scalar number
arctan	Returns the angle, θ, measured in radians, such that -π/2 ≤θ≤π/2.-or-NaN if d equals NaN, -π/2 rounded to double precision (-1.5707963267949) if d equals NegativeInfinity, or π/2 rounded to double precision (1.5707963267949) if d equals PositiveInfinity. Remarks:A positive return value represents a counterclockwise angle from the x-axis; a negative return value represents a clockwise angle.Multiply the return value by 180/Math.PI to convert from radians to degrees	arctan(ex1)	8 byte float (default) or custom scalar number
sinh	The hyperbolic sine of value. If value is equal to NegativeInfinity. The parameter is an angle, measured in radians. Remarks:The angle, value, must be in radians. Multiply by Math.PI/180 to convert degrees to radians.	sinh(ex1)	8 byte float (default) or custom scalar number
cosh	The hyperbolic cosine of value. If value is equal to NegativeInfinity or PositiveInfinity, PositiveInfinity is returned. If value is equal to NaN, NaN is returned. The parameter is an angle, measured in radians.Remarks:The angle, value, must be in radians. Multiply by Math.PI/180 to convert degrees to radians.	cosh(ex1)	8 byte float (default) or custom scalar number
tanh	The hyperbolic tangent of value. If value is equal to NegativeInfinity, this method returns -1. If value is equal to PositiveInfinity, this method returns 1. If value is equal to NaN, this method returns NaN. The parameter is an angle, measured in radians. Remarks:The angle, value, must be in radians. Multiply by Math.PI/180 to convert degrees to radians.	tanh(ex1)	8 byte float (default) or custom scalar number
asinh	Represents the inverse of the hyperbolic sine function	asinh(ex1)	8 byte float (default) or custom scalar number
acosh	Represents the inverse of the hyperbolic cosine function.	acosh(ex1)	8 byte float (default) or custom scalar number
atanh	Represents the inverse of the hyperbolic tangent function.	atanh(ex1)	8 byte float (default) or custom scalar number

Expressions for vector and scalar inputs

Where the result has a boolean outcome, the value of -1 is a logical true, and 0 is a logical false.

Arithmetic equation operators

Vectors must have the same lengths.

Operator	Description	Example	Item Type
+	The sum of two vectors, element by element	ex1 + ex2	Array of 8 byte float
-	The subtraction of one vector from another, element by element	ex1 - ex2	Array of 8 byte float
*	The multiplication of two vectors, element by element	ex1 * ex2	Array of 8 byte float
/	The division of two vectors, element by element	ex1 / ex2	Array of 8 byte float

Comparison operators

When ex1 is a scalar and ex2 is a vector, the elements of the vector is compared with the scalar. The scalar must be the first element in the expression.

When ex1 and ex2 are both vectors, the comparison is done element by element.

Comparison operators can also be used in conjunction with the function Any.

Vectors must have the same lengths.

Operator	Description	Example	Item Type
==	Equality.	ex1 == ex2	Array of 8 byte float
<	Less than	ex1 < ex2	Array of 8 byte float
>	Greater than	ex1 > ex2	Array of 8 byte float
<=	Less than or equal	ex1 <= ex2	Array of 8 byte float
>=	Greater than or equal	ex1 >= ex2	Array of 8 byte float
<>	Not equal	ex1 <> ex2	Array of 8 byte float
!=	Not equal	ex1 != ex2	Array of 8 byte float

Functions

Function	Description	Example	Item Type
max	The largest of the vector elements	max(ex1)	8 byte float (default) or custom scalar number
min	The smallest of the vector elements	min(ex1)	8 byte float (default) or custom scalar number
avg	The average value of the vector elements	avg(ex1)	8 byte float (default) or custom scalar number
append	Combine two or more vectors into one larger vector	append(ex1, ex2)	Array of 8 byte float
split	Get a sub-vector of the external vector. The range is either hardkoded integers or scalar external items. The first argument is the source vector, the second argument is the start index and the third argument is the end index.	split(ex1, ex2, ex3) and split(ex1, 2, 4)	Array of 8 byte float
reverse	Reverse the order of the elements of a vector	reverse(ex1)	Array of 8 byte float
interp1(table lookup)	Lookup a value or values from a x-y table, where y is a function of x. First argument is the lookup target, second argument is the x-vector and the third argument is the y-vector. The lookup argument can be scalar or vector. If the lookup argument is a scalar, the result item will be a scalar. If the lookup argument is a vector, the resulting item is a vector of same size containg the y values for the argument elements. Interpolats when lookup argument is between x_min og x_max. If lookup argument is less than x_min, the value of y at x_min is returned. If lookup argument is larger than x_max, the value of y at x_max is returned.	avg(ex1)	Scalar target argument:8 byte float (default) or custom scalar number.Vector target argument: Array of 8 byte float
any	The expressions of the Comparison Operators table can be placed inside an any function. The comparisons are done element by element, and any will return true if any of the individual comparisons are true.	any(ex1 > ex2)	boolean (default) or custom scalar number

Properties

The Calculate module has the following properties:

Name	Description	ID	Flags
Calculation	This enables or disables caculation of the expression	1700	Persisted, Enumerated, ExpertPage
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
ExternalItem report	A status-report for the External Item manager of this module	110	InfoPage
ExtItem pass-through quality	Specifies the quality of external item values that will pass through external item transfers. Default is 'Good and Uncertain qualities'	400	Persisted, Enumerated, ExpertPage
ExtItemCalculationSequence	Decides whether data validation or data transfer will be performed first in the external item manager.	300	Persisted, Enumerated, ExpertPage
PersistValToInitVal	Choose strategy for copying and persisting current value to the InitValue. Tip: Consider using an InitVQTFromHoneystore attribute instead, for better performance.	1650	Persisted, Enumerated
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
TraceToFile	If the file name path is set, internal debug information will be written to file. The file has a max size of 50MB. When this limit is reached the file will be restarted.	1900	Persisted, File, ExpertPage
UpdateInitvalsOnSave	If True, items having initial values will have them updated from their current values when configuration is saved.	1600	Persisted, ReadOnly, Hidden, ExpertPage

See also Module Properties

Commands And Events

The Calculate module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS Calculate Item Types

Covered Topics:

Variable item

User defined item, which can be written and read.

The Variable item type has the following properties:

Name	Description	ID	Flags
AutoResetTime	The timeout for when to automatically reset the value. The timeout is in milliseconds. To disable the autoreset, type 0.	10020	Persisted, ExpertPage
AutoResetValue	The value to set when the AutoResetTimeout occurs.	10019	Persisted, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
Valuetype	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	10010	Persisted, Enumerated

Aggregated item

An item which keeps the result value based on the expression and external item(s). The calculation is revaluated when one of the external items have changed but not faster than the exchange rate set in the module. If the valuetype is default the type is set by the result of an calculation. By selecting an specific type the result will be formatted to this type if possible.

The AggregatedItem item type has the following properties:

Name	Description	ID	Flags
EnableVendorQuality	Set this attribute to true to use vendor quality to validate the quality of an calculation. The worst quality will be used.	10023	Persisted, ExpertPage
Expression	An expression used to calculate the value of this item.	5110	Persisted
OverrideQuality	Set this value to 'true' to run calculations independent of the quality of external items.	10021	Persisted, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
TreatDateAsNumeric	Set this to true to treat external items of type "data" as numeric.	10022	Persisted, ExpertPage
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
Valuetype	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	10010	Persisted, Enumerated

Apis Connection Manager

This module is used to configure connections to external services, and clusters of such configurations.

Provider: Prediktor

Item types:

OpcUa Connection Item

OpcUa Cluster Item

OpcUa Replication Item

APIS Connection Manager Item Types

Covered Topics:

OpcUa Connection Item

An item used to configure the connection to one OpcUa server. This connection setup can then be used by the OpcUa and OpcUaProxy modules, and/or be part of an OpcUa cluster,

The OpcUa connection item has the following standard properties:

Name	Description	ID	Flags
Name	The name selected for the OpcUa connection configuration.
Endpoint URL	The server endpoint, e.g. 'opc.tcp://servername:4880'	10010	Persisted
Reverse connection	If true, the endpoint URL is used for reverse connections	10016	Persisted
Security mode	The level of security used when communicating with this server (one of 'None', 'Sign', 'Sign and encrypt')	10020	Persisted, Enumerated
Security policy	The security policy used when communicating with this server.	10021	Persisted, Enumerated
Authentication	The type of authentication to use when connecting to this server (one of 'Anonymous', 'Username/password')	10030	Persisted, Enumerated
Username	The username to use when authenticating with the server.	10031	Persisted
Password	The password to use when authenticating with the server.	10032	Persisted, Password
Pki provider	The Pki (certificate) provider to use when 'Security mode' is different from 'None', or 'Authentication' is different from 'Anonymous'.	10040	Persisted, Enumerated
Application certificate (SSL)	The name of the file containing the application certificate that will be sent to the server. If not specified, the default SSL application certificate for the Apis instance will be used.	10041	Persisted
Application private key (SSL)	The name of the file containing the private key for the application certificate. If not specified, the default SSL private key for the Apis instance will be used.	10042	Persisted
Server certificate (SSL)	The name of the file containing a copy of the servers application certificate.	10043	Persisted
Storage path (SSL)	The path to the root PKI directory. If not specified, the default pki directory for this Apis instance will be used (<INSTALL_DIR>\Config\<INSTANCE_NAME>\pki).	10044	Persisted
Application certificate (W32)	The subject-name of the application certificate that will be sent to the server. If not specified, the default Windows certificate for the Apis instance will be used.	10050	Persisted
Server certificate (W32)	The subject-name of the servers application certificate.	10051	Persisted
Storage path (W32)	Name of the folder in Windows Certificate Store where the application- and server-certificates are stored.	10052	Persisted

The OpcUa connection item has the following advanced properties:

Name	Description	ID	Flags
Watchdog interval	The number of seconds between each read of the servers status-variable. When one such read-operation fails, a reconnect sequence will be started.	10060	Persisted
Reconnect interval	The number of seconds between each reconnect attempt when the server is not responding.	10061	Persisted
Rpc timeout	The number of seconds to wait for rpc replies.	10070	Persisted
Session timeout	The number of seconds to keep the session alive in the server when there is no rpc requests from the client.	10071	Persisted
Token timeout	The number of seconds between security token renewals.	10072	Persisted
Cluster	When specified, this connection item becomes part of the selected cluster.	10090	Persisted, Enumerated

The OpcUa connection item has the following informational properties:

Name	Description	ID	Flags
Servicelevel	The last servicelevel received from the server. This is used for automatic failover between servers in a cluster.	10060	Persisted

OpcUa Cluster Item

An item used to configure a cluster of two or more redundant OpcUa servers. This item defines the cluster and its failover behavior, while the connection information for each server in the cluster are defined by OpcUa connection items.

Each OpcUa cluster can be selected as a server configuration option in the OpcUa and OpcUaProxy modules, thereby giving these module types transparent failover support.

A failover between servers can occur when the ServiceLevel reported by each server changes. The ServiceLevel is a number from 0 to 255 with the following semantics:

Levels 0-1: The server is not able to provide any data from its data sources
Levels 2-199: The server has lost connection to some, but not all, of its data sources
Levels 200-255: The server is connected to all of its data sources

There are different failover rules for each ServiceLevel group:

The active server has ServiceLevel 0-1: a failover occurs if another server has a ServiceLevel greater than 1.
The active server has ServiceLevel 2-199: a failover occurs if another server has a ServiceLevel greater than 199, or if another server has a ServiceLevel greater than the ServiceLevel of the active server plus the value of the 'Failover deadband' property.
The active server has ServiceLevel 200-255: failovers do not occur

Additionally, failovers never occur more frequently than specified by the 'Failover interval' property.

The OpcUa cluster item has the following standard properties:

Name	Description	ID	Flags
Name	The name selected for the cluster. This name will become available as a Server configuration option in the OpcUa and OpcUaProxy modules.
Value	The server endpoint currently having the highest ServiceLevel for this cluster (read-only). The active OpcUa connection of the cluster does not necessarily change even when this value changes.	2

The OpcUa cluster item has the following advanced properties:

Name	Description	ID	Flags
Failover timeout	Number of seconds to wait for additional servers to come online (after the first server reponse), before selecting a server as the current endpoint for the cluster.	10100	Persisted
Failover interval	Minimum number of seconds between failovers.	10101	Persisted
Failover deadband	Minimum ServiceLevel difference required to trigger a failover (only applies to servicelevels below 200).	10102	Persisted

OpcUa Replication Item

This itemtype is used to trigger a replication of another ApisHive instance. Each module with items in the replicated server will get an equally named OpcUa module in the replicating client, and one OpcItem for each item in the server. Global attributes for Logger and AlarmArea modules will also be replicated to the client.

The OpcUa Replication item has the following standard properties:

Name	Description	ID	Flags
Value	Boolean value indicating if a replication is currently running. Set this to TRUE to trigger the replication.	2	NormalPage
OpcUa server	The name of the OpcUa connection or cluster which should be replicated	10120	Persisted
StandardPropSync	When to synchronize selected OpcUA Standard Properties from server nodes to local apis item attributes (Never, First time, Each session)	10128	Persisted, Enumerated
ExtraProperties	Array of additional item properties to replicate for each item	10130	Persisted

APIS EventBus

Apis module used to process events

Provider: Prediktor

The EventBus module has the following item types

Properties

The EventBus module has the following properties:

Name	Description	ID	Flags
Description	A user defined description of this module instance.	900	Persisted, InfoPage
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
LogLevel	Specifies the loglevel for diagnostic messages from this module.	500	Persisted, Enumerated
Text1	A generic user defined text related to this module instance.	910	Persisted, InfoPage
Text2	A generic user defined text related to this module instance.	911	Persisted, InfoPage
Text3	A generic user defined text related to this module instance.	912	Persisted, InfoPage
Text4	A generic user defined text related to this module instance.	913	Persisted, InfoPage

See also Module Properties

Commands And Events

The EventBus module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified by user. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS EventBus Item Types

Covered Topics:

Properties

Item used to define an event channel/stream

The Channel item type has the following properties:

Name	Description	ID	Flags
BatchTime	Time used to batch events, in seconds	10060	Persisted
BatchSize	Maximum number of events per batch. Overrides BatchTime if both attributes are specified.	10070	Persisted
IsConsumer	This attribute is TRUE on items that can consume events	10010	ReadOnly, InfoPage
IsProducer	This attribute is TRUE on items that can produce events	10020	ReadOnly, InfoPage

Properties

Item used to route and/or transform an event stream

The Router item type has the following properties:

Name	Description	ID	Flags
InputChannel	The input channel for events consumed by this item	10030	Persisted, DynamicEnumeration
IsConsumer	This attribute is TRUE on items that can consume events	10010	ReadOnly, InfoPage
IsProducer	This attribute is TRUE on items that can produce events	10020	ReadOnly, InfoPage
OutputChannel	The output channel for events produced by this item	10040	Persisted, DynamicEnumeration
Script	The XSLT scipt that will be executed on incoming events to produce outgoing events	10100	Persisted, Multiline

Properties

Item used to subscribe to events from Apis Chronical

The Source.Chronical item type has the following properties:

Name	Description	ID	Flags
Eventsource	Path to the root eventsource to monitor	10200	Persisted, ApisEventSourcePath
Eventtype	Name of the root eventtype to monitor	10210	Persisted, DynamicEnumeration
IsConsumer	This attribute is TRUE on items that can consume events	10010	ReadOnly, InfoPage
IsProducer	This attribute is TRUE on items that can produce events	10020	ReadOnly, InfoPage
OutputChannel	The output channel for events produced by this item	10040	Persisted, DynamicEnumeration

Properties

Item used to write events to a SQL database

The Sink.Db item type has the following properties:

Name	Description	ID	Flags
ConnectionString	ADO Connectionstring for the database	10400	Persisted
InputChannel	The input channel for events consumed by this item	10030	Persisted, DynamicEnumeration
IsConsumer	This attribute is TRUE on items that can consume events	10010	ReadOnly, InfoPage
IsProducer	This attribute is TRUE on items that can produce events	10020	ReadOnly, InfoPage

Properties

Item used to send emails. The Sink.Smtp item will automatically use TLS if the server supports the STARTTLS command.

The Sink.Smtp item type has the following properties:

Name	Description	ID	Flags
Server	Address of smtp server, e.g. 'smtp.office365.com:587'	10500	Persisted
Username	Username used to authenticate with the smtp server	10510	Persisted
Password	Password used to authenticate with the smtp server	10520	Persisted
From	Email address used in the 'From:' field	10530	Persisted
To	Email address(es) used in the 'To:' field	10540	Persisted
Cc	Email address(es) used in the 'Cc:' field	10550	Persisted
Bcc	Email address(es) used in the 'Bcc:' field	10560	Persisted
Importance	Value of 'Importance:' field (0=Normal, 1=High, 2=Low)	10560	Persisted, DynamicEnumeration
IsConsumer	This attribute is TRUE on items that can consume events	10010	ReadOnly, InfoPage
IsProducer	This attribute is TRUE on items that can produce events	10020	ReadOnly, InfoPage

Properties

Item used to log events to a tracefile

The Sink.Tracelog item type has the following properties:

Name	Description	ID	Flags
Enabled	Enable/disable tracing of events	10050	Persisted
InputChannel	The input channel for events consumed by this item	10030	Persisted, DynamicEnumeration
IsConsumer	This attribute is TRUE on items that can consume events	10010	ReadOnly, InfoPage
IsProducer	This attribute is TRUE on items that can produce events	10020	ReadOnly, InfoPage
TraceFile	Full path to the trace-file	10300	Persisted

Apis FileReader

This is a called ApisFileReader which reads data from a file and inserts it into the namespace of Apis Hive

Provider: Prediktor

The FileReader module has the following item types

FileItem

AnalogueVectorItem

Properties

The FileReader module has the following properties:

Name	Description	ID	Flags
Alarm command	The command executed when there hasn't been any file update in 'TimeToAlarm' milliseconds in the specified directory. This typically is the full path to an executable or similar.	1610	Persisted, ExpertPage
Alarm command parameters	The parameters sent to the command in 'Alarm command'.	1620	Persisted, ExpertPage
Completion port handle	The handle of the I/O completion port in use.	50120	InfoPage
Database login	Same as User ID in connection string. If blank, integrated security will be used.	10005	Persisted, User, ExpertPage
Database login password	Used when Database login is other than blank.	10006	Persisted, Password, ExpertPage
Database name	The name of the database on given server, used in connection string.	10004	Persisted, ExpertPage
Database server	The server machine where the database exists, used in connection string.	10003	Persisted, ExpertPage
Directory handle	The handle of the monitored directory.	50110	InfoPage
FavorArrayItems	When 'true', the module tell it's file parser object to use vector and matrices as item types when applicable.	10000	Persisted, ExpertPage
FileChangeTimeout	The maximum amount of milliseconds to wait for a file change notification to occur before the directory is manually scanned for filechange(s).	1350	Persisted, Enumerated, ExpertPage
FileChangeToParseDelay	A delay in milliseconds indicating how long to wait from a file is detected as changed until it is actually being parsed by the FileParserObject.	1400	Persisted, ExpertPage
Filename Pattern	A filename pattern including the path for files that will be sent to the parser	1150	Persisted, File
FilenamePattern	A filename pattern that The ProgID of the component actually parsing the file in question	1200	Persisted, Hidden, File
FileParser	The ProgID identifying the parser component used by this module when parsing the file(s).	1300	Persisted, Enumerated, ProgID
FileParser debug trace file	If specified, the complete filename of a tracefile used for debugging from parsers. Whether or not a file is generated, is parser specific behavior. If empty, no tracefile will be used.	10009	Persisted, File, ExpertPage
FileReader trace file	If set, internal file update handling of the ApisFileReaderBee will be traced to this file. Should only be used for short time periods and for verbose troubleshooting of file update dynamics.	2000	Persisted, File, ExpertPage
Honeystore database	If applicable, the name of the Honeystore database to use for parser component.	10008	Persisted, ExpertPage
LastFileChangeTime	The time of the last notification of a matching file-change the module has registered.	100000	PerformancePage
LastFileParserFileName	The name of file last parsed.	103000	PerformancePage
LastFileParserFileTimeUsage	The time used by the file-parser to handle last file update.	102000	PerformancePage
LastUpdatedItemCount	The number of items updated by the last file-change notification.	101000	PerformancePage
Locale ID	The locale ID to be used when parsing files.	10001	Persisted, ExpertPage
Offset from UTC	The offset from UTC can be used by the parser component when handling files. Norwegian timezone is +60.	10002	Persisted, ExpertPage
Parser specific enum	This property may have meaning for some types of parsers, other may not use it.	10007	Persisted, DynamicEnumeration, ExpertPage
ScanDirectoryOnStart	If true, the SourceDirectory will be scanned once upon startup to look for matching files, if false directory will be scanned on startup but depend on directory changes and/or FileChangeTimeout for first scan.	1340	Persisted, ExpertPage
SourceDirectory	The directory which the module shall monitor for file changes.	1100	Persisted, Hidden, Folder
TimeToAlarm	The time in milliseconds that the module delays when lack of fileupdates until the alarm action specified in the 'Alarm command' property is executed.	1600	Persisted, ExpertPage
UseApisTime	Use Apis timestamps instead of the timestamps given by the parser component.	1500	Persisted, ExpertPage

See also Module Properties

Commands And Events

The FileReader module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS Filereader Item Types

Topics Covered:

FileItem

A generic item parsed from a file

The FileItem item type has the following properties:

Name	Description	ID	Flags
MapKey	The key of item in m_Handles map (parser handle)	10100	Hidden
Quality	Item quality	3	ReadOnly
ReqVartype	The type requested to be delivered for the value of this item from the server. Only change this one for special situations.	10200	Persisted, ReadOnly, Hidden, Enumerated
Rights	Item access rights	5	ReadOnly
Time	Item timestamp	4	ReadOnly
Type	Item canonical datatype	1	ReadOnly
Value	Item value	2	ReadOnly

AnalogueVectorItem

An analogue vector item of 4 byte floats parsed from a file

The AnalogueVectorItem item type has the following properties:

Name	Description	ID	Flags
Dimension	The dimension of a vector item (number or elements)	5007	Persisted, ReadOnly
MapKey	The key of item in m_Handles map (parser handle)	10100	Hidden
Quality	Item quality	3	ReadOnly
Rights	Item access rights	5	ReadOnly
Time	Item timestamp	4	ReadOnly
Type	Item canonical datatype	1	ReadOnly
Value	Item value	2	ReadOnly

Apis GPSolarBee

TCP/IP XML communication to GP Solar Equipment(s)

Provider: Prediktor

The GPSolarBee module has the following item types

Properties

The GPSolarBee module has the following properties:

Name	Description	ID	Flags
ArticleConfig	Used to set which element is contains article information	1015	Persisted
Connected	Status if Apis is connected to server.	1005	InfoPage
DataConfig	Used to filter which elements should be registered as data value. Default (empty) register all elements as data. Each name is separeated by ';'	1017	Persisted
EnableLaneTrayInfo	For example, for Tray Id 9999, lane Id 2 and Wafer Id 12345, Schmid will be sending '99992000000000012345' to GP for Wafer Id (Refered to as 'MaterialSplit'.)	1100	Persisted, ExpertPage
EnableReconnect	If true the module will reconnect when a disconnect is received.	1009	Persisted
EquipmentHeartbeatTime	Last time equipment heartbeat was sent to the server.	1050	InfoPage
EquipmentReconectTime	Last time equipment reconnect was run.	1060	InfoPage
EquipmentStateLocation	The equipment location of where to register equipment states.	1018	Persisted
EquipmentTimeAsUtc	Is equipment time represented in UTC.	1011	Persisted
EquipmentType	The equipment type is used to select which type of equipment to use, GPSolar or Semilab. The choice will affect the interpretation of the XML documents received.	1023	Persisted, Enumerated
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
HeartbeatRestart	Restart connection if missing heartbeat is greater that the value specified. If the heartbeat is missed in a continous sequence compared to the value specified, the connection will be restarted. Only valus greater than '1' is allowed (DefaultValue: 5).	1024	Persisted, ExpertPage
HeartbeatTimeout	The timeout for when to send a heartbeat. The unit is in milliseconds [ms] and must be > 1000.	1003	Persisted
IP-Address	The IP address of the server. You can not specify host name.	1001	Persisted, TcpIpAddr
LogFile	Reference to the log file name to log input received on the socket.	1008	Persisted, File
MaterialAttributeLocation	The equipment location of where to register material attribute.	1019	Persisted
MaxLogFileSize	The max size of the log file before it get recycled. The value must be > 1000 [bytes]	1080	Persisted, ExpertPage
MaxXmlHistoryFiles	The maximum numbers of history files in the 'XmlHistoryDirectory'. If the numbers of files gets above this size the oldest file is deleted.The value selected must be between 10 and 500. Default value is 100	1021	Persisted, ExpertPage
MessageBrokerKeepAlive	Last time MessageBroker.GetMessages was called.	1070	InfoPage
MessageType	Used to define if the material should be registerd with message 'RegisterMaterialAttributes' or 'RegisterInterimMaterialAttributes'.	1012	Persisted, Enumerated
Port-Number	The listening port of the server.	1002	Persisted
QualityConfig	Used to set which element is contains quality information	1016	Persisted
ReconnectInSeparateThread	Used to run connection in a separate thread when the timer kick inn.	1350	Persisted
ReconnectTime	The time for reconnect equipment after a connection loss. The unit is in milliseconds [ms] and must be > 1000	1004	Persisted
ReuseLogFile	Set this value to 'true' if the log file should be keeped open between each log write operation. Default value is 'true'	1090	Persisted, ExpertPage
TcpBufferSize	The size in bytes of the TCP socket buffer. The value must be > 8 [bytes]	1110	Persisted, ExpertPage
TimeFormat	The format of the time received from the equipment.	1010	Persisted
UseApisTime	Use Apis time as time reference.	1006	Persisted
UseLogSynchEvent	By setting this propery to 'true' no new XML document received will be handled before the logger has reported logger event 'LogDone' (default=false).	1120	Persisted, ExpertPage
WaferIdMask	This property is used to mask out any '0' (zero) in the beginging of the waferid used in constructing the Apis message. Ex '0000234232' --> '234232'.	1022	Persisted, ExpertPage
XmlHistoryDirectory	The directory of where to put the files after read.	1020	Persisted, Folder, ExpertPage

See also Module Properties

Commands And Events

The GPSolarBee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
OnNamespaceUpdated	Blank	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
OnLoggerReady	Blank	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS GPSolarBee Item Types

Topics Covered:

Properties

This item is used to trigg command on equipment. The type of command is specified by the attribute 'Command Type'

The EquipmentCommand item type has the following properties:

Name	Description	ID	Flags
CommandType	This attribute allows you to select the type of command to use.	10001	Persisted, Enumerated
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

The raw XML document received from the server

The ReceivedXml item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Reference to an element or attribute in the received XML document. The syntax for accessing element or attribute field in an XML node is by XPath

The XmlItem item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
ItemType	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	10005	Persisted, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	1	ReadOnly
Value	The current value of the item.	2	NormalPage
XPath	The XPath syntax is used to access the element or attribute in the recevied XML document.	10004	Persisted

Properties

Used to count selected type defined in the module property

The Counter item type has the following properties:

Name	Description	ID	Flags
CounterMaxValue	The maximum value of the counter. When the maximum value is reached, the counter is reset to '1'.	10007	Persisted
CounterType	The type of counter to use: NewDoc - reports when a new document type received; ValueChange - counts the changes to a specific element or attribute; SpecificValueSet - counts specific values received on a given element or attribute.	10006	Persisted, Enumerated
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
XPath	The XPath syntax is used to access the element or attribute in the recevied XML document.	10004	Persisted

Properties

This item is used to expose internal status information

The StatusItem item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Apis HAGovernor

This is an Apis module that governs High Availability tasks for an Apis Hive instance. I.e. synchronizing configuration, time-series and event data between redundant instances.

Provider: Prediktor

The HAGovernor module has the following item types

Command Item

State Item

Function item

Tutorial

To use the Apis HA Governor module, please refer to this topic: Getting Started

Properties

The HAGovernor module has the following properties:

Name	Description	ID	Flags
TrendHistory_LastUpToDate	The last time (in UTC) the HA Governor has determined that the Trend History of this instance, was up to date compared with all Hive Instances.	3010	Persisted, ReadOnly

See also Module Properties

Commands And Events

The HAGovernor module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified by user. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS HAGovernor Item Types

Topics Covered:

Command Item

An item that represents a command to apply on this module.

The Command Item item type has the following properties:

Name	Description	ID	Flags
Command type	This attribute defines the command type of the command item.	10130	Persisted, ReadOnly, Hidden
Description	Item description	101	Persisted
Quality	Item quality	3	NormalPage
Rights	Item access rights	5	ReadOnly
Time	Item timestamp	4	NormalPage
Type	Item canonical datatype	1	ReadOnly
Value	Item value	2	NormalPage

State Item

An item that represents a well defined state of this module.

The State Item item type has the following properties:

Name	Description	ID	Flags
Description	Item description	101	Persisted
Quality	Item quality	3	ReadOnly
Rights	Item access rights	5	ReadOnly
Time	Item timestamp	4	ReadOnly
Type	Item canonical datatype	1	ReadOnly
Value	Item value	2	ReadOnly

High Availability Data Concept

By High Availability (HA), we do not mean full redundancy, but something that is close and in many situations serves the same purpose adequately.
In short, the HA provided by this module, will be like described below. There are 2 Hive instances involved; one local instance and one remote instance.

Configration Data

For now, synchronizing configuration data is not supported, and is required to be synchronized manually.

TimeSeries data

TimeSeries data will be synchronized like this: When your local Hive instance starts, the HAGovernor will request all items that are trended locally from the local instance. For each of these items, it will try to retrieve from the remote instance timeseries data from the time period when the local instance was not running. All timeseries data received from the remote instance, will be inserted into the corresponding timeseries data of the local instance. If any (for some reason) timeseries data already exists locally for the time period when your local instance was not running, it will be overwritten.

Event data

Event data will be synchronized like this: When your local Hive instance starts, the HAGovernor will request all event data from the remote instance, from the time period when the local instance was not running. All Event data received from the remote instance, will be inserted into the event data of the local instance. If any (for some reason) event data already exists locally for the time period when your local instance was not running, it will be not be overwritten.

Also, please refer to this section: Apis High Availability.

Getting Started

This module uses an proprietary TCP protocol to exchange timeseries and event data between this Hive instance and another redundant Hive instance.
For now, synchronizing configuration data is not supported, and is required to be synchronized manually.

What is meant by High Availability (HA), is described here: High Availability Data Concept

Basic configuration

Assuming you have 2 Hive instances, that has redundant configuration, one local and one remote. We will now describe how to configure an ApisHAGovernorBee on each of these instances in a HA setup

In your local Hive instance, add new Apis module of type ApisHAGovernor.
In your remote Hive instance, add new Apis module of type ApisHAGovernor.
Specify a free and valid ServerPort property on both added modules.
On the Hive Instances property of your local Hive instance, specify the endpoint to the remote Hive instance. Eg: <remote computername or IP>:<port from step 3.>
On the Hive Instances property of your remote Hive instance, specify the endpoint to the local Hive instance. Eg: <local computername or IP>:<port from step 3.>
Specify the HA Deputies property you want to use on both added modules. (Note: the Config Sync deputy is not implemented and will have no effect).
Restart the modules to apply the changes.

When restarting the modules or their Hive instances, the HA Governor will synchronize TimeSeries/Event data from the timestamps of the properties TrendHistory_LastUpToDate / EventHistory_LastUpToDate depending on which deputies were activated in the HA Deputies properties.

Advanced operation

If you want to manually control from what time a Timeseries/Event synchronization shall start, you can set the ExpertMode property to true. Then, the properties TrendHistory_LastUpToDate / EventHistory_LastUpToDate will become writable and you may specify a custom start time. Synchronization from that time will take place the next time the module or the Hive instance is restarted.

The property RedundancySupport will reflect and control the RedundancySupport exposed by the OpcUa server of this Hive instance (if enabled).

The property ServerUriArray will reflect and control the ServerUriArray exposed by the OpcUa server of this Hive instance (if enabled).

Apis HSMirror

This Apis module, connects to an Apis HoneyStore real-time Historian, and exposes the trend items of its databases as items in this Hive instance.

Provider: Prediktor

The HSMirror module has the following item types

Properties

The HSMirror module has the following properties:

Name	Description	ID	Flags
AutoConfig	Select a strategy for automatically configuing the items of this module, based on changes in the databases of the Apis HoneyStore historian. Typically used in combination with property Database-ItemFilters. Enum options are: Manual: No automatic configuration, items must be addedand deleted manually. AutoAdd: When trend-items matching the Database-ItemFilters are added to HoneyStore, items are automatically added to this module. Also, when module is started, HoneyStore is investigated for matching trend-items and if found, automatically added to this module. AutoDelete: When trend-items matching the Database-ItemFilters are deleted from HoneyStore, items are automatically added to this module. Note, when module is started, HoneyStore is not investigated for missing trend items to delete. The reason for this is that we don't want items to disappear when HoneyStore databases are temporarily put into Disabled or Admin modes and this Hive instance is restarted. AutoAddAndDelete: Same as selecting both AutoAdd and AutoDelete.	2000	Persisted, Enumerated
Database-ItemFilters	When specified; a vector of "DataBase.ItemName" filters to use for automagic item configuration, wildcard syntax is supported. If an empty array, items must be added/deleted manually to the module. When specified, this also works as filter(s) for browsing the namespace of HoneyStore when adding HoneyStoreItems.	2010	Persisted
Description	A user defined description of this module instance.	900	Persisted, InfoPage
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
HS-Computer	HS-Computer\nThe computer hosting the Apis HoneyStore Historian. Leave empty for localhost, or enter a valid hostname/IP-address.	1100	Persisted, TcpIpAddr
LogLevel	Specifies the loglevel for diagnostic messages from this module.	500	Persisted, Enumerated
PersistValToInitVal	Choose strategy for copying and persisting current value to the InitValue.	1500	Persisted, Enumerated
Text1	A generic user defined text related to this module instance.	910	Persisted, InfoPage
Text2	A generic user defined text related to this module instance.	911	Persisted, InfoPage
Text3	A generic user defined text related to this module instance.	912	Persisted, InfoPage
Text4	A generic user defined text related to this module instance.	913	Persisted, InfoPage

See also Module Properties

Commands And Events

The HSMirror module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified by user. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS HSMirror Item Types

Topics Covered:

Item type: HoneyStoreItem

An item mirrored from a HoneyStore database trend item.

The HoneyStoreItem item type has the following properties:

Name	Description	ID	Flags
Quality	Item quality	3	ReadOnly
Rights	Item access rights	5	ReadOnly
SrcItemID	Item ID in source	5030	Persisted
Time	Item timestamp	4	ReadOnly
Type	Item canonical datatype	1	ReadOnly
Value	Item value	2	ReadOnly

Item type: Variable

User defined item of any scalar type, being both readable and writeable.

The Variable item type has the following properties:

Name	Description	ID	Flags
Quality	Item quality	3	NormalPage
Rights	Item access rights	5	ReadOnly
Time	Item timestamp	4	NormalPage
Type	Item canonical datatype	1	ReadOnly
Value	Item value	2	NormalPage
Valuetype	Item canonical datatype.	10010	Persisted, Enumerated

Apis IEC62056Bee

Description of ApisIEC62056Bee

Provider: Prediktor

The IEC62056Bee module has the following item types

StatusItem

Properties

The IEC62056Bee module has the following properties:

Name	Description	ID	Flags
Com port	Serial IO Com port id. Must Start with COM	1055	Persisted, ExpertPage
Communication type	Choose the communication type for the connection to the meter	1020	Persisted, Enumerated
Communicationtimeout	The communication timeout period in milliseconds	1050	Persisted, ExpertPage
Connected	Status if Apis is connected to device.	1200	InfoPage
ConnectedTime	Last time host connected device.	1215	InfoPage
Device Address	RS485 Address of the device. Will be ommitted if not set. 32 characters Max	1017	Persisted
Enable	If true the module will try to connect the equipment with IP address and port number specified (default: false).	1010	Persisted
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
ItemUpdateInterval	The interval in seconds that the module will try to update the read items.Minimum value is 1.	1013	Persisted
LastMsgRcv	Last message received from device.	1210	InfoPage
LastMsgSend	Last message send to device.	1205	InfoPage
Log file	The file name for Seg scale serial IO log.	1090	Persisted, ExpertPage
Log file Maxsize	The max size of the log file before it get recycled (Default value=5.000.000 [bytes]).	1085	Persisted, ExpertPage
MaxParseTime	The maximum time used to parse a SF message [ms].	1300	PerformancePage
Meter manufacturer	Choose the right configuration for the meter. This selection affects the use of protocolmode and item creation	1015	Persisted, Enumerated
Password Level 1	Password used for level 1 data read.	1035	Persisted
Password Level 2	Password used for level 2 data read.	1040	Persisted
Password Level 3	Password used for level 3 data read.	1045	Persisted
ReconnectInterval	The interval in seconds that the module will try to connect to a device after lost connection.Minimum value is 1.	1012	Persisted
Serial IO Data bits	The serial IO Data bits	1065	Persisted, ExpertPage
Serial IO Stop bits	The serial IO Stop bits	1070	Persisted, Enumerated, ExpertPage
Serial IO Stop bits	The serial IO Stop bits	1080	Persisted, Enumerated, ExpertPage
TCP/IP address	The IP address of the meter. Used for TCP communication	1025	Persisted, URL
TCP/IP port	The IP port of the meter. Used for TCP communication	1030	Persisted

See also Module Properties

Commands And Events

The IEC62056Bee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS IEC62056Bee Item Types

Topics Covered:

Properties

A Register Readout items main purspose is to read out specific register data

The Register Readout item type has the following properties:

Name	Description	ID	Flags
Address	Register address.	11000	Persisted
Enable	Set to true to enable the item in the configuration.	10005	Persisted
Index	The index of the data field.	11010	Persisted
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
Length	The length of the data field.	11020	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

A Register Readout items main purspose is to read out specific register data, after Set/Reset register is changed

The Register Set/Reset Readout item type has the following properties:

Name	Description	ID	Flags
Address	Register address.	11000	Persisted
Enable	Set to true to enable the item in the configuration.	10005	Persisted
Index	The index of the data field.	11010	Persisted
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
Length	The length of the data field.	11020	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Reset Value	Value the Transaction Manager will check against.	12040	Persisted
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Set Value	Value to set in the Set/Reset register.	12030	Persisted
Set/Reset Address	Set/Reset Register address.	12000	Persisted
Set/Reset Length	Set/Reset Length of the data field in the register.	12020	Persisted
Set/Reset Offset	Set/Reset Offset of the data field in the register.	12010	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

A Register Data Interpreter Item main purpose is iterpret data read out bu registerreadoutItems

The Register Data Interpreter item type has the following properties:

Name	Description	ID	Flags
Enable	Set to true to enable the item in the configuration.	10005	Persisted
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Scale	The linear transformation multiplier to use when calculating the item value. (Value = RawValue * Scale + Offset)	11120	Persisted
Second Value Length	The length of the second data field in the register.	13040	Persisted
Second value start index	Zero-based index indicating where to start interpreting the read second data.	13030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
Value Arithmetic	The arithmetic used on values from first and second register data. On subtraction, the second value will be subtracted from the first.	13001	Persisted, Enumerated
Value Cut Off Type	The cut off type is used on values to cut of positive or negative values.	13005	Persisted, Enumerated
Value interpretation type	This property determines how to interpret the data file value: String: reads the value as a plain string; BCD (Binary Coded Digital): reads the value as an integer and scales it according to the scale property.	11100	Persisted, Enumerated
Value Length	The length of the data field in the register.	13020	Persisted
Value start index	A zero-based index indicating where to start interpreting read data.	13010	Persisted

Properties

This item is used to expose internal status information

The StatusItem item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Apis InnolasBee

TCP/IP XML communication to Innolas equipment.

Provider: Prediktor

The InnolasBee module has the following item types

Properties

The InnolasBee module has the following properties:

Name	Description	ID	Flags
Connected	Status if Apis is connected to server or not.	1005	InfoPage
EnableReconnect	If true the module will reconnect when a disconnect is received on the socket.	1009	Persisted
EquipmentHeartbeatTime	Last time equipment heartbeat was sent to the server.	1050	InfoPage
EquipmentLocation	The equipment location of where to register material attribute and equipment states.	1013	Persisted
EquipmentReconectTime	Last time equipment reconnect was run.	1060	InfoPage
EquipmentTimeInUtc	Is equipment time represented in UTC.	1011	Persisted
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
HeartbeatTimeout	The timeout for when to send a heartbeat. The value of '0' will disable the timout. The unit is in milliseconds [ms] and must be > 1000	1003	Persisted
IP-Address	The IP address of the server. You can not specify host name.	1001	Persisted, TcpIpAddr
LogFile	A file path name to a log file used for debug purpose only. NB: there will be no watchout of the file size. This is a manual job.	1008	Persisted, File
MaxLogFileSize	The max size of the log file before it get recycled. The value must be > 1000 [bytes]	1080	Persisted, ExpertPage
MaxXmlHistoryFiles	The maximum numbers of history files in the 'XmlHistoryDirectory'. If the numbers of files gets above this size the oldest file is deleted.The value selected must be between 10 and 500. Default value is 100	1015	Persisted, ExpertPage
MessageBrokerKeepAlive	Last time MessageBroker.GetMessages was called.	1070	InfoPage
MissingMachineParameter	Restart connection if machine parameter is missing at next request.	1120	Persisted, ExpertPage
Port-Number	The listening port of the server.	1002	Persisted
ReconnectInSeparateThread	Used to run connection in a separate thread when the timer kick inn.	1350	Persisted
ReconnectTime	The time for reconnect equipment after a connection loss. The value of '0' will disable the timout. The unit is in milliseconds [ms] and must be > 1000	1004	Persisted
RequestData	Used to request spooled data and SEMI-E10 status at startup.	1006	Persisted
RequestMachineParameterTime	Last time machine parameter was requested from the server.	1040	InfoPage
RequestMachinePrameterTimeout	The timeout for when to request machine parameter. The value of '0' will disable the timout. The unit is in milliseconds [ms] and must be > 1000.	1012	Persisted
ReuseLogFile	Set this value to 'true' if the log file should be keeped open between each log write operation. Default value is 'true'	1090	Persisted, ExpertPage
TcpBufferSize	The size in bytes of the TCP socket buffer. The value must be > 8 [bytes]	1110	Persisted, ExpertPage
TimeFormat	The format (yyyy-MM-ddTHH:mm:ss.fffzzz) of the time received in the XML document received.	1010	Persisted
UseLocalTime	Use local time reference to time stamp XML items. If false the dockument time will be used.	1007	Persisted
UseLogSynchEvent	By setting this propery to 'true' no new XML document received will be handled before the logger has reported logger event 'LogDone' (default=false).	1115	Persisted, ExpertPage
XmlHistoryDirectory	The directory of where to put the files after read.	1014	Persisted, Folder, ExpertPage

See also Module Properties

Commands And Events

The InnolasBee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
OnNamespaceUpdated	Blank	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
OnLoggerReady	Blank	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS InnolasBee Item Types

Topics Covered:

Properties

This item is used to trigg command on equipment. The type of command is specified by the attribute 'Command Type'

The EquipmentCommand item type has the following properties:

Name	Description	ID	Flags
CommandType	This attribute allows you to select the type of command to use.	10001	Persisted, Enumerated
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

The raw received XML document from the server

The ReceivedXml item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Reference to an element or attribute in the received XML document. The syntax for accessing element or attribute field in an XML node is by XPath

The XmlItem item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
ItemType	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	10005	Persisted, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
XPath	The XPath syntax is used to access the element or attribute in the recevied XML document.	10004	Persisted

Properties

Used to count selected type defined in the module property

The Counter item type has the following properties:

Name	Description	ID	Flags
CounterMaxValue	The maximum value of the counter. When the maximum value is reached, the counter is reset to '1'.	10007	Persisted
CounterType	The type of counter to use: NewDoc - reports when a new document type received; ValueChange - counts the changes to a specific element or attribute; SpecificValueSet - counts specific values received on a given element or attribute.	10006	Persisted, Enumerated
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
XPath	The XPath syntax is used to access the element or attribute in the recevied XML document.	10004	Persisted

Properties

Used to reflects the bit pattern for alarms defined by the Innolas equipment. Each type of alarm is defined by a AlarmBit.

The Alarm item type has the following properties:

Name	Description	ID	Flags
AlarmBit	The bit the alarm reflects. The bit starts at '0'.	10008	Persisted
ItemHandle	The current value of the item.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

This item is used to expose internal status information

The StatusItem item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Apis IntegoBee

XML file share reader for Intego

Provider: Prediktor

The IntegoBee module has the following item types

ReceivedXml

XmlItem

Counter

Properties

The IntegoBee module has the following properties:

Name	Description	ID	Flags
ArticleConfig	Used to set which element is contains article information	1016	Persisted
DataConfig	Used to filter which elements should be registered as data value. Default (empty) register all elements as data. Each name is separeated by ';'	1018	Persisted
Enable	Enable input file.	1008	Persisted
EnableMessaging	Use this property to disable reporting the received XML document to Apis Message broker. Default value is 'True'	1100	Persisted, ExpertPage
EquipmentTimeAsUtc	Is equipment time represented in UTC.	1011	Persisted
EquipmentType	Used to select the type of xml document to receive	1015	Persisted, Enumerated
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
FilterSettings	Used to filter on which file to read in input directory and files to delete from history directory.	1005	Persisted, ExpertPage
LastScanTime	Last time the input directory was scaned.	1009	InfoPage
LogFile	Reference to the log file name.	1007	Persisted, File
MaterialAttributeLocation	The equipment location of where to register material attribute.	1014	Persisted
MaxLogFileSize	The max size of the log file before it get recycled.	1080	Persisted, ExpertPage
MaxXmlHistoryFiles	The maximum numbers of history files in the 'XmlHistoryDirectory'. If the numbers of files gets above this size the oldest file is deleted.The value selected must be between 10 and 500. Default value is 100	1004	Persisted, ExpertPage
MessageBrokerKeepAlive	Last time MessageBroker.GetMessages was called.	1070	InfoPage
MessageType	Used to define if the material should be registerd with message 'RegisterMaterialAttributes' or 'RegisterInterimMaterialAttributes'.	1012	Persisted, Enumerated
NumberDecimalSeparator	Use this property to set the type of NumberDecimalSeparator	1110	Persisted, Enumerated, ExpertPage
QualityConfig	Used to set which element is contains quality information	1017	Persisted
ReuseLogFile	Set this value to 'true' if the log file should be keeped open between each log write operation. Default value is 'true'	1090	Persisted, ExpertPage
ScanTime	The scan time in [ms] to search for new xml files in directory defined by property 'XmlDirectory'. The value of 0 will disable the functionality.	1002	Persisted
TimeCheckXmlFileDirectory	Last time the chekc xml file directory timer run.	1040	InfoPage
TimeFormat	The format of the time.	1010	Persisted
UseApisTime	Use Apis time as time reference.	1006	Persisted, ExpertPage
UseLogSynchEvent	By setting this propery to 'true' no new XML document received will be handled before the logger has reported logger event 'LogDone' (default=false).	1120	Persisted, ExpertPage
XmlDirectory	The directory of where the xml files are located	1001	Persisted, Folder
XmlHistoryDirectory	The directory of where to put the files after read.	1003	Persisted, Folder, ExpertPage

See also Module Properties

Commands And Events

The IntegoBee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
OnNamespaceUpdated	Blank	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
OnLoggerReady	Blank	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS IntegoBee Item Types

Topics Covered:

Properties

The raw received XML document from the server

The ReceivedXml item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Reference to an element or attribute in the received XML document. The syntax for accessing element or attribute field in an XML node is by XPath

The XmlItem item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
ItemType	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	10005	Persisted, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
XPath	The XPath syntax is used to access the element or attribute in the recevied XML document.	10004	Persisted

Properties

Used to count selected type defined in the module property

The Counter item type has the following properties:

Name	Description	ID	Flags
CounterMaxValue	The maximum value of the counter. When the maximum value is reached, the counter is reset to '1'.	10007	Persisted
CounterType	The type of counter to use: NewDoc - reports when a new document type received; ValueChange - counts the changes to a specific element or attribute; SpecificValueSet - counts specific values received on a given element or attribute.	10006	Persisted, Enumerated
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
XPath	The XPath syntax is used to access the element or attribute in the recevied XML document.	10004	Persisted

Apis Interpreter

This module interprets single line ascii string terminated by terminating character like <CR><LF> received from serial port or TCP socket

Provider: Prediktor

The Interpreter module has the following item types

More information

Characteristics of the Interpreter module:

Reads ASCII string from a device and interprets to numeric value(s).
Supports Read and Write.
Supports query, Write->Read (synchronous)
Can act as a simple TCP server
Supports, serial and TCP/IP communication (TCP and UDP)

Further, as an integrated module in the Apis Hive, the following optional features are available:

High performance data logging to the Apis Honeystore historian, with OPC Historical Data Access server interface

Properties

The Interpreter module has the following properties:

Name	Description	ID	Flags
ACK	If Greater or equal "0" this value is sent as ACK on successful receive	1273	Persisted, ExpertPage
Serial BaudRate	Baud rate for serial communication. Valid only when Comm. type is Serial	1210	Persisted, Enumerated, ExpertPage
Buffer size	Size of buffer (min. 10).	1270	Persisted, ExpertPage
Serial COM port	The COM port to use. Valid only when Comm. type is Serial	1200	Persisted, Enumerated
Comm. type	Communication method, Serial or Winsock	1110	Persisted, Enumerated
Client command timeout	Time to wait for client command in (seconds) before giving up and reset connection	1320	Persisted
Serial DataBits	Number of bits in the bytes transmitted and received. Valid only when Comm. type is Serial	1230	Persisted, Enumerated, ExpertPage
Mode of operation	Read, Write, Write->Read, TCP-Server. Write->Read; Writes and then reads responce, TCP-Server acts as a stream server	1120	Persisted, Enumerated
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
Field separator	Separation character for values when multiple values in one string.	1075	Persisted, Enumerated, ExpertPage
Serial FlowControl	Flow control for serial communication. Valid only when Comm. type is Serial	1250	Persisted, Enumerated, ExpertPage
IP address	IP Address of Interpreter server. Valid only when Comm. type is Winsock	1310	Persisted, Computer
Interpret	Interpret string to numeric value(s)	1072	Persisted, ExpertPage
Serial Parity	Parity scheme for the serial communication. Valid only when Comm. type is Serial	1220	Persisted, Enumerated, ExpertPage
IP port	The TCP/UDP port of Interpreter server. Valid only when Comm. type is Winsock	1311	Persisted
RawValueReceive	Last telegram raw value received	1500	ReadOnly, PerformancePage
RawValueSend	Last telegram raw value received sent	1501	ReadOnly, PerformancePage
RawValueSend(hex)	Last telegram raw value received sent (hex)	1502	ReadOnly, PerformancePage
ResetOnTimeout	Reset communication when timeout error occurs.	1262	Persisted, ExpertPage
SkipAfterTermChar	Bytes rejected after termination character. Typical CRC.	1272	Persisted, ExpertPage
SkipLeft	Number of characters to skip on left side of telegram.	1073	Persisted, ExpertPage
SkipRight	Number of characters to skip on right side of telegram.	1074	Persisted, ExpertPage
Start character	If Greater or equal "0" this value is used as start character for synchronization	1269	Persisted, ExpertPage
Serial StopBits	Number of stop bits to be used. Valid only when Comm. type is Serial	1240	Persisted, Enumerated, ExpertPage
Terminating character	The character terminating the string.	1271	Persisted, Enumerated, ExpertPage
Timeout	Time-out interval, in milliseconds.	1261	Persisted, ExpertPage
Timer	Polling interval in TCP-Send mode transmit interval (seconds)	1055	Persisted
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
TraceToFile	This is used to trace detail information about the incoming data over the link	15010	Persisted, File, ExpertPage
Trim control chars	Remove control characters like <CR> <LF> <STX> etc. from telegram prior to update item. Useful when you need to receive "control" characters	1280	Persisted, ExpertPage
IP protocol	Protocol type TCP/UDP. Valid only when Comm. type is Winsock	1312	Persisted, Enumerated

See also Module Properties

Commands And Events

The Interpreter module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
DataReady	Event indicating that new data is ready, i.e. item is updated with new value an timestamp. Use case: Connect HandleExteralItems on consuming modules to this event to instantly transfer value.	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
StartSend	Triggers send of SendItems when Direction is Write or Write->Read.	Asynchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS Interpreter Item Types

Topics Covered:

Properties

A Interpreter item, built from raw data or measurement elements

The InterpreterItem item type has the following properties:

Name	Description	ID	Flags
Address	Position of field to interpret when multiple items in one telegram.	5020	Persisted
CRC calculation	CRC calculation. On InterpreterItem check CRC on telegram. On InterpreterSendItem generate CRC	10010	Persisted, Enumerated
CRC position	The position of CRC from RIGHT
CRC order	Byte order of multibyte CRC. MSB/LSB	10022	Persisted
CRC Skip Left	The number of bytes to exclude from CRC calculation left.	10030	Persisted
CRC Skip Right	The number of bytes to exclude from CRC calculation right.	10040	Persisted
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Offset	The linear transformation addend to use when calculating and item value. (Value = RawValue * Scale + Offset)	5006	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Scale	The linear transformation multiplier to use when calculating the item value. (Value = RawValue * Scale + Offset)	5005	Persisted
Update only on change	Update timestamp only when value changes.	10005	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Unit	EU units - this is the unit this item value uses. For example: centimetres, kilograms, kilowatts, etc.	100	Persisted
Value	The current value of the item.	2	ReadOnly

Properties

A Interpreter item, built from raw data or measurement elements

The InterpreterItem item type has the following properties:

Name	Description	ID	Flags
Address	Position of field to interpret when multiple items in one telegram.	5020	Persisted
CRC calculation	CRC calculation. On InterpreterItem check CRC on telegram. On InterpreterSendItem generate CRC	10010	Persisted, Enumerated
CRC position	The position of CRC from RIGHT
CRC order	Byte order of multibyte CRC. MSB/LSB	10022	Persisted
CRC Skip Left	The number of bytes to exclude from CRC calculation left.	10030	Persisted
CRC Skip Right	The number of bytes to exclude from CRC calculation right.	10040	Persisted
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Offset	The linear transformation addend to use when calculating and item value. (Value = RawValue * Scale + Offset)	5006	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Scale	The linear transformation multiplier to use when calculating the item value. (Value = RawValue * Scale + Offset)	5005	Persisted
Update only on change	Send value only when value has changed.	10005	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Unit	EU units - this is the unit this item value uses. For example: centimetres, kilograms, kilowatts, etc.	100	Persisted
Value	The current value of the item.	2	ReadOnly

Properties

Toggle this value to force write in Write mode

The CommandItem item type has the following properties:

Name	Description	ID	Flags
Description	Toggle this item to connect to the Interpreter server; true: is connect, false: is disconnect	01	Persisted
ExtItemOverrideMethod	This attribute decides what method to use when assigning a value from an external item.	5999	Persisted, Enumerated, BitMask
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
ResetCommand	Reset when value has been sent (Write Mode).	10110	Persisted
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
Parent	The Item handle of the parent item to this item, an item in the same module as this item.	5500

The Parent attribute must be added manually and must point to InterpreterSendItem to be sendt.

Properties

Item telling if module is connected to the Interpreter server; true: is connected, false: is disconnected

The State Item item type has the following properties:

Name	Description	ID	Flags
Description	Item telling if module is connected to the Interpreter server; true: is connected, false: is disconnected.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Apis Java

This module connects to an Java application using JNI, exchanging data with Apis. Module is called ApisJava.

Provider: Prediktor

The Java module has the following item types

Properties

The Java module has the following properties:

Name	Description	ID	Flags
AddItembufferSnaphostAvg	The average duration in milliseconds of adding item snaphots	1530	PerformancePage
ApplicationFilePath	The file path in which the applicationsfiles should reside	1152	Persisted, Folder
AutoDeletePersistenceItems	If PersistedStateDestination is Items (or Both files and items) items will be created behind the scenes in which the states will be stored. An item of this type will be removed if the last persistence action did not include the state which corresponds to this certain item and this property is set to true. The reason why one might to turn off this option is to reduce the time spent on persisting the states	1590	Persisted, ExpertPage
Dbg-ExceptionHandlerMode	This value determines how an exception is handled. ONLY USE FOR DEBUGGING PURPOSES!	3000	Persisted, Enumerated, ExpertPage
EventReportLevel	The level of the reported events from the java application. (E.g. if Warning is chosen, Warning and Alarm events will be reported, but the Information events will not.)	1197	Persisted, Enumerated
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
ExternalItem report	A status-report for the External Item manager of this module	110	InfoPage
ItemWriteMasking	Set the quality level of items that will be written to the Java application from this module	1200	Persisted, Enumerated, ExpertPage
JavaAppStartfile	Name of file which the Java-application will open when it is first started by the ApisJavaBee. The path of this file is set in the ApplicationPath property	1150	Persisted
JavaAppVisible	If false all of the windows of this Java-application shall be closed.	1140	Persisted, ExpertPage
LibraryFilePath	The file path in which library files should reside	1154	Persisted, Folder
MaxItemBufferSize	The maximum time steps item values will be buffered	1195	Persisted
NativeJavaClass	The java class which contains the defintion of the native C-functions	1090	Persisted, ReadOnly, ExpertPage
OneStepTimeLapse	The duration in milliseconds of the previous call to 'OneStep' function	1500	PerformancePage
OneStepTimeLapseAvg	The average duration in milliseconds of all calls to 'OneStep' function	1505	PerformancePage
OneStepTimeLapseJavaAvg	The average duration in milliseconds of all calls to 'OneStep' function, inside the java application.	1525	PerformancePage
OneStepTimeLapseMax	The maximum duration in milliseconds of any call to 'OneStep' function	1510	PerformancePage
PersistedStateDestination	Decides where the destination of the persisted states. They may be persisted to File(s), Item(s), or Both. State persistence is turned off by selecting None	1570	Persisted, Enumerated, ExpertPage
PersistValToInitVal	Choose strategy for copying and persisting current value to the InitValue. Tip: Consider using an InitVQTFromHoneystore attribute instead, for better performance.	1220	Persisted, Enumerated, ExpertPage
RMIServerInfo	The complete RMI Server info, if applicable, of the Java application	1550	InfoPage
Run	States whether the java application is simulating. (I.e . whether the OnOneStep() java method should be called on regular basis.)	1095	Persisted
SaveAction	Determines when the java application will be saved	1148	Persisted, Enumerated, ExpertPage
StartupJavaClass	The java class which contains the startup method (StartupMethod)	1040	Persisted, ReadOnly, ExpertPage
StartupJavaMethod	The static method which will be called after the JVM and the StartupJavaClass have been loaded	1050	Persisted, ReadOnly, ExpertPage
StateFileFolder	The folder in which the file(s) recides (Working folder)	1600	Persisted, ExpertPage
StateLoggers	The loggers which will log the state if PersistedStatesDestination is Items	1580	Persisted, ExpertPage
SupportsAttributes	If true the java application supports item-attribute reflection	1610	ReadOnly, Hidden
SupportsItemsPersistence	True if state can be persisted to items	1620	ReadOnly, Hidden
SupportsPrimitiveArrays	Indicates whether primitive array transfer is supported (this is a more optimal way of transferring vectors and matrices)	1560	ReadOnly, Hidden
Timer	A timer which generates events. If set to less than 50, the timer is not active.	1160	Persisted
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
TimeStep	The time step in the java application (ms)	1159	Persisted

See also Module Properties

Commands And Events

The Java module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
OneStepDone	An event indicating that the OnOneStep() java method is finished.	Normal
OnTimer	An event fired when at a rate given by the ModelRefreshInterval or Timerperiod property	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
OneStep	A command calling the OnOneStep() java method.	Asynchronous
RefreshTimestamps	Will force refresh of the time stamps of items (Scalar, Vector and Matrix).	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS Java Item Types

Topics Covered:

Properties

Scalar value of arbitrary type.

The Scalar item type has the following properties:

Name	Description	ID	Flags
InputValue	If true, this item is an input value into the Java-application (Write). If it's set to false, then this value is an output from the Java-application (Read).	10030	Persisted
Itemtype	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	10020	Persisted, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Vector value of arbitrary type

The Vector item type has the following properties:

Name	Description	ID	Flags
Dimension	The dimension of a vector item (number or elements).	5007	Persisted
InputValue	If true, this item is an input value into the Java-application (Write). If it's set to false, then this value is an output from the Java-application (Read).	10030	Persisted
Itemtype	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	10020	Persisted, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Matrix value of arbitrary type

The Matrix item type has the following properties:

Name	Description	ID	Flags
Columns	The number or columns in matrix item.	5009	Persisted
InputValue	If true, this item is an input value into the Java-application (Write). If it's set to false, then this value is an output from the Java-application (Read).	10030	Persisted
Itemtype	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	10020	Persisted, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Rows	The number of rows in a matrix item.	5008	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Item that holds a time value

The TimeItem item type has the following properties:

Name	Description	ID	Flags
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Item which contains a value of a state

The PersistenceItem item type has the following properties:

Name	Description	ID	Flags
PersistenceHierarchy	A string array containing the persistence hierarchy.	10200	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
Valuetype	Item canonical datatype. This is the type of data the field holds. For example: integer, string, datetime, etc.	10100	Persisted, Enumerated

Properties

Contains the file name of a file in which states will be stored

The StateFileItem item type has the following properties:

Name	Description	ID	Flags
FileAccess	Decides whether the file specified in the item is in read, write, or read/write mode (Read=0, Write=1, Read/Write=2).	10300	Persisted, Enumerated
ForceStopBeforeRead	This property will force the application to go to a "STOPPED" state before loading the state file. If this attribute is false, the application must be put in the "STOPPED" state manually.	10330	Persisted
IncludeStateFileFolder	If this property is true, the state file will be put in the "StateFileFolder", otherwise it will be stored in the current directory.	10320	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
TriggerOnChange	If true, the state file will be read/written to when the item changes.	10310	Persisted
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Will trigger read/write of states

The StateTriggerItem item type has the following properties:

Name	Description	ID	Flags
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
ReadStates	If this property is set to "true", it triggers the reading of states, if "false" it triggers writing.	10400	Persisted
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Performs a specific command when set to true. The command is decided by attribute COMMAND (10500)

The CommandItem item type has the following properties:

Name	Description	ID	Flags
CommandType	This attribute allows you to select the type of command to use.	10500	Persisted, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Reset	Setting this property to true will perform a reset in the java application on the next iteration.	10700	Persisted
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Contains the current status of the module represented as an integer. UNDEFINED = 0, STOPPED = 1, RUNNING = 2, WAITINGFORSTOP = 3, LOADING = 4, LOADED = 5

The StatusItem item type has the following properties:

Name	Description	ID	Flags
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
StatusAsString	Set this property to display the current status as a string instead of an integer.	10600	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Apis Logger

This module stores item data into the Apis Honeystore real-time trend historian. Data are retrieved through the Apis OPC HDA server and the APIS Hive UA server. Any OPC HDA and UA client can then access the data.

Global attributes

The Apis Logger registers 2 global attributes to the Hive:

The regular global boolean attribute that turns trending on/off for the item in question, given the same name as the Apis Logger module itself, ie. LoggerName
A global expression attribute that when used, represents an expression to be applied upon the value before it is stored to the database. The attribute is given the name LoggerName_Expr.

Logging of raw values (VQTs)

To store the raw VQTs of an item into a timeseries, you simply add the regular logger attribute (named LoggerName) to that item, and set its value to true.

Logging of calculated values (VQTs)

To store a derived, calculated value instead of the raw value, you also add the global expression attribute (name LoggerName_Expr) to the item, and specify the desired expression. You will also have to add and set the regular logger attribute to the item, and set its value to true.

When storing a calculated value, instead of the raw value, i.e. using the LoggerName_Expr attribute, the value type of the samples will always be 8 byte float, and the HDA quality part will be Calculated. Further, the name of the item in the HoneyStore database, will be the same as in the case of plain logging; the item ID in the Hive configuration.

Valid Expressions are the same as for the Calculations Operator of Function items. Here is one limiteation however, you cannot use more than a single external input to the expression. Meaning just a single ex1 is allowed in the Expression.

Hint: If you would like to trend both the raw, as well as a calculated value of an item, you will need to use 2 different Apis Logger modules, targetting to different HoneyStore databases.

Provider: Prediktor

Properties

The Logger module has the following configuration properties:

Tells how to recycle the databases in the databasename pool, when Log-switch item triggers a change of active database.

None (no database pooling) - reuse existing database name.
The current database is renamed by appending its creation date and time to its name, and a new database is created having same name as before, or named according to the value of Log-switch new database name item.
When strategy is None, the Log-switch databasename pool is ignored.
Sliding (first always active) - means that the first database in the pool always is the active, a switch simply shifts the history of the first to second, second to third and last to nothing.
When strategy is Sliding, the Log-switch databasename pool must contain at least one database name.
Circular (next in pool active) - means that the next database in the pool will set as the active when a switch is triggered.
When strategy is Circular , the Log-switch databasename pool must contain at least one database name.

|1718|Persisted, Enumerated, ExpertPage| |DefaultLogAttributeValue|The default value of the global log attribute when added to items. Note! If you change this property, you need to restart the Hive instance to make it take effect.|1600|Persisted, ExpertPage| |FlushingStrategy|Determines the strategy to use when temporarily flushing the whole cache file to disk.|3010|Persisted, Enumerated, ExpertPage| |FreshestValue|When TRUE, all items will be read directly from their physical source to receive the freshest possible values.|2010|Persisted, ExpertPage| |Historylength_Unit|Total length of historical data in database is given by multiplying this property with the Historylength_X property.|1410|Persisted, Enumerated| |Historylength_X|Total length of historical data in database is given by multiplying this property with the Historylength_Unit property.|1400|Persisted| |Log timestamp-filter item|A reference to an item giving a maximum timestamp filter for item value imestamps. Items having timestamps newer than this filter value, will not be logged. Only applies when Recordtype is Eventbased.|1750|Persisted, ApisItem, ExpertPage| |Log-enable item|When the value of this item is 'true', the module is logging timeseries.
When value is 'false', logging is disabled.|1740|Persisted, ApisItem, ExpertPage| |LogOnStart|When 'true' and property RecordType is 'Eventbased...', a sample will be written to the database at every time the mode of the database changes to Online, every time a 'LogEnable' item goes true and everytime the module enters the 'Started' runningstate.|1650|Persisted, ExpertPage| |LogStateResolution|If using any of 'Log-switch item', 'Log-enable item', 'Log-trigger item' or 'Log-switch new database name item' properties, this is the internal polling period in Apis when checking for updated item states.|1690|Persisted, ExpertPage| |Log-switch databasename pool|A pool of databasenames that will be re-used when the Log-switch item toggled. If this pool is empty, the current database name (according to Database-property) will be re-used and the previous database will be set to read-only and renamed by appending the creation-date to its name.|1720|Persisted, ExpertPage| |Log-switch item|

Set to an item that will control when active log/database is switched.

If ie. the current database will be renamed, set in read-only mode and a new database will be started. If set to a boolean item; log switches when value toggles 'false' to 'true'. If set to a non-boolean item; log switches when value changes.

This property determines how data logged by this module, is stored to the database:

Sampled
Stores data, without quality info, at a regular time interval given by Resolution
Sampled with quality
Stores data, with quality info, at a regular time interval given by Resolution
Eventbased with quality
Stores data, with quality and timestamp info, whenever data (Value, quality or timestamp) changes. The data is scanned for changes at a regular time interval, given by Resolution

|1210|Persisted, Enumerated| |Resolution|When 'Recordtype' is one of the sampled options, this is the sampling period in seconds. If 'Recordtype' is 'Eventbased with quality', this is the internal polling period in Apis when checking for updated item values.|1300|Persisted|

Informational properties:

Performance properties:

See also Module Properties

Commands And Events

The Logger module has the following Commands and Events:

Events

Name	Description	Event Type
LogDone	An event notifying that a Log-cycle issued by the log-command of this LoggerBee instance has completed.	Normal

Commands

Name	Description	Command Type
Log	A command initiating a Log cycle of the items logged by this LoggerBee instance.	Synchronous
Log_DataPush	This command ensure that all items and samples in the data push package, are stored to the HoneyStore database where applicable. See also: APIS data transfer mechanism; Data Push	Synchronous

See also Commands And Events

Apis LVEstimator2

Module for performin latent variable estimations

Provider: Prediktor

The LVEstimator2 module has the following item types

Command item

Model//Group result item

Properties

The LVEstimator2 module has the following properties:

Name	Description	ID	Flags
Active model list	Debug only. Comma separated list of active models	1080	Persisted
CalculationTime	The calculation time	11000	PerformancePage
Command timeout	The time, in seconds, to wait for commands to complete	1060	Persisted
Connection timeout	The time, in seconds, to wait for the datasource connection to become open	1050	Persisted
Custom connection string	Used to connect to other datasources than an sql/odbc server. This property overrides the four previous settings	1040	Persisted
Database name	The database that contains models	1015	Persisted
Database server	The server machine where the database exists, used in connection string.	1010	Persisted
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
ExternalItem report	A status-report for the External Item manager of this module	110	InfoPage
ExtItemCalculationSequence	Decides whether data validation or data transfer will be performed first in the external item manager.	300	Persisted, Enumerated, ExpertPage
Model refresh interval	How often, in seconds, to refresh models from the database. 60 seconds is minimum. If lower, this feature will be disabled.	1090	Persisted
Password	The password used to log on to the database	1030	Persisted, Password
PersistValToInitVal	Choose strategy for copying and persisting current value to the InitValue. Tip: Consider using an InitVQTFromHoneystore attribute instead, for better performance.	1650	Persisted, Enumerated
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
Username	The username used to log on to the database	1020	Persisted, User

See also Module Properties

Commands And Events

The LVEstimator2 module has the following Commands and Events:

Events

Name	Description	Event Type
Calculate models done	Calculate models done.	Normal
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
Fetch models done	Fetch models done	Normal
OnTimer	An event fired when at a rate given by the ModelRefreshInterval or Timerperiod property	Normal
Start to calculate models	Start to calculate models	Normal
Start to fetch models	Start to fech models	Normal
Start to set the input vector and do calculations	Start to set the input vector and do calculations	Normal

Commands

Name	Description	Command Type
Fetch models	Fetch models	Asynchronous
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
Normal spectrum set	Normal spectrum set	Asynchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS LVEstimator2 Item Types

Topics Covered:

Properties

An item representing commands

The Command item item type has the following properties:

Name	Description	ID	Flags
Command	This attribute allows you to select the type of command to use.	10001	ReadOnly, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Item representing the result of an LV estimation

The Model//Group result item item type has the following properties:

Name	Description	ID	Flags
Model database ID	The database ID of the model.	10003	Persisted, ReadOnly
Model group database ID	The database ID of the model group.	10005	Persisted, ReadOnly
Model group name	The name of the model group.	10004	Persisted, ReadOnly
Model name	The name of the model.	10002	Persisted, ReadOnly
Model/group parameter name	The name of a model group parameter.	10006	Persisted, ReadOnly
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

An item representing a incoming spectrum

The Spectrum item item type has the following properties:

Name	Description	ID	Flags
Dimension	The dimension of a vector item (number or elements).	5007	Persisted
ExtItemOverrideMethod	This attribute decides what method to use when assigning a value from an external item.	5999	Persisted, Enumerated, BitMask
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

An item representing an result/outgoing spectrum

The Spectrum item item type has the following properties:

Name	Description	ID	Flags
Dimension	The dimension of a vector item (number or elements).	5007	Persisted
Model database ID	The database ID of the model.	10003	Persisted, ReadOnly
Model group database ID	The database ID of the model group.	10005	Persisted, ReadOnly
Model group name	The name of the model group.	10004	Persisted, ReadOnly
Model name	The name of the model.	10002	Persisted, ReadOnly
Model/group parameter name	The name of a model group parameter.	10006	Persisted, ReadOnly
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

XML source of the model

The Model XML item type has the following properties:

Name	Description	ID	Flags
Model database ID	The database ID of the model.	10003	Persisted, ReadOnly
Model group database ID	The database ID of the model group.	10005	Persisted, ReadOnly
Model group name	The name of the model group.	10004	Persisted, ReadOnly
Model name	The name of the model.	10002	Persisted, ReadOnly
Model/group parameter name	The name of a model group parameter.	10006	Persisted, ReadOnly
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

Estimation state

The Estimation state item type has the following properties:

Name	Description	ID	Flags
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	If true, this item is an input value into the Java-application (Write). If it's set to false, then this value is an output from the Java-application (Read).	2	NormalPage

Properties

Info items (i.e. BatchID,SampleID etc)

The Text info item type has the following properties:

Name	Description	ID	Flags
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	If true, this item is an input value into the Java-application (Write). If it's set to false, then this value is an output from the Java-application (Read).	2	NormalPage

Properties

Recipe name

The Recipe item type has the following properties:

Name	Description	ID	Flags
ExtItemOverrideMethod	This attribute decides what method to use when assigning a value from an external item.	5999	Persisted, Enumerated, BitMask
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

An item representing a incoming data vector

The Input vector item item type has the following properties:

Name	Description	ID	Flags
Dimension	The dimension of a vector item (number or elements).	5007	Persisted
ExtItemOverrideMethod	This attribute decides what method to use when assigning a value from an external item.	5999	Persisted, Enumerated, BitMask
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Apis MessageBuilderBee

An Apis module for building Apis messages based on regular Apis items

Provider: Prediktor

The MessageBuilderBee module has the following item types

Properties

The MessageBuilderBee module has the following properties:

Name	Description	ID	Flags
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
ExternalItem report	A status-report for the External Item manager of this module	110	InfoPage
MaxCountMessageFiles	MaxCountMessageFiles specifies the maximum number of MessageLog files the module writes to MessageLogDirectory before it starts to delete. The value selected must be <= 1000. Default value is 100	1110	Persisted
MessageLogDirectory	MessageLogDirectory specifies a valid directory, all messages will be written to text-files into this directory. If property is blank, no text files will be written.	1100	Persisted, Folder

See also Module Properties

Commands And Events

The MessageBuilderBee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS MessageBuilderBee Item Types

Topics Covered:

Properties

Int32Item items are used to supply ApisMessages with scalar member data

The Int32Item item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

DoubleItem items are used to supply ApisMessages with scalar member data

The DoubleItem item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

DateTimeItem items are used to supply ApisMessages with scalar member data

The DateTimeItem item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

StringItem items are used to supply ApisMessages with scalar member data

The StringItem item type has the following properties:

Name	Description	ID	Flags
FormatString	A general purpose format string, used when applying string formatting to calculate the value of this item.	5105	Persisted
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

BoolItem items are used to supply ApisMessages with scalar member data

The BoolItem item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Int64Item items are used to supply ApisMessages with scalar member data

The Int64Item item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

VectorItem items are used to supply ApisMessages with vector member data

The VectorItem item type has the following properties:

Name	Description	ID	Flags
Dimension	The dimension of a vector item (number or elements).	5007	Persisted
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

MatrixItem items are used to supply ApisMessages with matrix member data

The MatrixItem item type has the following properties:

Name	Description	ID	Flags
ColNames	All the column names in a matrix, separated by semi-colon ';'	5091	Persisted
Columns	The number or columns in matrix item.	5009	Persisted
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Rows	The number of rows in a matrix item.	5008	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

This item controls Apis Messages creation. Add all necessary message element items, and triggers generation of a new message when its value is being changed.

The Message Control Item item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
MessageTypeID	The ID for the message type of an Apis message.	5300	Persisted, Enumerated
NumGeneratedMessages	The number of messages generated from this control item since it started (start time).	10001	ReadOnly
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Apis Modbus Master

This module communicates with Modbus slave as a Modbus master using Modbus RTU or TCP

Provider: Prediktor

The Modbus module has the following item types

More information

Modbus Specifications and Implementation Guides

Characteristics of the Apis Modbus Master module:

Implements Modbus Master
Supports: Modbus TCP, Modbus RTU over TCP/IP and Modbus RTU (serial)
Support redundant slaves in TCP mode
Uses following Modbus function codes:
- 1 Read Coil status
- 2 Read Input status
- 3 Read Holding registers
- 4 Read Input registers
- 5 Force single Coil
- 6 Preset single Register
- 16 Preset multiple Registers
Supports following data types
- 2 byte signed int
- 4 byte signed int
- 2 byte unsigned int
- 4 byte unsigned int
- 8 byte unsigned int
- 4 byte float
- 8 byte float
- Unicode String
- ACSII String
Endianness
- Big-endian
- Little-endian
Bit numbering
- MSB..LSB
- LSB..MSB

Further, as an integrated module in the Apis Hive, the following optional features are available:

High performance data logging to the Apis Honeystore historian, with OPC Historical Data Access server interface

Properties

The Modbus module has the following properties:

Name	Description	ID	Flags
AdressMapping	True: Registertype base adress is subtracted from address given in SrcItemID, eg. daddr = SrcItemID - 40000 , for Holding registers	1125	Persisted
AdressOffset	True: Registers are adressed starting at zero: register 1 is adressed as 0	1127	Persisted
BaudRate	Baud rate for serial communication. Only valid when Comm. type is Serial	1210	Persisted, Enumerated, ExpertPage
Byteorder	Byte transfer order	1121	Persisted, Enumerated
COM port	The COM port to use. Only valid when Comm. type is Serial	1200	Enumerated, ExpertPage
Comm. type	Communication method, RTU(Serial), TCP, RTU over TCP/IP or None. Set to None if not connectet, to simulate signals.	1110	Persisted, Enumerated
DataBits	Number of bits in the bytes transmitted and received. Only valid when Comm. type is Serial	1230	Persisted, Enumerated, ExpertPage
Default Slaveaddress	The Slaveaddress (Unit ID) on Modbus slave, this property can be set individually on item level.	1260	Persisted, ExpertPage
Endian	Modbus is a "big-endian" protocol: that is, the more significant byte of a 16-bit value is sent before the less significant byte. It seems obvious that 32-bit and 64-bit values should also be transferred using big-endian order. However, some manufacturers have chosen to treat 32-bit and 64-bit values as being composed of 16-bit words, and transfer the words in little-endian order. For example, the 32-bit value 0x12345678 would be transferred as 0x56 0x78 0x12 0x34. Select LittleEndian to use this mixed ordering.	1120	Persisted, Enumerated
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
FlowControl	Flow control for serial communication. Only valid when Comm. type is Serial	1250	Persisted, Enumerated, ExpertPage
Function Delay	Delay between multiple function calls where inquired data is not organized continuous in modbus registers and multiple calls are required on every read cycle. (ms)	1060	Persisted
IP address	Ip Address of Modbus server. Only valid when Comm. type is TCP/IP	1310	Persisted, Computer
LastQuery	Last command to modbus slave	1500	ReadOnly, PerformancePage
LastResponse	Last modbus slave response	1501	ReadOnly, PerformancePage
Number Of Redundant Slaves	The maximum number of redundant slave for this instance, valid range is 0-2.	2000	Persisted, ExpertPage
Parity	Parity scheme for the serial communication. Only valid when Comm. type is Serial	1220	Persisted, Enumerated, ExpertPage
Port	The TCP port of Modbus server. Only valid when Comm. type is TCP/IP	1311	Persisted
Poll interval	Set this to other than 0 for a timer based polling (seconds)	1055	Persisted
Read optimization	Valid only for function codes 03 Read Holding Registers and 04 Read Input Registers. Read strategy if data is organized in series with no gap in registry. Continuous Datatype: (default) Multiple values are read of same datatype. Continuous Address: Multiple values are read regardless of datatype.
RedundantComputer_1	The computer hosting the redundant Modbus slave, if configured.	2010	Persisted, ExpertPage
RedundantPort_1	The TCP port of the redundant Modbus slave, if configured.	2011	Persisted, ExpertPage
RedundantComputer_2	The computer hosting the redundant Modbus slave, if configured.	2020	Persisted, ExpertPage
RedundantPort_2	The TCP port of the redundant Modbus slave, if configured.	2021	Persisted, ExpertPage
Socket timeout	The timeout, in seconds, for blocking send and receive calls. Only valid when Comm. type is TCP/IP	1315	Persisted
StopBits	Number of stop bits to be used. Only valid when Comm. type is Serial	1240	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
TraceToFile	This is used to trace detail information about the incoming data over the link	15010	Persisted, File, ExpertPage

See also Module Properties

Commands And Events

The Modbus module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
ReadDone	An event signalled when a read of modbus slave has finished.	Normal
WriteDone	An event signalled when a write to modbus slave has finished.	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
Start Polling	Initiate a poll from slave.	Asynchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS Modbus Master Item Types

Topics Covered:

Properties

Single bit Read-Only Starting address 0x10001 to 0x1FFFF when address mapping is active or 0 to FFFF when addressmapping deactivated

The DiscretesInput item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Read single	Force master to read this item only in a single request. Used to optimize error handling. WARNING: Enabling this feature on numerous items will affect overall performance.	10032	Persisted
External quality tag	External tag overriding quality.	10040	Persisted
External quality mask	Bitmap representing quality bits field, when External quality tag is used.	10041	Persisted
External pattern bad quality	Bit pattern determinating bad quality, when External quality tag is used.	10042	Persisted
External mask unertain quality	Bit pattern determinating unsertain quality, when External quality tag is used.	10043	Persisted
Slaveaddress	The slave address (Unit ID) of the Modbus slave (overrides the module property).	10030	Persisted
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Unit	EU units - this is the unit this item value uses. For example: centimetres, kilograms, kilowatts, etc.	100	Persisted
Value	The current value of the item.	2	ReadOnly

Properties

Single bit Read-Write Starting address 0x00001 to 0x0FFFF when address mapping is active or 0 to FFFF when addressmapping deactivated

The Coil item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Direction	Direction of data. Input (false) or Output (true).	5040	Persisted
EvaluationOrder	What order to use to evaluate the values: Apis: The value is written to the slave on every cycle; Slave: The value is read from the slave before the write. The value is only written to the slave when its changed in Apis.	10020	Persisted, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Read single	Force master to read this item only in a single request. Used to optimize error handling. WARNING: Enabling this feature on numerous items will affect overall performance.	10032	Persisted
External quality tag	External tag overriding quality.	10040	Persisted
External quality mask	Bitmap representing quality bits field, when External quality tag is used.	10041	Persisted
External pattern bad quality	Bit pattern determinating bad quality, when External quality tag is used.	10042	Persisted
External mask unertain quality	Bit pattern determinating unsertain quality, when External quality tag is used.	10043	Persisted
Slaveaddress	The slave address (Unit ID) of the Modbus slave (overrides the module property).	10030	Persisted
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Unit	EU units - this is the unit this item value uses. For example: centimetres, kilograms, kilowatts, etc.	100	Persisted
Value	The current value of the item.	2	NormalPage

Properties

16 bit word Read-Only Starting address 0x30001 to 0x3FFFF when address mapping is active or 0 to FFFF when addressmapping deactivated

The InputRegister item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Endian	Only valid when the Valuetype property is set to "Unicode String" or "ASCII". This property overrides the module's endian. Modbus is a "big-endian" protocol: that means the more significant byte of a 16-bit value is sent before the less significant byte. Be careful with 32-bit and 64-bit values, which may not be transferred using big-endian order. Some manufacturers treat 32-bit and 64-bit values as being composed of 16-bit words, and transfer the words in little-endian order. For example, the 32-bit value 0x12345678 would be transferred as 0x56 0x78 0x12 0x34. Select LittleEndian to use this mixed ordering.	10012	Persisted, Enumerated
Modulus	Value = registerhigh x Modulus + registerlow. Valid only for 4 byte signed and unsigned int	10015	Persisted, Enumerated
Offset	The linear transformation addend to use when calculating and item value. (Value = RawValue * Scale + Offset)	5006	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Read single	Force master to read this item only in a single request. Used to optimize error handling. WARNING: Enabling this feature on numerous items will affect overall performance.	10032	Persisted
External quality tag	External tag overriding quality.	10040	Persisted
External quality mask	Bitmap representing quality bits field, when External quality tag is used.	10041	Persisted
External pattern bad quality	Bit pattern determinating bad quality, when External quality tag is used.	10042	Persisted
External mask unertain quality	Bit pattern determinating unsertain quality, when External quality tag is used.	10043	Persisted
Scale	The linear transformation multiplier to use when calculating the item value. (Value = RawValue * Scale + Offset)	5005	Persisted
Slaveaddress	The slave address (Unit ID) of the Modbus slave (overrides the module property).	10030	Persisted
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
StringSize	The number of buffers to read. Only valid when "Valuetype" is "Unicode String" or "ASCII".	10011	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Unit	EU units - this is the unit this item value uses. For example: centimetres, kilograms, kilowatts, etc.	100	Persisted
Value	The current value of the item.	2	ReadOnly
Valuetype	Item canonical datatype. This is the type of data the field holds. For example: integer, string, datetime, etc.	10010	Persisted, Enumerated

Properties

16 bit word Read-Write Starting address 0x40001 to 0x4FFFF when address mapping is active or 0 to FFFF when addressmapping deactivated

The HoldingRegister item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Direction	Direction of data. Input (false) or Output (true).	5040	Persisted
Endian	Only valid when the Valuetype property is set to "Unicode String" or "ASCII". This property overrides the module's endian. Modbus is a "big-endian" protocol: that means the more significant byte of a 16-bit value is sent before the less significant byte. Be careful with 32-bit and 64-bit values, which may not be transferred using big-endian order. Some manufacturers treat 32-bit and 64-bit values as being composed of 16-bit words, and transfer the words in little-endian order. For example, the 32-bit value 0x12345678 would be transferred as 0x56 0x78 0x12 0x34. Select LittleEndian to use this mixed ordering.	10012	Persisted, Enumerated
EvaluationOrder	What order to use to evaluate the values: Apis: The value is written to the slave on every cycle; Slave: The value is read from the slave before the write. The value is only written to the slave when its changed in Apis.	10020	Persisted, Enumerated
Modulus	Value = registerhigh x Modulus + registerlow. Valid only for 4 byte signed and unsigned int	10015	Persisted, Enumerated
Offset	The linear transformation addend to use when calculating and item value. (Value = RawValue * Scale + Offset)	5006	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Read single	Force master to read this item only in a single request. Used to optimize error handling. WARNING: Enabling this feature on numerous items will affect overall performance.	10032	Persisted
External quality tag	External tag overriding quality.	10040	Persisted
External quality mask	Bitmap representing quality bits field, when External quality tag is used.	10041	Persisted
External pattern bad quality	Bit pattern determinating bad quality, when External quality tag is used.	10042	Persisted
External mask unertain quality	Bit pattern determinating unsertain quality, when External quality tag is used.	10043	Persisted
Scale	The linear transformation multiplier to use when calculating the item value. (Value = RawValue * Scale + Offset)	5005	Persisted
Slaveaddress	The slave address (Unit ID) of the Modbus slave (overrides the module property).	10030	Persisted
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
StringSize	The number of buffers to read. Only valid when "Valuetype" is "Unicode String" or "ASCII".	10011	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Unit	EU units - this is the unit this item value uses. For example: centimetres, kilograms, kilowatts, etc.	100	Persisted
Value	The current value of the item.	2	NormalPage
Valuetype	Item canonical datatype. This is the type of data the field holds. For example: integer, string, datetime, etc.	10010	Persisted, Enumerated

Properties

Command for controlling module. #Connect# Toggle this item to connect to the Modbus slave/server; true: is connect, false: is disconnect

Properties

The item #Connected# telling if module is connected to the Modbus slave/server; true: is connected, false: is disconnected.

The item #Response_Ok# telling if module is receiving valid response from the Modbus slave/server; true: is ok, false: no or invalid response.

The item #Roundtrip# Poll roundtrip (s)

Apis ModbusSlave

This module acts as an Modbus slave.

Provider: Unspecified

The ModbusSlave module has the following item types

More information

Characteristics of the Apis Modbus Slave module:

Implements Modbus Slave
Supports Read and Write.
Supports, Modbus TCP and Modbus RTU.
Supports functioon codes:
- 1 Read Coil status
- 2 Read Input status
- 3 Read Holding registers
- 4 Read Input registers
- 5 Force single Coil
- 6 Preset single Register
- 15 Force multiple Coils
- 16 Preset multiple Registers

Further, as an integrated module in the Apis Hive, the following optional features are available:

High performance data logging to the Apis Honeystore historian, with OPC Historical Data Access server interface

APIS Modbus Slave Item Types

Topics Covered:

Properties

Single bit Read-Only Starting address 0x10001 to 0x19999 when address mapping is active or 0 to FFFF when addressmapping deactivated

The DiscretesInput item type has the following properties:

Name	Description	ID	Flags
Inverted	If this attribute is true, the incoming value is inverted before writing to the Modbus register.	10070	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Slaveaddress	The slave address (Unit ID) of the Modbus slave (overrides the module property).	10030	Persisted
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly

Properties

Single bit Read-Write Starting address 0x00001 to 0x09999

The Coil item type has the following properties:

Name	Description	ID	Flags
Inverted	If this attribute is true, the incoming value is inverted before writing to the Modbus register.	10070	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Slaveaddress	The slave address (Unit ID) of the Modbus slave (overrides the module property).	10030	Persisted
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly

Properties

16 bit word Read-Only Starting address 0x30001 to 0x39999

The InputRegister item type has the following properties:

Name	Description	ID	Flags
Offset	The linear transformation addend to use when calculating and item value. (Value = RawValue * Scale + Offset)	5006	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rawvalue	The raw, untranslated value of the item.	10075	Persisted
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Scale	The linear transformation multiplier to use when calculating the item value. (Value = RawValue * Scale + Offset)	5005	Persisted
Slaveaddress	The slave address (Unit ID) of the Modbus slave (overrides the module property).	10030	Persisted
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Valuetype	Item canonical datatype in Modbus register.	10045	Persisted, Enumerated

Properties

16 bit word Read-Write Starting address 0x40001 to 0x49999

The HoldingRegister item type has the following properties:

Name	Description	ID	Flags
Offset	The linear transformation addend to use when calculating and item value. (Value = RawValue * Scale + Offset)	5006	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rawvalue	The raw, untranslated value of the item.	10075	Persisted
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Scale	The linear transformation multiplier to use when calculating the item value. (Value = RawValue * Scale + Offset)	5005	Persisted
Slaveaddress	The slave address (Unit ID) of the Modbus slave (overrides the module property).	10030	Persisted
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Valuetype	Item canonical datatype in Modbus register. This determines what kind of data this field holds. For example: string, integer, etc.	10045	Persisted, Enumerated

Commands And Events

The ModbusSlave module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

Properties

The ModbusSlave module has the following properties:

Name	Description	ID	Flags
BaudRate	Baud rate for serial communication. Only valid when Comm. type is Serial	1040	Persisted, Enumerated
Byteorder	Byte transfer order	1038	Persisted, Enumerated
COM port	The COM port to use. Only valid when Comm. type is Serial	1060	Persisted, Enumerated
Comm. type	Communication method, Serial or TCP/IP.	1025	Persisted, Enumerated
DataBits	Number of bits in the bytes transmitted and received for serial communication.	1072	Persisted, Enumerated
Default Slaveaddress	The Slaveaddress (Unit ID) on Modbus slave, this property can be set individually on item level.	1035	Persisted
Endian	Modbus is a "big-endian" protocol: that is, the more significant byte of a 16-bit value is sent before the less significant byte. It seems obvious that 32-bit and 64-bit values should also be transferred using big-endian order. However, some manufacturers have chosen to treat 32-bit and 64-bit values as being composed of 16-bit words, and transfer the words in little-endian order. For example, the 32-bit value 0x12345678 would be transferred as 0x56 0x78 0x12 0x34. Select LittleEndian to use this mixed ordering.	1037	Persisted, Enumerated
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
Exception Code	Exception code to send for testing purpose, valid only when Send Exception property is greater that 0	16010
Handshaking	Handshaking option for serial transmission	1070	Persisted, Enumerated
IP address	Endpoint Ip address of Modbus server. Only valid when Comm. type is TCP/IP	1301	Persisted
Master command timeout	Time to wait for master command in (seconds) before giving up and reset connection	1302	Persisted
Message timeout	Time interval, the active message is reported (in seconds).	1090	Persisted
Parity	Parity scheme for the serial communication. Only valid when Comm. type is Serial	1050	Persisted, Enumerated
Port	The endpoint TCP/UDP port of Modbus server. Only valid when Comm. type is TCP/IP	1300	Persisted
Send Exception	This is used to simulate exception to master for test purposes. Set value to greater that 0, to enable exception response. 1 - exception on every response 2 - exception on every second response and so on.
StopBits	Number of stop bits to be used for serial communication.	1074	Persisted, Enumerated
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
TraceToFile	This is used to trace detail information about the incomming data over the link	15010	Persisted, File, ExpertPage
Writetimeout	Time to wait (milliseconds) before giving up an attempt to write to master	1080	Persisted

See also Module Properties

Set up an Modbus Slave

Follow the guide Add Module to Apis Hive, but this time select a module of type ApisModbusSlave from the Module type drop down list, name it "ModbusSlave" in this case.

After adding the module, select the new module named "ModbusSlave" from theSolution Explorer.

Basic setup, communication interface

The module supports both serial (RTU) and TCP/IP (Modbus TCP) interface, depending on your needs. In the Properties Editor, enter values for:

TCP/IP based server:
- Comm. type: TCP/IP
- IP address: The endpoint IP address of your ModbusSlave server.
- Port: The endpoint TCP port of your ModbusSlave server.
Serial communication based server :
- Comm. type receive : Serial
- Com port: Com port connected to the slave.
- BaudRate: Baud rate of your slave serial setup.
- DataBits: Data bits of your slave serial setup.
- FlowControl: Handshake of your slave serial setup.
- Parity: Parity of your slave serial setup.
- StopBits: Stop bits of your slave serial setup.

Further in the Properties Editor:
- Default Slave address : Note! this is the initial property when new items are created.
- Assure the byte order and endianness is according to your needs
Press "Apply" when done.

Add Items (registers)

Now follow the guide Add Items to a Module, but this time select the Modbus module and add items of one of the register types:

Coil
DiscretesInput
InputRegister
HoldingRegister

Example Holding register:

Expose data

To expose data, ModbusSlave Items must be connected to a source item . See Connecting Items

The Worker.Signal1 is now exposed to Modbus masters (clients) in Holding register 40002 as 8 byte float.

Trouble shooting

If no connection or data received:

Use 3 party terminal application like putty to check if server is sending telegrams.
Check firewall settings for the port.
Check network connection to server, (ping)

ApisMQTTClientBee

This module can be used to subscribe to messages on topics from a MQTT broker. The messages can be decoded and stored in Value Items. Currently we support a simple Json formated messages. Se Json messages for details. To configure this module, set up the needed property, MQTTAddress, MQTTPort, MQTTClient (any textstring). MQTTTransport (TcpServer or TcpServerTls if security is needed).

By using secure communication (TcpServerTls) a certificate from the server will be added under default certificatepatch (..instancename/pki/rejected/xxxx.crt) . This certificate should be checked and moved to the thrusted directory to allow secure communication with this broker.

When these parameters are ok then the status-item shall show value "Connected". Add a TopicItem by right-click the module on the left side. Configure the Topic by setting the correct topic to listen to. It is possible to listen to several topics.

Then add ValueItem. Connect the Item to a topic by the property "TopicItem", and the select the correct textvalues for properties "TimeName", "QualityName", and "ValueName", (See JSONMessage).

Provider: Prediktor

Json messages

The ApisMQTTClientBee module has the following item types

Topic

Value Item

Status

ApisMQTTClientBee Item Types

Topics Covered:

Item type: Topic

Topic item class description

The Topic item type has the following properties:

Name	Description	ID	Flags
DecoderName	The name of decoder used for this topic (currently not in use)	11001	Persisted, Hidden
Quality	Item quality	3	NormalPage
Rights	Item access rights	5	ReadOnly
Time	Item timestamp	4	NormalPage
Topic	The topics to get messages from	11000	Persisted
Type	Item canonical datatype	1	ReadOnly
Value	Item value	2	NormalPage

Item type: ValueItem

ValueItem item class description

The ValueItem item type has the following properties:

Name	Description	ID	Flags
Quality	Item quality	3	NormalPage
QualityName	The name of quality in JSON-object	11111	Persisted
Rights	Item access rights	5	ReadOnly
Time	Item timestamp	4	NormalPage
TimeName	The name of time in JSON-object	11110	Persisted
TopicItem	The Topic used for this item.	11101	Persisted, APISLocalItem, DynamicEnumeration
Type	Item canonical datatype	1	ReadOnly
Value	Item value	2	NormalPage
ValueName	The name of value in JSON-object	11112	Persisted

Item type: Status

This item is used to expose internal status information

The Status item type has the following properties:

Name	Description	ID	Flags
Quality	Item quality	3	ReadOnly
Rights	Item access rights	5	ReadOnly
Time	Item timestamp	4	ReadOnly
Type	Item canonical datatype	1	ReadOnly
Value	Item value	2	ReadOnly

Commands And Events

The MQTTClientBee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified by user. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

Properties

The MQTTClientBee module has the following properties:

Name	Description	ID	Flags
Client certificate	The filename of the clients certificate when broker expect a client certificate to accept connection.	1015	Persisted, File
Exchangerate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
External item report	A status-report for the External Item manager of this module	110	InfoPage
ExtItem full refresh	When true, the external items manager will force a full refresh initially on start/reset when reading items. I.e. items not yet initialized in their source, will also trigger an external item update. Default is true.	150	Persisted, ExpertPage
ExtItem pass-through quality	Specifies the quality of external item values that will pass through external item transfers. If external item qualities has worse quality the this mask, the external item transfer is blocked. Default is 'Any quality'.	400	Persisted, Enumerated, ExpertPage
Loglevel	Specifies the loglevel for diagnostic messages from this module.	500	Persisted, Enumerated
MQTT address	Address to MQTT broker	1002	Persisted
MQTT clean session	If selected then the client will not get history messages the broker has stored for this clientid since last disconnection.	1009	Persisted
MQTT clientid	A string that define/identify the clients session at the broker.	1004	Persisted
MQTT password	The clients password.	1006	Persisted, Password
MQTT port	MQTT broker port	1003	Persisted
MQTT service level	Quality of service	1008	Persisted, Enumerated
MQTT transport	Transmission protocole: TcpServer, use unencrypted communication. TcpServeTLS use encrypted communication.	1011	Persisted, Enumerated
MQTT user	The clients username.	1005	Persisted
MQTTVersion	Version to use when connecting to server	1010	Persisted, Enumerated

See also Module Properties

JSON messages

Currently we support a simple Json format

JSON Message

This is an example of a format this Bee can decode. For each Value Item you need to configure where to get the value, time, and quality from.

One example of a configuation for a Iremvalue would be:

TimeName t

Qualityname q

ValueName ai0

this will gives a value with the VQT( 27.923456789 ,192, 2020-09-29T12:55:52.5972965Z)

TimeName t

Qualityname q

ValueName A[2]

this will gives a value with the VQT(28.123456789000004 ,192, 2020-09-29T12:55:52.5972965Z)

Json-message example

{

"c": 5779,

"t": "2020-09-29T12:55:52.5972965Z",

"q": 192,

"ai0": 27.923456789,

"ai1": 28.923456789,

"ai2": 29.923456789,

"ai3": 30.923456789,

"ai4": 31.923456789,

"ai5": 32.923456789,

"ai6": 33.923456789,

"ai7": 34.923456789,

"ai8": 35.923456789,

"ai9": 36.923456789,

"ai10": 37.923456789,

"A": [

27.923456789,

28.023456789,

28.123456789000004,

28.223456789,

28.323456789,

28.423456789,

28.523456789,

28.623456789000004,

28.723456789,

28.823456789

]

}

Apis OPC

The Apis OPC Client module connects the Apis system to an OPC Data Access Server. An OPC Data Access Server is a software driver that enables a standard way of accessing real-time data from a system. For further information about OPC technology, see: http://www.opcfoundation.org/.

Provider: Prediktor

The OPC module has the following item types:

More information

Characteristics of the ApisOPCBee Client module:

Implements an OPC Data Access 1.01a and 2.05a client.
Supports both polling and subscriptions when reading data.
Supports both asynchronous and synchronous writing.
Automatically re-connects if connection to the OPC Server breaks down (such as temporarily loss of network connections etc.)

Further, as an integrated module in the Apis Hive, the following optional features are available:

High performance data logging to the Apis Honeystore historian, with OPC Historical Data Access server interface
Enhances OPC DA 1.01a servers to OPC DA 2.05a servers
Cross connection between OPC servers, or cross connection between an OPC server and another Apis Access module
Conventional and Advanced Control with Apis Soft PLC or Apis Advanced Soft Controller
Access to OPC data, through Apis Process Explorer WEB application, as well as other Apis report generation tools.

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: none=0 Restart if update interval > ReconnectTime Restart if watchdog item(s) update interval > ReconnectTime Restart if watchdog item(s) update or bad quality interval > ReconnectTime	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

Commands And Events

The OPC module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
ServerConnected	The OPC server if connected.	Normal
ServerDataChange	The OPC server has sent a subscription based data change notification.	Normal
ServerFirstTimeDataChanged	The OPC server has sent a subscription based data change notification first time after reconnect.	Normal
ServerShutdown	The OPC server has sent a shutdown notification.	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
ResetExternalItems	Resets the external item manager, by forcing a full refresh of all external items when the 'HandleExternalItems' is fired next time.	Synchronous
Reconnect	Reconnects to the OPC server.	Asynchronous
Reset	Resets the OPC items in the client by performing a synchronous read from server.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

APIS OPC Item Types

Topics Covered:

OPC Item

An item in an OPC server

The OPC Item item type has the following properties:

Standard

Name	Description	ID	Flags
SrcItemID	Item ID in source	5030	Persisted

Advanced

Name	Description	ID	Flags
ActiveInServer	True when this item is active in the OPC server.	10110	ReadOnly, ExpertPage
LocalOverrideToBad	If true, a good:local override item quality from the server will be remapped to a bad quality.	10130	Persisted, ExpertPage
ReqVartype	The type requested to be delivered for the value of this item from the server. Only change this one for special situations.	10100	Persisted, Enumerated, ExpertPage

Information

Name	Description	ID	Flags
Client handle	The client handle of the item, as registered with the OPC sever. When negative, the item has not been accepted by the OPC server.	10160	ReadOnly, InfoPage

Command Item

An item that represents a command to apply on this module.

The Command Item item type has the following properties:

Name	Description	ID	Flags
Command argument 1	This attribute may be used by an item to specify additional arguments.	10150	Persisted
Command type	This attribute allows you to select the type of command to use.	10140	Persisted, ReadOnly, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Trans OPC Item

An OPC item with automatic calculation of a linear transformation.

The Trans OPC Item item type has the following properties:

Name	Description	ID	Flags
ActiveInServer	True when this item is active in the OPC server.	10110	ReadOnly, ExpertPage
Client handle	The client handle of the item, as registered with the OPC sever. When negative, the item has not been accepted by the OPC server.	10160	ReadOnly, InfoPage
LocalOverrideToBad	If true, a "good:local" override item quality from the server will be remapped to a "bad" quality.	10130	Persisted, ExpertPage
Offset	The linear transformation addend to use when calculating and item value. (Value = RawValue * Scale + Offset)	5006	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
ReqVartype	The type requested from the server for the value of this item. Only change this property in special circumstances.	10100	Persisted, Enumerated, ExpertPage
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Scale	The linear transformation multiplier to use when calculating the item value. (Value = RawValue * Scale + Offset)	5005	Persisted
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

State Item

An item that represents a well defined state of this module.

The State Item item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Item type: Module State Items

An item which retrieves status information from the module

The Module state items item type has the following properties:

Name	Description	ID	Flags
Item type	The item type this item aggregates statistics on, when applicable. Use the number inside the parentheses in "FileAdd" configuration files.	19001	Persisted, ReadOnly, DynamicEnumeration
Module state	The kind of module state information represented by this item. This can be a number of items having a given quality, a total number of items, the time the newest/oldest item was updated. Use a number inside the parentheses in "FileAdd" configuration files.	19000	Persisted, ReadOnly, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Item type: Item Attribute Items

An item which exposes an attribute of another item in the module

The Item attribute items item type has the following properties:

Name	Description	ID	Flags
Attribute ID	The ID of the attribute this item exposes from an item.	19002	Persisted, ReadOnly, DynamicEnumeration
ParentItem	The parent item name of this item.	5502	Persisted, ReadOnly, ApisLocalItem
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Apis OpcUa

This module connects to an OPC server, and provides access to OPC items.

Provider: Prediktor

The OpcUa module has the following item types

OPC UA catch-up

OPC UA Catch-up

Properties

The OpcUa module has the following properties:

Enables data catchup functionality of the communication.

NoCatchup: No data catchup, just pure real-time communication.
SerializedCatchup: Historical data is streamed through Hive sample-by-sample, until we have caught up real-time. Note that this requires the UA server to implement the OPC UA HA profile!
SerializedCatchup_PauseAfterInitial: Same as 'SerializedCatchup', but with one stop in playback sequence after first StepNext, use CommandItem #ContinueCatchup# to continue playback sequence.
PartialCatchup: Only data missing locally, per item, is read from remote server and streamed through Hive, sample-by-sample, until we have caught up real-time.
PartialCatchup_PauseAfterInitial: Same as 'PartialCatchup', but with one stop in playback sequence after first StepNext, use CommandItem #ContinueCatchup# to continue playback sequence.

Note that to fully benefit from using catchup, the UA server is required to implement the OPC UA HA profile!

More details on how to use catchup can be found here.

How to generate item names on items from the UA NodeID, DisplayName and/or BrowseName. Set of predefined choices, or a custom string, containig following specifiers:

{dn} = DisplayName
{bn} = BrowseName
{ni} = NodeId

Example: {bn}mystring{dn}

|1020|Persisted, Enumerated, ExpertPage| ItemNameSeparator|A character or string used when concatenating item names. Applies only when ItemNameFormat is ConcatenateDisplayName or ConcatenateBrowseName.|1022|Persisted, ExpertPage| LifetimeCount|Requested lifetime count. The lifetime count shall be a minimum of three times the keep keep-alive count. When the publishing timer has expired this number of times without a Publish request being available to send a NotificationMessage, then the Subscription shall be deleted by the Server.|1052|Persisted, ExpertPage| MaxKeepAliveCount|Requested maximum keep-alive count. When the publishing timer has expired this number of times without requiring any NotificationMessage to be sent, the Subscription sends a keep-alive Message to the Client. The negotiated value for this parameter is returned in the response. If the requested value is 0, the server shall revise with the smallest supported keep-alive count.|1051|Persisted, ExpertPage| NotificationsPerPublish|The maximum number of notifications that the Client wishes to receive in a single Publish response. A value of zero indicates that there is no limit. The number of notifications per Publish is the sum of monitoredItems in the DataChangeNotification and events in the EventNotificationList.|1053|Persisted, ExpertPage| PublishingInterval|This interval defines the cyclic rate that the Subscription is being requested to return Notifications to the Client. This interval is expressed in milliseconds. The negotiated value for this parameter returned in the response is used as the default sampling interval for MonitoredItems assigned to this Subscription. If the requested value is 0 or negative, the server shall revise with the fastest supported publishing interval.|1050|Persisted| QualityOverriding|This property controls whether the module itself is allowed to set item qualities, in some situations. If 'when connection lost', qualities will be set to 'Bad: not connected', when connection to ua server gets lost. If 'when write fails', qualities will be set to whatever the write class returned when a failed write happens. If set to 'never', no qualities other than what is received from the UA server will be set on item qualities. Note: this property only applies when CatchupMode = NoCatchup.|1340|Persisted, Enumerated, ExpertPage| Server|The OpcUa connection or OpcUa cluster item to use for the server connection.|1000|Persisted, Enumerated| ServerWatchdog|A strategy for server communication monitoring. This can be useful when dealing with erronous servers that stop to operate correctly.|1360|Persisted, Enumerated, ExpertPage| ServerWatchdogItems|Set to one or more local items, when using ServerWatchdog = 'Restart if watchdog item(s) update interval > ReconnectTime'|1365|Persisted, ApisLocalItem, 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)|1218|Persisted, ExpertPage| StandardPropSync|

When to synchronize selected OpcUA Standard Properties from server nodes to local apis item attributes (Unit, EU).

never
first time adding item
each ua session

|1310|Persisted, Enumerated, ExpertPage| SubscriptionActive|Active flag for the subscription.|1300|ExpertPage| StandardPropSync|When to synchronize selected OpcUA Standard Properties from server nodes to local apis item attributes (Unit, EU).|1310|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| TraceLogLevel|The level of trace messages to log.|1420|Persisted, Enumerated, 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.|1400|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.|1410|Persisted, File, ExpertPage| TraceToFileVerbosity|Specifies how much information that are written to the trace-file, if property 'TraceToFile' is set to a valid file. (Property ID: 1411)|1411|Persisted, File, Enumerated, ExpertPage| UseApisTime|Use Apis timestamps instead of the timestamps given by the OPC server.|1223|Persisted, ExpertPage| WriteMode|How items are being written to the server. Synchronous: items are written through a blocking call; Asynchronous; items are written through a non-blocking call. When the module is data, it might be desirable to do so without blocking any executing thread/operation, like any other eventbroker commands configured on the same eventbroker event, i.e. like External items transfer.|1201|Persisted, Enumerated| WriteTimeStamp|Select the timestamp to include, if any, when writing a data value to the OPCUA server.|1500|Persisted, ExpertPage|

Informational properties:

Performance properties:

Connection properties:

The following properties have been deprecated by the introduction of the Server property.
When the Server property is set to "<Custom configuration>", the properties in this list behave as in prior versions of Apis Hive. When the Server property is set to an OpcUa connection or OpcUa cluster, the properties in this list gets the additional flags ReadOnly and Hidden (except the ServerEndpoint property, which becomes ReadOnly but not Hidden; this property can then be used to check which server endpoint is active when connecting to an OpcUa cluster).

Anonymous
Username/password

Use this property to specify which certificate the OpcUaBee should use when connecting to the server.

When property 'PkiType' is 'Win32', this property specifies the subject-name of a certificate in the Windows Certificate Store. Typically this will be the name of the ApisHive instance.

Example using Win32: "ApisHive"

When property 'PkiType' is 'OpenSSL', this property specifies the name of a certificate file in the '<certificatestore>\trusted' folder.

Example using OpenSSL: "ApisHive.der"

|1042|

Persisted, File

(ReadOnly, Hidden)

| |CertificateStorePath|

This property specifies where the OpcUaBee should look for certificates. Default value is empty.

If PkiType is "Win32", this property specifies a folder within the Windows Certificate Store. If the property is empty, the OpcUaBee will use the value "UA Applications".

If PkiType is "OpenSSL", this property specifies a file system path relative to the ApisHive instance configuration folder. If the property is empty, the OpcUaBee will use the value "pki", which resolves to the folder "<APISDir>\Config<InstanceName>\pki".

|1041|

Persisted, Folder

(ReadOnly, Hidden)

| |MessageSecurity|

This property sets the required security level for OpcUa messages. When setting this property, you may also have to set others.

If set to:

Unsecure: You must set 'SecurityPolicy' to 'None'.
'Signed' or 'Signed and encrypted:' You must sprecify a 'SecurityPolicy' other than 'None'

|1045|

Persisted, Enumerated

(ReadOnly, Hidden)

| |NetworkTimeout|

This property specifies the timeout period for RPC messages sent to the OpcUa server, measured in milliseconds. Default is 5000.

|1111|

Persisted

(ReadOnly, Hidden)

| |PkiType|

This property selects which certificate handling implementation to use (PKI=Public Key Infrastructure). The options are:

OpenSSL: using the filesystem to access certificates
Win32: using the Windows Certificate Store.

|1040|

Persisted, Enumerated

(ReadOnly, Hidden)

| |Password|

Password used to authenticate with server. Only applies when the property 'Authentication' is 'Username/password'.

|1003|

Persisted

(ReadOnly, Hidden)

| |PrivateKeyPath|

This propery is used to select the private key for the active certificate.

When PkiType is 'OpenSSL', the property specifies the name of a key-file in the "<certificatestore>\private" folder, encoded in PEM format. Typically, if CertificatePath is "ApisHive.der", PrivateKeyPath would be "ApisHive.pem".

When PkiType is 'Win32', this property is ignored (the Windows Certificate Store handles the link between certificates and their private key).

|1043|

Persisted, File

(ReadOnly, Hidden)

| |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.

This property is identical to the CertificatePath property, but for the redundant server.

This property is identical to the CertificateStorePath property, but for the redundant server.

This property is identical to the MessageSecurity property, but for the redundant server.

|1545|

Persisted, Enumerated, ExpertPage

(ReadOnly, Hidden)

| |RedundantPkiType|

This property is identical to the PkiType property, but for the redundant server.

|1540|

Persisted, Enumerated, ExpertPage

(ReadOnly, Hidden)

| |RedundantPrivateKeyPath|

This property is identical to the PrivateKeyPath property, but for the redundant server.

|1543|

Persisted, File

(ReadOnly, Hidden)

| |RedundantSecurityPolicy|

The OpcUa securitypolicy URI do use when connecting to the redundant server. Default value is "http://opcfoundation.org/UA/SecurityPolicy#None"

|1546|

Persisted, Enumerated

(ReadOnly, Hidden)

| |RedundantServerCertificatePath|

Path/name of redundant server certificate. This property must refer to a valid certificate when RedundantMessageSecurity is either "Signed" or "Signed and encrypted".

|1544|

Persisted, File, ExpertPage

(ReadOnly, Hidden)

| |RedundantServerEndpoint|

The Endpoint URL of any redundant OPC UA server. The use of a redundant server when the primary server is unavailable is triggered by setting this property.

|1501|

Persisted, ExpertPage

(ReadOnly, Hidden)

| |SecurityPolicy|

The OpcUa securitypolicy URI do use when connecting to the server. Default value is "http://opcfoundation.org/UA/SecurityPolicy#None"

|1046|

Persisted, Enumerated

(ReadOnly, Hidden)

| |ServerCertificatePath|

Path/name of server certificate. This property must refer to a valid certificate when MessageSecurity is either "Signed" or "Signed and encrypted". If MessageSecurity is 'None', this property is ignored.

When property 'PkiType' is 'Win32', this property specifies the subject-name of a certificate in the Windows Certificate Store.

Example using Win32: "ApisHiveUaServerInstance"

When property 'PkiType' is 'OpenSSL', this property specifies the name of a certificate file in the '<certificatestore>\trusted' folder.

Example using OpenSSL: "ApisHiveUaServerInstance.der"

|1044|

Persisted, File

(ReadOnly, Hidden)

| |EndpointUrl|

The endpoint URL used to connect with an OPC UA server. Syntax: opc.tcp://{HostName or IP address}:{port number}

Example: opc.tcp://localhost:4850

|1001|

Persisted

(ReadOnly)

| |ReverseConnection|

Specifies if the client or the server should initiate the connection

|1005|

Persisted

(ReadOnly)

| |SessionTimeout|

Requested maximum number of milliseconds that a Session should remain open without activity. If the Client fails to issue a Service request within this interval, then the Server shall automatically terminate the Client Session. Default is 60000 milliseconds.

|1112|

Persisted

(ReadOnly, Hidden)

| |TokenTimeout|

The timeout in seconds, of the security token if using 'MessageSecurity' other than 'None'. Default is 60000 seconds.

|1113|

Persisted

(ReadOnly, Hidden)

| |Username|

Username used to authenticate with server. Only applies when the property 'Authentication' is 'Username/password'.

|1002|

Persisted

(ReadOnly, Hidden)

See also Module Properties

Commands And Events

The OpcUa module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
ServerConnected	The OPC server if connected.	Normal
ServerDataChanged	The OPC server has sent a subscription based data change notification.	Normal
ServerDataChanged_DataPush	The OPC server has sent a subscription based data change notification. This event is fired when the UA client receives data from the UA server, and the items and samples in the data push package are the ones that is received from the server. See also: APIS data transfer mechanism; Data Push	Normal
ServerFirstTimeDataChanged	The OPC server has sent a subscription based data change notification first time after reconnect.	Normal
Catchup-StepNextDone	Event telling that one data set from catchup-manager has been applied to items of the module!	Normal
Catchup-Done	Event telling that the catchup opertation has completed and that module is running in normal real-time mode.	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
ResetExternalItems	Resets the external item manager, by forcing a full refresh of all external items when the 'HandleExternalItems' is fired next time.	Synchronous
Reconnect	Reconnects to the OPC server.	Asynchronous
Reset	Resets the OPC items in the client by performing a synchronous read from server.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous
Catchup-StepNext	Step the catchup data 'playback' one step ahead, updating the item values according to next step. The event Catchup-StepNextDone, is fired when all items have their updated values set, to hook other commands onto.	Synchronous

See also Commands And Events

APIS OpcUa Item Types

Topics Covered:

OPC Item

An item in an OPC UA Server

The OPC Item item type has the following properties:

Name	Description	ID	Flags
DeadbandType	The monitoring deadband. Default = None.	10550	Persisted, Enumerated
DeadbandValue	The value of the monitoring deadband. Ignored when 'Deadband' is 'None'.	10560	Persisted
DiscardOldest	A boolean parameter that specifies the discard policy when the queue is full and a new notification is to be queued. It has the following values: True - the oldest (first) notification in the queue is discarded. The new notification is added to the end of the queue; False - the last notification added to the queue gets replaced by the new notification. Default = true.	10530	Persisted
ExcludeFromCatchup	If true, this item is excluded from catchup, ie. no historical data is read from the server, for this item, during the catchup process.	10600	Persisted
MonitoringMode	The monitoring mode parameter is used to enable and disable the sampling of a MonitoredItem, and also to provide for independently enabling and disabling the reporting of notifications. This capability allows a MonitoredItem to be configured to sample, sample and report, or neither. Default = Reporting.	10500	Persisted, Enumerated
MonitorState	The actual state of the monitored item.	11030	ReadOnly
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
QueueSize	The requested size of the "MonitoredItem" queue. Default = 1.	10520	Persisted
RevisedQueueSize	The actual queue size that the Server will use.	11020	ReadOnly
RevisedSamplingInterval	The actual sampling interval that the Server will use. This value is based on a number of factors, including capabilities of the underlying system. The Server shall always return a revisedSamplingInterval that is equal or higher than the requested samplingInterval. If the requested samplingInterval is higher than the maximum sampling interval supported by the Server, the maximum sampling interval is returned.	11010	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SamplingInterval	The interval that defines the fastest rate at which the MonitoredItem(s) should be accessed and evaluated. This interval is defined in milliseconds. The value 0 indicates that the Server should use the fastest practical rate. The value -1 indicates that the default sampling interval defined by the publishing interval of the subscription is requested. A different sampling interval is used if the publishing interval is not a supported sampling interval. Any negative number is interpreted as -1. Default = -1.	10510	Persisted
SrcUaNodeId	UA Node ID in source.	5031	Persisted
SrcUaNodeId-HA	UA Node ID in source, used for reading history, if the UA server has different nodeids for reading real-time data versus historical data. If empty, history reads defaults to using the 'SrcUaNodeId'.	10505	Persistd
Time	The date and time when this item was last updated.	4	ReadOnly
Trigger	This property specifies the conditions under which a data change notification should be reported: Status: Report a notification ONLY if the StatusCode associated with the value changes; StatusOrValue: Report a notification if either the StatusCode or the value change. The Deadband filter can be used in addition for filtering value changes; StatusOrValueOrTimestamp: Report a notification if either StatusCode, value, or the SourceTimestamp changes. If a Deadband filter is specified, this trigger has the same behaviour as StatusOrValue. Default = StatusOrValueOrTimestamp.	10540	Persisted, Enumerated
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
Write as server datatype	If false, using current value datatype when writing this item to the server. If true, convert to datatype initially reported by server for this item, when writing to the server.	10610	Persisted, Expert

Command Item

An item that represents a command to apply on this module.

The Command Item item type has the following properties:

Name	Description	ID	Flags
Command argument 1	This attribute may be used by an item to specify additional arguments.	10150	Persisted
Command type	This attribute allows you to select the type of command to use.	10140	Persisted, ReadOnly, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Trans OPC Item

An item in an OPC UA Server, with automatic calculation of a linear transformation.

The Trans OPC Item item type has the following properties:

Name	Description	ID	Flags
DeadbandType	The monitoring deadband. Default = None.	10550	Persisted, Enumerated
DeadbandValue	The value of the monitoring deadband. Ignored when 'Deadband' is 'None'.	10560	Persisted
DiscardOldest	A boolean parameter that specifies the discard policy when the queue is full and a new notification is to be queued. It has the following values: True - the oldest (first) notification in the queue is discarded. The new notification is added to the end of the queue; False - the last notification added to the queue gets replaced by the new notification. Default = true.	10530	Persisted
ExcludeFromCatchup	If true, this item is excluded from catchup, ie. no historical data is read from the server, for this item, during the catchup process.	10600	Persisted
MonitoringMode	The monitoring mode parameter is used to enable and disable the sampling of a MonitoredItem, and also to provide for independently enabling and disabling the reporting of notifications. This capability allows a MonitoredItem to be configured to sample, sample and report, or neither. Default = Reporting.	10500	Persisted, Enumerated
MonitorState	The actual state of the monitored item.	11030	ReadOnly
Offset	The linear transformation addend to use when calculating and item value. (Value = RawValue * Scale + Offset)	5006	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
QueueSize	The requested size of the "MonitoredItem" queue. Default = 1.	10520	Persisted
RevisedQueueSize	The actual queue size that the Server will use.	11020	ReadOnly
RevisedSamplingInterval	The actual sampling interval that the Server will use. This value is based on a number of factors, including capabilities of the underlying system. The Server shall always return a revisedSamplingInterval that is equal or higher than the requested samplingInterval. If the requested samplingInterval is higher than the maximum sampling interval supported by the Server, the maximum sampling interval is returned.	11010	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SamplingInterval	The interval that defines the fastest rate at which the MonitoredItem(s) should be accessed and evaluated. This interval is defined in milliseconds. The value 0 indicates that the Server should use the fastest practical rate. The value -1 indicates that the default sampling interval defined by the publishing interval of the subscription is requested. A different sampling interval is used if the publishing interval is not a supported sampling interval. Any negative number is interpreted as -1. Default = -1.	10510	Persisted
Scale	The linear transformation multiplier to use when calculating the item value. (Value = RawValue * Scale + Offset)	5005	Persisted
SrcUaNodeId	UA Node ID in source.	5031	Persisted
SrcUaNodeId-HA	UA Node ID in source, used for reading history, if the UA server has different nodeids for reading real-time data versus historical data. If empty, history reads defaults to using the 'SrcUaNodeId'.	10505	Persistd
Time	The date and time when this item was last updated.	4	ReadOnly
Trigger	This property specifies the conditions under which a data change notification should be reported: Status: Report a notification ONLY if the StatusCode associated with the value changes; StatusOrValue: Report a notification if either the StatusCode or the value change. The Deadband filter can be used in addition for filtering value changes; StatusOrValueOrTimestamp: Report a notification if either StatusCode, value, or the SourceTimestamp changes. If a Deadband filter is specified, this trigger has the same behaviour as StatusOrValue. Default = StatusOrValueOrTimestamp.	10540	Persisted, Enumerated
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
Write as server datatype	If false, using current value datatype when writing this item to the server. If true, convert to datatype initially reported by server for this item, when writing to the server.	10610	Persisted, Expert

State Item

An item that represents a well defined state of this module.

The State Item item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

OPC Method Item

A method item in an OPC UA Server, letting you invoke a method on an object.

The OPC Method Item item type has the following properties:

Name	Description	ID	Flags
SrcUaNodeId	UA Node ID in source.	5031	Persisted
MethodId	The NodeId of the method to invoke, on the uaserver object.	12000	Persistd

The method items also automatically creates necessary OPC Method Input Arguments Item(s) and OPC Method Output Arguments Item(s), according to the definition of the method item in the UA server, represent any necessary inputs and outputs for the method.

Event Monitor Item

An item used to subscribe to events from the OPC UA server.

The Event Monitor Item has the following properties:

Name	Description	ID	Flags
SrcUaNodeId	The UA Node ID in the source server which should be monitored for events.	5031	Persisted
EventType NodeId	The UA Node ID of the base EventType this monitor should subscribe to.	13000	Persisted
UnmappedEventsourceAction	The action to perform when a received event has an unknown eventsource	13001	Persisted
LookupSourcePathTemplate	Template string used to construct an eventsource path from the received event fields	13002	Persisted
UnmappedEventtypeAction	The action to perform when a received event has an unknown eventtype	13003	Persisted

The property UnmappedEventsourceAction can have one of the following values, which decide the action to take when an event with unknown eventsource nodeid is received:

DropEvent: the event is dropped
UseModuleAsEventsource: the module containing the Event Monitor Item is used as the eventsource
LookupSourcename: the sourcename field of the event is used to lookup a fully qualified itemname in Apis Hive. If such an item is found, it will be used as the event source, automatically creating the needed source in Apis Event Server if required.
LookupSourcepath: A sourcepath is created from the property LookupSourcePathTemplate, and if exactly one event source in Apis Event Server matches the path, this is used as the event source.

The property LookupSourcePathTemplate is a string with injected event field values. Any event field can be referenced in the template with the syntax $(BrowseName), e.g. "Server/Plant/*/ABC-$(SourceName)". The search is case-insensitive and supports the following operators:

*: matches zero or more characters
?: matches one character
#: matches one digit
[]: match any character between the '[' and ']', unless the first character after '[' is '^', in which case the logic is inverted.

The property UnmappedEventtypeAction can have one of the following values, which decide the action to take when an event with unknown eventtype is received:

DropEvent: the event is dropped
UseParentType: traverse the OPC UA eventtype hierarchy and use the first known parent-type

Namespace Item

An item that represents a semantics caching namespace.

The namespace item type has the following properties:

Name	Description	ID	Flags
Name	The name of the item is the uri for the namespace it represents on the remote server the ua client module is connected to
Exposed URI / Value	The uri representing the namespace on the hive UA server. This may or may not be the same uri as the source uri on the remote server	15020	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Namespace store	Path to the database file containing the cached model for the namespace	15030	Persisted
Separator char	Character used to separate parts of function item names. Normally '.' is used to indicate parent-child like separation.	15040	Persisted
Name elements	What should make up the parts of function item names. Either browsename or displayname, possibly with the nodeid appended.	15050	Persisted, Enumerated
Name termination	When to stop following parent nodes for inclusion in function item names. Stop at naming root: Stop at the first parent object node having a property of the naming root property type. Stop at first object node: Stop at the first parent that is an object node.	15060	Persisted, Enumerated
Name generation	Determines when to generate function items fordata variables in the namespace. If no types in namespace: Only generate function items if there are no types defined by the namespace. Always, Never, Data variables that are not instance declarations: Unless a data variable is part of a type definition (instance declaration), it will have a function item generated for it.	15070	Persisted, Enumerated
URI for naming root	The uri-part of the node id for the naming root property type.	15080	Persisted
Naming root id type	The identifier-type-part of the node id for the naming root type.	15090	Persisted
Naming root identifier	The identifier-part of the node id for the naming root type	15100	Persisted
Naming root subtypes	Wether subtypes of the naming root type should be treated as a naming root	15110	Persisted
Naming root fail policy	What to do if the objects folder is reached without identifying an object having a naming-root property along the way. Fail: Generate an error, Stop at first object node: Regenerate the name, but stop at the first object node. Stop at objects folder: Use the full path to the objects folder.	15120	Persisted, Enumerated

Item type: Module State Items

An item which retrieves status information from the module

The Module state items item type has the following properties:

Name	Description	ID	Flags
Item type	The item type this item aggregates statistics on, when applicable. Use the number inside the parentheses in "FileAdd" configuration files.	19001	Persisted, ReadOnly, DynamicEnumeration
Module state	The kind of module state information represented by this item. This can be a number of items having a given quality, a total number of items, the time the newest/oldest item was updated. Use a number inside the parentheses in "FileAdd" configuration files.	19000	Persisted, ReadOnly, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Item type: Item Attribute Items

An item which exposes an attribute of another item in the module

The Item attribute items item type has the following properties:

Name	Description	ID	Flags
Attribute ID	The ID of the attribute this item exposes from an item.	19002	Persisted, ReadOnly, DynamicEnumeration
ParentItem	The parent item name of this item.	5502	Persisted, ReadOnly, ApisLocalItem
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

OPC UA Catch-Up

Overview

This document describes the Catch-Up functionality implemented in the Apis Hive OPC UA client module. The Apis Hive OPC UA client module provides as default a standard OPC UA client with Node subscription and method call functionality.

In the cases of communication loss between an OPC UA server and OPC UA client, most OPC UA servers provides a short term buffering of subscription values. When clients re-connects after a relative short termed communication loss, the server start sending the buffered values. This standard OPC UA functionality will only work on short-term communication losses and are dependent on client/server buffer settings and server capabilities.

To accommodate problems with lost data after a long-term communication failure Prediktor has implemented the Catch-Up functionality in the OPC UA client. Unlike classic OPC, OPC UA provides both Data Access and History Access through the same interface. Apis Hive OPC UA client uses the History Access capability in OPC UA to read the logged values on the subscription nodes provided from the server for the duration of the communication failure. When all available history values on the subscription nodes are read up to the time of the re-connect, the client continues to read the subscribed node value through OPC UA Data Access as normal.

To get Catch-Up in Apis Hive UA client bee to work as intended, the server need to provide history data on all the items that the client subscribes to through Data Access.

The resolution on the logged data is not necessary the same as the negotiated sample-interval on the subscription nodes on source system. Differences between the logging interval and sample interval will result in different resolution on data collected through catch-up periods than through normal data access. Careful configuration on both the source server and client is necessary to accommodate this, if correct data resolution through both the catch-up (History Access) and Data Access data is important for the data consuming system.

Dependencies

The Apis Hive OPC UA bee has no Apis Hive dependencies.

Status Items

The Apis Hive OPC UA bee has a set of status items:

Item	Description
#Connected#	Item telling if module is connected to the OPC server; true: is connected, false: is disconnected.
#Catchup-State#	Item telling the current state of data Catchup process.
#Catchup-PointInTime#	Item telling the current point in time for the catchup process, when Catchup process is active.
#Catchup-RealTimeBufferCount#	Item telling the current number of buffered real-time data callbacks during the catchup process, when Catchup process is active.
#Catchup-ReadChunksCount#	Item telling the total number of data chunks read from the UA server during the catchup process, when Catchup process is active.
#Catchup-ReadSamplesCount#	Item telling the total number of data samples read from the UA server during the catchup process, when Catchup process is active.
#Catchup-Speed#	Item telling how many times faster than real-time the catchup process is running Â (note that a low figure may indicate both bad performance as well as high data density).
#Catchup-ReadSpeedAvg#	Item telling the average read speed of the UA server, in samples per millisecond.
#Catchup-ReadSpeedStdDev#	Item telling the standard deviation of the average read speed of the UA server.
#Catchup-StepNextTimeAvg#	Item telling the average duration of a StepNext iteration, in milliseconds.
#Catchup-StepNextTimeStdDev#	Item telling the standard deviation of the duration of a StepNext iteration.

Command Item

The Apis Hive OPC UA bee has a catch-up relevant command item:

Item	Description
$Cmd_Catchup-Continue$	Trigger continuation of the catch-up prosess when catch-up type is Â SerializedCatchup_PauseAfterInitial

The command item is added through the add item method. The command type id: 10140.

Catch-Up relevant module properties

CatchUpMode: The data catchup functionality of the communication. Set this to enable catch-up. Property ID: 1250
- NoCatchup: No data cathcup, just pure real-time communication.
- SerializedCatchup: Historical data is streamed through Hive sample-by-sample, until we have caught up real-time. Note that this requires the UA server to implement the OPC UA HA profile!
- SerializedCatchup_PauseAfterInitial: Same as 'SerializedCatchup', but will stop in playback sequence after first StepNext, use CommandItem $Cmd_Catchup-Continue$ to continue playback sequence.
- PartialCatchup: Only data missing locally, per item, is read from remote server and streamed through Hive, sample-by-sample, until we have caught up real-time.
- PartialCatchup_PauseAfterInitial: Same as 'PartialCatchup', but with one stop in playback sequence after first StepNext, use CommandItem #ContinueCatchup# to continue playback sequence.
CatchUpPeriod: The maximum period to look back for historical data when initiating a catchup operation. Select a pre-set value, or enter a value in seconds. Property ID: 1262
CatchUpChunkSize: How many values to read per node during catchup read operations. Maps to 'numValuesPerNode' parameter of 'ReadRawModifiedDetails'. Default is 5000. Property ID: 1261
CatchUpNumberOfChunks: How many chunks to cache during catchup read operations. Must be between 0-255. Default is 5.Property ID: 1260
CatchUpPeriod: The maximum period to look back for historical data when initiating a catch-up operation. Select a pre-set value, or enter a value in seconds. Property ID: 1262

CONFIGURATION OF CATCH-UP

Catch-Up operation, step by step

When the OPC UA Client module re-connects after a period of communication loss, and if configured to do automatic catch-up, the OPC UA Client module will start to read the history data on the subscription items, starting from the time when the connection was lost, possibly limited by the set CatchUpPeriod module property. During this period of history data read, the module will buffer all Data Access subscription values in the module until all history data are read from the source system. After all the available item data is read up to the time of the re-connect, the module continuous with normal OPC UA Data Access subscription operation. During the Catch-Up the OPC UA Client Bee updates the configured data items in steps, assuring that all History data values for the items are written to the tags. Only single values are updated in each step.

Implications on memory usage

The OPC UA Client module reads the data in chunks. The number and size of the chunks for each item is configurable through the module properties: CatchUpChunkSize and CatchUpNumberOfChunks. The values set on these properties together with the number of items and item types will have implications on memory usage. The buffering of the OPC UA Data Access subscription items will also add to the memory consumption, so careful choice of Catch-up period must be selected to avoid out-of-memory situations. It is recommended to use the 64bit version of Apis Hive to ensure enough memory in high item volume solutions.

Timestamps

Item values read through OPC UA History Access (and OPC UA Data Access) will keep the server data timestamp through all the External Item transfers in Apis Hive, if not the TimeReferenceItems module property is set explicit. We recommend not using the TimeReferenceItems property in a catch-up solution.

EventBroker

Each Apis module normally have set of events and a set of commands. An event in one module can cause a command to be fired in another module. The mapping of the events to commands are done in the Event Broker. The OPC UA client module has a specific event CatchUp-StepNextDone and a specific command CatchUp-StepNext, that fires when a catch-up step is done and triggers each step in the catch-up process respectively. The module also fires a ServerDataChanged event after a new set of item values are received, both during catch-up and normal operation. Only a single value for each item are updated for each trigging of the ServerDataChanged event.

Trig the CatchUp-StepNext command by the CatchUp-StepNextDone event on the OPC UA Client Module, to ensure proper operation of events during normal operation.

This will be coverd in more detail below.

Figure 1, Event broker, CatchUp-StepNext on CatchUp-StepNextDone.

Apis Hive Inter-module data exchange

When using the Catch-Up functionality in the Apis Hive OPC UA Client Bee, it is important to configure the Apis Hive Data Exchange accordingly.

It is important to use the synchronized event/command functionality in the Apis Hive Event Broker instead of asynchronous timer-based Data Exchange

ExternalItem transfer in Apis

Apis Hive is a module based system environment that gives you the opportunity to collect, process and store real-time data. Different modules in Apis Hive provides different functionality, but common to all is the inter-module data exchange provided by the ExternalItem functionality.

Example of data exchange between modules

In this example system, we use a simple setup consisting of tree modules in an Apis Hive default instance:

A connection module, the OpcUa Client bee, named OpcUaBee.
A process module, the Calculate Bee, named Calculate.
A store module, the Logger Bee, named ClientLogger.

A simple view of the modules:

Figure 2, Apis Hive with Calculate, Logger and OpcUa client module.

The OpcUaBee module has one subscription item that reads a sine signal from the a source systemed named CustomerServer. The Item is named CustomerServer.Worker.Sine. Further the Calculate module has one item, named SineTimes2, which has CustomerServer.Worker.Sine as input through the external item connection.

Figure 3, Item connection.

Data exchange, by exchange rate (not recommended with catch-up):

Normally, data exchange (ExternalItem) is configured at destination side by adding one or more external items to an item by the item attributes. Second the destination module need to be set to use a specific Exchange rate, a definition of the period between each read of the connected items, normally in the millisecond area. In this way, the items will be inter-connected, and read at a specific time period.

Data exchange, by event broker:

In the figure below, we see that the OpcUa trigger the ClientLogger module to log, the Calculate module to handle its external items and the ClientLogger module to log again when ServerDataChanged event fires. The reason for logging twice is to ensure that history values that could be needed by calculate operations are properly logged before calculations are trigged, and results from the calculations are logged. Values on items that has not changed will not be logged.

We also see that CatchUp-StepNext is triggered as before by CatchUp-StepNextDone.

Figure 4, Event broker.

Catch-Up steps summary

The steps of the Catch-Up summed up:

The module re-connects after a period of lost communication
The buffering of the OPC UA Data Access subscription data on the items starts immediately
The module decides from what timestamp to start to read item history data from, based on time of communication loss or reconnect-time and CatchUpPeriod setting.
The module starts to read history data in chunks and trigger the event in event broker for each change in item value.
If configured, the external item values are synchronously updated through the Event Broker for each value update. ServerDataChanged
After all history data is read, the OPC UA Client Module continuous with normal OPC UA Data Access subscription operation.
If configured, the external item values are synchronously updated through the Event Broker for each value update.

Recommendations

Use 64bit Apis Hive installation when using catch-up in high item volume installations and expected catch-up for long periods.
Use event-broker to handle Apis Hive Data Exhange, trigging of CatchUp-StepNext command by the CatchUp-StepNextDone event is a must.
Ensure proper configuration of both client and source system server to achieve same data sampling rate of both History Access item data and item subscription (OPC UA Data Access) data.

Apis OpcUa Proxy

This module is used to configure federation of selected namespaces from a remote OpcUa server.

Provider: Prediktor

Item types:

Namespace item

APIS OpcUa Proxy Item Type

Topic Covered:

Namespace Item

NamespaceItem

The Namespace item is used to configure one remote OpcUa namespace for federation through the OpcUa server in this Apis instance.

It has the following standard properties:

Name	Description	ID	Flags
Name	The namespace uri on the remote server.		Persisted
Exposed uri	If specified, a custom uri used to represent the remote uri when exposing the federated namespace in the OpcUa server in this Apis instance.	10010	Persisted
Value	The uri exposed by the OpcUa server in this Apis instance (read-only). This value is equal to the"Exposed uri" property when that property has been specified. When not, "Value" equals "Name", i.e. the actual namespace uri on the remote server.	2

Properties

The OpcUaProxy module has the following standard properties:

Name	Description	ID	Flags
OpcUa server	The server configuration to use for this proxy module. The list of available servers is populated with OpcUa connection and OpcUa cluster items defined by ApisCnxMgr modules.	1001	Persisted, Enumerated
Impersonate	If checked, the authentication information provided by each OpcUa client connecting to this Apis instance, will be used when federating OpcUa messages for the client to the selected server. If not checked, all clients will reuse the authentication information configured by the selected OpcUa connection item.	1002	Persisted

The OpcUaProxy module has the following informational properties:

Name	Description	ID	Flags
Endpoint url	The current endpoint url for the selected server.	1100

Apis PerformanceMonitor

Module for collecting performance data from a local or remote machine.

Provider: Prediktor

The PerformanceMonitor module has the following item types

Performance Counter

Perfmon Command

Properties

The PerformanceMonitor module has the following properties:

Name	Description	ID	Flags
Computer	The computer to connect to for getting Performance Monitor data. Left blank for local computer.	1002	Persisted
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
Interval	The update interval for the Performance Counters, in ms. Determines how often the module will poll the system for updates.	1001	Persisted

See also Module Properties

Commands And Events

The PerformanceMonitor module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

Add new Performance Counter items

You can add new Performance Counter items by right-click on PerformanceMonitor --> Add Items --> Performance Counter:

A dialog then pops up to allow you to configure the items to be created:

You MUST click on the Browse button to choose from all system predefined Performance Counters to add.

The Browse button brings up another dialog:

In this dialog, choose one or more Performance Counter and click Ok. You can also search for keywords in the Search bar on the top.

For example, if you want to monitor the incoming and outgoing internet connection speed, you can choose "@IPv4/Datagrams/sec":

Click Ok, you will see a new Performance Counter is added:

Now you have added a new Performance Counter item, you can use it as the same as other OPC items.

Identify Processes By Instance Name

When you use the system built-in utility Perfmon.exe to monitor multiple instances of the same process and you have more than one instances of the same executable file running at the same time, you have probably noticed that Perfmon.exe differentiates the process by giving them an arbitrary numbered name, for example ApisHive, ApisHive#1 and ApisHive#2. This behavior is most likely not what you would expect, since it is not very clear which process responds to which ApisHive instance you started, and the random numbers change every time you restart your ApisHive instances.

PerformanceBee improves this by adding the instance name to the process name, such as ApisHive_apishiveinstance, ApisHive_anotherinstance, where ApisHive is the process name(executable file name) and apishiveinstance is the instance name. This works even after you restart your ApisHive instances.

Now only ApisHive instances are identified in this way.

To support this, there are some configurations need to be done:

On target machine(machine being monitored):

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\PerfProc\Performance\ProcessNameFormat set to 2. (DWORD)
Service named RemoteRegistry is running.
ApisHive instances are running using different names.
The monitoring account (usually a domain account, which is also used to launch the PerformanceBee on the monitoring machine) is added into user group “Performance Log Users” and “Performance Monitor Users”
The monitoring account is allowed in WMI\Root\CIMV2\Securities (use WMI Control snapin, wmimgmt.msc)

On monitoring machine:

The monitoring account(the account that launched PerformanceBee) can be added to related user groups on target machine.

APIS PerformanceMonitor Item Types

Topics Covered:

Properties

A Performance Counter describes a measurable property of a machine, remote or local, such as CPU load.

The Performance Counter item type has the following properties:

Name	Description	ID	Flags
Performance Counter Category	The category that the Performance Counter belongs in.	10001	Persisted
Performance Counter Instance	Instance name for the Performance Counter, when it is necessary to distinguish between them. Left blank for single-instance counters.	10002	Persisted
Performance Counter Name	The name given to the Performance Counter within its category.	10003	Persisted
Performance Counter Sample Exposure	The aspect of the Performance Counter to expose. Default means to expose the appropriate value depending on the counter type. RawValue exposes the CounterSample.RawValue Int64 Property of the counter. Calculated exposes the 4 byte floating point value resulting from the CounterSample.Calculate Method of the counter.	10004	Persisted
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Inputs	The item handle (unique identifier) of the inputs.	5510	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

This item controls whether the Performance Monitor module is running or not.

The Perfmon Command item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Apis PrinterBee

This Apis module is used to print documents from and RDLC file with optional parameters.

Provider: Prediktor

This module dependent on Microsoft Report Viewer 2010 this must be insatalled manually

The CodeModule Version parameter in the rdls file must match the Neodynamic.ReportingServices.Barcode version in use

Example: Neodynamic.ReportingServices.Barcode, Version=9.0.2000.0, Culture=neutral, PublicKeyToken=c6b33c3093a0d4cd

The PrinterBee module has the following item types

PrintTrigger

Printparameter

Properties

The PrinterBee module has the following properties:

Name	Description	ID	Flags
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
Printername	The name of the printer	1010	Persisted, Printer
RDLC file	Path to the RDLC file	1020	Persisted, File

See also Module Properties

Commands And Events

The PrinterBee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS PrinterBee Item Types

Topics Covered:

Properties

Item that will trigger printjob (bool)

The PrintTrigger item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Printer parameteres that will be input for RDLC file

The Printparameter item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted
Parameter name	The parameter name (this must match the RDLC file parameter).	10002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Apis Replay

This module will playback values recorded to an OPC HDA server.

Provider: Prediktor

The Replay module has the following item types

More information

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

Commands And Events

The Replay module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
OnPlaybackDone	An event that notifies that a playback step has finished. Necessary if another module is to be synchronized with the playback mechanism.	Normal
OnSynchReadDone	An event that notifies that a synchronous read operation has finished for all the SynchronousItem's of this module.	Normal
OnSynchReadEnd	An event that notifies that a synchronous start time is bigger than end time.	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
ReadSynch	A command initiating a synchronized read operation into the OPCHDA server for all SynchronousItems.	Synchronous
StartSyncRead	Initialize sync read.	Synchronous
StepSynch	A command initiating a synchronized step operation into the OPCHDA server for all SynchronousItems.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS Replay Item Types

Topics Covered:

Properties

An item available for synchronous replay from the OPC HDA server.

The SynchronousItem item type has the following properties:

Name	Description	ID	Flags
AlwaysActive	This property forces the item to always be in the active item set.	10030	Persisted
ItemActive	The status for if the item is active or not.	10025	ReadOnly
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

Time (UTC) of the history to be read.

The Time item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

RelativeTime (UTC) of the history to be read.

The RelativeTime item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Integrated control item

The Control item item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Replay state

The State item item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Apis Scenario

This module is used for sequential execute mathematical and condition based expressions.

The scenario file is parsed run-time at start up and any changes made to this file will be detected and the scenario will restarted.

NOTE: A scenario script consists of only one START condition and a number of user defined action condition. Supported actions are WHEN, WHILE and END.

The first condition that always must be fulfilled before the different actions conditions are executed is the START condition. A condition is an expression that can be evaluated to true or false. When the start condition is true, the script engine runs through the init sections to initialize the variables before it start to evaluate the different actions in that order it is written. To stop an execution of a script, you use the END action. You can allow the script engine to restart after the END condition is fulfilled by setting the module property AllowScenarioRestart. The figure below shows how to construct an scenario file.

To add comments in a scenario file this can be done by use of '//'

Scenario variable

All variables can be initialized in 'Init section'.
All variables are global within the same script engine executing the scenario file
You can access items in Apis namespace by using syntax '#<ModuleName>.<ItemName>#'. However, this requires that the AssignmentMode is set to UserDefined.
Types of variables
- Internal scenario variables
  - Should be initialized (default value is ’0.0’)
  - Created when used the first time
- Mapped scenario variables
  - MAP scnItem = #Worker.Variable#. However, this requires that the AssignmentMode is set to UserDefined.
    - The 'scnItem' is an internal scenario variable name which is accessible only the executing script engine
  - Through global attributes '<ModuleName>.Out' and '<ModuleName>.In'

Predefined variable names

Name	Description
Error	The numbers of errors
ErrorText	The last error description
SimTime	External reference or PC clock (numbers of seconds since start)

Condition based actions

Operator	Description	Example
START	Condition to start the script	START <condition>
WHILE	Action done each time criterion is met Note: For RAMP and PULSE the execution of a period will be restarted after the running period is completed as long as the WHILE condition remains true.	WHILE <condition>
WHEN	Action done first time criterion is met. Note: For RAMP and PULSE the execution of a period will pause if the WHEN condition becomes false in the running period.	WHEN <condition>
END	Condition to stop the script execution	END <condition>

Expressions supported

In addition to the expressions support in ApisCalculateBee, these functions are supported

Function	Description	Syntax
RAMP	The RAMP function will generate a ramp signal between start and stop at the defined period. In each calculation interval the result will be written to the variable name.	RAMP<variable name> <start value> <stop value> <period>
PULSE	The PULSE function will generate a pulse signal between low and high value and stop at the defined period. In each calculation interval the result will be written to the variable name.	PULSE <variable name> <low value> <high value> <period>

Provider: Prediktor

The Scenario module has the following properties:

Name	Description	ID	Flags
Active	This is the property for disable or activate the execution of the scenario.	1700	Persisted, Enumerated
AllowScenarioRestart	Set this value to true to allow that the sceario execution to restart when execution criteria 'END' fulfils.	2250	Persisted, Enumerated, ExpertPage
AssignmentMode	This property specifies how scenario variable are defined either ‘User defined’ in the scenario file by appearing on the left side of an assignment, or ‘Predefined’ by configuration in Apis (Explicitly, Implicitly). The default value is ‘User defined’. If is also possible to have an combination of both which is ‘All’	1800	Persisted, Enumerated
ExecutionErrorCount	The numbers of errors counted during execution	1950	InfoPage
ExecutionLastUpdateDate	The datetime for when the apis namespace was last updated by the scenario bee.	2000	PerformancePage
ExecutionRate	The periode in ms of the execution of the scenario file. The minimum execution rate is 250 ms	1850	Persisted
ExecutionStartDate	The start time for when the execution was started	1900	InfoPage
ExecutionStatus	The status of the execution NotRunning, running, finished, etc.	2050	Enumerated, PerformancePage
FileChangeTimeout	The maximum amount of milliseconds to wait for a file change notification to occur before the scenario file is manually scanned for change(s).	2200	Persisted, Enumerated, ExpertPage
FreshestValue	When TRUE, all items will be read directly from their physical source to receive the freshest possible values.	2010	Persisted, ExpertPage
ReportDetailInfo	By setting this to false only the count of info, warning and error messages will be reported to the log files for log view in Apis Management Studio	2400	Persisted, Enumerated, ExpertPage
ScenariofileLastLoaded	The time the scenario file was last loaded	2300	InfoPage
ScenarioFilePath	The file name path for the scenario file	1750	Persisted, File
TagAccessFilter	This property specifies which tag’s can be accessed if the AssigmentMode is defined as ‘Predefined’ (Implicitly). The variable names can either be specified like this <<ModuleName>>.<<VariableName>> or wild card ‘*’ can be used. The different names are separated by ‘;’	1875	Persisted

See also Module Properties

Commands And Events

The Scenario module has the following Commands and Events:

See also Commands And Events

Scenario Properties

The ApisScenarioBee has two global attributes which can be used to map local scenario variable to Apis items. These two global attributes are:

Depending on which access rights you want to give the local scenario variable, you can map it either to 'In' (read-only) as input to the scenario file or 'out' to write the scenario variable to the Apis item or both (read and write). You can also use this functionality to give same scenario file different mapping of items for different scenario bee's.

Note: You need to set the module property AssigmentMode to Predefined to restrict access to Apis namespace directly from script engine

Apis SecsGemHost

SECS Gem Host implementation of E30 with the transport layer described in E37. Uses neccessary part from E5 for message description. The received SECS GEM events is converted to message broker messages regarding and trace collections to signal items.

Provider: Prediktor

Predefined LinkedEventReport CtrlItem

The SecsGemHost module has the following item types

PredefinedReport ScalarVariable

PredefinedReport VectorVariable

PredefinedReport ComplexVariable

Userdefined LinkedEventReport CtrlItem

UserdefinedReport ScalarVariable

UserdefinedReport VectorVariable

UserdefinedReport ComplexVariable

Message Control Item

ComplexItemFlattening Scalar

ComplexItemFlattening Vector

StatusItem

Trace Data Collection

EquipmentConstant Item

StatusDataItem Item

Alarm Config Item

Spool Config Item

Properties

The SecsGemHost module has the following properties:

Name	Description	ID	Flags
Connected	Status if Apis is connected to equipment.	1060	InfoPage
ConnectedTime	Last time host connected equipment.	1075	InfoPage
DeviceID	A number between 0 and 32767 used in identifying the particular piece of equipment communicating with a host. The message transfer protocol must be capable of identifying the device ID (0–32767) which indicates the source or destination of a message (default: 0).	1140	Persisted
Enable	If true the module will try to connect the equipment with IP address and port number specified (default: false).	1010	Persisted
Enable Alarms	By enabling this the host will enalbe configured alarms on the Equipment. The AlarmID's to subscribe is done be setting the value on item AlarmSubscription.The type of alarm supporetd is eitherGEM (S5F1) or PV2 (S6F11). Default is disabled	1156	Persisted, Enumerated
Enable OnlineRequest	Used to set if equipment supports Online Request capability (default: true).	1151	Persisted
Enable Spooling	Used to set if equipment support spooling (default: false).	1152	Persisted
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
ExternalItem report	A status-report for the External Item manager of this module	110	InfoPage
InitiateConnection	Set this value too true if you want the host to be the active part in InitiateConnection and Initiate On-Line-ID (default: true).	1150	Persisted
IP-Address	The IP address of the equipment (only used when 'ActiveMode' is selected).You can not specify host name, only IP address (default: 127.0.0.1).	1120	Persisted, TcpIpAddr
LastMsgRcv	Last message received from equipment.	1070	InfoPage
LastMsgSend	Last message send to equipment.	1065	InfoPage
LinkTest Timeout	The timeout between sending control HSMS characters LinkTest (default 20 sec).	1015	Persisted, ExpertPage
Listening	Status of listen socket if Pasive mode is used.	1055	InfoPage
Log SECS BitPattern	This will log all bits and bytes recived on the socket to the log file so used this care (default: false).	1180	Persisted, ExpertPage
MaxCountMessageFiles	MaxCountMessageFiles specifies the maximum number of MessageLog files the module writes to MessageLogDirectory before it starts to delete. The value selected must be between 10 and 500. Default value is 100	1220	Persisted
MaxParseTime	The maximum time used to parse a SF message [ms].	1090	PerformancePage
MaxSendLinkRequestTime	The maximum time used to send a Linktest.req [ms].	1095	PerformancePage
MessageBrokerTime	Last time messages was requested from MessageBroker.	1080	InfoPage
MessageLogDirectory	MessageLogDirectory specifies a valid directory, all messages will be written to text-files into this directory. If property is blank, no text files will be written.	1210	Persisted, Folder
Multiblock Enabled	If this is enabled Multiblock/Grant request will be used if the size of the message is to large (default: true).	1135	Persisted
OperationMode	The type of operation mode for the SECS HostPasiveMode (equal to a server) listen for incomming connectionActiveMode (equal to a client) takes the initiaive to connect (default: ActiveMode).	1110	Persisted, ReadOnly, Enumerated
Port	This property depends on the what has been select in the property 'OperationMode'PasiveMode is the listen port for incomming connectionActiveMode is the port to use when connect to an equipment (default: 7000).	1130	Persisted
RequestSpoolData	The type of spool request to do on equipment at connect (default: TransmitSpooledMessages).	1153	Persisted, Enumerated
ResetSpooling At Shutdown	By enabling this the spooling will be stoped when Apis module is stoped (default: false).	1154	Persisted
SECS log file	The file name for SECS II messages send and received (default: "").	1170	Persisted, ExpertPage
SECS log file Maxsize	The max size of the log file before it get recycled (Default value=5.000.000 [bytes]).	1160	Persisted, ExpertPage
T3-Reply Timeout	Specifies maximum amount of time an entity expecting a reply message will wait for that reply (1-120 seconds, default 45 sec).	1020	Persisted, ExpertPage
T5-ConnectionSeparation Timeout	Connection Separation Timeout.Specifies the amount of time which must elapse between successive attempts to connect to a remote entity (1-240 seconds, default 10 sec).	1025	Persisted, ExpertPage
T6-ControlTransaction TimeOut	Specifies the time which a control transaction may remain open before it is considered a communication failure (1-240 seconds, default 5 sec).	1030	Persisted, ExpertPage
T7-NotSelected Timeout.	Time which a TCP/IP connection can remain in NOT SELECTED state (i.e. , no HSMS activity) before it is considered a communication failure (1-240 seconds, default 10 sec).	1035	Persisted, ExpertPage
T8-NetworkIntercharacter Timout	Maximum time between successive bytes of single HSMS message which may expire before it is considered a communication failure (1-120 seconds, default 5 sec).	1040	Persisted, ExpertPage
UseLogSynchEvent	By setting this propery to 'true' no new SecsMessage received will be handled before the logger has reported logger event 'LogDone' (default=false).	1012	Persisted, ExpertPage

See also Module Properties

Commands And Events

The SecsGemHost module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
OnNamespaceUpdated	Blank	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
OnLoggerReady	Blank	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS SecGemHost Item Types

Topics Covered:

Properties

Int32Item items are used to supply ApisMessages with scalar member data

The Int32Item item type has the following properties:

Name	Description	ID	Flags
InitValue	Initial value, set during initialization of the Apis Module.	5002	Persisted
ParentItemID	The Item name of the parent item to this item, an item in the same module as this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

DoubleItem items are used to supply ApisMessages with scalar member data

The DoubleItem item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

DateTimeItem items are used to supply ApisMessages with scalar member data

The DateTimeItem item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

StringItem items are used to supply ApisMessages with scalar member data

The StringItem item type has the following properties:

Name	Description	ID	Flags
FormatString	A general purpose format string, used when applying string formatting to calculate the value of this item.	5105	Persisted
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

BoolItem items are used to supply ApisMessages with scalar member data

The BoolItem item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Int64Item items are used to supply ApisMessages with scalar member data

The Int64Item item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

VectorItem items are used to supply ApisMessages with vector member data

The VectorItem item type has the following properties:

Name	Description	ID	Flags
Dimension	The dimension of a vector item (number or elements).	5007	Persisted
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

MatrixItem items are used to supply ApisMessages with matrix member data

The MatrixItem item type has the following properties:

Name	Description	ID	Flags
ColNames	All the column names in a matrix, separated by semi-colon ';'	5091	Persisted
Columns	The number or columns in matrix item.	5009	Persisted
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Rows	The number of rows in a matrix item.	5008	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

This item is used to configure Secs GEM Event Report and convert the received SECS event messagee to Apis message.The event can either be trigged on new received SECS event message or when value change on the item.

The Predefined LinkedEventReport CtrlItem item type has the following properties:

Name	Description	ID	Flags
AlarmType	Used to define the type of alarm Detected/Cleared (Default: Disabled). Note: by enabling this property, you'll disable default alarm message S5F1.	10550	Persisted, Enumerated
CEID	The collection event ID is a unique identifier defined by the equipment. Any values >= 0 are valid values.	10130	Persisted
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Enable	Set to true to enable the item in the configuration.	10005	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
RPTID	The report id is a unique id, defined by the equipment. Any values >= 0 are valid values.	10140	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Time Reference Item	If this is an empty string, local Apis time will be used.	10160	Persisted, ApisLocalItem
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

The main purspose of this item is to configure variable information in a Report. This item uses the configuration made for the message item by setting the parrent attribute.

The PredefinedReport ScalarVariable item type has the following properties:

Name	Description	ID	Flags
AlarmVariableData	This attribute is used to define the type of alarm variable (Default: Disabled).	10600	Persisted, Enumerated
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
ReportIndex	The index of the variable in the report (zero based). The default value is -1 which means that the index is not used.	10011	Persisted, ExtraInfo
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly
ValueAsDate	Can be enabled if the SECS variable is a SECS time (ASCII 12 or 16 ) should be interpreted as DateTime (Default: false).	10003	Persisted

Properties

The main purspose of this item is to configure variable information in a Report. This item uses the configuration made for the message item by setting the parrent attribute.

The PredefinedReport VectorVariable item type has the following properties:

Name	Description	ID	Flags
Dimension	The dimension of a vector item (number or elements).	5007	Persisted
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
ReportIndex	The index of the variable in the report (zero based). The default value is -1 which means that the index is not used.	10011	Persisted, ExtraInfo
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

The main purspose of this item is to configure variable information in a Report. This item uses the configuration made for the message item by setting the parrent attribute.

The PredefinedReport ComplexVariable item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
ReportIndex	The index of the variable in the report (zero based). The default value is -1 which means that the index is not used.	10011	Persisted, ExtraInfo
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

The Userdefined LinkedEventReport CtrlItem item type has the following properties:

Name	Description	ID	Flags
AlarmType	Used to define the type of alarm Detected/Cleared (Default: Disabled). Note: by enabling this property, you'll disable default alarm message S5F1.	10550	Persisted, Enumerated
CEID	The collection event ID is a unique identifier defined by the equipment. Any values >= 0 are valid values.	10130	Persisted
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Enable	Set to true to enable the item in the configuration.	10005	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
RPTID	The report id is a unique id, defined by the equipment. Any values >= 0 are valid values.	10140	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Time Reference Item	If this is an empty string, local Apis time will be used.	10160	Persisted, ApisLocalItem
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

The main purspose of this item is to configure variable information in a Report. This item uses the configuration made for the message item by setting the parrent attribute.

The UserdefinedReport ScalarVariable item type has the following properties:

Name	Description	ID	Flags
AlarmVariableData	This attribute is used to define the type of alarm variable (Default: Disabled).	10600	Persisted, Enumerated
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly
ValueAsDate	Can be enabled if the SECS variable is a SECS time (ASCII 12 or 16 ) should be interpreted as DateTime (Default: false).	10003	Persisted
VID	Variable ID. It must be larger or equal to 0 to be valid.	10010	Persisted

Properties

The main purspose of this item is to configure variable information in a Report. This item uses the configuration made for the message item by setting the parrent attribute.

The UserdefinedReport VectorVariable item type has the following properties:

Name	Description	ID	Flags
Dimension	The dimension of a vector item (number or elements).	5007	Persisted
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly
VID	Variable ID. It must be larger or equal to 0 to be valid.	10010	Persisted

Properties

The main purspose of this item is to configure variable information in a Report. This item uses the configuration made for the message item by setting the parent attribute.

The UserdefinedReport ComplexVariable item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly
VID	Variable ID. It must be larger or equal to 0 to be valid.	10010	Persisted

Properties

This item controls Apis Messages creation. Add all necessary message element items, and triggers generation of a new message when its value is being changed.

The Message Control Item item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Expression	An expression used to calculate the value of this item.	5110	Persisted
ExpressionRule	Used to set the requirement of expression validation. If value is 'And', then the items used in the expression must all have been updated after the previous generation of the message.	10105	Persisted, Enumerated
MessageTrigger	This property determines how to trigger a new Apis message.	10110	Persisted, Enumerated
MessageTypeID	The ID for the message type of an Apis message.	5300	Persisted, Enumerated
NumGeneratedMessages	The number of messages generated from this control item since it started (start time).	10120	ReadOnly
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

This item is used to flattening complex report variable of type SECS List item

The ComplexItemFlattening Scalar item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
LevelFlattening	This is used to set the position into a SECS List item for flattening. The object to flatten is either a scalar or a homogeneous vector item. The syntax for positioning is, for example, 'Level_1(pos number).Level_2(pos number).Level_3(pos number)'.The index starts at 1.	10070	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

This item is used to flattening complex report variable of type SECS List item

The ComplexItemFlattening Vector item type has the following properties:

Name	Description	ID	Flags
Dimension	The dimension of a vector item (number or elements).	5007	Persisted
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
LevelFlattening	This is used to set the position into a SECS List item for flattening. The object to flatten is either a scalar or a homogeneous vector item. The syntax for positioning is, for example, 'Level_1(pos number).Level_2(pos number).Level_3(pos number)'.The index starts at 1.	10070	Persisted
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly
Vector Type	The data type of the vector item. The default value is "None".	10004	Persisted, Enumerated

Properties

This item is used to expose internal status information

The StatusItem item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

A Trace Data Collection item's main purpose is to be used for logging. For that purpose the capability Trace Collection will be used

The Trace Data Collection item type has the following properties:

Name	Description	ID	Flags
DSPER	Data sample period [ms].	10030	Persisted
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
REPGSZ	Report group size (read only).	10060	Persisted, Hidden
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
TOTSMP	The total number of samples (read only).	10050	Persisted, Hidden
TRID	The trace ID is auto-generated by the module (read only).	10040	Persisted
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
ValueAsDate	Can be enabled if the SECS variable is a SECS time (ASCII 12 or 16 ) should be interpreted as DateTime (Default: false).	10003	Persisted
VID	Variable ID. It must be larger or equal to 0 to be valid.	10010	Persisted

Properties

EquipmentConstant Item's main purpose is to be used for changing value on the host.

The EquipmentConstant Item item type has the following properties:

Name	Description	ID	Flags
DSPER	Data sample period [ms].	10030	Persisted
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
ValueAsDate	Can be enabled if the SECS variable is a SECS time (ASCII 12 or 16 ) should be interpreted as DateTime (Default: false).	10003	Persisted
VID	Variable ID. It must be larger or equal to 0 to be valid.	10010	Persisted

Properties

StatusDataItem's main purpose is to be used for logging.

The StatusDataItem Item item type has the following properties:

Name	Description	ID	Flags
DSPER	Data sample period [ms].	10030	Persisted
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
ValueAsDate	Can be enabled if the SECS variable is a SECS time (ASCII 12 or 16 ) should be interpreted as DateTime (Default: false).	10003	Persisted
VID	Variable ID. It must be larger or equal to 0 to be valid.	10010	Persisted

Properties

This item is used to configure alarm functionality in SECS Gem

The Alarm Config Item item type has the following properties:

Name	Description	ID	Flags
AlarmArea	The default alarm area for the item.	10450	Persisted
AlarmEnable	Used to enable or disable the alarm.	10420	Persisted
AlarmID	A unique identifier for the alarm.	10400	Persisted
AlarmSeverityHigh	The severity when the alarm condition is active.	10480	Persisted
AlarmSeverityNormal	The severity when the alarm condition is inactive.	10500	Persisted
AlarmText	The text of the alarm. The message is separated with ';' Eg: Normal;Alarm (Default is empty).	10465	Persisted
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

This item is uses to configure StreamFunction (SF) to spool. Default value is false ()

The Spool Config Item item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SpoolFunctionAttribute	The function number. Any value below -1 is not valid.	10750	Persisted
SpoolStream	The stream number (Default=-1). Spooling allows equipment to queue messages intended for the host. This happens during times of communication failure, and then delivers these messages when communication is restored. Spooling is limited to primary messages of user-selected streams. Primary Message - an MSMS Data Message With an odd number function. Also, the first message of an data transaction.	10700	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Apis SegScaleBee

Description of ApisSegScaleBee

Provider: Prediktor

Batch weight of the last batch

The SegScaleBee module has the following item types

Int VectorVariable

String VectorVariable

Double VectorVariable

Int Trigger In

Properties

The SegScaleBee module has the following properties:

Name	Description	ID	Flags
Com port	Serial IO Com port id. Must Start with COM	1002	Persisted
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
Log file	The file name for Seg scale serial IO log.	1010	Persisted, ExpertPage
Log file Maxsize	The max size of the log file before it get recycled (Default value=5.000.000 [bytes]).	1009	Persisted, ExpertPage
Log level	Defines the log level	1011	Persisted, Enumerated, ExpertPage
Scale address	The RS 485 bus address of the Seg scale	1003	Persisted
ScaleRole	Defines the SegScaleBee role type. The items will be generated based on the role of the module.	1001	Persisted, ReadOnly, Enumerated, ExtraInfo
Serial IO Baud Rate	The serial IO Baud Rate	1004	Persisted, ExpertPage
Serial IO Data bits	The serial IO Data bits	1006	Persisted, ExpertPage
Serial IO Stop bits	The serial IO Stop bits	1007	Persisted, Enumerated, ExpertPage
Serial IO timeout	The serial IO communication timeout period in milliseconds	1005	Persisted, ExpertPage
Weight margin	The margin in kilograms period, in seconds, for weight to indicate stand-still state	1012	Persisted, ExpertPage
Weight stand still period	The period, in seconds, for weight to standstill to indicate stand-still state	1008	Persisted, ExpertPage

See also Module Properties

Commands And Events

The SegScaleBee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS SegScaleBee Item Types

Topics Covered:

Properties

Int Status Item

The Int Status Item item type has the following properties:

Name	Description	ID	Flags
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

Bool Status Item

The Bool Status Item item type has the following properties:

Name	Description	ID	Flags
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

String Status Item

The String Status Item item type has the following properties:

Name	Description	ID	Flags
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

The weight

The Weight item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

Double Status Item

The Double Status Item item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

Int Input

The Int Input item type has the following properties:

Name	Description	ID	Flags
Inputs	The item handle (unique identifier) of the inputs.	5510	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Double Input Item

The Double Input Item item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
Inputs	The item handle (unique identifier) of the inputs.	5510	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Bool Input Item

The Bool Input Item item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
Inputs	The item handle (unique identifier) of the inputs.	5510	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

String Input Item

The String Input Item item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
Inputs	The item handle (unique identifier) of the inputs.	5510	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

The batch level trigger will change value when weight reaches batch size

The Batch weight of the last batch item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

Int VectorVariable

The Int VectorVariable item type has the following properties:

Name	Description	ID	Flags
Dimension	The dimension of a vector item (number or elements).	5007	Persisted
Inputs	The item handle (unique identifier) of the inputs.	5510	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

String VectorVariable

The String VectorVariable item type has the following properties:

Name	Description	ID	Flags
Dimension	The dimension of a vector item (number or elements).	5007	Persisted
Inputs	The item handle (unique identifier) of the inputs.	5510	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Double VectorVariable

The Double VectorVariable item type has the following properties:

Name	Description	ID	Flags
Dimension	The dimension of a vector item (number or elements).	5007	Persisted
Inputs	The item handle (unique identifier) of the inputs.	5510	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	Decides which type (e.g. Double, String, Bool) the item is to be. (Bool=10, Double=20, String=30)	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Int Trigger In

The Int Trigger In item type has the following properties:

Name	Description	ID	Flags
Inputs	The item handle (unique identifier) of the inputs.	5510	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Apis Semantics

This module defines an opc ua namespace and allows mapping data variables in the model to hive function items.

Provider: Prediktor

The semantics module has the following item types

Module State Items

Item Attribute Items

Function item

Properties

The Worker module has the following properties:

Name	Description	ID	Flags
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
ExtItem pass-through quality	Specifies the quality of external item values that will pass through external item transfers. Default is 'Good and Uncertain qualities'	400	Persisted, Enumerated, ExpertPage
ExtItemCalculationSequence	Decides whether data validation or data transfer will be performed first in the external item manager.	300	Persisted, Enumerated, ExpertPage
PersistValToInitVal	Choose strategy for copying and persisting current value to the InitValue. Tip: Consider using an InitVQTFromHoneystore attribute instead, for better performance.	1650	Persisted, Enumerated
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
Objectstore	Path to the (sqlite) database containing the ua model for the namespace. The path may be expressed relative to the hive instance's configuration folder.	1020	Persisted
Uri	The unique uri identifying the namespace	1025	Persisted
Update of uri-metainfo	Specifies wether the PublicationDate, ModelVersion and LastChanged properties for the namespace should be maintained automatically or manually.	1027	Persisted, Enumerated
ModelVersion	The current model version	1028	Persisted
PublicationDate	The publication date for the namespace model	1029	Persisted
LastModified	The last modified date for the namespace model	1030	Persisted
Nameoptions	What should make up the parts of function item names. Either browsename or displayname, possibly with the nodeid appended.	1050	Persisted, Enumerated
Valuename separator	Character used to separate parts of function item names. Normally '.' is used to indicate parent-child like separation.	1065	Persisted
Name termination	When to stop following parent nodes for inclusion in function item names. Stop at naming root: Stop at the first parent object node having a property of the naming root property type. Stop at first object node: Stop at the first parent that is an object node.	1095	Persisted, Enumerated
Naming root type URI	The uri-part of the node id for the naming root property type.	1100	Persisted
Naming root type ID type	The identifier-type-part of the node id for the naming root type.	1101	Persisted, Enumerated
Naming root type ID	The identifier-part of the node id for the naming root type	1102	Persisted
Allow naming root subtypes	Wether subtypes of the naming root type should be treated as a naming root	1103	Persisted
Missing nameroot policy	What to do if the objects folder is reached without identifying an object having a naming-root property along the way. Fail: Generate an error, Stop at first object node: Regenerate the name, but stop at the first object node. Stop at objects folder: Use the full path to the objects folder.	1105	Persisted, Enumerated
Function item generation	Determines when to generate function items fordata variables in the namespace. If no types in namespace: Only generate function items if there are no types defined by the namespace. Always, Never, Data variables that are not instance declarations: Unless a data variable is part of a type definition (instance declaration), it will have a function item generated for it.	1115	Persisted, Enumerated
Assign Ids	If set, unique ids must be assigned by the client when creating new objects. If not set, unique (numerical) ids will be automatically generated when creating new objects.	1080	Persisted

See also Module Properties

APIS Semantics Item Types

Topics Covered:

Properties

Properties

User defined item, which can be written and read.

The Variable item type has the following properties:

Name	Description	ID	Flags
AutoResetTimeout	The timeout for automatically resetting the value. The timeout is in milliseconds. To disable the autoreset, type 0.	10020	Persisted, ExpertPage
AutoResetValue	The value to set when the AutoResetTimeout occurs.	10019	Persisted, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
Valuetype	Item canonical datatype. This is the type of data the field holds. For example: integer, string, datetime, etc.	10010	Persisted, Enumerated

Apis SPCBee

Apis SPC module using the Prediktor Model Management service.

Provider: Prediktor

The SPCBee module has the following item types

SpcAvgRecipeSelectorItem

Properties

The SPCBee module has the following properties:

Name	Description	ID	Flags
Active	Switches the bee on or off.	1003	Persisted
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
MMServiceUri	Connection URI to the web service used to retrieve the SPC parameters.	1001	Persisted
Normalized	Switches normalized calculation on or off.	1002	Persisted
SerivceConnectionStatus	Connection status to MM service	1101	InfoPage
SPCHoneystore	Honeystore for SPC-data. Leve blank for no storage	1004	Persisted

See also Module Properties

Commands And Events

The SPCBee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS SPCBee Item Types

Topics Covered:

Properties

SPCAverageItem...

The SPCAverageItem item type has the following properties:

Name	Description	ID	Flags
AverageCalculationMethod	The method used to calculate the average (mean) value.	10003	Persisted, Enumerated
ModelParameters	The preprocessing model parameters. This property takes a semicolon-separated list of numbers (eg. "3.4;2.1;9.8").	10002	Persisted
ModelParameterType	The type of preprocessing performed on the values.	10001	Persisted, ReadOnly, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SampleCount	The number of samples.	10005	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

SPCRangeItem...

The SPCRangeItem item type has the following properties:

Name	Description	ID	Flags
ModelParameters	The preprocessing model parameters. This property takes a semicolon-separated list of numbers (eg. "3.4;2.1;9.8").	10002	Persisted
ModelParameterType	The type of preprocessing performed on the values.	10001	Persisted, ReadOnly, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
RangeCalculationMethod	The range calculation method that is used.	10004	Persisted, Enumerated
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SampleCount	The number of samples.	10005	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

SPCReloadTriggerItem...

The SPCReloadTriggerItem item type has the following properties:

Name	Description	ID	Flags
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

SPCParameterItem...

The SPCParameterItem item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

SPCValueItem...

The SPCValueItem item type has the following properties:

Name	Description	ID	Flags
ConfiguredLimits	The set limits for DV tests.	10007	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

An item representing a min/max value

The MinMaxValueItem item type has the following properties:

Name	Description	ID	Flags
ConfiguredLimits	The set limits for DV tests.	10007	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Inhibit alarming on the item...

The SPCInhibitAlarmsItem item type has the following properties:

Name	Description	ID	Flags
Delay for the inhibit signal	A float value in seconds indicating the time to wait.	10008	Persisted
InhibitedItem	The name of a tag/item to inhibit.	10006	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Select recipes for an average item

The SpcAvgRecipeSelectorItem item type has the following properties:

Name	Description	ID	Flags
Indicates if item is used as a recipe limit handler or if local limits are used on charts	Bool value	10010	Persisted
LCL_A tagname	String value	10019	Persisted
LCL_A values	String value, semicolon separated	10013	Persisted
LCL_B tagname	String value	10021	Persisted
LCL_B values	String value, semicolon separated	10015	Persisted
LCL_C tagname	String value	10023	Persisted
LCL_C values	String value, semicolon separated	10017	Persisted
Quality	Item quality	3	ReadOnly
Rights	Item access rights	5	ReadOnly
Tagname for recipe value	String value	10009	Persisted
Time	Item timestamp	4	ReadOnly
Type	Item canonical datatype	1	ReadOnly
UCL_A tagname	String value	10018	Persisted
UCL_A values	String value, semicolon separated	10012	Persisted
UCL_B tagname	String value	10020	Persisted
UCL_B values	String value, semicolon separated	10014	Persisted
UCL_C tagname	String value	10022	Persisted
UCL_C values	String value, semicolon separated	10016	Persisted
Value	Item value	2	NormalPage
Values for the recipe items	String value, semicolon separated	10011	Persisted

Properties

Select recipes for an average item

The SpcAvgRecipeSelectorItem item type has the following properties:

Name	Description	ID	Flags
Indicates if item is used as a recipe limit handler or if local limits are used on charts	Bool value	10010	Persisted
LCL_A tagname	String value	10019	Persisted
LCL_A values	String value, semicolon separated	10013	Persisted
LCL_B tagname	String value	10021	Persisted
LCL_B values	String value, semicolon separated	10015	Persisted
LCL_C tagname	String value	10023	Persisted
LCL_C values	String value, semicolon separated	10017	Persisted
Quality	Item quality	3	ReadOnly
Rights	Item access rights	5	ReadOnly
Tagname for recipe value	String value	10009	Persisted
Time	Item timestamp	4	ReadOnly
Type	Item canonical datatype	1	ReadOnly
UCL_A tagname	String value	10018	Persisted
UCL_A values	String value, semicolon separated	10012	Persisted
UCL_B tagname	String value	10020	Persisted
UCL_B values	String value, semicolon separated	10014	Persisted
UCL_C tagname	String value	10022	Persisted
UCL_C values	String value, semicolon separated	10016	Persisted
Value	Item value	2	NormalPage
Values for the recipe items	String value, semicolon separated	10011	Persisted

Apis SQL

The ApisSQL module reads and/or writes data to/from any SQL relational database.

Provider: Prediktor

The SQL module has the following item types

More information

SQL Procedure Examples

Get SQLBee Values

Pu and Get SQLBee Values

Write Data Target

Properties

The SQL module has the following properties:

Name	Description	ID	Flags
ADO CommandTimeout	Indicates how long to wait (in seconds) while executing an SQL command before terminating the attempt and generating an error. The default is 30 seconds. If you enter the value 0, SQL commands will never timeout.	1090	Persisted
AvgSQLQTime	The average query time in milliseconds for SQL queries performed. This is averaged from the last time the statistics were reset or Apis was restarted.	100000	PerformancePage
Connection state	The current state of the connection to the database. This field allows you to see if the bee is connected to the database, if it has the appropriate security rights and if the stored procedure ran successfully.	10000	InfoPage
Custom ConnectionString	When not using MS SQL Server, or if you want to have full control over the connection string, you can specify a custom connection string here. NOTE! When this property is in use, the database login, database login password, database name, and database server are ignored.	1040	Persisted, ExpertPage
Database login	The same as User ID in a standard connection string. If this field is blank, integrated security will be used.	1020	Persisted, User
Database login password	The password to use when accessing the SQL database.	1030	Persisted, Password
Database name	The name of the database on given server, used in the connection string.	1015	Persisted
Database server	The server machine where the database exists, used in the connection string.	1010	Persisted
Description	A description of this module, useful for future maintenance to describe what this module should do.	101	Persisted
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
Last executed SQL	The last executed SQL statement, the text last sent to the SQL server for execution. This field can be useful for debugging, as it allows you to see exactly what SQL is being sent to the SQL server.	10100	InfoPage
LastRecordsetParseTime	The last time a recordset was received and parsed from the SQL Server.	100100	PerformancePage
Locale ID	The locale ID to be used when parsing files. This is a unique id for the country and language, used to determine multiple factors including date formats and decimal points.	1057	Persisted
MaxSQLQTime	The maximum query time in seconds for the SQL queries performed since the last time the statistics were reset or Apis was restarted.	100001	PerformancePage
PDS snapshot SourceDatabase	The name of the snapshot source database. Must be specified when running queries on a PDS snapshot, use this field together with the property 'PDS snapshot usage'	1046	Persisted, ExpertPage
PDS snapshot usage	Whether to use PDS Snapshots or not. When snapshots are to be used, specify the name of the source database database in property 'PDS snapshot SourceDatabase' as well , and the SQL query will be executed on a snapshot acquired from the PDS Snapshot Manager.	1045	Persisted, Enumerated, ExpertPage
Provider	The provider of the module.		Persisted
SQL statement	The SQL statement to execute. Can be an 'execute statement' or a fully qualified file name containing the statements to execute. This, in combination with the SQL statement type property, decides what text to send to SQL server.	1080	Persisted
SQL statement type	This dropdown property has two options: Execute as text - the text will be sent to the SQL database as it's written and executed. For example, SELECT * FROM AnyTableName; Execute as stored procedure - A name of a stored procedure with predefined signature that will be executed with arguments (mandatory when using Write items). The write items are sent as XML, which is covered in further detail in the Quick Start Guide.	1079	Persisted, Enumerated
Table schema	How the data will be returned from the SQL executed. 'By rows' means item name, value, timestamp and quality are in one row, in this order. 'By columns' means item name(s) is column header(s), value in first row, timestamps and quality are not supported.	1075	Persisted, Enumerated
Timer interval	Timer interval in milliseconds, must be >= 50 ms. Ensure that this is not smaller than the runtime of the SQL executed, or the server may struggle to keep up with demand from the module.	1110	Persisted
TimeReferenceItem	An item, the value of which will be used as the time reference for this module instead of the system time when setting the timestamp on items.	200	Persisted, ApisItem, ExpertPage
Version	The version of SQL Bee this module is running.		Persisted

See also Module Properties

Commands And Events

The SQL module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
OnTimer	An event fired when at a rate given by the ModelRefreshInterval or Timerperiod property	Normal
UpdateDone	An event for when the updating of the recordset is done.	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
SynchUpdate	Updates the recordset synchronously.	Synchronous
Update	Update the recordset.	Asynchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS SQL Item Types

Topics Covered:

Read Item Properties

Item type for reading scalar, vector and matrix values from the database.

The Read item item type has the following properties:

Name	Description	ID	Flags
InitValueEnabled	Whether this item has an initial value on start up of Apis Hive. If enabled, this allows for the setting of a value so the initial value isn't blank or null on each restart.		Persisted
Item type	A field indicating what type of item this is. This is always set to "Read item" for Read Items.		ReadOnly
Name	The name of this item. This is independent of the name of the item from SQL server (see the SrcItemID property).		Persisted
Quality	Item quality. This indicates the current quality of the signal from SQL Server. The quality may be "Good" meaning the field is being read correctly, "Bad:Connect error" meaning that there's a problem with the database location or security properties on the module, or "Bad:Config error" meaning there's another problem with the connection to the database, or the field is not found in the database results.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly
Valuetype	Item canonical datatype. The type of value this field contains. For example, string, int, datetime, etc.	10031	Persisted, Enumerated

Write Item Properties

Item type for writing scalar values to the database.

The Write item item type has the following properties:

Name	Description	ID	Flags
InitValueEnabled	Whether this item has an initial value on start up of Apis Hive. If enabled, this allows for the setting of a value so the initial value isn't blank or null on each restart.		Persisted
Item type	A field indicating what type of item this is. This is always set to "Write item" for Write Items.	5801	ReadOnly
Name	The name of this item. This is independent of the name of the item from SQL server (see the SrcItemID property).	100	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly
Valuetype	Item canonical datatype. The type of value this field contains. For example, string, int, datetime, etc.	10031	Persisted, Enumerated
WriteUpdatedOnly	This field is set to true by default, and means that values will only be sent to SQL Server if the value has changed since the last time the command was run. If the value has no changed, it will be omitted from the list of parameters in the XML to SQL Server.	11000	Persisted

Write Vector Properties

Item type for writing vector values to the database.

The Write vector item item type has the following properties:

Name	Description	ID	Flags
Arraytype	The data type of the values to be held in the matrix. For example, string, int, datetime, etc.	10041	Persisted
Dimension	The dimension of a vector item (number or elements).	5007	Persisted
InitValueEnabled	Whether this item has an initial value on start up of Apis Hive. If enabled, this allows for the setting of a value so the initial value isn't blank or null on each restart.		Persisted
Item type	A field indicating what type of item this is. This is always set to "Write vector item" for Write Vector Items.	5801	ReadOnly
Name	The name of this item. This is independent of the name of the item from SQL server (see the SrcItemID property).	100	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly
WriteUpdatedOnly	This field is set to true by default, and means that values will only be sent to SQL Server if the value has changed since the last time the command was run. If the value has no changed, it will be omitted from the list of parameters in the XML to SQL Server.	11000	Persisted

Write Matrix Properties

Item type for writing matrix values to the database.

The Write matrix item item type has the following properties:

Name	Description	ID	Flags
Arraytype	The data type of the values to be held in the matrix. For example, string, int, datetime, etc.	10041	Persisted
Columns	The number or columns in matrix item.	5009	Persisted
InitValueEnabled	Whether this item has an initial value on start up of Apis Hive. If enabled, this allows for the setting of a value so the initial value isn't blank or null on each restart.		Persisted
Item type	A field indicating what type of item this is. This is always set to "Write matrix item" for Write Matrix Items.	5801	ReadOnly
Name	The name of this item. This is independent of the name of the item from SQL server (see the SrcItemID property).	100	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Rows	The number of rows in a matrix item.	5008	Pesisted
SrcItemID	The item ID in the source. This is the item ID this item uses to fetch data from the source.	5030	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly
WriteUpdatedOnly	This field is set to true by default, and means that values will only be sent to SQL Server if the value has changed since the last time the command was run. If the value has no changed, it will be omitted from the list of parameters in the XML to SQL Server.	11000	Persisted

Trigger Item Properties

Item which can trigger an SQL update.

The Triggeritem item type has the following properties:

Name	Description	ID	Flags
InitValueEnabled	Whether this item has an initial value on start up of Apis Hive. If enabled, this allows for the setting of a value so the initial value isn't blank or null on each restart.		Persisted
Item type	A field indicating what type of item this is. This is always set to "Triggeritem" for Trigger Items.	5801	ReadOnly
Name	The name of this item. This is independent of the name of the item from SQL server (see the SrcItemID property).	100	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

SQL Examples

Covering these AMAZING examples:

WriteDataTarget

This query creates table (WriteDataTarget) with all necessary columns to be able to read/write data from Apis SQL module.


USE [TestDB]

GO

/****** Object: Table [dbo].[WriteDataTarget] Script Date: 06/08/2009 15:53:05 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

CREATE TABLE [dbo].[WriteDataTarget](

[ID] [int] IDENTITY(1,1) NOT NULL,

[ItemID] [nvarchar](max) NOT NULL,

[ItemValue] [nvarchar](max) NOT NULL,

[ItemTimestamp] [datetime] NOT NULL,

[ItemQuality] [smallint] NOT NULL,

[Row] [smallint] NULL,

[Col] [smallint] NULL,

CONSTRAINT [PK_WriteDataTarget] PRIMARY KEY CLUSTERED

(

[ID] ASC

)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]

) ON [PRIMARY]

GO

PutAndGetSQLBeeValues


--USE [TestDB]

--GO

/****** Object: StoredProcedure [dbo].[PutAndGetSQLBeeValues] Script Date: 12/09/2005 08:50:44 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

if (not exists(

select SS.Name, SO.Name from Sys.objects SO

INNER JOIN Sys.schemas SS ON SS.schema_id = SO.schema_id

where SS.Name = 'dbo' and SO.Name = 'PutAndGetSQLBeeValues' and SO.type = 'P'))

BEGIN

exec ('CREATE PROCEDURE dbo.PutAndGetSQLBeeValues AS')

END

GO

-- =============================================

-- Create date: 30/5-2009

-- Description: Sample SP for reading and writing data to/from SQL server using Apis SQL Bee

-- =============================================

ALTER PROCEDURE [dbo].[PutAndGetSQLBeeValues]

-- Add the parameters for the function here

@ByRows bit = 1,

@ModuleName nvarchar(max) = '',

@TriggerName nvarchar(max) = '',

@xmlWriteData xml = null

AS

BEGIN

-- SET NOCOUNT ON added to prevent extra result sets from interfering with SELECT statements.

SET NOCOUNT ON;

------------------------------------------------------------------

-- First handle WRITE operations:

-- GENERIC CODE:

-- The Format of the XML Document give as input param @xmlWriteData:

-- <?xml version="1.0" encoding="utf-16"?>

-- <ROOT>

-- <ItemSample ItemID="SQLBee1.MyWriteItem1" ItemValue="1.1" ItemTimestamp="2009-05-29 12:00:00.000" ItemQuality="192" />

-- <ItemSample ItemID="SQLBee1.MyWriteItem2" ItemValue="3.14" ItemTimestamp="2009-05-29 12:00:00.000" ItemQuality="192" />

-- <ItemSample ItemID="SQLBee1.MyWriteItem3" ItemValue="6.28" ItemTimestamp="2009-05-29 12:00:00.000" ItemQuality="192" />

-- :

-- <ItemSample ItemID="SQLBee1.MyWriteVector1" ItemValue="1.1" ItemTimestamp="2009-05-29 12:00:00.000" ItemQuality="192" Row="0"/>

-- <ItemSample ItemID="SQLBee1.MyWriteVector1" ItemValue="2.1" ItemTimestamp="2009-05-29 12:00:00.000" ItemQuality="192" Row="1"/>

-- <ItemSample ItemID="SQLBee1.MyWriteVector1" ItemValue="3.1" ItemTimestamp="2009-05-29 12:00:00.000" ItemQuality="192" Row="2"/>

-- <ItemSample ItemID="SQLBee1.MyWriteVector1" ItemValue="4.1" ItemTimestamp="2009-05-29 12:00:00.000" ItemQuality="192" Row="3"/>

-- :

-- <ItemSample ItemID="SQLBee1.MyWriteMatrix1" ItemValue="1.1" ItemTimestamp="2009-05-29 12:00:00.000" ItemQuality="192" Row="0" Col="0"/>

-- <ItemSample ItemID="SQLBee1.MyWriteMatrix1" ItemValue="2.1" ItemTimestamp="2009-05-29 12:00:00.000" ItemQuality="192" Row="1" Col="0"/>

-- <ItemSample ItemID="SQLBee1.MyWriteMatrix1" ItemValue="1.2" ItemTimestamp="2009-05-29 12:00:00.000" ItemQuality="192" Row="0" Col="1"/>

-- <ItemSample ItemID="SQLBee1.MyWriteMatrix1" ItemValue="2.2" ItemTimestamp="2009-05-29 12:00:00.000" ItemQuality="192" Row="1" Col="1"/>

-- </ROOT>

--print convert(nvarchar(max), @xmlWriteData)

Declare @WriteDataTable TABLE

(

ItemID nvarchar(max),

ItemValue nvarchar(max),

--ItemType smallint,

ItemTimestamp datetime,

ItemQuality smallint,

Row smallint,

Col smallint

)

DECLARE @hXmlDoc int

Exec sp_xml_preparedocument @hXmlDoc Output, @xmlWriteData

if (@hXmlDoc is not null)

begin

INSERT INTO @WriteDataTable(ItemID, ItemValue, ItemTimestamp, ItemQuality, Row, Col)

SELECT ItemID, ItemValue, ItemTimestamp, ItemQuality, Row, Col

FROM

OPENXML(@hXmlDoc, '/ROOT/ItemSample',1)

WITH (ItemID nvarchar(max), ItemValue nvarchar(max), ItemTimestamp datetime, ItemQuality smallint, Row smallint, Col smallint)

end

Exec sp_xml_removedocument @hXmlDoc

-- Then use contents of @WriteDataTable to insert into target system

-- END OF GENERIC CODE:

-- CUSTOMER SPECIFIC CODE!

-- Sample 1: Insert into target table:

--insert into WriteDataTarget

--select * from @WriteDataTable

-- Sample 2: Call a customer specific stored procedure

--Exec CustomerStoredProc

-- convert( real, select ItemValue from @WriteDataTable where ItemID = 'Tagnavn 1'),

-- convert( real, select ItemValue from @WriteDataTable where ItemID = 'Tagnavn 2'),

-- convert( real, select ItemValue from @WriteDataTable where ItemID = 'Tagnavn 3'),

-- convert( real, select ItemValue from @WriteDataTable where ItemID = 'Tagnavn 4')

------------------------------------------------------------------

-- Then handle READ operations:

-- Insert statements for procedure here

-- Below is sample code for generating a dummy namespace and dummy values:

Declare @TS datetime

Set @TS = GetUtcDate()

if @ByRows = 1

begin

Declare @RandomTable TABLE

(

ItemName varchar(64),

ItemValue varchar(128),

ItemTimestamp datetime

)

insert into @RandomTable select 'BoolValue', cast(round(Rand(), 0) as varchar(128)), @TS

insert into @RandomTable select 'FloatValue', cast(10*RAND() as varchar(128)), @TS

insert into @RandomTable select 'StringValue', 'StringValue X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV', @TS

insert into @RandomTable select 'DateValue', cast(getDate() as varchar(128)), @TS

insert into @RandomTable select 'BoolValue2', cast(round(Rand(), 0) as varchar(128)), @TS

insert into @RandomTable select 'FloatValue2', cast(10*RAND() as varchar(128)), @TS

insert into @RandomTable select 'StringValue2', 'StringValue2 X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV', @TS

insert into @RandomTable select 'DateValue2', cast(getDate() as varchar(128)), @TS

insert into @RandomTable select 'BoolValue3', cast(round(Rand(), 0) as varchar(128)), @TS

insert into @RandomTable select 'FloatValue3', cast(10*RAND() as varchar(128)), @TS

insert into @RandomTable select 'StringValue3', 'StringValue3 X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV', @TS

insert into @RandomTable select 'DateValue3', cast(getDate() as varchar(128)), @TS

insert into @RandomTable select 'BoolValue4', cast(round(Rand(), 0) as varchar(128)), @TS

insert into @RandomTable select 'FloatValue4', cast(10*RAND() as varchar(128)), @TS

insert into @RandomTable select 'StringValue4', 'StringValue4 X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV', @TS

insert into @RandomTable select 'DateValue4', cast(getDate() as varchar(128)), @TS

insert into @RandomTable select 'BoolValue5', cast(round(Rand(), 0) as varchar(128)), @TS

insert into @RandomTable select 'FloatValue5', cast(10*RAND() as varchar(128)), @TS

insert into @RandomTable select 'StringValue5', 'StringValue5 X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV', @TS

insert into @RandomTable select 'DateValue5', cast(getDate() as varchar(128)), @TS

insert into @RandomTable select 'StringArray', '[2] elem1-' +cast(round(100*RAND(), 0) as varchar(128)) + '; elem2-' + cast(round(100*RAND(), 0) as varchar(128)) + ';', @TS

insert into @RandomTable select 'DoubleArray', '[2] ' + cast(100*RAND() as varchar(128)) + '; ' + cast(100*RAND() as varchar(128)) + ';', @TS

select * from @RandomTable

end

else

begin

Select

cast(round(Rand(), 0) as bit) as 'ColBoolValue',

10*RAND() as 'ColFloatValue',

'column X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV' as 'ColStringValue',

getDate() as 'ColDateValue',

cast(round(Rand(), 0) as bit) as 'ColBoolValue2',

10*RAND() as 'ColFloatValue2',

'column X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV' as 'ColStringValue2',

getDate() as 'ColDateValue2',

cast(round(Rand(), 0) as bit) as 'ColBoolValue3',

10*RAND() as 'ColFloatValue3',

'column X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV' as 'ColStringValue3',

getDate() as 'ColDateValue3',

cast(round(Rand(), 0) as bit) as 'ColBoolValue4',

10*RAND() as 'ColFloatValue4',

'column X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV' as 'ColStringValue4',

getDate() as 'ColDateValue4',

cast(round(Rand(), 0) as bit) as 'ColBoolValue5',

10*RAND() as 'ColFloatValue5',

'column X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV' as 'ColStringValue5',

getDate() as 'ColDateValue5',

'[2] tkst-' +cast(round(100*RAND(), 0) as varchar(128)) + '; tkst-' + cast(round(100*RAND(), 0) as varchar(128)) + ';' as 'StringArray',

'[2] ' + cast(100*RAND() as varchar(128)) + '; ' + cast(100*RAND() as varchar(128)) + ';' as 'DoubleArray'

end

END

GetSQLBeeValues


USE [TestDB]

GO

/****** Object: StoredProcedure [dbo].[GetSQLBeeValues] Script Date: 12/09/2005 08:50:44 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

-- =============================================

-- Author: <Author,,Name>

-- Create date: <Create Date,,>

-- Description: <Description,,>

-- =============================================

CREATE PROCEDURE [dbo].[GetSQLBeeValues]

-- Add the parameters for the function here

@ByRows bit = 1

--<@Param2, sysname, @p2> <Datatype_For_Param2, , int> = <Default_Value_For_Param2, , 0>

AS

BEGIN

-- SET NOCOUNT ON added to prevent extra result sets from

-- interfering with SELECT statements.

SET NOCOUNT ON;

waitfor delay '00:00:01'

-- Insert statements for procedure here

--SELECT @p1, @p

Declare @TS datetime

Set @TS = GetUtcDate()

if @ByRows = 1

begin

Declare @RandomTable TABLE

(ItemName varchar(64), ItemValue varchar(128), ItemTimestamp datetime)

insert into @RandomTable select 'BoolValue', cast(round(Rand(), 0) as varchar(128)), @TS

insert into @RandomTable select 'FloatValue', cast(10*RAND() as varchar(128)), @TS

insert into @RandomTable select 'StringValue', 'row X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV', @TS

insert into @RandomTable select 'DateValue', cast(getDate() as varchar(128)), @TS

insert into @RandomTable select 'BoolValue2', cast(round(Rand(), 0) as varchar(128)), @TS

insert into @RandomTable select 'FloatValue2', cast(10*RAND() as varchar(128)), @TS

insert into @RandomTable select 'StringValue2', 'row X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV', @TS

insert into @RandomTable select 'DateValue2', cast(getDate() as varchar(128)), @TS

insert into @RandomTable select 'BoolValue3', cast(round(Rand(), 0) as varchar(128)), @TS

insert into @RandomTable select 'FloatValue3', cast(10*RAND() as varchar(128)), @TS

insert into @RandomTable select 'StringValue3', 'row X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV', @TS

insert into @RandomTable select 'DateValue3', cast(getDate() as varchar(128)), @TS

insert into @RandomTable select 'BoolValue4', cast(round(Rand(), 0) as varchar(128)), @TS

insert into @RandomTable select 'FloatValue4', cast(10*RAND() as varchar(128)), @TS

insert into @RandomTable select 'StringValue4', 'row X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV', @TS

insert into @RandomTable select 'DateValue4', cast(getDate() as varchar(128)), @TS

insert into @RandomTable select 'BoolValue5', cast(round(Rand(), 0) as varchar(128)), @TS

insert into @RandomTable select 'FloatValue5', cast(10*RAND() as varchar(128)), @TS

insert into @RandomTable select 'StringValue5', 'row X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV', @TS

insert into @RandomTable select 'DateValue5', cast(getDate() as varchar(128)), @TS

insert into @RandomTable select 'StringArray', '[2] tkst-' +cast(round(100*RAND(), 0) as varchar(128)) + '; tkst-' + cast(round(100*RAND(), 0) as varchar(128)) + ';', @TS

insert into @RandomTable select 'DoubleArray', '[2] ' + cast(100*RAND() as varchar(128)) + '; ' + cast(100*RAND() as varchar(128)) + ';', @TS

select * from @RandomTable

end

else

begin

Select

cast(round(Rand(), 0) as bit) as 'ColBoolValue',

10*RAND() as 'ColFloatValue',

'column X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV' as 'ColStringValue',

getDate() as 'ColDateValue',

cast(round(Rand(), 0) as bit) as 'ColBoolValue2',

10*RAND() as 'ColFloatValue2',

'column X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV' as 'ColStringValue2',

getDate() as 'ColDateValue2',

cast(round(Rand(), 0) as bit) as 'ColBoolValue3',

10*RAND() as 'ColFloatValue3',

'column X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV' as 'ColStringValue3',

getDate() as 'ColDateValue3',

cast(round(Rand(), 0) as bit) as 'ColBoolValue4',

10*RAND() as 'ColFloatValue4',

'column X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV' as 'ColStringValue4',

getDate() as 'ColDateValue4',

cast(round(Rand(), 0) as bit) as 'ColBoolValue5',

10*RAND() as 'ColFloatValue5',

'column X' +cast(round(100*RAND(), 0) as varchar(128)) + 'XEV' as 'ColStringValue5',

getDate() as 'ColDateValue5',

'[2] tkst-' +cast(round(100*RAND(), 0) as varchar(128)) + '; tkst-' + cast(round(100*RAND(), 0) as varchar(128)) + ';' as 'StringArray',

'[2] ' + cast(100*RAND() as varchar(128)) + '; ' + cast(100*RAND() as varchar(128)) + ';' as 'DoubleArray'

end

END

Apis StateSave

This module saves and load values of items from the namespace of Apis Hive to ascii file.

Provider: Prediktor

The StateSave module has the following item types

Properties

The StateSave module has the following properties:

Name	Description	ID	Flags
AwaysReportStateChange	Set this value to false when you only want to fire 'StateSave' or 'StateLoad' event on successfully save or load of state of one or more state file.	1800	Persisted, ExpertPage
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
SkipModuleName	When true, module part of item names are omitted when saving/loading statesave files. This property applies only when NOT using global Key attribute to lookup statesave items.	1700	Persisted
StateFileFolder	The folder in which the file(s) recides (Working folder)	1600	Persisted, Folder

See also Module Properties

Commands And Events

The StateSave module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
StatesDeleted	A state-delete operation has been performed.	Normal
StatesLoaded	A state-load operation has been performed.	Normal
StatesSaved	A state-save operation has been performed.	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS StateSave Item Types

Topics Covered:

Properties

A StateSave file item

The StateFileName item type has the following properties:

Name	Description	ID	Flags
CreateDirectory	Whether to attempt to create file directory if it doesn't exist.	10306	Persisted
DeleteDir	Deletes the snapfile directory after a delete of snapfile, if the directory is empty.	10320	Persisted
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
FileAccess	Decides whether the file specified in the item is in read, write, or read/write mode (Read=0, Write=1, Read/Write=2).	10300	Persisted, Enumerated
FilePrefix	A fixed value to include before the file name.	10302	Persisted
FileSuffix	A fixed value to include after the file name.	10304	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
TriggerOnChange	If true, the state file will be read/written to when the item changes.	10310	Persisted
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

The folder in which the file(s) recides (Working folder)

The StateFileFolder item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

A StateSave item

The StateSaveLoad item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

A StateSave delete item

The StateSaveDelete item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Apis TaskScheduler

This module schedules non-Apis tasks for execution.

Provider: Prediktor

The TaskScheduler module has the following item types

Task

Properties

The TaskScheduler module has the following properties:

Name	Description	ID	Flags
DefaultFolder	Default browsing folder for files to use when adding tasks.	1010	Persisted, Folder
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
ShowWebBrowser	Show the window which navigates to- and prints 'HTMLprint' tasks.	1020	Persisted
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

See also Module Properties

Commands And Events

The TaskScheduler module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS TaskScheduler Item Types

Topics Covered:

Task

Properties

An executable command in the OS or a file to apply a verb to.

The Task item type has the following properties:

Name	Description	ID	Flags
CurrentState	The CURRENT_STATE of a task.	11000	Persisted, Hidden
Directory	The directory in which to execute the task.	10050	Persisted, Folder
File	The file to execute, print etc..	10005	Persisted, File
NextTime	The next execution time of the task in the local timezone.	10010	Persisted
Parameter	The parameters to send to the task (if needed).	10040	Persisted
Period	The time period between each repetition of the task.	10020	Persisted, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Show	How to display the task when executed.	10060	Persisted, Enumerated
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage
Verb	The verb to apply to this task (normally 'print' or 'open').	10030	Persisted, Enumerated

Apis TunnelBee

The main purpose of this module is to simplify the exchange of real-time data when communicating through a firewalls between Apis instances. You can setup TunnelBee to either push of pull data from the server. This is done by adding the TunnelBee to either the server side (push) or the client side (pull). The TunnelBee requires that you have Apis configured on both sides of the firewall and one port number open in the firewall. The TunnelBee will be hosted in the Apis instance in the direction where the port has been open in the firewall. The port number is configurable through module properties.

To get communication to work between the two Apis instances using Apis tunneler, you need to enable Apis messaging in the Apis instance that the TunnelBee is communicating with and configure the security of the WCF service.

Communication:

This module is based on Windows Communication Foundation (WCF) and its security model.

Pull data:

If the server is running behind the firewall and the firewall has open an port to allow incoming connections, the TunnelBee will be configured in the Apis instance outside the firewall (client side). In this mode you can replicate the namespace of the server meaning that the namespace can maintain itself based on the configuration of the server.

Push data:

If the server is running behind the firewall and the firewall has open an port to allow outgoing connections, the TunnelBee will be configured in the Apis instance inside the firewall (server side). In this mode you need to maintain the namespace manually.

Provider: Prediktor

The TunnelBee module has the following item types

ApisItem

Properties

The TunnelBee module has the following properties:

Name	Description	ID	Flags
ACU_ItemRegistrationChanged	Last time received ACU message 'ItemRegistrationChanged'	1160	InfoPage
ACU_ItemsAdded	Last time received ACL message 'ItemsAdded'	1130	InfoPage
ACU_ItemsDeleted	Last time received ACU message 'ItemsDeleted'	1140	InfoPage
ACU_ModuleAdded	Last time received ACU message 'ModuleAdded'	1170	Hidden, InfoPage
ACU_ModuleDeleted	Last time received ACU message 'ModuleDeleted'	1180	Hidden, InfoPage
ACU_ModulePropertiesChanged	Last time received ACU message 'ModulePropertiesChanged'	1190	Hidden, InfoPage
ClientHash		1020	InfoPage
ClientMode	Defines the type of mode to run the client in. Hub mode extract items independent of the name space and replication mode maintains the name space of the items based on the name of the module.	1001	Persisted, ReadOnly, Enumerated, ExtraInfo
ClientName		1010	InfoPage
Connected	Status of connection to the remote host (Host is define by module property URL)	1050	InfoPage
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
Fingerprint		1015	InfoPage
ItemCountRead	Number of items in the last read call to the server	1080	InfoPage
ItemCountReadFailed	Number of items faild to be read in the last read call to the server	1090	InfoPage
ItemCountWrite	Numbers of items to be written in the last write call to the server.	1110	InfoPage
ItemCountWriteFailed	Number of items failed to be written in the the last write call to the server.	1120	InfoPage
LastReadTime	Last time items was read from server	1070	InfoPage
LastWriteTime	Last time items was written to server	1100	InfoPage
LocalUpdateTime	The current time to update local namespace [msec]	1350	PerformancePage
MaxLocalUpdateTime	The time used to update namespace in Apis with received data from remote host [msec]	1450	PerformancePage
MaxRemoteRequestTime	The max time for requesting new data from remote host [msec]	1400	PerformancePage
MaxTotalTime	The max total time used to request and update data from remote host [msec]	1500	PerformancePage
MinTotalTime	The max total time used to request and update data from remote host [msec]	1550	PerformancePage
NamespaceDiscovery	Type of mode used to fetch items from remote server.	1005	Persisted, Enumerated, ExpertPage
OpenTimeout	Gets or sets the interval of time provided for a connection to open before the open operation has to complete. The default value is 60 seconds.	1200	Persisted, ExpertPage
Password	Nettwork password	1004	Persisted, Password, ExpertPage
ReceiveTimeout	Gets or sets the interval of time that a connection can remain inactive, during which no application messages are received, before it is dropped. The default value is 600 second	1220	Persisted, ExpertPage
RemoteRequestTime	The current time to request remote data [msec]	1300	PerformancePage
RequestStatus	Current request mode	1600	PerformancePage
SendTimeout	Gets or sets the interval of time provided for a write operation to complete before timing out. The default value is 60 second	1210	Persisted, ExpertPage
SubscriptionCount	Number of items in subscription list	1060	InfoPage
UpdateRate	The time to request data and messages from the remote server in ms	1007	Persisted, ExpertPage
URL	The URL to the server. Ex http://<ServerName>:<PortNumber>/Prediktor.Apis.MessageBroker/ApisMessageBrokerSvc or net.tcp://<ServerName>:<PortNumber>/Prediktor.Apis.MessageBroker/ApisMessageBrokerSvc	1002	Persisted, URL
Username	Nettwork username	1003	Persisted, ExpertPage

See also Module Properties

Commands And Events

The TunnelBee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS TunnelBee Item Types

Topic Covered:

ApisItem

Properties

Apis item from external system.

The ApisItem item type has the following properties:

Name	Description	ID	Flags
ClientHandle	The client handle of the item, as registered with the OPC sever. When negative, the item has not been accepted by the OPC server.	10003	Persisted, ExpertPage
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SourceItemId	The item ID in the source. This is the item ID this item uses to fetch data from the source.	10002	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Communication Security

The communication is based on Windows Communication Foundation (WCF).

To configure security, you use behaviors and bindings for your WCF service. Bindings and behaviors allow you to configure transfer security, authentication, authorization, impersonation, and delegation as well as auditing and logging

Figure 1, Bindings

With transfer security is the means by which WCF secures messages over the network. WCF gives you two options to implement transfer security: transport security and message security. Transport security secures the entire communication channel (e.g., by using SSL), while message security secures each message individually.

Transport Security

When using transport security, the user credentials and claims are passed using the transport layer. In other words, user credentials are transport-dependent, which allows fewer authentication options compared to message security. Each transport protocol (TCP, IPC, MSMQ, or HTTP) has its own mechanism for passing credentials and handling message protection. The most common approach for this is to use Secure Sockets Layer (SSL) for encrypting and signing the contents of the packets sent over Secure HTTP (HTTPS).

Transport security is used to provide point-to-point security between the two endpoints (service and client). If there are intermediary systems between the client and the service, each intermediate point must forward the message over a new SSL connection.

Figure 2, Transport security

Use transport security for the following scenarios:

You are sending a message directly from your application to a WCF service and the message will not be routed through intermediate systems.
You have both the service and the client in an intranet.

Using transport security has the following advantages:

It provides interoperability, meaning that communicating parties do not need to understand the WS-Security specification.
It may result in better performance.
Hardware accelerators can be used to further improve performance.

Using transport security has the following disadvantages:

Because security is applied on a point-to-point basis, there is no provision for multiple hops or routing through intermediate application nodes.
It supports a limited set of credentials and claims compared to message security.
It is transport-dependent upon the underlying platform, transport mechanism, and security service provider such as NTLM or Kerberos.

Message Security

When using message security, the user credentials and claims are encapsulated in every message using the WS-Security specification to secure messages. This option gives the most flexibility from an authentication perspective. You can use any type of security credentials you want, largely independent of transport, as long as both the client and the service agree

Figuire 3, Message security

Use message security for the following scenarios:

You are sending a message to a WCF service, and the message is likely to be forwarded to other WCF services or may be routed through intermediate systems.
Your WCF clients are accessing the WCF service over the Internet, it is possible that other intermediate systems may be used in between, and security is your top consideration.

Using message security has following advantages:

It provides end-to-end security. Because message security directly encrypts and signs the message, having intermediaries does not break the security.
It allows partial or selective message encryption and signing, thus improving overall application performance.
Message security is transport-independent and can be used with any transport protocol.
It supports a wide set of credentials and claims, including issue token, which enables federated security.

Using message security has following disadvantages:

This option may reduce performance compared to transport security because each individual message is encrypted and signed.
It does not support interoperability with older ASP.NET Web Services (ASMX) clients because it requires both the client and service to support WS-Security specifications.

Apis UaAcClientBee

Used to communicate to OPC UA AC servers.

Provider: Prediktor

ApisSimpleAttributeFilterItem

The UaAcClientBee module has the following item types

ApisStatusItem

ApisAlarmConditionItem

ApisAlarmMonitorItem

Properties

The UaAcClientBee module has the following properties:

Name	Description	ID	Flags
Area	The default area to link the source item in Apis Hive (default: Area).	1140	Persisted
Certificate	Specifies the certificate used when connecting to an OpcUA server (default = Apis Hive instance certificate)	1490	Persisted, Enumerated, ExpertPage
CertificateSubject	The server certificate subject	3050	InfoPage
CertificateThumbprint	The server certificate thumbprint	3060	InfoPage
CurrentKeepAliveCount		3010	InfoPage
CurrentLifetimeCount		3020	InfoPage
CurrentPriority		3040	InfoPage
CurrentPublishingEnabled		3030	InfoPage
CurrentPublishingInterval		3001	InfoPage
Enabled	The parameter is used to enable or disable the module (default:false).	1050	Persisted
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
KeepAliveCount	When this counter reaches the value calculated for the lifetime of a Subscription based on the MaxKeepAliveCount parameter, the Subscription is closed. Minimum value is 5 (default:10).	1200	Persisted
LifetimeCount	A value that contains the number of consecutive publishing timer expirations without Client activity before the Subscription is terminatedSubscription LifetimeCount. Minimum value is 5 (default:10).	1250	Persisted
MaxNotificationsPerPublish	The maximum number of notifications that the Client wishes to receive in a single Publish response. A value of zero indicates that there is no limit (default:1000)	1300	Persisted
Operation Mode	The type of mode of the Bee (default: Both_auto).	1112	Persisted, Enumerated
OperationTimeout	The OperationTimeout should be twice the minimum value for PublishingInterval*KeepAliveCount (default=20000)	1150	Persisted
Password		1450	Persisted, Hidden, Password, ExpertPage
Priority	Indicates the relative priority of the Subscription. When more than one Subscription needs to send Notifications, the Server should dequeue a Publish request to the Subscription with the highest priority number. A Client that does not require special priority settings should set this value to zero .Subscription Priority (default:0)	1350	Persisted
PublishingInterval	This interval defines the cyclic rate that the Subscription is being requested to return Notifications to the Client. This interval is expressed in milliseconds Subscription PublishingInterval. The value 0 is invalid (default:1000).	1170	Persisted
ReconnectTimout	The timeout for reconnecting server. The unit is in sec and value >5 is valid, and 0 will disabled it (default: 30).	1125	Persisted
RefreshSupported	If server support refresh function of alarms (default=true).	1145	Persisted
StorePath	The path of the certificate store (Default='LocalMachine\UA Applications')	1550	Persisted, ExpertPage
StoreType	The type of the certificate store (Default=Windows)	1500	Persisted, Enumerated, ExpertPage
SubjectName	The subject name of the certificate. Required if Certificate=Custom.	1600	Persisted, ExpertPage
TraceLogMaxSize	The max size of the trace log file. The value of '<0' means no limits and the value of '=0' means the log is turned off.When the log size if specified the size must be greater than 100KByte.Note: The unit is in KBytes and the file is located in configuration folder (Default='0')	1800	Persisted, ExpertPage
URL	OPC UA server url (http OR opc.tcp).	1100	Persisted
Username		1400	Persisted, Hidden, ExpertPage

See also Module Properties

Commands And Events

The UaAcClientBee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS UaAcClientBee Item Types

Topics Covered:

Properties

Internal items that are used to inform you about the status.

The ApisStatusItem item type has the following properties:

Name	Description	ID	Flags
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

This item is used to link an OPC UA Alarm&Condition event to an item source in Apis.

The ApisAlarmConditionItem item type has the following properties:

Name	Description	ID	Flags
Area	This is the source item reference.	10025	Persisted, ExpertPage
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted, ExpertPage
OpcEventType	The source item reference.	10150	Persisted, Enumerated, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SourceName	The name of the source event object.	10050	Persisted, ExpertPage
SourceUri	The source URI of the item reference (Default:nsu=http://opcfoundation.org/UA/;i=2253).	10075	Persisted, ExpertPage
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Properties

This item is used to configure monitoring of alarms in UA.

The ApisAlarmMonitorItem item type has the following properties:

Name	Description	ID	Flags
AreaUri	The source URI of the item reference (Default:nsu=http://opcfoundation.org/UA/;i=2253).	10065	Persisted, ExpertPage
Enabled	Whether this item Is enabled or not.	10012	Persisted
EventType	The type of event to subscribe to.	10175	Persisted, Enumerated
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
SimpleAttributeFilters	The SimpleAttributeOperand structure is used in the select clause to select the value to return. It returns it if an event meets the criteria specified by the where clause.	10200	Persisted, ApisLocalItem
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

This iem is used to create filters which when set up monitoring on items

The ApisSimpleAttributeFilterItem item type has the following properties:

Name	Description	ID	Flags
AttributeType	The type of attribute used in the simple operand expression. For example, string, integer, etc.	10400	Persisted, Enumerated
BrowsePath	The browse path used in the simple operand expression.	10375	Persisted, Enumerated
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
ItemHandle	The handle of the item - this is the unique ID for the item. This property is often hidden.	10001	Persisted, ExpertPage
LiteralOperand	The operand used in the filter expression.	10300	Persisted, Enumerated
LiteralValueType	The value type of the literal value. The value of the item is used to set the "LiteralValue".	10275	Persisted, Enumerated
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
TypeDefinition	The type definition used in the "Simple operand" expression.	10350	Persisted, Enumerated
Value	The current value of the item.	2	NormalPage

Apis UaPublisherBee

This module can be used to publish information to Microsoft Eventhub. We create the messages according to the OpcUa spesification defined in "OpcUa Part 14 PubSub Release 1.04 Specification".

Also see: Stream data to broker

We only support the Json messages defined in 7.3.2 JSON Message Mapping and Json_Simplified

We use a standard communication protocol AMQP, MQTT, and Kafka to send the information to the broker. We also have the possibilities store the created messages in files, but this is to check the messages layout and content for more debugging purpose.

The property "BrokerType" define the communication to the broker. Below is a description how to configure different

File:

Select this and define a filename under an existing directory. e.g "c:/pubsub/data.json" in the property "FileName".The file will be created, and for every message sent, a new line in the file will be added. There is a maximum size of the file and then a new file will be created. Up to 10 files and then the files will be reused.

AMQP:

Then AMQP kommunication is used. Properies starting with AMQP has to be set. Se the Stream data to broker for more information.

MQTT:

The properties starting with the "MQTT." define this communication. Check the used broker to get the details. The MQTTTransport define either plain or secure communication. The value TcpServerTls represent secure communication. Then the certificate from the broker will be stored in the rejected directory for certs. (e.g. ...Config/InstanceName/pki/rejected) . If you thrust this broker and the certificate, move it to the "thrusted" directory.

Provider: Prediktor

JSON messages

UaPublisher data flow

The UaPublisherBee module has the following item types

Writer Group

Variable DataSetWriter

Status

Properties

The UaPublisherBee module has the following properties:

				</tbody>
			</table>

See also Module Properties

Commands And Events

The UaPublisherBee module has the following Commands and Events:

Events

Name	Description	ID	Flags
_DataSetWriterId_	hidden prop to book-keep the DataSetWriterIdAttribute put on dataset writer items	5010	Persisted, Hidden
_WriterGroupIdProperty_	hidden prop to book-keep the WriterGroupIdAttribute put on writer group items	5011	Persisted, Hidden
Backfill databasename	The name of the database where messages are stored when they could not be transmitted to the broker	6010	Persisted, File
Backfil databasesize	The maximun size of Backfill database in Gb. If 0 , then no limit in database-size is set.	6011	Persisted
Broker type	File: messages are witten to a file. AMQP: sending messages to Microsoft Azure Eventhub. MQTT: sending the messages to a MQTT broker.	1100	Persisted, Enumerated
DeltaTime	Dataset with newest timestamp older than now - deltatime (in seconds) will be sent to Backfill address. If 0 then no time-evaluation is done.	6007	Persisted
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
ExternalItem report	A status-report for the External Item manager of this module	110	InfoPage
ExtItem full refresh	When true, the external items manager will force a full refresh initially on start/reset when reading items. I.e. items not yet initialized in their source, will also trigger an external item update. Default is true.	150	Persisted, ExpertPage
ExtItem pass-through quality	Specifies the quality of external item values that will pass through external item transfers. If external item qualities has worse quality the this mask, the external item transfer is blocked. Default is 'Any quality'.	400	Persisted, Enumerated, ExpertPage
LogLevel	Specifies the loglevel for diagnostic messages from this module.	500	Persisted, Enumerated
Message encoding	The encoding to use: Json: The message will be created according to the opcua json publishe spesification. See opcua documentation. UADP: Not in use. Json_Simplifies: A simplifier json format. See dokumentation. Json_Simplified_2: A simplifier json format with common timestamp and quality. See dokumentation.	5000	Persisted, Enumerated
Metadata directory	The directory where metadata files are created. If empty or invalid, no meta data will be created.	6000	Persisted, Folder
PublisherId	The PublisherId is a unique identifier for a Publisher within a Message Oriented Middleware	1010	ReadOnly, ReadOnlyAfterCreate
Reset counters	Resets all counters for the publisher.	6005	Persisted, Folder
Tracecverbosity	The trace verbosity when property LogLevel is set to Debug or higher. (If LogLevel < Debug, this property has no effect.	1005	Persisted, Enumerated
Transport protocol	The TransportProtocol to use (Datagram or Broker)	1050	Persisted, Hidden, Enumerated
AMQP main address	The connectionstring to Azure Event Hub. In addition the EntityPath have to be added to the WriterGroup item property AMQP main EntenityPath."	2100	Persisted
AMQP backfill address	The connectionstring to Azure Event Hub. In addition the EntityPath have to be added to the WriterGroup item property AMQP backfill EntenityPath."	2120	Persisted
AMQP communication	The communication to use.	1101	Persisted
AMQP connectiontype	Wether there are one connection per group(Multiple), one connection for all groups (Single), or a new connection for each transaction(Transient).	2122	Persisted
Filename	The Filename when BrokerType is File.	2300	Persisted, Hidden, File
MQTT main address	Address to MQTT broker	2402	Persisted
MQTT main port	MQTT broker port.	2403	Persisted
MQTT main clientid	A string that define/identify the clients session at the broker.	2404	Persisted
MQTT main user	The clients username.	2405	Persisted
MQTT main password	The clients password.	2406	Persisted
MQTT main clean session	Not relevant when sending data.	2409	Persisted
MQTT main version	Select between V3.1.1 or V5.0	2410	Persistede
MQTT main transport	Transmission protocole: TcpServer, use unencrypted communication. TcpServeTLS use encrypted communication.	2411	Persisted
MQTT main client certificate	The filename of the clients certificate when broker expect a client certificate to accept connection.	2415	Persisted
MQTT backfill address	Address to MQTT broker	2502	Persisted
MQTT backfill port	MQTT broker port.	2503	Persisted
MQTT backfill clientid	A string that define the client at the broker.	2504	Persisted
MQTT backfill user	Username this client use when connecting to MQTT broker.	2505	Persisted
MQTT backfill password	Username this client use when connecting to MQTT broker.	2506	Persisted
MQTT backfill clean session	Not relevant when sending data.	2509	Persisted
MQTT backfill version	Select between V3.1.1 or V5.0	2510	Persistede
MQTT backfill transport	Transmission protocole: "TcpServer", use unencrypted communication. "TcpServeTLS" use encrypted communication.	2511	Persisted
MQTT backfill client certificate	The filename of the clients certificate when broker expect a client certificate to accept connection.	2515	Persisted

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified by user. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

JSON messages

We support two main type of messages: Json defined by OpcUa and Json_Spesial defined by Prediktor. At present time we do not support the binary message UADP..

Json_Spesial Message

The Json_Simplifies is simple and fixed Json format consist of one object with element named "data" that holds an array of VQT objects. In addition the object can be expanded by the user with a fixed string. The Italicized part is here an example of a user defined extension. This can be added in UserExtra parameter (id : 11045) for a Writer Group Item. This has to expand the object with a valid Json format.

When using this format the UaPublisherBee will autocratically split or concatenate DataSet to maximize the message size without being too large. Because of this the user do not need to tune the number of values to control the message-size.

Json_Spesial Example


{

"data": [

_"schema": "apis/schemas/vqt.json","dataType":"raw","plant":"myPlant",_

{"tag": "test2.Worker.mySignal1","time": "2019-02-09T11:44:34.8905431Z","value": 145.126114,"status": 0},

{tag": "test2.Worker.mySignal2","time": "2019-02-09T11:44:34.8895786Z","value": 126.807716,"status": 0},

. . .

]

}

Json Message defined by OPC Unified Architecture.

This format is defined in the "OPC Unified Architecture Specification Part 14: PubSub Release 1.04", and the user should look at chapter 7.2.3 Json Message Mapping where this is described in details. Below is an example where we have a WriterGroup with property JsonNetworkMessageContentMask (id:11100 ) set to NetWorkMessageHeader=true, DataSetMessageHeader=true, and PublisherId=true. The VariableDataSet Writer property DataSetFieldContent (id:12060) set to StatusCode=true, and SourceTimeStamp=true. To test how the JSON change look in documentation, or try it out by change the parameters anf write the messages to a file.

Json Message Example


{

"MessageId": "5aaf34fe-51d8-4ddc-a294-3e8d3db3b5ab",

"MessageType": "ua-data",

"PublisherId": "UaPublisherBee1",

"Message": [

{

"DataSetWriterId": "2",

"PayLoad": {

"test2.Worker.Signal1": {

"Value": 0.911874,

"SourceTimestamp": "2019-02-13T15:03:33.1637587Z"

},

"test2.Worker.Signal2": {

"Value": 426.613861,

"SourceTimestamp": "2019-02-13T15:03:33.1637587Z"

},

"test2.Worker.Signal3": {

"Value": 113.692924,

"SourceTimestamp": "2019-02-13T15:03:33.1637587Z"

}

}

},

{

"DataSetWriterId": "2",

"PayLoad": {

"test2.Worker.Signal1": {

"Value": 0.889142,

"SourceTimestamp": "2019-02-13T15:03:34.163777Z"

},

"test2.Worker.Signal2": {

"Value": 423.00354,

"SourceTimestamp": "2019-02-13T15:03:34.163777Z"

},

"test2.Worker.Signal3": {

"Value": 113.268066,

"SourceTimestamp": "2019-02-13T15:03:34.163777Z"

}

}

}

]

}

UaPublisher Data Flow

Below is a picure visualize the internal data flow in the ApisUaPublisherBee.

The OpcUa bee creates new DataSet every time new values from the OpcUa-server arrive. The DataSet is transfered to UaPublisher and added to the DataQue. Each writer in UaPublisher has it own que. The QueSize is defined by the property MaxDataSetMessageBufferSize (id: 121100) and should be 2-3 times the expected size in a PublishInterval (id:11020). By setting the DiagnosticLevel for the Variabel DataSetWrter to debug you get a status DataSetQueSize showing the current number of DataSet in the DataQue.

On PublishInterval (id:11020) the WriterGroup empty all DataQue convert the DataSet according to specification and store the messages in the MessageQue. The maximum size of MessageQue is defined by the paramete NetworkMessageQueSize (id:11025). It is one que for each WriterGroup. If the MessageQue is dfull, then the message is written to the Database (DB).

There is one thread for each MessageQue that sends the messages to the specified destination. If a sending fails, the message will be resent once, and if that one also fail, the message is stored in the DB. When e.g. the network to an Eventhub is down all messages will end up in the DB.

Messages in DB are sent to the Backfill eventhub. Messages are deleted from DB when messages are successfully written to Eventhub.

If the OpcUaBee that represent the DataSet are configured with catchup, all DataSet are converted to JsonMessages and stored directly in DB. If there are added sizelimits to the DB, the UaPublisher will wait until DB er ready for more. In this case no DataSet will be lost.

APIS UaPublisherBee Item Types

Topics Covered:

Writer Group Properties

Items representing a Publisher WriterGroup.

The Writer Group item type has the following properties:

Name	Description	ID	Flags
DataSetOrdering	The DataSetOrdering defines the ordering of the DataSetMessages in the NetworkMessages. The default value is Undefined.	11210	Persisted, Hidden, Enumerated
Diagnostics level	Define the level of diagnostics to be created.	10150	Persisted, Enumerated
Enabled	Whether the item is enabled or not.	10100	Persisted
GroupVersion	The parameter GroupVersion with DataType VersionTime defines the expected value in the field GroupVersion in the header of the NetworkMessage. The default value 0 is defined as null value, and means this parameter shall be ignored.	11200	Persisted, Hidden
JsonNetworkMessageContentMask	The parameter NetworkMessageContentMask defines the optional header fields to be included in the NetworkMessages produced by the WriterGroup. The DataType for the JSON NetworkMessage mapping is JsonNetworkMessageContentMask. (See doc OpcUa Part 14 1.0.4 chapter 6.3.2.2.1)	11100	Persisted, EnumeratedFlags
KeepAliveTime	The KeepAliveTime with DataType Duration defines the time in milliseconds until the Publisher sends a keep alive DataSetMessage in the case where no DataSetMessage was sent in this period by a DataSetWriter. The minimum value shall equal the PublishingInterval.	11030	Persisted
Max NetworkMessage queuesize	Maxium number of NetworkMessages in the internal queue.	11025	Persisted
MaxNetworkMessageSize	The maximum size in bytes for networkmessages created by the Writergroup. It refers to the size of the complete message including padding and signature without any additional headers added by the transport protocol mapping. If the size of a message exceeds the "Max message size", the behaviour depends on the message mapping./td>	11010	Persisted
MessageRepeatCount	The MessageRepeatCount with DataType Byte defines how many times every NetworkMessage is repeated. The default value is 0 and disables the repeating.	11060	Persisted, Hidden
MessageRepeatDelay	The MessageRepeatDelay with DataType Duration defines the time between NetworkMessage repeats in milliseconds. The parameter shall be ignored if the parameter MessageRepeatCount is set to 0.	11065	Persisted, Hidden
AMQP partitionkey	The key used to generate a hash code which decides the partition the message will be sent to when using AMQP.	11015	Persisted
Priority	The Priority with DataType Byte defines the relative priority of the WriterGroup to all other WriterGroups across all PubSubConnections of the Publisher. If more than one WriterGroup needs to be processed, the priority number defines the order of processing. The highest priority is processed first. The lowest priority is 0 and the highest is 255.	11040	Persisted, Hidden
PublishingOffset	The SamplingOffset with the DataType Duration defines the time in milliseconds for the offset of creating the NetworkMessage in the PublishingInterval cycle. Any negative value indicates that the optional parameter is not configured. In this case the Publisher shall calculate the time before the PublishingOffset that is necessary to create the NetworkMessage in time for sending at the PublishingOffset.	11240	Persisted, Hidden
PublishInterval	The PublishingInterval with the defines the interval in milliseconds for publishing NetworkMessages and the embedded DataSetMessages created by the related DataSetWriters	11020	Persisted
Quality	Item quality	3	ReadOnly
AMQP main EntityPath	A string parameter specifies the EntityPath in the broker.	11053	Persisted
AMQP backfill EntityPath	A string parameter specifies the EntityPath in the broker.	11054	Persisted
MQTT main topic	The topic string parameter specifies the queue this WriterGroup send messages to.	11050	Persisted
MQTT backfill topic	The topic string parameter specifies the queue this WriterGroup send messages to.	11051	Persisted
RequestedDeliveryGuarantee	The RequestedDeliveryGuarantee parameter with DataType BrokerTransportQualityOfService specifies the delivery guarantees that shall apply to all NetworkMessages published by the WriterGroup unless otherwise specified on the DataSetWriter transport settings.	11055	Persisted, Enumerated
Rights	Item access rights	5	ReadOnly
SamplingOffset	TThe SamplingOffset with the DataType Duration defines the time in milliseconds for the offset of creating the NetworkMessage in the PublishingInterval cycle. Any negative value indicates that the optional parameter is not configured. In this case the Publisher shall calculate the time before the PublishingOffset that is necessary to create the NetworkMessage in time for sending at the PublishingOffset.	11230	Persisted, Hidden
Time	Item timestamp	4	ReadOnly
Type	Item canonical datatype	1	ReadOnly
UadpNetworkMessageContentMask	The parameter NetworkMessageContentMask defines the optional header fields to be included in the NetworkMessages produced by the WriterGroup. The DataType for the UADP NetworkMessage mapping is UadpNetworkMessageContentMask.	11220	Persisted, Hidden, EnumeratedFlags
UserExtra	UserExtra is a static Json-part that is added to the Json_spesial message	11045	Persisted
Value	Item value	2	ReadOnly
WriterGroupId	The WriterGroupId with DataType UInt16 is an identifier for the WriterGroup and shall be unique across all WriterGroups for a PublisherId. All values, except for 0, are valid. The value 0 is defined as null value.	11000	Persisted, ReadOnly

Variable DataSet Writer Properties

Items representing a variable DataSet writer.

The Variable DataSetWriter item type has the following properties:

				</tbody>
			</table>

Status Properties

This item is used to expose internal status information

The Status item type has the following properties:

Name	Description	ID	Flags
ConfiguredSize	The parameter ConfiguredSize with the DataType UInt16 defines the fixed size in bytes a DataSetMessage uses inside a NetworkMessage. The default value is 0 and it indicates a dynamic length. If a DataSetMessage would be smaller in size (e.g.because of the current values that are encoded) the DataSetMessage is padded with bytes with value zero.In case it would be larger, the Publisher shall set bit 0 of the DataSetFlags1 to false to indicate that the DataSetMessage is not valid.	12510	Persisted, Hidden
DataSetFieldContentMask	A DataSet field consists of a value and related metadata. In most cases the value comes with status and timestamp information. Set flags to decide what to include in addition to the value in the DataSetMessage.(See OpcUa Part 14 1.04 chapter 7.2.3.3)	12060	Persisted, EnumeratedFlags
DataSet connected data	The name of the corresponding PublishedDataSet. I.e. the name of an apis module in this instance, that implements the IApisPublishedDataSet interface, and that will provide the dataset to publish.	12100	Persisted, DynamicEnumeration
DataSetWriterId	The DataSetWriterId with defines the unique ID of the DataSetWriter for a PublishedDataSet. It is used to select DataSetMessages for a PublishedDataSet on the Subscriber side. It shall be unique across all DataSetWriters for a PublisherId. All values, except for 0, are valid DataSetWriterIds. The value 0 is defined as null value.	12050	Persisted, ReadOnly
Diagnostics level	Define the level of diagnostics to be created.	10150	Persisted, Enumerated
Enabled	Whether the item is enabled or not.	10100	Persisted
JsonDataSetMessageContentMask	The DataSetMessageContentMask defines the flags for the content of the DataSetMessage header.	12400	Persisted, EnumeratedFlags
KeyFrameCount	The KeyFrameCount with DataType UInt32 is the multiplier of the PublishingInterval that defines the maximum number of times the PublishingInterval expires before a key frame message with values for all published Variables is sent.The delta frame DataSetMessages contains just the changed values.If no changes exist, the delta frame DataSetMessage shall not be sent.If the KeyFrameCount is set to 1, every message contains a key frame.	12070	Persisted
MajorVersion	The MajorVersion reflects the time of the last major change of the DataSet content.	18050	ReadOnly, InfoPage
DataSet message buffer size	The maximum number of DataSet that can be buffered internaly	12110	Persisted
MinorVersion	The MinorVersion reflects the time of the last change of the DataSet content.	18051	ReadOnly, InfoPage
Quality	Item quality	3	ReadOnly
Rights	Item access rights	5	ReadOnly
Time	Item timestamp	4	ReadOnly
Type	Item canonical datatype	1	ReadOnly
UadpDataSetMessageContentMask	The UadpDataSetMessageContentMask defines the flags for the content of the DataSetMessage header, when using UADP message mapping.	12500	Persisted, Hidden, EnumeratedFlags
Value	Item value	2	ReadOnly
WriterGroup itemname	The WriterGroupItem for this dataset writer.	10200	Persisted, APISLocalItem, DynamicEnumeration
Value identifier	The names to use in messages to identify values. SourceNodeId: selecr opcu ua nodeid to the value. ItemName: use the APIS itemname, SourceNodeId_Regex: Use the opcus nodid, but in addition manipulate this with regex. ItemName_Regex: Use APIS itemname and manipulate it with regex.	12205	Persisted
Regex source	If the name shall use regex: This parameter holds the string to search for.	12210	Persisted
Regex replace	If the name shall use regex: This parameter holds the replace string.	12220	Persisted

Name	Description	ID	Flags
DiagnosticsClassification		14020	Persisted, ReadOnly, Enumerated
DiagnosticsLevel		14010	Persisted, ReadOnly, Enumerated
Quality	Item quality	3	ReadOnly
Reset	Resets this status item	14000	Persisted
Rights	Item access rights	5	ReadOnly
Time	Item timestamp	4	ReadOnly
Type	Item canonical datatype	1	ReadOnly
Value	Item value	2	ReadOnly

Module Status	Description	DiagnisticsLevel	DiagnosticClassification
DBMessageCount	The number of messages currently stored in the database	Basic	Information
MainPublisher.SentMessages	Number of sent messages	Basic	Information
BackfillPublisher.SentMessages	Number of messages sent to backfill eventhub	Basic	Information
LostMessages	Number of lost mesages	Basic	Error
MainPublisher.ResolvedAddress	status of resolving the address to the eventhub	Basic	Information
BackfillPublisher.ResolvedAddress	status of resolving the address to the backfill eventhub	Basic	Information

Writer Group Status	Description	DiagnisticsLevel	DiagnosticClassification
ConversionError	number of error when converting data to JSON	basic	Error
PublisherExceedsTimer	used time in sendigprosess	Advanced	Information
BackfillPublisherExeedsTimer	used time in sendingprosess	Advanced	Information
SentNetworkMessages	number of sent messages	Info	Information
FailedTransmissions	number of failed transmissions	Info	Information
RemovedNetworkMessagtes	removed messages	Info	Information
SendMessageQueSize	Number currently in the messageque	Debug	Information
SendThread	current status of the messagethread	Debug	Information

Variable DataSet Writer Status	Description	DiagnisticsLevel	DiagnosticClassification
RemovedDataSetMessages	Number of removed datasetmessages	Info	Information
KeyFrameCount	Number KeyFramest sent	Info	Information
DataSetsReceived	Number of dataset veceived	Info	Information
MessageSequenceNumber	the current MessageSequenceNumber	Info	Information
DataSetQueSize	The current size of the Dataset que	debug	Information

Apis VectorFunctionBee

General vector function bee.

Provider: Prediktor

Child item - DoubleVectorItem

The VectorFunctionBee module has the following item types

Child item - BooleanItem

Child item - TriggerItem

Child item - IntegerItem

Child item - DoubleItem

Child item - StringItem

FunctionItem

AggregatedItem

Properties

The VectorFunctionBee module has the following properties:

Name	Description	ID	Flags
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted

See also Module Properties

Commands And Events

The VectorFunctionBee module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS VectorFunctionBeeItem Types

Topics Covered:

Properties

Boolean child item type.

The Child item - BooleanItem item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
MandatoryAttribute	An attribute that determines if the child item is mandatory or not.	10003	Persisted, ReadOnly
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Trigger child item type.

The Child item - TriggerItem item type has the following properties:

Name	Description	ID	Flags
MandatoryAttribute	An attribute that determines if the child item is mandatory or not.	10003	Persisted, ReadOnly
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Integer (Int32) child item type.

The Child item - IntegerItem item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
MandatoryAttribute	An attribute that determines if the child item is mandatory or not.	10003	Persisted, ReadOnly
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Double child item type.

The Child item - DoubleItem item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
MandatoryAttribute	An attribute that determines if the child item is mandatory or not.	10003	Persisted, ReadOnly
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

String child item type.

The Child item - StringItem item type has the following properties:

Name	Description	ID	Flags
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
MandatoryAttribute	An attribute that determines if the child item is mandatory or not.	10003	Persisted, ReadOnly
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Double array child item type.

The Child item - DoubleVectorItem item type has the following properties:

Name	Description	ID	Flags
ExtItemOverrideMethod	This attribute decides what method to use when assigning a value from an external item.	5999	Persisted, Enumerated, BitMask
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
MandatoryAttribute	An attribute that determines if the child item is mandatory or not.	10003	Persisted, ReadOnly
ParentItem	The parent item name of this item.	5502	Persisted, ApisLocalItem, ExpertPage
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Function item.

The FunctionItem item type has the following properties:

Name	Description	ID	Flags
FunctionDefinitionAttribute	The function definition implemented by a function item.	10001	Persisted, Enumerated, ExtraInfo
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

An aggregated item to perform functions on. Use external input.

The AggregatedItem item type has the following properties:

Name	Description	ID	Flags
FunctionListAttribute	A semi-colon ';' separated list of function instances to use in calculations.	10002	Persisted
InitValue	The initial value, set during initialisation of the Apis Module. In other words, when Apis Hive is restarted, this is the value the item will be set to.	5002	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
TriggerAwareAttribute	If set to true, this item's value will be recalculated when one of its function item's trigger items has been triggered.	10004	Persisted
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Apis WITS client

This module sends / receives data on WITS level 0. For further information about WITS 0, see: W.I.T.S. Wellsite Information Transfer Specification

Provider: Prediktor

The WITS module has the following item types

WITSItem

Command Item

State Item

More information

Characteristics of the ApisWITS Client module:

Implements WITS 0 client.
Supports both passive and active and passive communication.
Supports Read and Write.
Supports, serial and TCP/IP communication (TCP and UDP)
Supports automatic tag generation of predefined WITS records. For more information on predefined WITS records, refer to W.I.T.S. Wellsite Information Transfer Specification

Further, as an integrated module in the Apis Hive, the following optional features are available:

High performance data logging to the Apis Honeystore historian, with OPC Historical Data Access server interface

Properties

The WITS module has the following properties:

Name	Description	ID	Flags
Active	server mode, some WITS servers (Pason i.a.) only send data when receiving request message, Set this property to true to activate request message, see property Request Message."	1050	Persisted, ExpertPage
Autogenerate	Automatic Tag Database Generation of predefined WITS records, based on telegram from server. For more information on predefined WITS records, refer to W.I.T.S. Wellsite Information Transfer Specification	1057	Persisted, Enumerated, ExpertPage
BaudRate receive	Baud rate for serial communication, valid only when Comm.type Serial is selected	1210	Persisted, Enumerated, ExpertPage
COM port receive	The COM port to use, valid only when Comm.type Serial is selected	1200	Persisted, Enumerated
Comm. type receive	Communication method, Serial or Winsock	1110	Persisted, Enumerated
DataBits receive	Number of bits in the bytes transmitted and received, valid only when Comm.type Serial is selected	1230	Persisted, Enumerated, ExpertPage
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
FlowControl receive	Flow control for serial communication, valid only when Comm.type is Serial	1250	Persisted, Enumerated, ExpertPage
ForceUpdate	Update time stamp even though value has not changed (Default=true).	1000	Persisted, ExpertPage
IP address receive	Ip Address of WITS server, valid only when Comm. type Winsock is selected	1310	Persisted, Computer
Last telegram	Last raw telegram received from WITS server	30000	ReadOnly, PerformancePage
Parity receive	Parity scheme for the serial communication, valid only when Comm.type Serial is selected	1220	Persisted, Enumerated, ExpertPage
Poll Interval	Set this to bigger than 0.01 for a timer based polling (seconds)	1055	Persisted
Port receive	The TCP/UDP port of WITS server.Valid only when Comm. type Winsock is selected	1311	Persisted
Port send	The TCP/UDP port of WITS server	1513	Persisted, Hidden
Protocol	Protocol TCP or UDP Valid only when Comm. type Winsock is selected	1312	Persisted, Enumerated
Request Message	This parameter specifies the message portion of the frame that the driver will send to request solicited data. Valid only when server mode is Active	1051	Persisted, Enumerated, ExpertPage
StopBits receive	Number of stop bits to be used, valid only when Comm.type Serial is selected	1240	Persisted, Enumerated, ExpertPage
Timeout	Time-out interval, in seconds when timerbased.	1120	Persisted
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
TraceToFile	This is used to trace detail information about the incomming data over the link	15010	Persisted, File, ExpertPage

See also Module Properties

Commands And Events

The WITS module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer
ReceiveDone	An event signalled when a receive from WITS serever is successful.	Normal

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
StartReceive	Initiate a receive of data from WITS server.	Asynchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS WITS Client Item Types

Topics Covered:

Properties

A WITS item, built from raw data or measurement elements

The WITSItem item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Direction	Direction of data. Input (false) or Output (true).	5040	Persisted
Field	The field of the item.	5037	Persisted
Offset	The linear transformation addend to use when calculating and item value. (Value = RawValue * Scale + Offset)	5006	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Record	The record of the item.	5036	Persisted
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Scale	The linear transformation multiplier to use when calculating the item value. (Value = RawValue * Scale + Offset)	5005	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Unit	EU units - this is the unit this item value uses. For example: centimetres, kilograms, kilowatts, etc.	100	Persisted
Value	The current value of the item.	2	ReadOnly
Valuetype	Item canonical datatype. This is the type of data the field holds. For example: integer, string, datetime, etc.	10010	Persisted, Enumerated

Properties

A command for controlling module

The Command Item item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	NormalPage

Properties

Item telling if module is connected to the WITS server; true: is connected, false: is disconnected

The State Item item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

Apis WITS Server

This module sends / receives data on WITS level 0. For further information about WITS 0, see: W.I.T.S. Wellsite Information Transfer Specification

Provider: Prediktor

The WITSServer module has the following item types

WITSItem

State Item

More information

Characteristics of the ApisWITS Server module:

Implements WITS 0 server.
Supports Read and Write.
Supports, TCP/IP TCP communication only
Supports automatic tag generation of predefined WITS records. For more information on predefined WITS records, refer to W.I.T.S. Wellsite Information Transfer Specification

Further, as an integrated module in the Apis Hive, the following optional features are available:

High performance data logging to the Apis Honeystore historian, with OPC Historical Data Access server interface
Add only ONE WITS server module pr computer across instances

Properties

The WITSServer module has the following properties:

Name	Description	ID	Flags
Bad value	Value to send when item is bad.	1700	Persisted
Client command timeout	Time to wait for client response (in seconds) before giving up and reset connection.	1320	Persisted
ExchangeRate	The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.	100	Persisted
IP address	The listening IP Address of WITS server, when empty listens on any	1310	Persisted
Port	The listening TCP port of WITS server	1311	Persisted
Send Interval	Telegram interval larger than 0.5 (seconds)	1055	Persisted
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
TraceToFile	This is used to trace detail information about the incomming data over the link	15010	Persisted, File, ExpertPage

See also Module Properties

Commands And Events

The WITSServer module has the following Commands and Events:

Events

Name	Description	Event Type
ExternalItems	Timer event for handling of external items. By default, the command 'HandleExternalItems' is connected to this event, but that can be modified. The timer resolution is specified by the 'ExchangeRate' property.	Timer

Commands

Name	Description	Command Type
HandleExternalItems	Command for reading external items. When fired, the module will read all its external items, and update/notify the ones that has changed.	Synchronous
UpdateItemTimestamp	Command used for updating the value of the item specified in the 'TimeReferenceItem' property, when configured.	Synchronous

See also Commands And Events

APIS WITS Server Item Types

Topics Covered:

State Item

Item indicating the number of clients connected

The State Item item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Value	The current value of the item.	2	ReadOnly

WITSItem

A WITS item, built from raw data or measurement elements

The WITSItem item type has the following properties:

Name	Description	ID	Flags
Description	A description of what this item does. This is free text, so you can write anything you like here.	101	Persisted
Field	The field of the item.	5037	Persisted
Quality	Item quality - this tells you whether an item currently has a good or bad quality. It might be bad, for example, because it isn't connected or is set to the wrong type.	3	ReadOnly
Record	The record of the item.	5036	Persisted
Rights	Item access rights - this property may be "read", or "read write". This means that the property may only be read from, or also can be written to. For OPC items, this written value will be passed on to the external items this item comes from.	5	ReadOnly
Send	Set the property to send the item.	10020	Persisted
Time	The date and time when this item was last updated.	4	ReadOnly
Type	The item canonical data type - the specific type of this item. Whether it's an integer, string, date, etc.	1	ReadOnly
Unit	EU units - this is the unit this item value uses. For example: centimetres, kilograms, kilowatts, etc.	100	Persisted
Value	The current value of the item.	2	NormalPage
Valuetype	Item canonical datatype. This is the type of data the field holds. For example: integer, string, datetime, etc.	10010	Persisted, Enumerated

Set up an WITS-0 server

Follow the guide Add Module to Apis Hive, but this time select a module of type ApisWITSServer from the Module type drop down list.

After adding the module, select the new module named "ApisWITS1" from theSolution Explorer.

In the Properties Editor, enter values for:

Port: TCP port of your WITS-0 server .

Send Interval: Interval of WITS-0 telegram.

Bad value: Value to send when item is bad in Apis.

Exchange rate : Exchange rate in milliseconds for updating items from external items.

Press "Apply" when done.

Follow the guide Add Items to a Module, but this time add item of type "WITSItem".

Click the "Browse" button.
A dialog opens that lets you select predefined items according to the specification in W.I.T.S. Wellsite Information Transfer Specification. Click "Ok" when done.

Alternative:
In Name field Custom name and click "Add item(s) " button

Select the new item an fill in properties manually; Record, Field, Type, etc.

The item list will get new entries showing the added items.

Expose data

To expose data, WITS Items must be connected to a source item . See Connecting Items

Trouble shooting

If no connection or data received:

Use 3 party terminal application like putty to check if server is sending telegrams.
Check firewall settings for the port.
Check network connection to server, (ping)

Apis Worker

This module generates signals of different types.

Provider: Prediktor