Overriding properties using YAML file
You can override properties at run time by modifying server.conf.yaml if it has stand-alone integration server and for node owned integration server node.conf.yaml file.
You can use any property from property1 to property5.
You can specify multiply properties with a semicolon as a separator.
Note: Not all properties are
mandatory. Based on the operation mode, some properties are optional.
The following is a sample format of the server/node.conf.yaml with the minimum required properties and its preferred value to run a connector.
ConnectorProviders:
ACMfg:
connectorClassName: 'com.ibm.industrypack.industryclient.connector.ICConnectorFactory'
jarsURL: 'C:\Program Files\IBM\ACMfg\2.0.0.8\runtime\amd64_nt_4'
property1: 'trustCertificate=true;allowEndpointMismatch=true;discardData=false'
property2: 'isHA=true;mqttHostName=<mqtt-server-host>;mqttPort=1883'
property3: 'disableLog=true'
Where,isHA=true
,mqttHostName=<mqtt-server-host>
,mqttPort=1883
properties are only applicable in a high-availability environment.Remove these properties if you are running the connector in a non-high availability environment.
disableLog=true
property is optional.Use this property only when you want to generate fewer logs or if you are running the connector against higher loads.Tip: When the productivity is on a higher load, disable the logs to increase the performance.
For a docker container, use the server.conf.yaml file. For more information, on using server.conf.yaml, see Validating certificate in runtime.
Note: Restart integration server to reflect the modified properties.
Property | Description |
---|---|
allowEndpointMismatch | Specifies whether to connect to the OPC Server even if there is a mismatch in the endpoint. The default value is false. Set the value to true to connect to the OPC server if the endpoints are mismatched. |
allowSessiontimeout | Specifies whether a session can time out. By default, the value is FALSE. The client keeps the session alive until requestWaitingtimeout and then closes the session. Used by all Nodes. |
connectorKeepAliveInterval | Specifies the interval between two connectors keepalive messages sent out by the control flow. The default value is 1000 milliseconds. Used by Control Nodes. |
connectorKeepAlivetimeout | Specifies the amount of time a connector is allowed to not send any keepalive message before
it is considered dead. This time out is also used for the internal request queue to determine
whether its own control flow is gone. By default, the value is 5000
milliseconds. Used by Control Nodes. Note: You no longer need to override this property due to the
isHA property.
|
datasourceSessiontimeout | Specifies the default session time-out. By default, the value is 3600000 milliseconds. Used by all Nodes. |
dataSourceStartupMaxRetryInterval | Specifies when data source starts are retried after a retry interval expired. This interval starts at 10 seconds and is incremented by 10 seconds with every retry. This method returns the configured maximum retry interval beyond which the retry interval is not incremented. The default value is 60000 milliseconds. Used by all Nodes. |
dataSourceStartupRetryTime | Specifies how long a data source should be retried to successfully start a data source. By default, the value is 3600000 milliseconds. Used by all Nodes. |
debugging | Specifying the connector for debugging disables all the time-out. The time-out messages are logged, but the waiting loops do not end. The default value is FALSE. Used by all Nodes. |
discardData | Specifies whether the server-side data is to be discarded. If the specified publish notification time is of future or past, the data gets discarded. The default value is FALSE. |
initializationTime | Specifies the Control flow wait for initialization up to this time, expecting other servers to send alive messages, if any. The default value is 1000 milliseconds. Used by Control Nodes. |
isHA | Specifies whether the App Connect for Manufacturing is running in high availability mode or not. Takes a Boolean value. The default value is false. |
mqttHostName | Specifies the hostname on which the MQTT broker is running. |
mqttPort | Specifies the port number that is used by the MQTT broker. |
queuedRequesttimeout | Specifies the amount of time a request (for example, registering a TriggerItemList for an ACMfg Input node) waits for an answer (for example, from the involved data sources, that the subscription failed or was successful for a TriggerItemList registration) before considering the request timed-out and failed. The default value is 30000 milliseconds. Used by Input Nodes. |
requestWaitingtimeout | Specifies how long a client waits until a data source request to close the session. By default, the value is 86400000 milliseconds. Used by all Nodes. |
revisedSessiontimeoutMax | Specifies the maximum session time-out at run time according to the OPC UA certification. The default value is 3600000 milliseconds. |
revisedSessiontimeoutMin | Specifies the minimum session time-out at run time according to the OPC UA certification. The default value is 1000 milliseconds. |
stoptimeout | Specifies the wait until that time out period for unregistering items before giving time-out error. Used by Input Nodes. |
subscriptiontimeout | ACMfg Read node is waiting for a result on registering its ClientItemList before it considers the request failed. The default value is 30000 milliseconds. Used by Read Nodes. |
triggerAssignmenttimeout | Specifies a trigger that is first assigned to a control flow having a message flow that has
registered for this trigger. The trigger then is started to be run by a message flows of this
control flow and finally the message flow reports having finished with the trigger. This parameter
represents the amount of time that can pass between the trigger appearing and its assignment to a
control flow before the assignment is considered failed. Used by Input Nodes. Following are the
default values,
|
triggerFinishExecutiontimeout | Specifies a trigger that is first assigned to a control flow having a message flow that has
registered for this trigger. The trigger then is started to be run by a message flows of this
control flow and finally the message flow reports having finished with the trigger. This parameter
represents the amount of time that can pass between the start of the trigger's execution and the
finish of it before the trigger's execution is considered failed. Used by Input Nodes. Following are
the default values,
|
triggerStartExecutiontimeout | Specifies a trigger is first assigned to a control flow having a message flow that has
registered for this trigger. The trigger then is started to be run by a message flows of this
control flow and finally the message flow reports having finished with the trigger. This parameter
represents the amount of time that can pass between a trigger's assignment to a control flow and the
start of its execution before the trigger's processing is considered failed. Used by Input Nodes.
Following are the default values,
|