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.3/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.3/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.3/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.3/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.3/engine-guide/configuration/users
46# !! If you change a security system then all users that are no longer defined by the changed security system will be disabled.
47# !! SecuritySystem changes are immediately reloaded and a user synchronization is executed.
48# !! Switching from Microsoft Active Directory or Novell eDirectory to Axon Ivy Security System keeps all synchronized users, but requires to set new passwords for them.
49#
50SecuritySystem: ""
51
52
53
54# == Environment ==
55#
56# Active Environment of this application. Only one environment can be active at the time.
57#
58# The configuration of Variables, Web Service Clients, Rest Clients and Databases
59# can be defined environment specific.
60#
61# The environment can be overriden on session-, case- and task level with Java API.
62#
63ActiveEnvironment: Default
64
65
66
67# == EMail Notification Settings ==
68#
69# These email notification settings will be applied to all users of an application.
70# Users still have the option to customize their e-mail notification settings for themselves.
71#
72EMailNotification:
73 # Whether users should receive a mail when a new task is assigned.
74 OnNewTasks: false
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 # 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
81 Language: en
82
83
84
85# == Data Settings ==
86#
87Data:
88 # Application folder where application files are stored. It overrides the root file folder setting.
89 # A change in this setting will NOT automatically move existing application files to the new location.
90 # A change will require to manually move existing files to the new directory.
91 # Absolute and relative (to the engine root directory) paths are supported.
92 # If not set the files will be stored in an application specific directory underneath the root file folder.
93 # [restart required] for existing apps
94 FilesDirectory: ""
95
96
97
98# == Standard Processes ==
99#
100# Standard processes are a set of predefined processes, which you can customize in your ivy project.
101# To enable these custom processes, the library id of the ivy project must be specified here.
102# The library id is <group-id>:<project-id> from the ivy project deployment defintion.
103# e.g the library id of the portal template is "ch.ivyteam.ivy.project.portal:portalTemplate"
104#
105StandardProcess:
106 # https://developer.axonivy.com/doc/dev/designer-guide/user-interface/standard-processes
107 DefaultPages: ""
108 # https://developer.axonivy.com/doc/dev/designer-guide/user-interface/standard-processes
109 MailNotification: ""
110
111
112
113# == JSF ==
114#
115#
116Jsf:
117 # JSF Primeface Theme that is used by HTML Dialogs.
118 # Standard themes:
119 # aristo, luna-amber, luna-blue, luna-green, luna-pink, nova-colored, nova-dark, nova-light, omega
120 # Serenity themes:
121 # serenity-ivy, serenity-amber, serenity-blue, serenity-bluegrey, serenity-brown, serenity-cyan, serenity-deeporange, serenity-deeppurple,
122 # serenity-green, serenity-grey, serenity-indigo, serenity-lightblue, serenity-lightgreen, serenity-lime, serenity-orange,
123 # serenity-pink, serenity-purple, serenity-teal, serenity-yellow
124 # Deprecated themes:
125 # ivy, modena-ivy, afterdark, afternoon, afterwork, black-tie, blitzer, bluesky, bootstrap, casablanca, cupertino, cruze, dark-hive,
126 # delta, dot-luv, ggplant, excite-bike, flick, glass-x, home, hot-sneaks, humanity, le-frog, midnight, mint-choc, overcast, pepper-grinder,
127 # redmond, rocket, sam, smoothness, south-street, start, sunny, swanky-purse, trontastic, ui-darkness, ui-lightness, vader, modena
128 # This configuration has no effect if theme is specified in the xhtml template.
129 # https://developer.axonivy.com/doc/dev/designer-guide/user-interface/user-dialogs.html#html-dialog-themes
130 primefaces.theme: modena-ivy
131
132
133
134# == Variables ==
135#
136# Variables are defined in ivy projects.
137# All of those can be overridden.
138#
139#Variables:
140# myVariable: value
141
142
143
144# == Databases ==
145#
146# Databases are defined in ivy projects with a name.
147# Connection details from those databases can be overridden by addressing the database with its name.
148#
149#Databases:
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.cj.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 by addressing the client with its name.
168#
169#RestClients:
170# # This is an example configuration for the rest client with the name myRestClient.
171# myRestClient:
172# Url: "http://localhost:8080"
173# # If defined, all features from the project will be completely replaced.
174# Features:
175# - ch.ivyteam.ivy.rest.client.mapper.JsonFeature
176# - ch.ivyteam.ivy.rest.client.authentication.HttpBasicAuthenticationFeature
177# # Properties are merged with higher priority with those from the project.
178# Properties:
179# username: admin
180# password: "${encrypt:1234}"
181# name: value
182
183
184
185# == WebServiceClients ==
186#
187# Web Service Clients are defined in ivy projects with a name.
188# Any configuration from those clients can be overriden by addressing the client with its name.
189#
190#WebServiceClients:
191# # This is an example configuration for the soap web service client with the name myWebService.
192# myWebService:
193# # If definied, endpoint urls will be completely replaced per port type with those from the project.
194# Endpoints:
195# # name of the port type, which is defined in the project.
196# myPortType:
197# - "http://localhost:8088"
198# - "http://webservice/api/soap"
199# # If defined, all features from the project will be completely replaced.
200# Features:
201# - ch.ivyteam.ivy.webservice.exec.cxf.feature.HttpBasicAuthenticationFeature
202# - ch.ivyteam.ivy.webservice.exec.cxf.feature.ProxyFeature
203# # Properties are merged with higher priority with those from the project.
204# Properties:
205# username: admin
206# password: "${encrypt:1234}"
207# name: value
208
209
210
211# == OverrideProject ==
212#
213# Defines a project containing overriding SubProcesses, HtmlDialogs or CMS entries for a dependent project.
214# This allows you to customize generic solutions with minimal effort.
215# The overriding project must be declared in the format <group-id>:<project-id> (e.g. ch.ivyteam.ivy:overrideProject).
216# These identifiers can be copied from the ivy project deployment definition (pom.xml).
217#
218# https://developer.axonivy.com/doc/dev/designer-guide/how-to/overrides.html
219#
220OverrideProject: ""