Skip to main content

Show an information banner in Client Portal

You can configure FA Client Portal to show an information banner to users at the top of the screen after they log in. You can use the banner, for example, to advertise new products and services or to communicate about maintenance breaks or changes to service hours.

There are two methods to set up the information banner. To set up a banner for the standard FA Client Portal, see Setup for standard FA Client Portal. If you use a customized FA Client Portal of several instances of FA Client Portal, see Setup for the customized FA Client Portal or an additional standard instance.

Setup for standard FA Client Portal

If you use one instance of the standard FA Client Portal, you can set up the banner in FA Back by doing the following:

  1. In FA Back, go to Tools → Administer → FA Client Portal → Configurations.

  2. Open the Information banner tab and fill in the fields:

    Type

    Banner type (sets the banner color). The options are: "Info" (blue), "Success" (green), "Warning" (yellow), and "Error" (red).

    Title

    Banner title.

    Text

    Banner content.

    Dismissable

    Option to make the banner dismissable, meaning that the user can hide the banner by clicking "X". If you don't enable this option, users can't hide the banner.

  3. Click Done.

After the setup is done, the banner is displayed in FA Client Portal after the user's browser is refreshed.

Setup for the customized FA Client Portal or an additional standard instance

If you use several instances of FA Client Portal or have a customized FA Client Portal in use, set up the banner in FA Admin Console:

  1. In the File management view, open the directory /public/<directory of FA Client Portal instance>/config.

  2. Download the config.json file and open it to make edits.

  3. Define the banner parameters under the "banner" key:

    Severity

    Banner type (sets the banner color). The options are: "Info" (blue), "Success" (green), "Warning" (yellow), and "Error" (red).

    Description

    Banner content.

    Title

    Banner title.

    Dismissable

    Option to make the banner dismissable, meaning that the user can hide the banner by clicking "X". If you don't enable this option, users can't hide the banner. The parameter is specified as follows:

    false = Dismissing disabled

    true = Dismissing enabled

    {
    "banner": {
    "title": "",
    "description": "",
    "severity": "Info",
    "dismissable": true
    },
    "pages": {
        "portfolio": {
            "overview": {
                "piechart": {
                    "groupby": "TYPE",
                    "groupcode": ""
                }
            }
        }
    }
}

  4. Save the config.json file with your edits.

  5. Upload the file back into the directory /public/<directory of FA Client Portal instance>/config by clicking Upload files in the File management view.

After the setup is done, the configured banner is displayed in FA Client Portal after the user's browser is refreshed.

In this section: