Engine Settings

 

 

The default settings.xml configuration file, found in the engine installation directory, is given in full below:

 

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

<Setting xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

          <Logging>

                    <LogFilePath>[ApplicationFolder]\Logs</LogFilePath>

                    <LogToTCP>true</LogToTCP>

                    <TCPPort>11169</TCPPort>

                    <DetailLogging>true</DetailLogging>

                    <PurgeLogDays>30</PurgeLogDays>

          </Logging>

          <Schedule>

                    <Period>3600</Period>

                    <Offset>0</Offset>

          </Schedule>

  <DefaultBackfillDays>30</DefaultBackfillDays>

  <AFServer>AF Server Name</AFServer>

  <AFDatabase>AF Database Name</AFDatabase>

  <LicenseFilePath>[ApplicationFolder]\License\License.lic</LicenseFilePath>

          <MovusConfig>

                    <ConnDetails>

                              <BaseURL>https://api.movus.com.au/public/prod/</BaseURL>

                              <UserName>Username</UserName>

                              <Password>Password</Password>

                              <Organisation>organisation name</Organisation>

                              <APIToken></APIToken>

                    </ConnDetails>

                    <EventFrameTemplateName>AF EventFrame Template Name</EventFrameTemplateName>

                    <ElementTemplateName>AF Element Template Name</ElementTemplateName>

           <OutboundElementTemplateName>FitMachine Device - Outbound Data</OutboundElementTemplateName>

           <OutboundVariablePageSize>10</OutboundVariablePageSize>

           <OutboundVariableDataPageSize>50</OutboundVariableDataPageSize>

                    <ElementRootPath>Root AF Element path following AF Database Name</ElementRootPath>

                    <SampleLookbackHours>8</SampleLookbackHours>

                    <DeviceMetaDataAttributesToIgnore>

                              <string>equipment_running</string>

                              <string>rms</string>

                              <string>rms2</string>

                              <string>temperature</string>

                    </DeviceMetaDataAttributesToIgnore>

                    <DeviceAlarmAttributesToIgnore>

                              <string>calibration</string>

                              <string>condition_overall</string>

                              <string>equipment_running</string>

                              <string>condition_temperature</string>

                              <string>condition_vibration</string>

                              <string>rms</string>

                              <string>rms2</string>

                              <string>temperature</string>

                    </DeviceAlarmAttributesToIgnore>

          </MovusConfig>

</Setting>

 

 

These parameters are detailed below:

 

Logging:

•LogFilePath: Log files folder path.

•LogToTCP: Whether to write the logs to a TCP port.

•TCPPort: TCP port number.

•DetailLogging: Whether to record more detailed log messages.

•PurgeLogDays: The retention period of the log files in days. Files older than this are automatically deleted to save space.

 

Schedule:

•Period & Offset (in seconds) is used to define how often the engine runs.

•DefaultBackfillDays: On the initial data load, how far back the engine will do a backfill.

•AFServer: Name of the AF Server.

•AFDatabase: Name of the AF Database.

 

Licensing:

LicenseFilePath: The engine's license file path. Contact Dimension Software at support@dimensionsoftware.co.nz  if you have not yet received the license file.

 

Movus Cloud Connection:

•ConnDetails: Contains details on how the engine authenticates with the Movus Cloud Web API. Either via login credentials (UserName, Password, Organisation) or via an API Token (APIToken).

•BaseURL: Base URL to the Movus Cloud Web API. Normally it will be similar to https://api.movus.com.au/public/prod/ .

 

Asset Framework Connection:

•EventFrameTemplateName: Name of the AF Event Frame Template that will be used to create the Alarms in the AF Database.

•ElementTemplateName: Name of the AF Element Template.

•ElementRootPath: (optional) The AF Element Path (excluding the path to AF Database).  The engine will process all AF Elements of ElementTemplateName template on the AFDatabase that falls under the ElementRootPath. If this ElementRootPath is empty, then the engine will search on the overall AFDatabase.

•OutboundElementTemplateName: (optional) To send data from PI AF to Movus Fit Machines, an element template must be referenced here. Elements using this template will be used to transmit sample data to the parent Fit Machine element. A template is provided during the configuration process.

•OutboundVariablePageSize: (optional) When transmitting PI data, the data is paginated into groups to avoid overwhelming the Movus API. This setting controls how many PI tags are transmitted per API request (default 10 PI tags).

•OutboundVariableDataPageSize: (optional) As part of paginating transmitted data, this setting controls how many individual data points per PI tag are transmitted per API request (default 50 data points).

 

Engine Processing Configuration:

•SampleLookbackHours: The sample data can arrive out of order in the Movus Cloud. To rectify this issue to avoid any data gaps, the engine will always look back this many hours when getting the sample data.

•DeviceMetaDataAttributesToIgnore: Some of the data is already returned in the Sample API call. To avoid duplication of the data in PI, these configured attributes will be ignored when getting the metadata values.

•DeviceAlarmAttributesToIgnore: Some of the data is already returned in the Sample or Metadata API calls. To avoid duplication of the data in PI, these configured attributes will be ignored when getting the Alarm values.

 

Configuration > Engine Settings