Categories: CONFIGURATION

Important settings

Controller settings

Main properties

The main configuration file of the Controller is step.properties.

Installation from archive

When installing Step manually from the archives, the file is located in the conf folder of the controller.

The main parameters to be updated in order to start the Controller are listed below :

  • port=<port_to_access_controller_gui>
  • grid.port=<port_for_agents_to_access_the_controller>
  • datasource.mongo.properties.host=<mongo_hostname_or_ip>
  • datasource.mongo.properties.port=<mongo_port>
  • datasource.mongo.properties.username=<step_database_username> (if any)
  • datasource.mongo.properties.password=<step_database_password> (if any)

For example :

  • port=8080 -> Controller GUI will be accessible on port 8080
  • grid.port=8081 -> Agents will connect to the Controller on port 8081
  • datasource.mongo.properties.host=127.0.0.1 -> Controller will try to access to MongoDB running on localhost
  • datasource.mongo.properties.port=27017 -> Controller will try to access to MongoDB on port 27017

For the Enterprise edition, the step.properties file contains all the available properties and are directly documented into the file itself.

Installation in Kubernetes with Helm

When installing Step with Helm, the important properties are exposed directly as values (See Helm Values for details). All properties supported by step.properties which are not directly exposed as value can be defined using the value map: controller.config.additionalProperties

Example

config:
  additionalProperties:
    cosmetics.folder: /home/controller/data/cosmetics
    cosmetics.interceptedResourceList: step-variables.css,logotopleft.png

Limit parallel executions on controller

By default, the maximum number of parallel executions in Step is limited to 30, this can be changed by adding or modifying following property in the step.properties: 

tec.executor.threads=30

File manager cleanup configuration

When the controller needs to transfer files to an agent for the execution of keywords, it caches these files in his own file cache. This cache is automatically cleaned up, but following properties can be customized in the step.properties to tweak this behaviour.

# enable or disable the cleanup (true by default)
grid.filenamanger.file.cleanup.enabled=true
# define file that are eligible for cleanup based on their last access time (default 120 minutes)
# When set to 0, files are cleaned up as soon as they're not used anymore without waiting for the cleanup job
grid.filemanager.file.cleanup.last.access.threshold.minutes=120
# define the frequency of the cleanup job in minutes (default 60)
grid.filenamanger.file.cleanup.interval.minutes=60