API documentation: statistics

Returns statistics data concerning the data transfers and invokation of simulatior commads. The returned statistics will give an indication of the condition of the integration solution.

URL:

api/statistics[.format]

Example: api/statistics.xml

Omitted format defaults to html.

Formats:

html, xml, json

HTTP Method(s):

GET

Response:

Element	Description
externalSystem
droppedFrames	Transfers of process data from the external system to the process model is done cyclically. If there are more than a single pending data transfer in each cycle, data from the external system is dropped and the droppedFrames counter is incremented by the numbers of pending frames minus one.
commandFailureCount	Icremented if an error occur when executing a simulator command on the external system.
dataWriteFailureCount	Incremented if an error occur when writing process data to the external system.
dataReadFailureCount	Incremented if an error occur when reading process data from the external system.
dataReadCount	Process data successfully read from the external system. This value minus droppedFrames shall be equal to dataWriteCount on the process model statistics below.
dataWriteCount	Process data successfully written to the external system.
processModel
droppedFrames	The process model is checked cyclically to detect frame changes. When a frame change is detected, the process data is read from the process model and added as pending transfers to the external system. If more than a single frame change is detected in one cycle the droppedFrames counter is incremented by the number of frame changes minus one. In addition to this, process model data will be dropped if there are more than a single pending transfer when data is written to the external system.
commandFailureCount	For each process model frame change, the process model is checked for simulator commands. If an error occur during this check the commandFailureCount is incremented.
dataWriteFailureCount	Incremented if an error occur when writing process data to the process models.
dataReadFailureCount	Incremented if an error occur when reading process data from the process models.
dataReadCount	Process data successfully read from the process model. This value minus droppedFrames shall be equal to dataWriteCount on the external system statistics above.
dataWriteCount	Process data successfully written to the process model.

Response example(s):

XML:

<statistics>
    <externalSystem>
        <droppedFrames>0</droppedFrames>
        <commandFailureCount>0</commandFailureCount>
        <dataWriteFailureCount>0</dataWriteFailureCount>
        <dataReadFailureCount>0</dataReadFailureCount>
        <dataReadCount>0</dataReadCount>
        <dataWriteCount>5</dataWriteCount>
    </externalSystem>
    <processModel>
        <droppedFrames>2</droppedFrames>
        <commandFailureCount>0</commandFailureCount>
        <dataWriteFailureCount>0</dataWriteFailureCount>
        <dataReadFailureCount>0</dataReadFailureCount>
        <dataReadCount>7</dataReadCount>
        <dataWriteCount>0</dataWriteCount>
    </processModel>
</statistics>