app.yamlΒΆ

[engineDir]/configuration/reference/app.yaml

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
#
# -------------------------------------------
# Axon.ivy Application Configuration
# -------------------------------------------
# 
# This file shows configurations of an Axon.ivy engine application.
# @engine.guide.url@/configuration/files/app-yaml.html
#
# By default applications are pre-configured to run without any dependencies.
# However in productive enviroments applications often interact with many 
# external system such a Mail Servers (SMTP) or Directory services (LDAP). 
# 
# Each application has its own app-<APPNAME>.yaml in the configuration directory.
# e.g. the corresponding file for the application 'MyApp' is 
# '[engineDir]/configuration/app-MyApp.yaml'.
#
# Furthermore 'app.yaml' can be deployed as part of application zip.
# The deployed 'app.yaml' is installed in the application directory and has a lower
# priority than the 'app-<APPNAME>.yaml' in the configuration directory.
# @engine.guide.url@/administration/deployment.html
#
# SECRETS / PASSWORDS:
# Any configuration value can be encrypted just by enclosing it with "${encrypt:}".
# * to encrypt the string myPassword write "${encrypt:myPassword}"
#   @engine.guide.url@/configuration/index.html#passwords
#
# OVERRIDING:
# Any configuration value provided here can be set in alternative sources. 
# * environment variables: of the operating system can set app config entries. 
#    Their key must be prefixed with 'IVY_APPLICATIONS_MYAPP_'. 
#    E.g. use 'IVY_APPLICATIONS_MYAPP_SECURITYSYSTEM' to override the security system.
#    @engine.guide.url@/configuration/index.html#overriding-configuration
#



# == Security System ==
# 
# A security system manages users and roles and must be defined in ivy.yaml with a name.
# Here you can reference those security system by its name. If no security system is defined the 'ivy Security System' is in charge.
# @engine.guide.url@/configuration/index.html#users
# !! 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. 
# !! 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.
#
SecuritySystem: ""



# == Environment ==
#
# Active Environment of this application. Only one environment can be active at the time.
# 
# The configuration of Global Variables, Web Service Clients, Rest Clients and External Database Configurations
# can be defined environment specific.
# 
# The environment can be overriden on session-, case- and task level with Java API.
#
ActiveEnvironment: Default



# == EMail Notification Settings ==
# 
# These email notification settings will be applied to all users of an application.
# Users still have the option to customize their e-mail notification settings for themselves.
#
EMailNotification:
  # Whether users should receive a mail when a new task is assigned.
  OnNewTasks: false

  # On which days of the week the users should receive a daily task summary.
  # Possible values are: never, always, monday, tuesday, wednesday, thursday, friday, saturday, sunday
  # Any combination of weekdays is allowed.
  # In ivy.yaml you can configure when the email is sent EMail:DailyTaskSummary:TriggerTime
  DailySummaryOn: never

  # 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
  Language: en



# == Data Settings ==
#
Data:

  # Application folder where application files are stored. It overrides the root file folder setting.
  # A change in this setting will NOT automatically move existing application files to the new location.
  # A change will require to manually move existing files to the new directory.
  # Absolute and relative (to the engine root directory) paths are supported.
  # If not set the files will be stored in an application specific directory underneath the root file folder.
  # [Restart required] for existing apps
  FilesDirectory: ""



# == Standard Processes ==
# 
# Standard processes are a set of predefined processes, which you can customize in your ivy project.
# To enable these custom processes, the library id of the ivy project must be specified here.
# The library id is <group-id>:<project-id> from the ivy project deployment defintion.
# e.g the library id of the portal template is "ch.ivyteam.ivy.project.portal:portalTemplate"
#
StandardProcess: 
 
  # @engine.guide.url@/administration/standard-processes.html#default-pages
  DefaultPages: ""

  # @engine.guide.url@/administration/standard-processes.html#email-notifications
  MailNotification: "" 



# == JSF ==
# 
#
Jsf:

  # JSF Primeface Theme that is used by HTML Dialogs.
  # Available themes:
  #  ivy, modena-ivy, afterdark, afternoon, afterwork, aristo, black-tie blitzer, bluesky, bootstrap, casablanca, cupertino, cruze, dark-hive,
  #  delta, dot-luv, ggplant, excite-bike, flick, glass-x, home, hot-sneaks, humanity, le-frog, midnight, mint-choc, overcast, pepper-grinder,
  #  redmond, rocket, sam, smoothness, south-street, start, sunny, swanky-purse, trontastic, ui-darkness, ui-lightness, vader, modena
  primefaces.theme: modena-ivy



# == Global Variables ==
# 
# Global variables are defined in ivy projects.
# All of those can be overridden independently of the environment.
#
#GlobalVariables:
  #myGlobalVariable: value



# == Databases ==
# 
# Databases are defined in ivy projects with a name.
# Connection details from those databases can be overridden independently of the environment by addressing the database with its name.
#
#Databases:

  # This is an example configuration for the database with the name myDb.
  #myDb:
    #Url: "jdbc:mysql://localhost:3306/myDbName"
    #Driver: com.mysql.jdbc.Driver
    #UserName: admin
    #Password: "${encrypt:1234}"
    #MaxConnections: 5

    # Properties are merged with higher priority with those from the project.
    #Properties:
      #name: value



# == RestClients ==
#
# Rest Clients are defined in ivy projects with a name.
# Any configuration from those clients can be overriden independently of the environment by addressing the client with its name.
#
#RestClients:

  # This is an example configuration for the rest client with the name myRestClient.
  #myRestClient:
    #Url: "http://localhost:8080"

    # If defined, all features from the project will be completely replaced.
    #Features:
      #- ch.ivyteam.ivy.rest.client.mapper.JsonFeature
      #- ch.ivyteam.ivy.rest.client.authentication.HttpBasicAuthenticationFeature

    # Properties are merged with higher priority with those from the project.
    #Properties:
      #username: admin
      #password: "${encrypt:1234}"
      #name: value



# == WebServiceClients ==
#
# Web Service Clients are defined in ivy projects with a name.
# Any configuration from those clients can be overriden independently of the environment by addressing the client with its name.
#
#WebServiceClients:

  # This is an example configuration for the soap web service client with the name myWebService.
  #myWebService:
  
    # If definied, endpoint urls will be completely replaced per port type with those from the project.
    #Endpoints:

      # name of the port type, which is defined in the project.
      #myPortType:
        #- "http://localhost:8088"
        #- "http://webservice/api/soap"
    
    # If defined, all features from the project will be completely replaced.
    #Features:
      #- ch.ivyteam.ivy.webservice.exec.cxf.feature.HttpBasicAuthenticationFeature
      #- ch.ivyteam.ivy.webservice.exec.cxf.feature.ProxyFeature

    # Properties are merged with higher priority with those from the project.
    #Properties:
      #username: admin
      #password: "${encrypt:1234}"
      #name: value
      
      # Authentication property for the legacy axis stack
      # Possible values for axis 1: NONE, HTTP_BASIC
      # Possible values for axis 2: NONE, HTTP_BASIC, HTTP_DIGEST, NTLM
      #authType: NONE