Project Settings

Project settings

Project settings can be set in the root index.yml file.
The values for these settings can be individually set for any particular environment. (Environment-specific entry points)

List of available parameters

Parameter	Required	Default Value	Description
`analytics`	false		Analytics configuration
`analyticsMapper`	false		Analytics configuration
`analyticsParams`	false		Analytics configuration
`apiVersion`	false	'v1'	API version ('v0' or 'v1') used to specify usage of legacy API
`authorizationTimeout`	false	10	Authorization cookie expiration timeout (in minutes)
`backDisabledAlert`	false		Message to be displayed in case of disabled back action
`coreLocale`	false		List of translates for Core messages (more in localization)
`defaultLocale`	false		Default locale code (more in localization)
`description`	false		Meta description tag
`devTools`	false	true	Toggles developer tools (open with `ctrl + shift + D` hotkey)
`errorPage`	false		Error page configuration
`favicon`	false		Path to favicon
`flowExport`	false		Mocked flow export
`flowIdName`	false		Flow ID name in Backend instance
`flowIdRevision`	false		Flow ID revision in Backend instance
`flowName`	true		Flow name in Backend instance
`flowStartParameters`	false		List of parameter to be passed to `flowStart` action
`formats`	false		Global formats settings
`globals`	false		Extending expression context
`handoffTimeout`	false	20	Handoff credentials cookie expiration (in minutes)
`indexPageInit`	false	true	Specifies if application initialization should start from `flowStart` action
`loadingComponent`	false		Component to be didsplayed during application initialization
`mockData`	false		Mocked input data for development tools
`og`	false		List of meta `og` tags
`pages`	true		Page Configuration
`serverUrl`	true		URL of Backend instance server
`studioSettings`	false		Studio settings
`styles`	false		LESS files includes
`title`	true		Meta title of an application, shown in browser tab header
`translates`	false		List of translates for specific languages (more in localization)
`url`	false		Application URL settings
`flowReference`	false		When this ref is changed, new flow execution will be initialized

Application URL settings

url: {
  persistHash?: boolean // defines if hash should be persistent on page change, default value is TRUE (default hash is page URI)
  persistQuery?: boolean // defines if query should be persistent on page change, default value is FALSE
  persistPathname?: boolean // defines if pathname should be persistent on page change, default value is FALSE
}

Example configuration

Here's an example of various settings in index.yml:

title: "Zenoo Demo Project"
serverUrl: "https://zenoo.onboardapp.io/api"
flowName: "zenoo"
favicon: "/assets/favicon.ico"
indexPageInit: true
mockData: !include ./mockdata.json
styles:
  - !include ./styles/index.less
analytics:
  gtm: "GTM-ID001"
authorizationTimeout: 60
translates:
  en: !include ./translates/en.yml
  cz: !include ./translates/cz.yml
defaultLocale: "en"
studioSettings:
  name: ZenooBank
  logo: /assets/logo.png
  country: Mexico
  previewUrl: https://onboarding.zenoo.com/
pages:
  index: !include ./pages/index.yml
  otp: !include ./pages/otp.yml
  loan-overview: !include ./pages/loan-overview.yml
  thanks: !include ./pages/thanks.yml
  rejected: !include ./pages/rejected.yml