app.yaml

[engineDir]/configuration/reference/app.yaml

  1#
  2# -------------------------------------------
  3# Axon.ivy Application Configuration
  4# -------------------------------------------
  5# 
  6# This file shows configurations of an Axon.ivy engine application.
  7# https://developer.axonivy.com/doc/8.0/engine-guide/configuration/files/app-yaml.html
  8#
  9# By default applications are pre-configured to run without any dependencies.
 10# However in productive enviroments applications often interact with many 
 11# external system such a Mail Servers (SMTP) or Directory services (LDAP). 
 12# 
 13# Each application has its own app-<APPNAME>.yaml in the configuration directory.
 14# e.g. the corresponding file for the application 'MyApp' is 
 15# '[engineDir]/configuration/app-MyApp.yaml'.
 16#
 17# Furthermore 'app.yaml' can be deployed as part of application zip.
 18# The deployed 'app.yaml' is installed in the application directory and has a lower
 19# priority than the 'app-<APPNAME>.yaml' in the configuration directory.
 20# https://developer.axonivy.com/doc/8.0/engine-guide/administration/deployment.html
 21#
 22# SECRETS / PASSWORDS:
 23# Any configuration value can be encrypted just by enclosing it with "${encrypt:}".
 24# * to encrypt the string myPassword write "${encrypt:myPassword}"
 25#   https://developer.axonivy.com/doc/8.0/engine-guide/configuration/advanced-configuration.html#passwords
 26#
 27# OVERRIDING:
 28# Any configuration value provided here can be set in alternative sources. 
 29# * environment variables: of the operating system can set app config entries. 
 30#    Their key must be prefixed with 'IVY_APPLICATIONS_MYAPP_'. 
 31#    E.g. use 'IVY_APPLICATIONS_MYAPP_SECURITYSYSTEM' to override the security system.
 32#    https://developer.axonivy.com/doc/8.0/engine-guide/configuration/advanced-configuration.html#overriding-configuration
 33#
 34
 35
 36
 37# == Security System ==
 38# 
 39# A security system manages users and roles and must be defined in ivy.yaml with a name.
 40# Here you can reference those security system by its name. If no security system is defined the 'ivy Security System' is in charge.
 41# https://developer.axonivy.com/doc/8.0/engine-guide/configuration/index.html#users
 42# !! If you change the security system of an application then all users that are no longer defined by the new security system will be deleted. 
 43# !! Tasks assigned to the deleted users are moved to the UNASSIGNED state and has to be manually reassigned later to a new user or role.
 44#
 45SecuritySystem: ""
 46
 47
 48
 49# == Environment ==
 50#
 51# Active Environment of this application. Only one environment can be active at the time.
 52# 
 53# The configuration of Global Variables, Web Service Clients, Rest Clients and External Database Configurations
 54# can be defined environment specific.
 55# 
 56# The environment can be overriden on session-, case- and task level with Java API.
 57#
 58ActiveEnvironment: Default
 59
 60
 61
 62# == EMail Notification Settings ==
 63# 
 64# These email notification settings will be applied to all users of an application.
 65# Users still have the option to customize their e-mail notification settings for themselves.
 66#
 67EMailNotification:
 68  # Whether users should receive a mail when a new task is assigned.
 69  OnNewTasks: false
 70
 71  # On which days of the week the users should receive a daily task summary.
 72  # Possible values are: never, always, monday, tuesday, wednesday, thursday, friday, saturday, sunday
 73  # Any combination of weekdays is allowed.
 74  # In ivy.yaml you can configure when the email is sent EMail:DailyTaskSummary:TriggerTime
 75  DailySummaryOn: never
 76
 77  # Language of the emails. You can specify a locale. e.g. de, de_CH, de_AT, de_DE, en, en_GB, en_US, fr, vi
 78  Language: en
 79
 80
 81
 82# == Data Settings ==
 83#
 84Data:
 85
 86  # Application folder where application files are stored. It overrides the root file folder setting.
 87  # A change in this setting will NOT automatically move existing application files to the new location.
 88  # A change will require to manually move existing files to the new directory.
 89  # Absolute and relative (to the engine root directory) paths are supported.
 90  # If not set the files will be stored in an application specific directory underneath the root file folder.
 91  # [Restart required] for existing apps
 92  FilesDirectory: ""
 93
 94
 95
 96# == Standard Processes ==
 97# 
 98# Standard processes are a set of predefined processes, which you can customize in your ivy project.
 99# To enable these custom processes, the library id of the ivy project must be specified here.
