app.yaml

[engineDir]/configuration/reference/app.yaml

# yaml-language-server: $schema=https://json-schema.axonivy.com/app/13.2.1/app.json
#
# -------------------------------------------
# Axon Ivy Application Configuration
# -------------------------------------------
# 
# This file shows configurations of an Axon Ivy Engine application.
# https://developer.axonivy.com/doc/13.2/engine-guide/configuration/files/app-yaml.html
#
# By default applications are pre-configured to run without any dependencies.
# However in productive environments applications often interact with many 
# external system such a Mail Servers (SMTP) or Directory services (LDAP). 
# 
# Each application has its own '<APPNAME>/app.yaml' in the configuration directory.
# e.g. the corresponding file for the application 'MyApp' is 
# '[engineDir]/configuration/applications/MyApp/app.yaml'.
#
# Furthermore 'app.yaml' can be deployed as part of application zip in a 'config' folder.
# The deployed 'app.yaml' is installed in the application directory and has a lower
# priority than the '<APPNAME>/app.yaml' in the configuration directory.
# https://developer.axonivy.com/doc/13.2/engine-guide/deployment
#
# SECRETS / PASSWORDS:
# Any configuration value can be encrypted just by enclosing it with "${encrypt:}".
# * to encrypt the string myPassword write "${encrypt:myPassword}"
#   https://developer.axonivy.com/doc/13.2/engine-guide/configuration/advanced-configuration.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.
#    https://developer.axonivy.com/doc/13.2/engine-guide/configuration/advanced-configuration.html#overriding-configuration
#

# The security system manages users and roles and must be referred by name.
# This setting is only evaluated at deployment time when the application not already exists!
# You can not change the security system of an application later on.
SecuritySystem: default
# Defines a project containing overriding SubProcesses, HtmlDialogs or CMS entries for a dependent project.
# This allows you to customize generic solutions with minimal effort.
# The overriding project must be declared in the format <group-id>:<project-id> (e.g. ch.ivyteam.ivy:overrideProject).
# These identifiers can be copied from the ivy project deployment definition (pom.xml).
# https://developer.axonivy.com/doc/13.2/designer-guide/how-to/overrides.html
OverrideProject: ""
Data:
  # DEPRECATED: All runtime data will be stored by default in Data.Directory specified in ivy.yaml. Use Data.Directory
  # to change the location of stored files.
  # 
  # 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, so you need to move files manually.
  # Absolute and relative (to the engine root directory) paths are supported.
  # If not set the files will be stored under the path Data.Directory configured in ivy.yaml.
  # [restart required] for existing apps
  FilesDirectory: ""

StandardProcess:
  # 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 definition.
  # e.g the library id of the portal template is "ch.ivyteam.ivy.project.portal:portalTemplate"
  # The default is 'auto' which means auto detection of standard process in your application
  # https://developer.axonivy.com/doc/13.2/designer-guide/user-interface/default-pages
  DefaultPages: auto

Jsf:
  # JSF Primefaces Theme that is used by HTML Dialogs
  # Standard themes:
  # vela, saga, arya
  # Freya themes:
  # freya-ivy-light, freya-ivy-dark
  # Deprecated themes:
  # luna-amber, luna-blue, luna-green, luna-pink, nova-colored, nova-dark, nova-light
  # This configuration has no effect if theme is specified in the xhtml template.
  # https://developer.axonivy.com/doc/13.2/designer-guide/user-interface/user-dialogs/html-dialog-themes.html
  primefaces.theme: freya-ivy-light

# Databases are defined in ivy projects with a name.
# Connection details from those databases can be overridden by addressing the database by name.
Databases:
#  # example Database
#  exampleDatabase:
#    # JDBC Url to use for connections.
#    # [examples: jdbc:{vendor}://{host}:{port}/{dbName}, jdbc:postgresql://pghost/prod, jdbc:mysql://mysqlhost/erpTstaging, jdbc:sqlserver://microsoft-host;databaseName=stammdaten]
#    Url: ""
#    # JDBC driver Name.
#    # [examples: com.mysql.cj.jdbc.Driver, org.postgresql.Driver, com.microsoft.sqlserver.jdbc.SQLServerDriver, oracle.jdbc.OracleDriver, org.mariadb.jdbc.Driver, org.hsqldb.jdbc.JDBCDriver]
#    Driver: ""
#    # Reference to a custom image.
#    # [examples: res:/webContent/myIcon.png]
#    Icon: ""
#    UserName: ""
#    # Secret password, should be stored encrypted. Encrypted values have a ${decrypt:} prefix
#    # [password]
#    Password: ""
#    MaxConnections:
#    # Driver specific custom properties
#    Properties:
#  

