Follow

Info: Customizing the labels and style of the Aperture Login Page

Applies to:

Venafi Trust Protection Platform 15.2+

Summary

The Aperture Console allows customers to customize the labels and messages that appear throughout the console as well as customizing any styling to allow the console to be branded for the customer's environment.  These files will persist across upgrades and patches so customizations will not have to be reapplied.

More Info

The scope of this article is how to customize the login page of the Aperture Console.  Labels can be changed by creating a custom terminology file (named terminology-custom-en-us.js).  Styles can be changed by creating a custom style sheet (named terminology-custom-en-us.css).  Samples of both of these files are available for download below.  To customize the login page, both of these files must be placed in:

C:\Program Files\Venafi\Web\Aperture\Client\Plugins\Authorize_Password

Note: the first time you add a new terminology file or stylesheet to Aperture, IIS must be restarted. 

Syntax of the custom terminology file

  • File must begin with { and end with }
  • Syntax of each change of terminology must be:
    "Terminology-Name":"Display Label"
    Example: 
    "Username":"Bank E-mail Address"
  • Each line must be separated by a comma
    Example:

    "VenafiTitle": "Bank of Antarctica Certificate Request Portal",
    "Username":"Bank E-mail Address"

  • File must conform to valid JSON syntax (ex: quotes must be escaped)

Syntax of the custom style sheet file

In order to have a custom style sheet, you must also have a custom terminology file.  Even if the custom terminology file is blank, it must be present in order for Aperture to load a custom stylesheet.

  • The syntax of the style sheet follows standard CSS3 syntax

    Example:
    #login form .login-header {background-color: #010858}

    The above example will change the background color of the header of the login form.

Making changes to other areas of Aperture

There are base terminology files and style sheets for the Aperture Console as well as terminology files and style sheets for different sections of the Aperture console, known as plugins. 

Location for custom style sheet for Aperture base:
C:\Program Files\Venafi\Web\Aperture\Client\Css

Location for custom terminology file for Aperture base:
C:\Program Files\Venafi\Web\Aperture\Client\Js

To make changes to the style or terminology of a specific plugin, for example, Custom Fields, both the style sheet and terminology file should be placed in:
C:\Program Files\Venafi\Web\Aperture\Client\Plugins\CustomFields

 

Make language specific terminology changes

Aperture has support for custom terminology files depending upon the language.  For example, if you would like to translate the terminology into other languages and have it load based on the browser language setting:

  1.  Follow the instructions above to make a correctly syntaxed custom terminology file.
    Spanish Example: 
    "Username":"Banco Dirección Electrónica"

  2. Name the file: terminology-custom-es.js

  3. Place file in C:\Program Files\Venafi\Web\Aperture\Client\Plugins\Authorize_Password

  4. Restart IIS

  5. Test the Aperture Login Page using a browser with the language set to Spanish (ES).

 

Upgrade testing

If your company decides to apply a customized skin to the Aperture Console, it is strongly recommended that you test your customizations in a non-production environment and re-test your customizations on each upgrade of the Venafi Trust Protection Platform.  It is possible for styling classes and terminology names to not be used in future versions as improvements are made to the Aperture Console.

 

Aperture Certificate Installation Type List

The download package has been updated with examples for modifying the name and description used in Aperture when creating new installations for automatic installation of certificates.  This section is new in TPP 17.1.




Custom Login Terminology and Style (17.1).zip

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk