Templating style
17.4.11.1. Selecting the templating style

With IAM 6.3, a new templating style has been introduced. You select the style version by adjusting the 8.1. application parameters "iam.loginapp.layout.version" and "iam.loginapp.layout.dirs".

Valid options are "1.0" for the old (Airlock IAM 6.2 and older) style or "2.0" for the new templating style.

instances/auth/instance.properties

## By default, 2.0 is used:
#iam.loginapp.layout.version = 2.0
#iam.loginapp.layout.dirs = instances/${instance.name}/loginapp-layout/,instances/common/loginapp-layout/2.0/

## To change to "1.0" in order to use previously created layouts:
iam.loginapp.layout.version = 1.0
iam.loginapp.layout.dirs = instances/${instance.name}/loginapp-layout/,instances/common/loginapp-layout/1.0/

New UI templates can only be initialized in the "2.0" style. The "1.0" option is only available for backwards compatibility with previously created layouts.

For old installations previous to 6.3, the files are in instances/common/loginapp-layout/.

Customizations in the common directory are applied to all instances where the "iam.loginapp.layout.dirs" parameter includes them. Since the default value of "iam.loginapp.layout.dirs" is "instances/${instance.name}/loginapp-layout/,instances/common/loginapp-layout/2.0/", the common layout files are applied by default.

Directories are specified in descending priority. That is directories listed first have precedence over those listed afterwards.

If any of the directories do not exist at application startup, they are ignored (even if later created at runtime).

The UI layout template files to be adapted are generated into either the common or a specific instance's loginapp-layout directory.

For example:

# Display all available options:
iam init-ui -h
# Initialize layout template 2.0 for instance "auth"
iam init-ui -c /home/airlock/iam -i auth
# Initialize special "common" template files
iam init-ui -c /home/airlock/iam -i common

When using layout templates "2.0", changes must be "built" to become active:

copy
iam build-ui -c /home/airlock/iam -i auth

The documentation below assumes the new templating style. The older set of JSPs is still supported, but the handling does differ in some details. Please refer to documentation of Airlock IAM 6.2.