Skip to main content
  • Bravura Security Fabric Documentation
  • Customization
  • Generating and installing skins

Generating and installing skins

Whenever you make a change to any of the Bravura Security Fabric design files, you must generate and install a new set of skins. You do this using the make.bat batch file in the <instance>\design\ directory.

Using make.bat

To generate and install new or modified skin files, use the following format for the commands to run from the <instance>\design\ directory, where en-us is American English:

  1. Compile the skins:

    make.bat default en-us

    Changes are saved in the instance's <instance>\design\skins\ directory

  2. Install the skins:

    make.bat install default en-us

    The compiled files are copied to the instance's skins\ directory

  3. If necessary, reload and review any changes to Bravura Security Fabric web pages.

    Warning

    Do not run the second command to install the skins if they fail to compile, especially if the first m4 file (links.m4) fails to compile.

Skins can fail to compile if something in the environment is locking the skin files. That can be a malware program, an automated backup tool running at the time, but more likely the product UI itself is being used at the time of the skin compilation.

Best practice

Have a test instance where you can compile the skins when the instance is not being used. Make a backup copy of the files on the production instance in case you need to quickly roll them back. Review changes on the test instance, then copy the skin files to the production instance.

Additional languages

If you have installed additional languages, you must run make.bat for each language. The procedure is the same as for American English, except that you replace en-us with the appropriate language code:

make.bat default <lang>-<locale>
make.bat install default <lang>-<locale>

For example, to generate and install new skin files for the default skin and for the Spanish language, run:

  1. Generate and install files for the Spanish language:

    make.bat default es-es
make.bat install default es-es

  2. Generate and install files for the default, English language:

    make.bat default en-us
make.bat install default en-us

    Note

    You must run the two default skin commands (as in step 2 above) in addition to any previous commands any time any language kvg file is touched.

Language support is covered in more detail in Supporting multiple languages and locales .

The skin name and the language code match the directory names where the skin and language are installed. For example, the \<instance>\skin\default\en-us\ directory contains American English and is for the default skin.

See About the UI files for more information about the files and their locations.

Example skins

Example skins are provided in the <instance>\design\examples\ directory. Follow the instructions noted in the files for the example skin.

Shipped examples include:

  • customLogo – sample UI to add a custom logo. See Customize the logo using the sample skin.

  • ska – default UI that is specifically for use with the Login Assistant SKA

  • unbranded – sample UI to remove branding

In this section: