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