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