ivy.yamlΒΆ

[engineDir]/configuration/reference/ivy.yaml

  1#
  2# -------------------------------------------
  3# Axon.ivy Engine Configuration
  4# -------------------------------------------
  5# 
  6# This file shows configurations of the Axon.ivy engine and its external systems.
  7# https://developer.axonivy.com/doc/8.0/engine-guide/configuration/
  8#
  9# Copy contents of this reference file to 'configuration/ivy.yaml' before adjusting
 10# them to your needs.
 11# https://developer.axonivy.com/doc/8.0/engine-guide/configuration/files/ivy-yaml.html
 12#
 13# By default the engine is pre-configured to run in demo mode.
 14# To run an engine in a productive environment at least the system database
 15# must be configured.
 16#
 17# SECRETS / PASSWORDS:
 18# Any configuration value can be encrypted just by enclosing it with "${encrypt:}".
 19# * to encrypt the string myPassword write "${encrypt:myPassword}"
 20#   https://developer.axonivy.com/doc/8.0/engine-guide/configuration/advanced-configuration.html#passwords
 21#
 22# OVERRIDING:
 23# Any configuration value provided here can be set in alternative sources. 
 24# * environment variables: of the operating system can set app config entries. 
 25#    Their key must be prefixed with 'IVY_'. 
 26#    E.g. use 'IVY_SYSTEMDB_URL' to override the jdbc driver url.
 27#    https://developer.axonivy.com/doc/8.0/engine-guide/configuration/advanced-configuration.html#overriding-configuration
 28#
 29
 30
 31
 32# == System Database Settings == 
 33#
 34# Axon.ivy requires a System Database to store the state of running workflow applications.
 35#
 36# Unless you run the engine in Demo mode, a valid System DB driver, url and the user+password credentials
 37# that are able to connect to the database are mandatory.
 38# 
 39# [Restart required]
 40SystemDb:
 41  # JDBC URL
 42  Url: ""
 43
 44  # Name of the user to connect to system database. E.g. root, sa, admin, ivy, AxonIvy
 45  # e.g. root
 46  UserName: ""
 47
 48  # Password of the user to connect to the system database.
 49  # e.g. "${encrypt:1234}"
 50  # [Format:PASSWORD]
 51  Password: ""
 52
 53  # If set to true the system database is automatically converted to the latest version during startup of the Axon.ivy Engine if needed.
 54  Autoconvert: false
 55
 56  # Defines how long ivy should wait (in seconds) at startup for the availability of the db server
 57  BootTimeout: 60
 58
 59  # JDBC Driver. If not set, it is auto determined based on the JDBC URL.
 60  Driver: ""
 61
 62  # Additional driver specific connection properties.
 63  DriverProperties:
 64    #driverProperty: propertyValue
 65
 66  # Maximum number of connections to the system database.
 67  MaxConnections: 50
 68
 69
 70
 71# == Adminstrators ==
 72#
 73# Administrators can configure, monitor and manage the Axon.ivy engine.
 74#
 75# Email is used to send info mails like license expiration
 76# FullName is used to display a nice name for this user.
 77# 
 78# You should hash the password with "${hash:mySecret}".
 79# The real password cannot be recovered from the hash.
 80#
 81# Default administrator in demo mode is 'admin' with password 'admin'
 82#Administrators:
 83
 84  # Example admin user with username james and password mySecret
 85  #  
 86  #james:
 87    #Password: "${hash:mySecret}"
 88    #Email: info@localhost
 89    #FullName: James David
 90
 91
 92
 93# == Deployment Setting ==
 94#
 95Deployment:
 96
 97  # Directory where the server watches for files to deploy.
 98  # https://developer.axonivy.com/doc/8.0/engine-guide/administration/deployment.html
 99  #