# Rest Clients are defined in ivy projects with a name.
# Any configuration from those clients can be overridden by addressing the client by name.
RestClients:
#  # example ConfigurableRestClient
#  exampleConfigurableRestClient:
#    Url: ""
#    # Full qualified class names, that contribute REST-client features, such as authentication.
#    # [examples: ch.ivyteam.ivy.rest.client.mapper.JsonFeature, ch.ivyteam.ivy.rest.client.authentication.HttpBasicAuthenticationFeature]
#    Features:
#    # Properties that supply dynamic values for REST-client features.
#    Properties:
#      jersey.config.client.followRedirects: ""
#      # Read timeout interval, in milliseconds.
#      jersey.config.client.readTimeout:
#      # Connect timeout interval, in milliseconds.
#      jersey.config.client.connectTimeout:
#      jersey.config.client.chunkedEncodingSize: ""
#      jersey.config.client.async.threadPoolSize: ""
#      jersey.config.client.backgroundScheduler.threadPoolSize: ""
#      jersey.config.client.useEncoding: ""
#      jersey.config.client.ignoreExceptionResponse: ""
#      jersey.config.client.disableAutoDiscovery: ""
#      jersey.config.client.contentLength.buffer: ""
#      jersey.config.client.disableJsonBinding: ""
#      jersey.config.client.disableJsonProcessing: ""
#      jersey.config.client.disableMetainfServicesLookup: ""
#      jersey.config.client.disableMoxyJson: ""
#      jersey.config.client.suppressHttpComplianceValidation: ""
#      jersey.config.client.digestAuthUriCacheSizeLimit: ""
#      jersey.config.client.proxy.uri: ""
#      jersey.config.client.proxy.username: ""
#      jersey.config.client.proxy.password: ""
#      jersey.config.client.request.entity.processing: ""
#      jersey.config.client.request.expect.100.continue.processing: ""
#      jersey.config.client.request.expect.100.continue.threshold.size: ""
#      jersey.config.client.uri.query.param.style: ""
#      # The fully-qualified class name for the connector provider to use. Ivy uses the ApacheConnectorProvider.
#      # Implementations of `org.glassfish.jersey.client.spi.ConnectorProvider` are valid.
#      # Only has an effect when set in the REST Client Editor, cannot be changed during execution.
#      # [examples: org.glassfish.jersey.client.HttpUrlConnectorProvider]
#      jersey.config.client.connector.provider: org.glassfish.jersey.apache.connector.ApacheConnectorProvider
#      jersey.config.client.sniHostName: ""
#      jersey.config.client.ssl.context.supplier: ""
#      # Maximum number of connections to pool.
#      # Only has an effect if no or the Apache connector provider is set.
#      # Only has an effect when set in the REST Client Editor, cannot be changed during execution.
#      jersey.client.pool.maxConnections:
#      # Bytes to record of the outgoing and incoming entity
#      jersey.config.client.logging.entity.maxSize:
#      JSON.Deserialization.USE_BIG_DECIMAL_FOR_FLOATS: false
#      JSON.Deserialization.USE_BIG_INTEGER_FOR_INTS: false
#      JSON.Deserialization.USE_LONG_FOR_INTS: false
#      JSON.Deserialization.USE_JAVA_ARRAY_FOR_JSON_ARRAY: false
#      # Feature that determines whether encountering of unknown properties
#      # (those that do not map to a property, and there is not "any setter" or handler that can handle it)
#      # should result in a failure or not.
#      JSON.Deserialization.FAIL_ON_UNKNOWN_PROPERTIES: false
#      JSON.Deserialization.FAIL_ON_NULL_FOR_PRIMITIVES: false
#      JSON.Deserialization.FAIL_ON_NUMBERS_FOR_ENUMS: false
#      JSON.Deserialization.FAIL_ON_INVALID_SUBTYPE: false
#      JSON.Deserialization.FAIL_ON_READING_DUP_TREE_KEY: false
#      JSON.Deserialization.FAIL_ON_IGNORED_PROPERTIES: false
#      JSON.Deserialization.FAIL_ON_UNRESOLVED_OBJECT_IDS: false
#      JSON.Deserialization.FAIL_ON_MISSING_CREATOR_PROPERTIES: false
#      JSON.Deserialization.FAIL_ON_NULL_CREATOR_PROPERTIES: false
#      JSON.Deserialization.FAIL_ON_MISSING_EXTERNAL_TYPE_ID_PROPERTY: false
#      JSON.Deserialization.FAIL_ON_TRAILING_TOKENS: false
#      JSON.Deserialization.FAIL_ON_SUBTYPE_CLASS_NOT_REGISTERED: false
#      JSON.Deserialization.WRAP_EXCEPTIONS: false
#      JSON.Deserialization.FAIL_ON_UNEXPECTED_VIEW_PROPERTIES: false
#      JSON.Deserialization.FAIL_ON_UNKNOWN_INJECT_VALUE: false
#      JSON.Deserialization.ACCEPT_SINGLE_VALUE_AS_ARRAY: false
#      JSON.Deserialization.UNWRAP_SINGLE_VALUE_ARRAYS: false
#      JSON.Deserialization.UNWRAP_ROOT_VALUE: false
#      JSON.Deserialization.ACCEPT_EMPTY_STRING_AS_NULL_OBJECT: false
#      JSON.Deserialization.ACCEPT_EMPTY_ARRAY_AS_NULL_OBJECT: false
#      JSON.Deserialization.ACCEPT_FLOAT_AS_INT: false
#      JSON.Deserialization.READ_ENUMS_USING_TO_STRING: false
#      JSON.Deserialization.READ_UNKNOWN_ENUM_VALUES_AS_NULL: false
#      JSON.Deserialization.READ_UNKNOWN_ENUM_VALUES_USING_DEFAULT_VALUE: false
#      JSON.Deserialization.READ_DATE_TIMESTAMPS_AS_NANOSECONDS: false
#      JSON.Deserialization.ADJUST_DATES_TO_CONTEXT_TIME_ZONE: false
#      JSON.Deserialization.EAGER_DESERIALIZER_FETCH: false
#      JSON.Serialization.WRAP_ROOT_VALUE: false
#      JSON.Serialization.INDENT_OUTPUT: false
#      JSON.Serialization.FAIL_ON_EMPTY_BEANS: false
#      JSON.Serialization.FAIL_ON_SELF_REFERENCES: false
#      JSON.Serialization.WRAP_EXCEPTIONS: false
#      JSON.Serialization.FAIL_ON_UNWRAPPED_TYPE_IDENTIFIERS: false
#      JSON.Serialization.WRITE_SELF_REFERENCES_AS_NULL: false
#      JSON.Serialization.CLOSE_CLOSEABLE: false
#      JSON.Serialization.FLUSH_AFTER_WRITE_VALUE: false
#      JSON.Serialization.WRITE_DATES_AS_TIMESTAMPS: false
#      JSON.Serialization.WRITE_DATE_KEYS_AS_TIMESTAMPS: false
#      JSON.Serialization.WRITE_DATES_WITH_ZONE_ID: false
#      JSON.Serialization.WRITE_DATES_WITH_CONTEXT_TIME_ZONE: false
#      JSON.Serialization.WRITE_DURATIONS_AS_TIMESTAMPS: false
#      JSON.Serialization.WRITE_CHAR_ARRAYS_AS_JSON_ARRAYS: false
#      JSON.Serialization.WRITE_ENUMS_USING_TO_STRING: false
#      JSON.Serialization.WRITE_ENUMS_USING_INDEX: false
#      JSON.Serialization.WRITE_ENUM_KEYS_USING_INDEX: false
#      JSON.Serialization.WRITE_NULL_MAP_VALUES: false
#      JSON.Serialization.WRITE_EMPTY_JSON_ARRAYS: false
#      JSON.Serialization.WRITE_SINGLE_ELEM_ARRAYS_UNWRAPPED: false
#      JSON.Serialization.WRITE_BIGDECIMAL_AS_PLAIN: false
#      JSON.Serialization.WRITE_DATE_TIMESTAMPS_AS_NANOSECONDS: false
#      JSON.Serialization.ORDER_MAP_ENTRIES_BY_KEYS: false
#      JSON.Serialization.FAIL_ON_ORDER_MAP_BY_INCOMPARABLE_KEY: false
#      JSON.Serialization.EAGER_SERIALIZER_FETCH: false
#      JSON.Serialization.USE_EQUALITY_FOR_OBJECT_ID: false
#      JSON.Mapper.USE_ANNOTATIONS: false
#      JSON.Mapper.USE_GETTERS_AS_SETTERS: false
#      JSON.Mapper.PROPAGATE_TRANSIENT_MARKER: false
#      JSON.Mapper.AUTO_DETECT_CREATORS: false
#      JSON.Mapper.AUTO_DETECT_FIELDS: false
#      JSON.Mapper.AUTO_DETECT_GETTERS: false
#      JSON.Mapper.AUTO_DETECT_IS_GETTERS: false
#      JSON.Mapper.AUTO_DETECT_SETTERS: false
#      JSON.Mapper.REQUIRE_SETTERS_FOR_GETTERS: false
#      JSON.Mapper.ALLOW_FINAL_FIELDS_AS_MUTATORS: false
#      JSON.Mapper.INFER_PROPERTY_MUTATORS: false
#      JSON.Mapper.INFER_CREATOR_FROM_CONSTRUCTOR_PROPERTIES: false
#      JSON.Mapper.ALLOW_IS_GETTERS_FOR_NON_BOOLEAN: false
#      JSON.Mapper.ALLOW_VOID_VALUED_PROPERTIES: false
#      JSON.Mapper.CAN_OVERRIDE_ACCESS_MODIFIERS: false
#      JSON.Mapper.OVERRIDE_PUBLIC_ACCESS_MODIFIERS: false
#      JSON.Mapper.INVERSE_READ_WRITE_ACCESS: false
#      JSON.Mapper.USE_STATIC_TYPING: false
#      JSON.Mapper.USE_BASE_TYPE_AS_DEFAULT_IMPL: false
#      JSON.Mapper.INFER_BUILDER_TYPE_BINDINGS: false
#      JSON.Mapper.REQUIRE_TYPE_ID_FOR_SUBTYPES: false
#      JSON.Mapper.DEFAULT_VIEW_INCLUSION: false
#      JSON.Mapper.SORT_PROPERTIES_ALPHABETICALLY: false
#      JSON.Mapper.SORT_CREATOR_PROPERTIES_FIRST: false
#      JSON.Mapper.SORT_CREATOR_PROPERTIES_BY_DECLARATION_ORDER: false
#      JSON.Mapper.ACCEPT_CASE_INSENSITIVE_PROPERTIES: false
#      JSON.Mapper.ACCEPT_CASE_INSENSITIVE_ENUMS: false
#      JSON.Mapper.ACCEPT_CASE_INSENSITIVE_VALUES: false
#      JSON.Mapper.USE_WRAPPER_NAME_AS_PROPERTY_NAME: false
#      JSON.Mapper.USE_STD_BEAN_NAMING: false
#      JSON.Mapper.ALLOW_EXPLICIT_PROPERTY_RENAMING: false
#      JSON.Mapper.FIX_FIELD_NAME_UPPER_CASE_PREFIX: false
#      JSON.Mapper.ALLOW_COERCION_OF_SCALARS: false
#      JSON.Mapper.IGNORE_DUPLICATE_MODULE_REGISTRATIONS: false
#      JSON.Mapper.IGNORE_MERGE_FOR_UNMERGEABLE: false
#      JSON.Mapper.BLOCK_UNSAFE_POLYMORPHIC_BASE_TYPES: false
#      JSON.Mapper.APPLY_DEFAULT_VALUES: false
#      JSON.Mapper.REQUIRE_HANDLERS_FOR_JAVA8_OPTIONALS: false
#      JSON.Mapper.REQUIRE_HANDLERS_FOR_JAVA8_TIMES: false
#      # Defines which properties of a java object should be included in the resulting JSON
#      # [examples: ALWAYS, NON_NULL, NON_ABSENT, NON_EMPTY, NON_DEFAULT, CUSTOM, USE_DEFAULTS]
#      JSON.Serialization.PROPERTY_INCLUSION: ""
#      # Enable serialization of JSR310/JavaTime objects.
#      JSON.Module.JavaTime: false
#      # The username used for authentication by Basic, Digest or NTLM authentication.
#      username: ""
#      # The password used for authentication by Basic, Digest or NTLM authentication.
#      password: ""
#      # The Workstation that is used for making the NTLM Request (optional). Used by the NtlmAuthenticationFeature.
#      NTLM.workstation: ""
#      # The Active Directory Domain to authenticate against (optional). Used by the NtlmAuthenticationFeature.
#      NTLM.domain: ""
#      # The keystore key alias to use if the SSL connection to the REST service is configured to use client authentication.
#      # This configuration can only be set in the REST Client configuration and cannot be configured in the REST Client call step.
#      # By default no keystore key alias is definied.
#      SSL.keyAlias: ""
#      # Wether the client is exchanging sensitive data (e.g. access tokens) or not.
#      # If set to 'true', the content won't be logged in tracing.
#      SensitiveData: false
#  

