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/10.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 '<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/10.0/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/10.0/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/10.0/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# This setting is only evaluated at deployment time when the application not already exists!
45# You can not change the security system of an application later on.
46#
47SecuritySystem: default
48
49
50
51# == Environment ==
52#
53# Active Environment of this application. Only one environment can be active at the time.
54#
55# The configuration of Variables, Web Service Clients, Rest Clients and Databases
56# can be defined environment specific.
57#
58# The environment can be overriden on session-, case- and task level with Java API.
59#
60ActiveEnvironment: Default
61
62
63
64
65
66# == Data Settings ==
67#
68Data:
69 # Application folder where application files are stored. It overrides the root file folder setting.
70 # A change in this setting will NOT automatically move existing application files to the new location.
71 # A change will require to manually move existing files to the new directory.
72 # Absolute and relative (to the engine root directory) paths are supported.
73 # If not set the files will be stored in an application specific directory underneath the root file folder.
74 # [restart required] for existing apps
75 FilesDirectory: ""
76
77
78
79# == Standard Processes ==
80#
81# Standard processes are a set of predefined processes, which you can customize in your ivy project.
82# To enable these custom processes, the library id of the ivy project must be specified here.
83# The library id is <group-id>:<project-id> from the ivy project deployment definition.
84# e.g the library id of the portal template is "ch.ivyteam.ivy.project.portal:portalTemplate"
85# The default is 'auto' which means auto detection of standard process in your application
86#
87StandardProcess:
88 # https://developer.axonivy.com/doc/10.0/designer-guide/user-interface/default-pages
89 DefaultPages: auto
90
91
92
93# == JSF ==
94#
95#
96Jsf:
97 # JSF Primeface Theme that is used by HTML Dialogs.
98 # Standard themes:
99 # vela, saga, arya
100 # Freya themes:
101 # freya-ivy-light, freya-ivy-dark
102 # Deprecated themes:
103 # serenity-ivy, serenity-amber, serenity-blue, serenity-bluegrey, serenity-brown, serenity-cyan, serenity-deeporange, serenity-deeppurple,
104 # serenity-green, serenity-grey, serenity-indigo, serenity-lightblue, serenity-lightgreen, serenity-lime, serenity-orange,
105 # serenity-pink, serenity-purple, serenity-teal, serenity-yellow
106 # luna-amber, luna-blue, luna-green, luna-pink, nova-colored, nova-dark, nova-light
107 # This configuration has no effect if theme is specified in the xhtml template.
108 # https://developer.axonivy.com/doc/10.0/designer-guide/user-interface/user-dialogs/html-dialog-themes.html
109 primefaces.theme: freya-ivy-light
110
111
112
113# == Variables ==
114#
115# Variables are defined in ivy projects.
116# All of those can be overridden.
117#
118#Variables:
119# myVariable: value
120
121
122
123# == Databases ==
124#
125# Databases are defined in ivy projects with a name.
126# Connection details from those databases can be overridden by addressing the database with its name.
127#
128#Databases:
129# This is an example configuration for the database with the name myDb.
130# myDb:
131# Url: "jdbc:mysql://localhost:3306/myDbName"
132# Driver: com.mysql.cj.jdbc.Driver
133# UserName: admin
134# Password: "${encrypt:1234}"
135# MaxConnections: 5
136#
137# # Properties are merged with higher priority with those from the project.
138# Properties:
139# name: value
140
141
142
143# == RestClients ==
144#
145# Rest Clients are defined in ivy projects with a name.
146# Any configuration from those clients can be overriden by addressing the client with its name.
147#
148#RestClients:
149# # This is an example configuration for the rest client with the name myRestClient.
150# myRestClient:
151# Url: "http://localhost:8080"
152# # If defined, all features from the project will be completely replaced.
153# Features:
154# - ch.ivyteam.ivy.rest.client.mapper.JsonFeature
155# - ch.ivyteam.ivy.rest.client.authentication.HttpBasicAuthenticationFeature
156# # Properties are merged with higher priority with those from the project.
157# Properties:
158# username: admin
159# password: "${encrypt:1234}"
160# name: value
161
162
163
164# == WebServiceClients ==
165#
166# Web Service 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#WebServiceClients:
170# # This is an example configuration for the soap web service client with the name myWebService.
171# myWebService:
172# # If definied, endpoint urls will be completely replaced per port type with those from the project.
173# Endpoints:
174# # name of the port type, which is defined in the project.
175# myPortType:
176# - "http://localhost:8088"
177# - "http://webservice/api/soap"
178# # If defined, all features from the project will be completely replaced.
179# Features:
180# - ch.ivyteam.ivy.webservice.exec.cxf.feature.HttpBasicAuthenticationFeature
181# - ch.ivyteam.ivy.webservice.exec.cxf.feature.ProxyFeature
182# # Properties are merged with higher priority with those from the project.
183# Properties:
184# username: admin
185# password: "${encrypt:1234}"
186# name: value
187
188
189
190# == OverrideProject ==
191#
192# Defines a project containing overriding SubProcesses, HtmlDialogs or CMS entries for a dependent project.
193# This allows you to customize generic solutions with minimal effort.
194# The overriding project must be declared in the format <group-id>:<project-id> (e.g. ch.ivyteam.ivy:overrideProject).
195# These identifiers can be copied from the ivy project deployment definition (pom.xml).
196#
197# https://developer.axonivy.com/doc/10.0/designer-guide/how-to/overrides.html
198#
199OverrideProject: ""