Update the Aternity Dashboard Server

The Dashboard Server displays Aternity's intuitive dashboards using Tableau as its engine. It presents the data from the Aternity Vertica Database Server.

Aternity 12.1 requires that your Dashboard Server runs Tableau Server 2019.3.10 (using Tomcat 7.0.91, Apache httpd 2.4.41).

Update the Dashboard Server component (Tableau Server)

Before you begin

Before updating the Dashboard Server:

  • If you are updating from Aternity 12.0, you do not need to update the Dashboard Server and you can proceed to the next step in the update procedure.

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

  • Check the correct sizing for your deployment before updating any of your Aternity servers. Learn more.

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

  • 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 set up and update Aternity Dashboard Server on a virtual machine, please note: An offline process (VM migration) may deactivate a valid license. To prevent Tableau license deactivation, verify that either Tableau virtual machine has a Static Mac address or VMotion is disabled on that virtual machine. Follow VMWare documentation to configure Tableau VM Mac address to Static.

Ensure the hardware conforms to the following requirements:

Attribute Requirement

Operating system for Dashboard Server

Use any of the following:
  • Windows Server 2016 64 bit or

  • Windows Server 2012 R2 64 bit (with KB2919355 and KB2999226) (install KB2919355 first, and only then KB2999226) or

Set the date and time formats to Control Panel > Regions > Formats > English (United States).

Time zone

Synchronize all Aternity components to have the same date, time AND time zone.

We recommend that an IT person define a clock synchronization service, like for example NTP, between all Aternity components. This will provide highly accurate timing for all network components and prevent clock drift.

Hardware

Hardware specifications depend on the size of your Aternity on-premise deployment. Choose the sizing and hardware specifications for your deployment size.

Microsoft .NET

Ensure this server has Microsoft .NET 3.5 (exactly) required for the database drivers, and .NET 4.5 or later, required for driver setup (both in parallel). To add .NET to a Windows Server, learn more.

Tableau version for Dashboard Server

Aternity 12.1 requires that your Dashboard Server runs Tableau Server 2019.3.10 (using Tomcat 7.0.91, Apache httpd 2.4.41).

Network

Ensure this server has a static IP v4 address, and that you open the required ports.

Connectivity for Dashboard Server

This server must be open for access on port 80 or 443 from the Aternity Management Server and users accessing the Aternity dashboards from their browser.

This server requires internet access (port 80) to connect to Tableau's map service to render Aternity's geographic maps correctly.

In addition, open port 8000 on the Windows Firewall for Tableau's internal load balancer. Check Tableau's online help for a full list of required open ports.

Permissions for Dashboard Server

When installing Dashboard Server, one needs either local or domain administrator rights on this computer, and also the administrator rights in the Tableau Server.

Verify that the Windows account which is going to set up this server has permission to read, write, list and execute in the Tableau Server setup directory and its sub-folders. Learn more.

For less standard hardware configurations, see the setup instructions and hardware best practices from Tableau. To deploy on a virtual machine, you must guarantee the CPU and memory requirements.

