Secure Agent Services > Process Server > Overriding properties in the platform.yaml file

Overriding properties in the platform.yaml file

You can override the default values for properties that the Process Server uses to get the configuration details related to Application Integration and communicate with the Secure Agent services.

To do this, you create a copy of the platform.yaml file and update the property values, name the file as user-platform.yaml, and save it in the following directory:

<Secure Agent installation directory>\apps\process-engine\conf

The platform.yaml file is available in the following directory:

<Secure Agent installation directory>\apps\process-engine\<latest_process_engine_version>\conf

When the Process Server is up and running, if a property is specified in the user-platform.yaml file, the Process Server uses that specific value. Otherwise, Process Server uses the values defined in the platform.yaml file.

When the Secure Agent is upgraded to a new version, the properties in the user-platform.yaml file are unchanged.

Creating a custom user-platform.yaml file

You can create a custom user-platform.yaml file with the required properties and their custom values to override the properties in the platform.yaml file on the Secure Agent.

You must have the same level of access permissions as the platform.yaml file to create and edit the user-platform.yaml file.

To create a custom user-platform.yaml file, perform the following steps:

1Log in to the Secure Agent machine.
2Create a file named user-platform.yaml in the following directory:

<Secure Agent installation directory>\apps\process-engine\conf

3Copy the properties that you want to customize from the platform.yaml file that is available in the following directory to the user-platform.yaml file and override the values, as required:

<Secure Agent installation directory>\apps\process-engine\<latest_process_engine_version>\conf

For example, consider that you need to override the values of the cacheExpiryMillis and lockTimeoutMillis properties.

These properties are available in the IDs section in the default platform.yaml file as shown in the following sample:

serviceHosts:
ids:
context: /identity-service/api/v1/
agentContext : /identity-service/agent/api/v1/
cache:
enabled: true
maxCacheItems: 2500
cacheExpiryMillis: 60000
lockTimeoutMillis: 30000
refreshAheadEnabled: true
queueCapacity: 500
corePoolSize: 1
maxPoolSize: 5
keepAliveSec: 120
timeToRefreshSec: 15
evictOnLoadMiss: false
clientPool:
socketTimeout : 60000
connectionTimeout : 60000
poolMaxTotal : 40
poolMaxPerRoute : 30
hystrix:
executionTimeoutInMilliseconds : 60000
fallbackEnabled: false

Copy these properties from the platform.yaml file and update the values in the user-platform.yaml file as shown in the following sample:

serviceHosts:
ids:
context: /identity-service/api/v1/
agentContext : /identity-service/agent/api/v1/
cache:
cacheExpiryMillis: 200000
lockTimeoutMillis: 150000

Note: You must ensure that you follow the same hierarchy and syntax as the default platform.yaml file.

4Save the user-platform.yaml file.
5Restart the Process Server for the changes to take effect.

When the Process Server is up and running, the properties specified in the user-platform.yaml file override the properties in the platform.yaml file.

Troubleshooting

When overriding the properties, if the user-platform.yaml file contains incorrect properties or values when compared to the platform.yaml file, you might encounter unexpected behavior.

For example, consider the following scenarios where you do not get the expected result because of manual intervention:

•The agentContext property is used to fetch the IDS-SESSION-ID. If the value for the agentContext property in the platform.yaml file is /identity-service/agent/api/v1/ and you entered the value as /identity-service/agent/api/v2/ in the user-platform.yaml file, Process Server fails to fetch the IDS-SESSION-ID because of the invalid endpoint. Therefore, the Secure Agent uses the basic authentication mechanism.
•The cacheExpiryMillis property value is expected to be numeric. However, if you enter an alphanumeric value, the value will be treated as a string without any error.