• 1. Table of content
• 2. gears.json
• 3. resources/application.yml
• 4. Override configuration just before runtime
  • 4.1. Overriding with environment variables
  • 4.2. Overriding with command line options

Part of the configuration is done in the gears.json which should be in the root of your project folder. This file contains the options you give to the GEARS development tools, e.g. the generator and the test scenario runner. Below is an example followed by some explanation:

{
  "groupId": "nl.some_client",
  "projectName": "some_tool",
  "projectVersion": "0.12.0-SNAPSHOT",
  "generatorVersion": "0.79",
  "files": {
    "specs": ["specs/*.sn"],
    "scenarios": ["scenarios/*.scenario", "scenarios/**/*.scenario"],
    "data": ["data/*.sql"]
  },
  "generatorOptions": {
    "tableNamePrefix": "GPT"
  },
  "runtimeVersion": "0.79",
  "frontendVersion": "0.50.0",
  "runnerVersion": "0.16",
  "plugins": [
    "com.xlrit.gears.runtime:gears-runtime-plugin-jasper",
    "com.xlrit.gears.runtime:gears-runtime-plugin-scim",
    "com.xlrit.gears.runtime:gears-runtime-plugin-mail"
  ]
}

In the below table all the options are explained:

This file configures the application that you are going to generate. It will be its default configuration. Below is an example application.yml followed by an explanation:

gears:
  init:
    create-demo-users: true
  frontend:
    name:               Some Tool
    theme:              some_client
    menu-overrides:     '{ "messages": false, "search": false, "admin": false, "reports": false }'
  document:
    output-dir:         C:\tmp
  #mail:
  #  enabled: true
  #  cron:    0/10 * * ? * * *
  testing:
    enabled:            true

spring:
  banner:
    location:           classpath:banner-sometool.txt
  datasource:
    url:                'jdbc:h2:mem:gears;DB_CLOSE_ON_EXIT=FALSE'
    # url:                'jdbc:postgresql://localhost:5432/databasename?user=postgres&password=secret'
  h2:
    console:
      enabled: true

graphql:
  servlet:
    async-timeout: 120000

In the below table the most relevant options are explained:

The default configuration can be found here: server/src/main/resources/application.yaml.

All configurations in application.yml can be overridden providing the options when starting the application. Either by setting environment variables or starting it with the command line.

You can override the default options by setting environment variables. As an example we use the option gears.document.output-dir. You could simply add an environment variable called GEARS_DOCUMENT_OUTPUT-DIR (replace the dots with underscores) and fill its value with what you like.

Don't forget: when using VS Code, all instances of VS code must be restarted before changes to environment variables will take effect.

You can override the default options by adding options when starting up the application from the command line. As an example we use the option gears.document.output-dir. You could simply start up the application like this:

`java -jar target\order_products-0.1-SNAPSHOT.jar --gears.document.output-dir=C:\Windows\Temp`

Configuration profiles are used to group together common configuration options. They are passed to the application upon start

mvn spring-boot:run -Dspring-boot.run.profiles=local,mail

To enable support for sending e-mails, you need two things:

• Add the mail-plugin (com.xlrit.gears.runtime:gears-runtime-plugin-mail) as shown in paragraph 2.
• Activate the "mail" configuration profile. This will set the property gears.mail.enabled to true.

The mail plugin supports two modes: "direct" and "batch". In "direct" mode, which is the default, mails are sent immediately when they are published. This is well suites for simple applications and demos. In "batch" mode the system regularly checks for the presence of published mails using an interval configured using the property gears.mail.cron, which is set to "0 10 * * * ?" by default, meaning every 10 minutes. This is better suited for larger applications.

All available configuration properties for the mail plugin are shown below: