Taskana is configured via a configuration file 'taskana.properties'
. This configuration file contains all parameters to control the behaviour of the taskana library.
General Parameter
Parameter | Description | Sample Value |
---|---|---|
taskana.domains | The comma separated list of administrative domains | DOMAIN_A, DOMAIN_B |
taskana.classification.types | The comma separated list of classification types | TASK, DOCUMENT |
taskana.classification.categories | The comma separated list of classification categories | EXTERNAL, MANUAL, AUTOMATIC, PROCESS |
Security Configuration
The properties file contains the specification of the lists of access ids (i.e. users or groups) that belong to the roles user, business_admin or admin.
The keywords to specify these roles are as follows:
Role | Keyword |
---|---|
user | taskana.roles.user |
business_admin | taskana.roles.businessadmin |
admin | taskana.roles.admin |
Each entry may contain a list of access ids that are separated by the '|' character. Whitespace at the begin or end of each access id is ignored. This is, as sample config may look like
taskana.roles.user = group1 | group2 taskana.roles.admin= Holger | admingroup1| admingroup2|admingroup3 | uid=john.doe,ou=People,dc=example,dc=com taskana.roles.businessadmin=busadmgrpa|busadmgrpb | busadmgrpc
By default, this configuration file has the name 'taskanaroles.properties' and is searched in the classpath. In addition, the separator '|' is used. Both defaults can be changed by specifying the property filename and separator explicitely when creating the TaskanaEngineConfiguration via constructor.
TaskanaEngineConfiguration(DataSource dataSource, boolean useManagedTransactions, boolean securityEnabled, String propertiesFileName, String propertiesSeparator)
If in this call, either propertiesFileName or propertiesSeparator is null, Taskana uses the default value.
If for example, you want Taskana to use the 'application.properties' file from the classpath, you should specify "/application.properties" as propertiesFileName.
You may also specify a fully qualified filename that addresses a file directly. In this case, that file is not searched on the classpath but loaded by its name.
Please note, that if you specify a non-default propertiesSeparator, the access ids must not contain any character that is contained in this propertiesSeparator.
If Taskana doesn't find a configuration file, it operates with empty roles.
Job Configuration
Parameter | Description | Sample Value |
---|---|---|
taskana.jobscheduler.delay | The period the scheduler looks for jobs to run. (in ms) | 60000 |
taskana.jobs.taskupdate.maxRetries | The maximum number of automatic retries if the job fails | 3 |
taskana.jobs.taskupdate.batchSize | The maximum number of task to be processed in one job | 50 |
taskana.jobs.cleanup.runEvery | Cycle time for the cleanup job to run (Duration in ISO 8601 format) | P1D |
taskana.jobs.cleanup.firstRunAt | First start of the cleanup job. (DateTime n ISO 8601 format) | 2018-07-25T08:00:00Z |
taskana.jobs.cleanup.minimumAge | The minimum time between the completion of the task and the deletion by the cleanup (Duration in ISO 8601 format) | P14D |