ThingWorx Edge ADO Service > Reference for Configuration Parameters
  
Reference for Configuration Parameters
This section provides tables that list and describe the configuration parameters for the ADO service. The tables also provide the base type and the default value for each of these parameters. The tables are presented in the order in which the elements appear in the AdoThing.config file.
See Also:
How to Perform a Basic Configuration
How to Configure the Settings for an SQL Database Connection
How to Configure a Secure Connection to ThingWorx Platform
How to Configure a Proxy Server
How to Configure Duty Cycle Modulation
How to Configure Settings for Windows Service
Connection Settings
Name
Description
Base Type
Default Value
Address
IP address or DNS name of the ThingWorx server.
STRING
"127.0.0.1"
Port
The number of the TCP port that is used by the ThingWorx server.
INTEGER
443
Resource
The resource on the ThingWorx platform.
STRING
"/Thingworx/WS"
IsSecure
Deprecated. This parameter is maintained for backwards compatibility. Use the settings described in the section, How to Configure a Secure Connection to ThingWorx Platform, instead.
BOOLEAN
true (1)
ThingName
The name of the entity (remote thing) on the ThingWorx server that represents this ADO service. Use the RemoteADOThing template when you create the remote thing.
STRING
"AdoThing"
AppKey
Application key (KeyID) used for authentication when this entity should use as an authentication token when connecting to a ThingWorx server. Encrypt this value by using the—encrypt option on the service executable.
STRING
xxxxxxxx‐xxxx‐xxxx‐xxxx‐xxxxxxxxxxxx
AllowSelfSignedCertificates
Set to true 1) to accept self-signed certificates during development. Do NOT set this to true for a production environment.
BOOLEAN
false (0)
DisableCertValidation
If you set this parameter to true, the TLS library does not validate the server certificate. Do NOT set this to true for a production environment.
BOOLEAN
false (0)
ConnectTimeout
Time to wait, in milliseconds, for the connection to be established.
INTEGER
10000
ConnectRetries
Number of times that attempts are made to establish a connection. An error is reported when this number is reached. Using the default value, the service continuously tries to connect.
INTEGER
-1
ReconnectInterval
Number of seconds after a connection is dropped before trying to reconnect to the server.
INTEGER
60
MaxMessageSize
The maximum size of a complete message (in bytes), whether the message is broken up into multiple parts (“multipart message”) or not. Outbound messages (sent to ThingWorx serve0 that are larger than this size are rejected.
INTEGER
64000
MessageTimeout
Time (in milliseconds) that the service waits for a response from the server after the service sends a message.
INTEGER
10000
OfflineMsgQueueSize
The maximum size (in bytes) of the queue of messages being stored while the service is not connected to the ThingWorx server (offline).
INTEGER
16384
OfflineMsgStoreDir
Path to the directory where messages are stored while the data source is not connected to the ThingWorx server (offline).
STRING
"/opt/thingWorx"
MaxMessages
Maximum number of messages that are allowed to wait in the queue for processing. When this number of messages is reached, messages are dropped, starting with the oldest message.
INTEGER
500
IdlePingRate
The number of seconds without communication between the service and the ThingWorx server that are allowed to pass before the service sends a ping message to the server. As long as the server returns a pong message, the connection remains open. NOTE: This value should never be greater than the value that is set on the server side, which by default is 60 seconds.
INTEGER
45
MessageChunkSize
The maximum size (in bytes) of a message chunk. Messages larger than this are broken up into a multipart message. NOTE: This value should be the same as the value set for the server, which by default is 8192.
INTEGER
8192
MessageFrameSize
The size of a message frame. In the WebSocket protocol, a frame is the smallest unit of a message. In general, this value should be the same as the MessageChunkSize. Do not change the value.
INTEGER
8192
AutoReconnect
Keep the default value of true to reconnect to the server automatically when a connection is lost.
BOOLEAN
true
ForceConnectOnReadProperty
When in the disconnected state of the duty cycle, force a reconnect so that the service can send a message to read a property.
BOOLEAN
false
ForceConnectOnWriteProperty
When in the disconnected state of the duty cycle, force a reconnect so that the service can send a message to write a property.
BOOLEAN
false
ForceConnectOnInvokeService
When in the disconnected state of the duty cycle, force a reconnect so that the service can send a message to invoke a service.
BOOLEAN
false
PongTimeout
The number of milliseconds to wait for a response to a ping message from the server. A pong message from the server is needed to keep the connection open. Otherwise, the service goes offline and collects messages in the offline message queue to deliver when reconnected to the server.
INTEGER
10000
StaleMsgCleanupRate
The number of milliseconds before the service removes multipart messages that never received all of the expected number of message chunks.
INTEGER
50000
StreamBlockSize
Incremental block size for dynamically allocated stream (byte array) variables. When adding bytes to a stream, this is the size of memory allocated if more memory is needed.
INTEGER
256
MaxConnectDelay
Maximum number of milliseconds that the service waits before any attempt is made to connect to the ThingWorx server.
INTEGER
10000
SocketReadTimeout
Time to wait for data to come in on the socket before timing out.
INTEGER
10
ThrowOnOfflineMesssageSave
When the service is not connected to the server, outgoing messages are automatically saved to the offline storage (if enabled) for delivery upon next connection. Set this property to true to have an exception thrown when messages are saved offline
BOOLEAN
false
ClientName
The identifier of the client gateway.
STRING
"ThingworxAdoGateway"
MessageStoreConfiguration
Defines the way that values of properties (tags) are stored, ALL or FOLD.
STRING
"ALL"
Settings for a Server Certificate File
Name
Description
Base Type
Default Value
IsEnabled
Enables (true) or disables (false) validation of the server certificate.
BOOLEAN
false
FilePath
The full path to the local certificate file (PEM or DER format) that is used to validate the server.
STRING
none
CertType
The default value (0) means that axTLS is the underlying TLS library.
INTEGER
0
See Also: the section on Server Certificates in How to Configure a Secure Connection to ThingWorx Platform
Settings for a Client Certificate File
Name
Description
Base Type
Default Value
IsEnabled
Enables (true) or disables (false) validation of the client to the server.
BOOLEAN
false
FilePath
The full path to the local certificate file (PEM or DER format) that is used to validate the client to the server.
STRING
none
CertType
The default value (0) means that axTLS is the underlying TLS library.
INTEGER
0
See Also: the section on Client Certificates in How to Configure a Secure Connection to a ThingWorx Platform from the ADO Service.
Settings for a Client Key File
Name
Description
Base Type
Default Value
IsEnabled
Enables (true) or disables (false) validation of the client key file.
BOOLEAN
false
FilePath
The full path to the file that contains the encrypted key (PEM or DER format).
STRING
none
Passphrase
The passphrase to use to open the key file. To encrypt this value, use the option, -encrypt, of the service executable.
STRING
none
KeyType
The default value (0) means that axTLS is the underlying TLS library.
INTEGER
0
See Also: the section on Client Key Files in How to Configure a Secure Connection to a ThingWorx Platform from the ADO Service.
Settings for an X.509 Certificate
Name
Description
Base Type
Default Value
IsEnabled
Enables or disables validation of the X.509 certificate fields.
BOOLEAN
false
Subject_cn
The common name of the subject in the certificate.
STRING
none
Subject_o
The organization of the subject in the certificate.
STRING
none
Subject_ou
The organizational unit of the subject in the certificate.
STRING
none
Issuer_cn
The common name of the issuer in the certificate.
STRING
none
Issuer_o
The organization of the issuer in the certificate.
STRING
none
Issuer_ou
The organizational unit of the issuer in the certificate.
STRING
none
Proxy Server Settings
Name
Description
Base Type
Default Value
IsEnabled
Enables (true) or disables (false) the use of a proxy server for the connection to the ThingWorx platform
BOOLEAN
false
Host
Use either the IP address or DNS name of the proxy server for this parameter.
STRING
none
Port
The number of the port that the proxy server uses to listen for connections from the ADO service.
INTEGER
80
UserName
If the proxy server requires authentication, the user name that the ADO-DA service should send to the proxy server. If the proxy server does not use authentication, this value can remain an empty string ("".
STRING
none
Password
If the proxy server requires authentication, the password that the ADO-DA service should send to the proxy server. If the proxy server doesnot use authentication, this valaue can remain an empty string ("".
STRING
none
See also: How to Configure a Proxy Server
Settings for Duty Cycle Modulation
Name
Description
Base Type
Default Value
DutyCycle
Percentage of the Period specified for the AlwaysOn connection that is modulated by this duty cycle. Acceptable values are 0-100%. A value of 100% (the default) means the connection always stays alive.
INTEGER
100
Period
Period of the AlwaysOn connection that is modulated by this duty cycle, measured in milliseconds. A value of 0 means the connections always stays alive. It is recommended that this value be greater than 10 seconds, at a minimum.
INTEGER
0
See also: How to Configure Duty Cycle Modulation.
Settings for the Windows Service
Name
Description
Base Type
Default Value
ServiceName
The name of the service in ThingWorx.
STRING
ThingWorx AdoClient
ServiceDescription
Description of the service.
STRING
ThingWorx .NET ADO Client
ServiceDisplayName
User-friendly name for the service. Appears in the Services tool of Windows.
STRING
ThingWorx ADO Client
ServicesDependedOn
List of Windows services (names of services) that this service depends on. Names are separated by semicolons (;). This is useful only if the database needs to be started before the ADO service, and is usually left empty.
STRING
(none)
ServiceStartMode
Specifies if the service should start automatically or will be started manually when the system is rebooted: The valid values are Automatic and Manual.
STRING
Manual
See Also: How to Configure Settings for Windows Service
Settings for the SQL Database Connection
Name
Description
Base Type
Default Value
ConnectionType
Type of connection: OleDb or Odbc.
STRING
OleDb
ConnectionString
Connection string used to connect the database.
Sample Connection String for SQL Server (OleDb):
Provider=SQLNCLI11;Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;
* 
www.connectionstrings.net provides possible connection strings.
STRING
AlwaysConnected
Is this client always connected to the database? True or False
BOOLEAN
false
QueryEnabled
Is query enabled (SELECT)? True or False.
BOOLEAN
true
CommandEnabled
Are commands enabled (CREATE, UPDATE, DELETE)? True or False.
BOOLEAN
false
CommandTimeout
Number of seconds to wait before a query times out.
INTEGER
60
See Also: How to Configure the Settings for an SQL Database Connection