Procedure

  1. Step 1 If you are upgrading from Aternity 12.0, you do not need to update the Dashboard Server and you can proceed to the next step in the update procedure.

    For those who continue, access the Aternity Dashboard 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 For updates from 11.0.3, proceed to the next step.

    For updates from on-premise 12.0, no upgrade of the Dashboard Server is necessary. Start the Dashboard Server using TSM:

    • Double-click the TSM (Tableau Services Manager) shortcut on the desktop and log in with the local administrator credentials.
    • Start Tableau by using the drop-down on the Tableau top bar.
      Start server

    Proceed to the update of the Aternity Dashboard Gateway Server (learn more).

  4. Step 4 Create a backup of your saved dashboards.
    Run a command line utility on the Dashboard Server. Navigate to the home directory of the setup files of the Dashboard Gateway (for example, d:\data\AternityTableauGateway). Enter the following command:
    TableauUtility.cmd backupSaved -outputFolder target_dir -site Tableau_site

    This creates a backup file in the defined target folder. You can restore it after publishing dashboards layouts. Learn more.

    Backup saved dashboards with a scheduled command line
    Field Description

    -outputFolder

    Enter the target directory to place the backup package (zip file) containing the saved dashboards. For example, c:\temp.

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

  5. Step 5 Locate the TableauServer-2019-3-10-Aternity-64bit.exe setup file, which you downloaded from the Additional Packages section.

    Copy it to a temporary location on this computer.

  6. Step 6 Right-click the setup and select Run as administrator to begin.
  7. Step 7 Create a backup before uninstalling the previous Tableau server version.
    Note that this might slow down the upgrade process.
    Create a backup before uninstalling Tableau
  8. Step 8 Select Next and enter the path to the setup directory on a local, non-system drive.
    Important

    To use the settings from the previous version, you MUST use the same target pathname as the old version. This can be confusing, as the old and new pathnames may be very similar.

    Select the location to place the Tableau files
  9. Step 9 Enter the name of the Start menu container to create, like Aternity Dashboard Server 11.0.
    Select the folder for the program's shortcuts
  10. Step 10 Select Next > Install to start.
  11. Step 11 Review the settings in the configuration wizard which opens automatically.

    When you install in the same directory as the previous version, it preserves the settings here. Typically you would not change these values.

    Tableau Server settings
  12. Step 12 Select Servers.
    Access the Dashboard Server configuration
  13. Step 13 Select This Computer (Primary) and select Edit.
    Edit the process allocation for dashboard components

    Enter the values according to the size of your deployment.

    Field Trial Small Medium Large X-Large XX-Large
    VizQL Server

    1

    2

    2

    2

    2

    2

    Application Server

    1

    1

    1

    1

    1

    1

    Backgrounder

    1

    2

    2

    2

    2

    4

    Cache Server

    0

    0

    0

    0

    0

    0

    Data Server

    1

    2

    2

    2

    2

    2

    Data Engine

    1

    1

    1

    1

    1

    1

  14. Step 14 Sign in to the Tableau Server which opens automatically, using the dashboard administrator credentials when you originally set up the Tableau Server.

    The update preserves the same username and password from the previous setup. This is NOT your Aternity username.

    Tip

    The Tableau Server administrator username is only for the Aternity Dashboard Gateway Server to connect to Tableau.

    If you set up SSL access to the dashboards, it requires a valid certificate. Therefore accessing localhost in this way may cause your browser to issue a security warning.

    Log in to the Tableau Server
  15. Step 15 Verify it selects the Launch the Aternity Dashboard Server Monitor, and select Finish.
    Select to launch the server automatically
  16. Step 16 Enter the activation key for the Tableau Server in Aternity 12.

    Double-click the TSM (Tableau Services Manager) shortcut on the desktop and provide the local administrator credentials (you can find them in the credentials file that is part of the package).

    Select Configuration > License. Enter the key TS1E-AFF9-2A60-C12B-CBF5, then select Activate License.

    Add a key to the Tableau Server
  17. Step 17 Verify the setup succeeded, by checking the status of the system on the Tableau top bar: verify it is RUNNING.
    Verify the Tableau is running

    If after several minutes it still remains in degraded or stopped state, restart the server.

  18. Step 18 Secure Dashboard Server.
    Tip

    For secure HTTPS (SSL) web access to Aternity, you must secure both the Aternity Management Server and the Aternity Dashboard Server.

    Secure the Dashboard Server for secure access to Aternity
    1. a Make sure you have your enterprise's certificate. Learn more.
    2. b On the main Dashboard Server, open the Tableau Services Manager (TSM) and stop Tableau by using the drop-down on the Tableau top bar.
      Stop the server on the main Dashboard Server
    3. c Configure SSL for secure communication between server and clients by selecting the Configuration tab > Security page > External SSL.
      Open the Tableau Server Configuration window
      Field Description
      Enable SSL for server communication

      Select to enable SSL encrypted communication with other components.

      SSL certificate file

      Enter the pathname of the certificate (.crt) file, which you prepared in advance.

      SSL certificate key file

      Enter the pathname of the key (.key) file, which you prepared in advance.

      SSL certificate key passphrase

      (Optional) Enter the pathphrase of the key if you have one.

      SSL certificate chain file

      Enter the pathname of the root CA certificate, which you prepared in advance.

    4. d Select Save Pending Changes.
    5. e On the Dashboard Server, open the Tableau Services Manager (TSM) and start Tableau by using the drop-down on the Tableau top bar.
      Start the Dashboard Server