100  # You may want to use a UNC path to specify a remote network location.
101  Directory: deploy
102
103
104
105# == Data Settings ==
106#
107Data:
108
109  # Folder where applications are stored, unless otherwise defined in the deployment.
110  # To change this path, proceed as follows...
111  #   1. Adjust the path to point to its new location
112  #   2. Stop the running Engine immediatelly to avoid files being written to the old location
113  #   3. Move the existing applications to this new directory
114  #   4. Start the engine
115  # Absolute paths and relative paths are supported
116  # In demo mode not configurable and set to: [Data.WorkDirectory]/demo-applications
117  # [Restart required] for existing apps
118  AppDirectory: applications
119
120  # Root folder where application files are stored.
121  # A change in this setting will NOT automatically move existing application files to the new location.
122  # A change will require to manually move existing files to the new directory.
123  # Absolute and relative (to the engine root directory) paths are supported.
124  # If not set the files will be stored underneath each application's file directory.
125  # [Restart required] for existing apps
126  FilesDirectory: ""
127
128  # Directory where the server writes temporary working files to.
129  # [Restart required]
130  WorkDirectory: work
131
132
133# == Data Cache Settings ==
134#
135DataCache:
136  
137  # Invalidate data cache groups and entries. Checks if the lifetime of caches has ended and invalidates them.
138  # You can set the delay in milliseconds between each check. This delay has to be greater than 0.
139  InvalidationInterval: 60000
140
141
142# == Elasticsearch Settings ==
143#
144# Axon.ivy uses an Elasticsearch instance to provide a fast query interface against BusinessData.
145# The bundled instance is started on demand, in a separate JVM, when an API request needs it.
146#
147# You can operate Axon.ivy with the bundled Elasticsearch server or with your own external Elasticsearch cluster.
148#
149# [Restart required] except for UserName and Password of ExternalServer
150Elasticsearch:
151
152  # The bundled Elasticsearch server...
153  # - is started in a separate JVM when a feature requires BusinessData access.
154  # - reachable only on 'localhost' but the access is unprotected. 
155  # - JVM arguments used to start the bundled Elasticsearch server can be 
156  #   configured in the 'elasticsearch/config/jvm.options' file.
157  BundledServer:
158    # The path to the directory where the bundled Elasticsearch server stores data.
159    # It is recommend to configure a data directory that is located outsite of the Engine 
160    # installation directory to ease the Engine migration to newer versions.
161    DataPath: elasticsearch/data
162    # The name of the cluster of the bundled Elasticsearch server.
163    ClusterName: ivy-elasticsearch-{uid}
164
165
166  # Configure the URL of your own Elasticsearch server if you want to use it instead of the bundled server.
167  #
168  # To install your own Elasticsearch server follow these steps
169  # https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html
170  #
171  # Currently Axon.ivy supports Elasticsearch server versions in the 7.3.x range. 
172  # If your Elasticsearch server is running on another host, the access to that instance has to be protected.
173  # You can achieve that with a front-end webserver like NGINX that enforces basic authentication.
174  ExternalServer:
175  
176    # Configure the URL of your own Elasticsearch server if you want to use it instead of the bundled server.
177    Url: ""
178
179    # Name of the user to use to authenticate in the external Elasticsearch server
180    UserName: ""
181    
182    # Password of the user to use to authenticate in the external Elasticsearch server.
183    # e.g. "${encrypt:}"
184    # [Format:PASSWORD]
185    Password: ""
186    
187    # Defines how long ivy should wait (in seconds) for the availability of the external elasticsearch server while booting.
188    BootTimeout: 60
189
190  # For every business data type an Elasticsearch index will be created. E.g. for type ch.ivy.Dossier the index name is <NamePrefix>-ch.ivy.dossier.
191  Index:
192    # The name prefix of the index to use to store business data.
193    # If multiple ivy Engines use the same Elasticsearch server instance, you need to change this property, that every ivy Engine has an unique indices.
194    NamePrefix: ivy.businessdata
195    
196    Reindex:
197      # The number of business data objects that should be read in one batch from the system database
198      ReadWindowSize: 1000
199      # The number of business data objects that should be write in one batch to Elasticsearch
200      WriteWindowSize: 1000
201      # The size of the queue that is used to store business data objects read from the database 
202      # until they are written to the Elasticsearch
203      QueueSize: 10000
204
205
206  # Configures the Elasticsearch client. The client is the ivy engine which communicates with Elasticsearch.
207  Client:
208    # Maximum seconds to wait until a connection to Elastisearch can be established.
209    ConnectTimeout: 10
210    
211    # Maximum seconds to wait for data sent by Elastisearch. 
212    # Raise this value if large datasets are expected.
213    ReadTimeout: 30
214         
215
216
217
218# == EMail Settings ==
219#
220EMail:
221  Server:
222    Host: localhost
223
224    Port: -1
225
226    # Email address that will be used for emails sent by the server (e.g. task notification emails)
227    MailAddress: noreply@ivyserver.local
228
229    User: guest
230
231    # [Format:PASSWORD]
232    Password: ""
233
234    # [Values: NONE, START_TLS, SSL]
235    EncryptionMethod: NONE
236
237    SSL:
238      KeyAlias: ""
239
240      UseKey: false
241
242  DailyTaskSummary:
243    # Time of day when the task summary mails will be sent.
244    # Format is hh:mm. e.g. "02:00" or "14:15"
245    # [Format:DAYTIME]
246    TriggerTime: "00:00"
247
248
249
250# == Show Error Messages To End Users Settings ==
251#
252# When an error occurs while processing a user request an error screen is displayed to the user. 
253# 
254# The displayed error page can be customized for your needs: 
255# https://developer.axonivy.com/doc/8.0/engine-guide/configuration/files/web-xml.html
256#
257Errors:
258  # Whether stacktraces, detailed error reports, etc. should be shown to end users.
259  #
260  # By default (false) we only show a unique 'Error Id'. This 'Error Id' can be used to find the error in the log files.
261  # 
262  # For security reasons normal users should not see technical implementation details.
263  # But in development or pre-production environments it might be save to show the full error
264  # details directly to the end user.
265  ShowDetailsToEndUser: false
266
267
268
269# == Persistence Setting ==
270#
271Persistence:
272  JPA:
273    # Persist ivyScript auto initialized fields with NULL values. Affects types are...
274    #  - ch.ivyteam.ivy.scripting.objects.Date
275    #  - ch.ivyteam.ivy.scripting.objects.DateTime
276    #  - ch.ivyteam.ivy.scripting.objects.Time
277    # If this option is disabled auto initialized values are stored as before Axon.ivy 6.4.
278    defaultInitializedAsNull: true
279
280
281
282# == Process Element Firing Statistic Settings ==
283#
284ProcessEngine:
285  FiringStatistic:
286
287    # If activated, a process element statistic is written periodically to the log-directory. If activated may slow down the server performance.
288    Active: false
289
290    # Interval in seconds the 'process element statistic' is written to the log directory
291    Interval: 300
292
293
294
295# == SSL Client Settings ==
296#
297SSL:
298  Client:
299    # A key store is used to read client keys (certificates). 
300    # This is only required if a remote server requests a client certificate in order to authenticate the client. 
301    KeyStore:
302      UseCustom: false
303      # [Format:PASSWORD]
304      KeyPassword: changeit
305      Algorithm: SunX509
306      File: configuration/keystore.p12
307      # [Format:PASSWORD]
308      Password: changeit
309      Provider: ""
310      Type: pkcs12
311
312    # A trust store is used to specify trusted server certificates or certificates of certification authorities. 
313    # An SSL client autenticates a server by using the certificates in a trust store. 
314    TrustStore:
315      # The system trust store of the Java Runtime Environment (JRE) contains well known certification authorities
316      UseSystem: true
317      
318      # The custom trust store contains certificates that are self signed or signed by an unknown certification authority 
319      UseCustom: false
320      Algorithm: PKIX
321      File: configuration/truststore.p12
322      # [Format:PASSWORD]
323      Password: changeit
324      Provider: ""
325      Type: pkcs12
326
327      # Full qualified class name of a trust manager class that is used to validate server certificates. 
328      # This manager is only considered if neither a custom nor a system trust store is used.
329      ManagerClass: ""
330
331
332
333# == Workflow Settings ==
334#
335Workflow:
336
337  # Wether done cases and tasks can be seen by substitutes of the user who has worked on them.
338  # [Values: VISIBLE, INVISIBLE]
339  History.ForSubstitutes: VISIBLE
340
341
342# == Failure Behaviour ==
343#
344SystemTask:
345  # Defines the behaviour in case a system task fails. 
346  # [Values: FAIL_TASK_DO_RETRY, FAIL_TASK_DO_NOT_RETRY, DESTROY_TASK, DESTROY_CASE]
347  Failure.Behaviour: FAIL_TASK_DO_RETRY
348
349  # Interval in seconds between executions of the search job for system tasks.
350  # The job searches system tasks that were not executed because of failures.
351  SearchJob.Interval: 900
352
353
354
355# == Thread Pools Settings ==
356#
357ThreadPool:
358  # Executes process engine background operations like Database, WebService calls, etc.
359  BackgroundOperationExecutor:
360    # Minimum number of threads
361    CorePoolSize: 5
362    # Maximum number of threads
363    MaximumPoolSize: 200
364  
365  # Executes unscheduled jobs
366  ImmediateJobExecutor:
367    # Minimum number of threads
368    CorePoolSize: 5
369    # Maximum number of threads
370    MaximumPoolSize: 50
371  
372  # Executes scheduled jobs
373  ScheduledJobExecutor:
374    # Minimum number of threads
375    CorePoolSize: 5
376
377
378
379# == Update Checker Settings ==
380#
381# When newer Axon.ivy versions are available a message will be displayed on the Axon.ivy Engine main web page. 
382# The update message contains information about the new versions and where those can be downloaded. 
383#
384# While checking for new versions the following statistic information are sent to the update server. 
385# These information are only used to improve the product:
386# - Engine (version, up time)
387# - Configuration (number of: cluster nodes, users, licenced users, applications, process model, process model version, deleted process model version, running cases, running tasks)
388# - Licence information (number, organisation, individual)
389# - Operating system information (name, version, architecture, number of processors)
390# - System database (product name and version, driver, identification number)
391# - Java memory information (maximum heap memory, maximum non heap memory)
392# - JVM (Java virtual machine) information (version, vendor, name)
393# - Host information (host name, SHA-256 hashes of IP address and MAC address to identify the host without being able to read the original IP address and MAC address itself)
394#
395UpdateChecker:
396  #  Whether Update notification messages are shown and statistic information are sent to the update server 
397  Enabled: true
398
399  # Time of day when a update check will be executed
400  # Format is hh:mm. e.g. "02:00" or "14:15"
401  # [Format:DAYTIME]
402  ExecutionTime: ""
403  
404
405
406Boot:
407  # Switch to maintencance mode if a configuration problem is detected during startup.
408  # If set to DISABLED you can explicit start the engine in maintenance mode by using the command line option '-maintenance'.
409  # [Values: AUTO, DISABLED]
410  MaintenanceMode: AUTO