Configuring Customization settings - Platform - BlueCat Gateway - 24.1

Gateway Administration Guide
Locale
English
Product name
BlueCat Gateway
Version
24.1

Settings in the Customization section of General configuration let you customize several miscellaneous Gateway features. Here you can:

  • Specify the language used by BlueCat Gateway

  • Add or remove HTML templates used by legacy UI workflows

  • Enable or disable server status tracking for the /serverstatus health endpoint

  • Automatically log in to Gateway using a python script

Tip: You can also specify general settings for the Gateway UI in the Interface section of General configuration.

Changing the language used by Gateway

To set the language for workflows:

  1. Open the General configuration window, then expand the Customization section. (Click the Navigator button if necessary, then click Configurations > General configuration. Click Customization at the bottom to expand the Customization settings.)

  2. In the Language field, specify a language. By default, this is en (English).

    Note: You can enter any string for the language name — Gateway does not restrict the identifier you can enter. However, we recommend that you use a standardized identifier, such as ISO language and country codes.

    BlueCat Gateway supports UNICODE characters. This means you can create workflows and HTML templates with characters for virtually any language. Custom language support is only available with the legacy Gateway UI.

  3. Click Save at the bottom of the page. (Or click Cancel to cancel the change.)

Enabling server status tracking

To enable or disable server status tracking:

  1. Open the General configuration window, then expand the Customization section. (Click the Navigator button if necessary, then click Configurations > General configuration. Click Customization at the bottom to expand the Customization settings.)

  2. Select the Enable server status checkbox.

    Doing so enables the /serverstatus endpoint. This endpoint returns basic BlueCat Gateway application statistics for monitoring or load balancing. For more details, see Gateway status HTTP API.

    To disable server status tracking, instead clear the Enable server status checkbox.

  3. Click Save at the bottom of the page. (Or click Cancel to cancel the change.)

Login banner text

To customize the login banner that users see when logging in to BlueCat Gateway:

  1. Open the General configuration window, then expand the Customization section. (Click the Navigator button if necessary, then click Configurations > General configuration. Click Customization at the bottom to expand the Customization settings.)

  2. In the Login Banner field, enter text that you want displayed as a banner in the BlueCat GatewayLogin page.

    The login banner text is useful for important administrative announcements, such as notification of maintenance periods or reminders of important usage policies.

    You can format text in the Login Banner field with HTML markup. For example: 
    <h1>ATTENTION</h1>
<body>Maintenance window tonight at 2AM.</body>


    Tip: To change the logo displayed on the login screen, see Configuring Interface settings.

  3. When you're done, click Save at the bottom of the page. (Or click Cancel to exit without saving any changes.)

HTML templates for the legacy UI

Note: These templates affect only custom workflows and adaptive applications that use the legacy user interface. They do not affect the UI for standard Gateway features.

To add or remove HTML templates for the legacy UI used by workflows:

  1. Open the General configuration window, then expand the Customization section. (Click the Navigator button if necessary, then click Configurations > General configuration. Click Customization at the bottom to expand the Customization settings.)

  2. To add an HTML template:

    • Either drag the HTML file onto the Custom HTML template box area, or click in the box area to browse to a file.

      You can add multiple Gateway templates.

    To remove an HTML Template:

    • Click the X at the end of the template's entry in the list of imported templates.

  3. When you're done, click Save at the bottom of the page. (Or click Cancel to exit without saving any changes.)

Enabling Autologin and uploading an Autologin module

The Autologin feature lets you configure Gateway

To set up an autologin script that automatically logs in to Gateway:

  1. Open the General configuration window, then expand the Customization section. (Click the Navigator button if necessary, then click Configurations > General configuration. Click Customization at the bottom to expand the Customization settings.)

  2. Click to enable the Enable autologin checkbox.

  3. Either drag an autologin python script (*.py file) into the Autologin module path box area, or click in the box area to browse to a file.

    The autologin module must implement functions named get_autologin_user and get_autologin_password that return the username and password (respectively) for the user account to be logged in. For more details, see Setting up Gateway Autologin module scripts.

  4. When you're done, click Save at the bottom of the page. (Or click Cancel to exit without saving any changes.)