API Server and Worker Configuration

The API Server and it's workers are supplied with a default configuration. This can be managed from iCM.

Viewing the Current Configuration

You can view server and worker configuration from the API Server Console. The values you see are a combination of the server and worker default configuration (found in the worker.conf of each worker and the APIServer.conf file) plus the configuration sent to the API Server from iCM.

API Server configuration is visible in the "Settings" tab of the console menu.

To see the configuration of a worker, select it form the "Overview" page of the console, then press the cog icon next to the worker name. Here's the full configuration for a typical Ajax Library worker.

Environment Configuration

When you send configuration to the API Server from iCM, as well as the custom configuration for workers and the server described below, iCM also sends environment configuration.

If you make changes to autoconfig or the iCM Settings section (in particular website user profile mappings) you'll need to resend the API Server configuration from iCM so these changes are propagated throughout your platform.

Custom Configuration

API Server configuration files are held in the iCM custom folder, accessed using the File Manager.

Workers

The "workers" array in the configuration file sets up each worker that should be started, the number of instances of it, and the threads per instance of threaded workers. You can override the value of any property in a worker's default configuration by including it in this file. For example:

{
    "name": "ajaxlibrary",
    "instances": 4,
    "displayName": "new name"
}

Which would make the Ajax Library appear like this in the console:

Not a very practical example! More useful is the "version" property. By default the API Server will use the latest installed version of a worker. You can roll back to an earlier version by explicitly setting the version to start, for example "version": "1.7.1" (assuming that version actually exists).

Additional options for each worker, like the providers used by the Authentication worker or the service the Postcode worker should connect to, are also set here. The documentation for each worker looks at these options in more detail.

API Server

In exceptional circumstances you may need to modify the configuration of the API Server itself. This is done in exactly the same way as workers, adding the properties you'd like to set at the top level of the file, like this:

{
    "workerKillTimeout": 6000,
    "enableHttp": true,
    "workers": [{...}, {...}]
}

The full configuration structure is described below.

Time intervals can either be expressed as integers representing milliseconds, or as objects with time and value properties. For example, one minute could be set as

"cacheSweepInterval": 60000

or

"cacheSweepInterval": { "T":"time", "V":"00:01:00" }

Where "V" represents hours, minutes and seconds. This is useful for longer intervals, like the lifetime of files in the tmp directory, which defaults to { "T":"time", "V":"120:00:00" } rather than the slightly harder to read 432000000.

${APISERVER} provides the path to the root installation directory of the API Server.

Datasources

It's also possible to define additional datasources in the API Server configuration, allowing your forms, End Points and workers like the FormUtils Worker to interact with data in external (ie not the iCM) databases.

To do this, add the top level environmentConfig object with the details of your database. The "default" should be left as "icm".

"environmentConfig": {
    "dataBases": {
        "default": "icm",
        "dataSources": {
            "mydatabase": {
                "databaseDriverClass": "com.microsoft.jdbc.sqlserver.SQLServerDriver",
                "databaseUserName": "theusername",
                "databaseConnectionString": "jdbc:sqlserver://GI00645:1433;DATABASENAME=mydatabase;sendStringParametersAsUnicode=true;SelectMethod=direct",
                "databasePassword": "thepassword"
            }
        }
    }
}