# Web Service Clients are defined in ivy projects with a name.
# Any configuration from those clients can be overridden by addressing the client with its name.
WebServiceClients:
#  # example ConfigurableWsClient
#  exampleConfigurableWsClient:
#    # Full qualified class names, that contribute WS-client call features, such as authentication.
#    Features:
#    # Properties that supply dynamic values for WS-client features.
#    Properties:
#    # Endpoint names, to URIs
#    # [examples: myPort: - https://myCustomProdHost/hr/employee/soap]
#    Endpoints:
#  

# Currently active business calendar for this application.
BusinessCalendar: ""
# Business calendars are organized as trees, with one root / default calendar and an arbitrary number of child calendars.
# Child business calendars inherit the values of their parent. A parent can be the root calendar or any child calendar.
# 
# At least one root calendar needs to be defined. If non is configured, a root / default calendar will be created automatically
# with following default values:
# - Parent is empty
# - First day of week is: Monday
# - Working times are: 'morning: 8:00 - 12:00' and 'afternoon: 13:00 - 17:00'
# 
# You can reference a business calendars in a ivy projects by its name. E.g ivy.cal.get("myRootBusinessCalendar")
# https://developer.axonivy.com/doc/13.2/engine-guide/configuration/advanced-configuration.html#business-calendar
BusinessCalendars:
#  # example BusinessCalendar
#  exampleBusinessCalendar:
#    # First day of the week.
#    # If empty or not existing the parent calendar's value is inherited.
#    # If not defined by any parent the value is retrieved from the current locale settings
#    # [enum: monday, tuesday, wednesday, thursday, friday, saturday, sunday]
#    FirstDayOfWeek: ""
#    # Name-value pairs of non-working days.
#    # 
#    # Yearly days:
#    # Recurring non-working days during a year, falling on the same date, e.g. Jan. 1 or Christmas.
#    # Format: MM-dd, e.g. 01-01 (New Year), 12-25 (Christmas Day)
#    # 
#    # Relative Easter Days:
#    # Recurring non-working days relative to Easter Sunday, e.g. Good Friday or Pentecost.
#    # Format (case insensitive): easter +/- Number, e.g. 'easter - 2' (Good Friday), 'easter + 50' (Pentecost Monday)
#    # 
#    # Fixed Dates:
#    # Once-off non-working days, e.g. a company celebration day or a special local public holiday.
#    # Format: YYYY-MM-dd
#    # [examples: "New Year": 01-01, "Christmas Day": 12-25, "Good Friday": easter - 2, "Easter Monday": easter + 1, "Pentecost Monday": easter + 50, "50 Years Ivyteam": 2043-04-07]
#    FreeDays:
#      # End of days that are always off
#      # [enum: monday, tuesday, wednesday, thursday, friday, saturday, sunday]
#      # [examples: sunday]
#      WeekendEnd: ""
#      # Start of days that are always off
#      # [enum: monday, tuesday, wednesday, thursday, friday, saturday, sunday]
#      # [examples: saturday]
#      WeekendStart: ""
#    
#    # Name of the parent business calendar.
#    # If empty or not existing this business calendar will be the root calendar for this application.
#    # Only one root calendar is allowed.
#    Parent:
#    # Name-value pairs of working times during a business day.
#    # At least one working time needs to be defined here or in any of the parents for business calendar calculations to work.
#    # 
#    # Warning: Ensure that your working times in your calendar tree do not overlap.
#    # Otherwise the business calendar calculations may not work correctly!
#    # 
#    # Value format is : HH:mm-HH:mm
#    # [examples: myMorning: 8:00-12:00, myAfternoon: 13:00-17:00]
#    WorkingTimes:
#  

# Variables are defined in ivy projects.
# All of them can be overridden.
Variables: