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