100# The library id is <group-id>:<project-id> from the ivy project deployment defintion.
101# e.g the library id of the portal template is "ch.ivyteam.ivy.project.portal:portalTemplate"
102#
103StandardProcess: 
104 
105  # https://developer.axonivy.com/doc/8.0/engine-guide/administration/standard-processes.html#default-pages
106  DefaultPages: ""
107
108  # https://developer.axonivy.com/doc/8.0/engine-guide/administration/standard-processes.html#email-notifications
109  MailNotification: "" 
110
111
112
113# == JSF ==
114# 
115#
116Jsf:
117
118  # JSF Primeface Theme that is used by HTML Dialogs.
119  # Standard themes:
120  #  aristo, luna-amber, luna-blue, luna-green, luna-pink, nova-colored, nova-dark, nova-light, omega
121  # Serenity themes:
122  #  serenity-ivy, serenity-amber, serenity-blue, serenity-bluegrey, serenity-brown, serenity-cyan, serenity-deeporange, serenity-deeppurple,
123  #  serenity-green, serenity-grey, serenity-indigo, serenity-lightblue, serenity-lightgreen, serenity-lime, serenity-orange,
124  #  serenity-pink, serenity-purple, serenity-teal, serenity-yellow 
125  # Deprecated themes:
126  #  ivy, modena-ivy, afterdark, afternoon, afterwork, black-tie, blitzer, bluesky, bootstrap, casablanca, cupertino, cruze, dark-hive,
127  #  delta, dot-luv, ggplant, excite-bike, flick, glass-x, home, hot-sneaks, humanity, le-frog, midnight, mint-choc, overcast, pepper-grinder,
128  #  redmond, rocket, sam, smoothness, south-street, start, sunny, swanky-purse, trontastic, ui-darkness, ui-lightness, vader, modena
129  primefaces.theme: modena-ivy
130
131
132
133# == Global Variables ==
134# 
135# Global variables are defined in ivy projects.
136# All of those can be overridden independently of the environment.
137#
138#GlobalVariables:
139  #myGlobalVariable: value
140
141
142
143# == Databases ==
144# 
145# Databases are defined in ivy projects with a name.
146# Connection details from those databases can be overridden independently of the environment by addressing the database with its name.
147#
148#Databases:
149
150  # This is an example configuration for the database with the name myDb.
151  #myDb:
152    #Url: "jdbc:mysql://localhost:3306/myDbName"
153    #Driver: com.mysql.jdbc.Driver
154    #UserName: admin
155    #Password: "${encrypt:1234}"
156    #MaxConnections: 5
157
158    # Properties are merged with higher priority with those from the project.
159    #Properties:
160      #name: value
161
162
163
164# == RestClients ==
165#
166# Rest Clients are defined in ivy projects with a name.
167# Any configuration from those clients can be overriden independently of the environment by addressing the client with its name.
168#
169#RestClients:
170
171  # This is an example configuration for the rest client with the name myRestClient.
172  #myRestClient:
173    #Url: "http://localhost:8080"
174
175    # If defined, all features from the project will be completely replaced.
176    #Features:
177      #- ch.ivyteam.ivy.rest.client.mapper.JsonFeature
178      #- ch.ivyteam.ivy.rest.client.authentication.HttpBasicAuthenticationFeature
179
180    # Properties are merged with higher priority with those from the project.
181    #Properties:
182      #username: admin
183      #password: "${encrypt:1234}"
184      #name: value
185
186
187
188# == WebServiceClients ==
189#
190# Web Service Clients are defined in ivy projects with a name.
191# Any configuration from those clients can be overriden independently of the environment by addressing the client with its name.
192#
193#WebServiceClients:
194
195  # This is an example configuration for the soap web service client with the name myWebService.
196  #myWebService:
197  
198    # If definied, endpoint urls will be completely replaced per port type with those from the project.
199    #Endpoints:
200
201      # name of the port type, which is defined in the project.
202      #myPortType:
203        #- "http://localhost:8088"
204        #- "http://webservice/api/soap"
205    
206    # If defined, all features from the project will be completely replaced.
207    #Features:
208      #- ch.ivyteam.ivy.webservice.exec.cxf.feature.HttpBasicAuthenticationFeature
209      #- ch.ivyteam.ivy.webservice.exec.cxf.feature.ProxyFeature
210
211    # Properties are merged with higher priority with those from the project.
212    #Properties:
213      #username: admin
214      #password: "${encrypt:1234}"
215      #name: value
216      
217      # Authentication property for the legacy axis stack
218      # Possible values for axis 1: NONE, HTTP_BASIC
219      # Possible values for axis 2: NONE, HTTP_BASIC, HTTP_DIGEST, NTLM
220      #authType: NONE
221
222
223
224# == OverrideProject ==
225#
226# Defines a project containing overriding SubProcesses, HtmlDialogs or CMS entries for a dependent project.
227# This allows you to customize generic solutions with minimal effort.
228# The overriding project must be declared in the format <group-id>:<project-id> (e.g. ch.ivyteam.ivy:overrideProject). 
229# These identifiers can be copied from the ivy project deployment definition (pom.xml).
230#
231# https://developer.axonivy.com/doc/8.0/designer-guide/how-to/overrides.html
232#
233OverrideProject: ""