Client and Server Configurations

Workflow supports adding server and client configurations that are not included in the respective configuration files.

CAUTION: Performance can be affected if values are adjusted in the configuration files.

The following steps apply to both client and server configuration files.

Determine which configuration(s) and value(s) you want to add to the applicable file.
Use the following XML element example to configure the file.
Note: All new configurations must be added to the <appSettings> element.
```
<appSettings>
    <add key="ServerStatePingInterval" value="10" />
</appSettings>
```
Note:
- If the configuration is for a client, then start a new client for the new configuration to take effect.
- If the configuration is for the SOA or STS service, then restart that service for the new configuration to take effect.

Client Configuration

All client configurations are added to the ProficyClient.exe.config file.

Configuration	Description
ServerStatePingInterval	Specifies the server state refresh interval. Sites with a large number of clients may need to increase this interval to prevent high load from the continuous pings. The default value is `30` seconds.
NavigatorSearchMaximumDisplayResults	Specifies the maximum number of objects that can be displayed in the navigator's search results area. The default value is `500`.
ChannelPoolMaxIdleAgeHours	Specifies the maximum amount of time (in hours) that a channel is held idle in the pool before being destroyed due to inactivity. The default value is `24` hours; the minimum value is `1` hour. If a valid value is not found or the value is less than the minimum, then the default value is used. Note: GE recommends a value no greater than 168 hours (one week) for practicality and to avoid possible overflow when converting to milliseconds. It is significant because channel creation is expensive when the server is busy. Thus we want to reuse channels where possible, especially where sites have an expensive event or operation occurring at a regular frequency. Setting this value to a period longer than the site event frequency allows channels to be maintained from the last occurrence so that few, if any, channels need to be created to satisfy the operation.
OperationTimeoutSeconds	Specifies the WCF operation timeout. The default value is `600` seconds.
ReceiveTimeoutMinutes	Specifies the WCF receive timeout. The default value is `48` hours. If this value is configured as `0`, the TimeSpan maximum value is used. Note: The time span value must be at least double the ChannelPoolMaxIdleAgeHours value.
UseDefaultWebProxy	Indicates whether the auto-configured HTTP proxy of the system should be used, if available. The default value is `True`.
UserPermissionsRefreshMinutes	Specifies the length of time it takes for a permission change to take effect. The default value is `1` minute.

Server Configuration: SOA Service

The following configurations are added to the ProficyServer.exe.config file.

Configuration	Description
WorkflowDomainServiceStartupPollingFrequencyInSeconds	Specifies the Workflow domain service start up polling frequency (in seconds). This configuration is used to check the essential services status. Waits for all essential service providers to start before starting the Workflow domain service. The default value is `10` seconds. If the configured value is less than `1` second, then the default value is used.
CacheBasePath	Specifies the root directory for all client caches. The default value is C:\Users\<myUsername>\AppData\Local.
LicensePollPeriodMinutes	Specifies the read and update license interval. The default value is 10 minutes. The maximum value is `24*60` minutes and the minimum value is `1` minute.
sqlCommandTimeout	Specifies the SQL command timeout (in seconds), from the configure file. A value of `0` indicates no limit (an attempt to execute a command will wait indefinitely). The default value is `30` seconds.
ChannelPoolMaxIdleAgeHours	Specifies the maximum amount of time (in hours) that a channel is held idle in the pool before being destroyed due to inactivity. The default value is `24` hours; the minimum value is `1` hour. If a valid value is not found or the value is less than the minimum, then the default value is used. Note: GE recommends a value no greater than `168` hours (one week) for practicality and to avoid possible overflow when converting to milliseconds. It is significant because channel creation is expensive when the server is busy. Thus we want to reuse channels where possible, especially where sites have an expensive event or operation occurring at a regular frequency. Setting this value to a period longer than the site event frequency allows channels to be maintained from the last occurrence so that few, if any, channels need to be created to satisfy the operation.
logStatistics	Indicates whether to log client dispatch details. The default value is `False`. Note: This configuration must enable tracing in the configuration file: `<logger name="ProxyClientDispatcher" threshold="DEBUG"> <file value=%TraceDir%\ProxyClientDispatcher.log"/> </logger>`
ReceiveTimeoutMinutes	Specifies the WCF receive timeout. The default value is `48` hours. If this value is configured as `0`, the TimeSpan maximum value is used. Note: The time span value must be at least double the ChannelPoolMaxIdleAgeHours value.
OperationTimeoutSeconds	Specifies the WCF operation timeout. The default value is `600` seconds.
UseEquipmentClassStoredProcedures	Indicates whether to use stored procedures to update equipment class properties to improve performance. The default value is `False`.
HistorianDeleteTimeout	Specifies the Historian deletion timeout. The default value is `300` seconds.
HistorianManualSyncOnly	Indicates whether Historian synchronization will only be triggered manually rather than automatically on startup. The default value is `False`.
HistorianCustomCollectorNames	Specifies the Historian collector names to synchronize that are not registered collectors in your Historian server. Use a comma (,) as a separator.
EquipmentProvisioningTimeout	This timeout configuration is for the equipment provisioning tool to process provisioning commands. By default, the equipment provisioning process times out if the processing time exceeds 10 minutes. For very large amounts of commands (for example, tens of thousands), 10 minutes may be insufficient preventing the provisioning from completing. If required, the timeouts can be adjusted. The following appSetting can be added. The value is the timeout in seconds. `<add key="EquipmentProvisioningTimeout" value="1200" />` If a value greater than 10 minutes is used, the WCF timeout must also be adjusted higher than the default of 10 minutes. `<add key="OperationTimeoutSeconds" value="1200" />`
DisplayCacheFolder	Specifies a custom folder path to store user display projects and assemblies on client machines. The path must be absolute; however, environment variables can be used as part of the path. For example: "%ProgramData%\Workflow Displays" The default path is the Proficy Workflow folder in your My Documents folder.

Server Configuration: SOASecurity Token Service

The following configurations are added to the ProficySTS.exe.config file.

Configuration	Description
MaximumClockSkew	Specifies the maximum allowable time difference between the system clocks of the two parties that are communicating. The default value is `5` minutes. Use a maximum value of `10` minutes.