Update (Publish) 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

Before you begin

Before upgrading the dashboard layouts you should:

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

  • If you are running a version earlier than 11.0.3, update to 11.0.3 before updating to 12.1.

  • Prepare the Aternity Oracle Database Server for Aternity by verifying its configuration. Learn more.

  • Aternity requires you set up one or more new Vertica Database Servers, depending on the size of your deployment. Learn more. (If you performed the data migration process, then your Vertica Database Server is already up and running.)

  • Update the Dashboard Server by removing the previous version of Tableau and then running the setup of the new version. Learn more.

  • On the Dashboard Server, update the Dashboard Gateway component. Learn more.

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

  • Update the Aternity Management Server by running its express setup or custom setup over the previous version.

Procedure

  1. Step 1 If Aternity Support provided you with a link to a dashboards package, download it to the Aternity Management Server.
  2. Step 2 Access the Aternity Management Server.
  3. Step 3 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.

  4. Step 4 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.

  5. Step 5 Select Tableau Dashboard Loader.
    Select to add dashboard layouts
  6. Step 6 Confirm the the details to connect to the Dashboard Gateway on the Aternity Dashboard Server.
    Confirm the connection details to the Dashboard Gateway on the 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.

  7. Step 7 Select Use an Existing Site and select the site name you used in your existing setup.
    Use the Tableau site as the target to save the dashboard layouts
  8. Step 8 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.

  9. Step 9 Select Next > Finish to complete the process.
  10. Step 10 Verify that web authoring is enabled.
    Important

    If web authoring is not enabled, your advanced dashboards will not work.

    1. a In a browser, navigate to the hostname of the Dashboard Server, such as http://tableau.example.com.
    2. b Sign in as a Tableau administrator, using the credentials assigned during the original setup of the Tableau server.
    3. c Select the site used by the Management Server. This should be the production site that you created in your initial setup of the Dashboard Server.
      Select the Tableau site
    4. d Enable web authoring by selecting Settings > Allow users to use web authoring from the side bar.
      Enable web authoring
  11. Step 11 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.
  12. Step 12 On the Aternity Management Server, open the Windows Services and start (or if running, restart) the AternityPlatform service.
  13. Step 13 (Optional) If you backed up the dashboards which users saved, you can restore them.
    1. a Access the Aternity Dashboard Server.
    2. b In a command prompt, navigate to the setup destination directory of the Dashboard Gateway.
    3. c Enter the following command:
      TableauUtility.cmd restoreSaved -inputFile pathname_of_backup_zip -site Tableau_site -convertToVertica
      Restore a backed up package of saved dashboards
      Field Description

      -inputFile

      Enter the full pathname and file to the package containing the dashboards you backed up earlier.

      -site

      Enter the name of the Tableau site. You can find this in Aternity settings, by selecting the Gear Icon > Settings > Advanced Settings > tableau > site.

  14. Step 14 Open a browser and sign in to Aternity.
  15. Step 15 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.