Publish or Upload Dashboard Layouts for Aternity

Upload Aternity dashboard layouts to deploy them to Aternity.

The Aternity dashboard layouts contain the names, calculations and layouts of the system's dashboards for this Aternity version. Customers of Aternity on-premise run this setup from the Aternity Management Server to plant them in the Dashboard Server via the Dashboard Gateway.

Important

Add the dashboard layouts ONLY from the Management Server.

Add the layouts from the Management Server into the Dashboard Server via Dashboard Gateway

The Configuration Tool already has the dashboard layouts built in as part of the tool, but if Aternity releases a patch update, download the updated layouts separately and browse to them during the setup.

Before you begin

Before adding the Aternity dashboard layouts, you must:

  • Download the latest Aternity on-premise's main setup package from the Aternity Support Site (learn more).

  • Complete setting up the Aternity Oracle Database Server.

  • Complete setting up one or more Aternity Vertica Database Servers.

  • Complete setting up the Aternity Dashboard Server and the set up of the Dashboard Gateway.

  • Complete setting up the Aternity Management Server.

  • Confirm that a local administrator on the Management Server can connect to the Dashboard Server.

Procedure

  1. Step 1 Access the Aternity Management Server.
  2. Step 2 Log in to the computer as a local administrator.

    To verify you are a local administrator on this computer, not a domain administrator, open the System control panel, select Advanced system settings > Computer Name, and confirm the Change button is active.

  3. Step 3 On that computer, launch the Configuration Tool from the Start menu, by right-clicking it and selecting Run as administrator to start.

    When you create any Aternity server it adds the Configuration Tool.

  4. Step 4 Select Tableau Dashboard Loader.
    Select to add dashboard layouts
  5. Step 5 Enter the details to connect to the Dashboard Gateway on the Aternity Dashboard Server.
    Connect to the Dashboard Gateway on the Aternity Dashboard Server
    Field Description
    Hostname / IP Address

    Enter the hostname or IP address of the Dashboard Gateway (which is the same as the Aternity Dashboard Server).

    Port

    Enter the port of the Dashboard Gateway, which you entered when creating the Dashboard Gateway.

    This is NOT the port for direct user access to the dashboards. This is the Dashboard Gateway port.

    Username / Password

    Enter the username and password of the Dashboard Gateway, which you entered when creating the Dashboard Gateway.

    Select Next to test the connection details to the Dashboard Gateway, which may take longer than expected.

  6. Step 6 Create and name a site on the Dashboard Server, by selecting Create a new site.

    You can only publish dashboard layouts into a named site. Enter a name of the site like production.

    Create a new site as the place to save the dashboard layouts
    Tip

    This allows you to have two sets of dashboards, one site for test and one site for production on the same computer.

    Select Next and wait until the site is set up successfully on the Dashboard Server.

  7. Step 7 Either select the dashboard layouts delivered with the setup package, or if you downloaded a custom dashboard package, select that option and browse to the file.
    Add the layouts built-in to the setup or a separate patch update
    Field Description
    Dashboards Shipped with Setup

    Select to add the dashboard layouts which are built-in to this Configuration Tool, if you did not download a separate dashboard layout package.

    Custom Dashboard Content

    Select to browse to a separate downloaded dashboards package.

  8. Step 8 Select Next > Finish to complete the process.
  9. Step 9 Once the dashboards are published, run the script that Aternity provides in the Management Server home folder to update Tableau configuration.

    This must be done before starting the AternityPlatform service for the Management Server. If you miss this step, the dashboards and Dashboards Library may not function properly.

    1. a Navigate to the Aternity home folder on the Management Server (by default it is X:\data\aternity).
    2. b Edit TableauConfigration.properties and provide values for each of the four properties inside it:
      Field Description
      adminUsername

      Provide the Tableau administrator user name created when installing the Tableau server.

      adminPassword

      Provide the Tableau administrator password created when installing the Tableau server.

      The password will be encrypted by the script before being updated in the Advanced Settings.

      The password cannot contain the backslash character \. If it does, contact Aternity Support Team to assist in manually updating these properties.

      port:80

      Provide the Tableau server listening port (default is either 80 for HTTP or 443 for HTTPS).

      ssl:false

      Set this property to either false (if SSL/HTTPS is OFF) or true (if it is ON).

      Tableau Configuration File
    3. c Type CMD to open the Command Prompt and navigate to the Aternity home folder.
    4. d Run the command grshell.bat script tableauConfiguration.groovy
      Tableau Configuration Output
    5. e Once the script has finished running, edit TableauConfigration.properties and delete the value for the adminUsername and especially adminPassword properties.
  10. Step 10 On the Aternity Management Server, open the Windows Services and start (or if running, restart) the AternityPlatform service.
  11. Step 11 Open a browser and sign in to Aternity.
  12. Step 12 Verify that you can see the full set of Aternity dashboards in your system.

    The dashboards might not display performance data at this stage, as you have not yet created all the servers required to gather new data from devices.

  13. Step 13 (Optional) Enable Product Tours in the Help menu.

    In Air-gapped networks, after installation, check the connection settings. In case there is no internet connection, the features that require internet will be disabled (Product Tours should then be set to work offline, the maps will not show). In the Help menu, check the server settings under the Gear Icon > aternity/account/hasInternetConnection/. By default, browser is set to Yes and server is set to No. Adjust the settings to the actual topology of your organization. For example, if only the browser has internet connection and the server does not have it, make sure to set browser to Yes and server to No under aternity/account/hasInternetConnection/. Note that Product Tours will work if your browser is set to Yes, and maps in dashboards will work if the server is set to Yes.