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 11.0.3 requires that your Dashboard Server runs Tableau Server 10.4.19 (using Tomcat 7.0.91, Apache httpd 2.4.35).

Update the Dashboard Server component (Tableau Server)

Before you begin

Before updating the Dashboard Server:

  • If you are running a version earlier than v9, update to v9 before updating to this version.

  • 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 by selecting Software (size) (learn more).

  • Prepare the Aternity Oracle Database Server for Aternity by verifying its schema. 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.)

  • 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

  • Windows Server 2008 R2 Enterprise Edition (with KB2117917).

Note

If you set up a trial deployment using VMWare virtual machines, the operating system in the OVA file comes with Windows Server 2012 R2 64 bit.

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.

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 11.0.3 requires that your Dashboard Server runs Tableau Server 10.4.19 (using Tomcat 7.0.91, Apache httpd 2.4.35).

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

You may need either local or domain administrator privileges on this computer.

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 Access the new 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 version 10.x and 11.x) First, 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.

  4. Step 4 Locate the TableauServer-10-4-19-Aternity-64bit.exe setup file, which you downloaded from the Useful Links section.

    Copy it to a temporary location on this computer.

  5. Step 5 Right-click the setup and select Run as administrator to begin.
  6. Step 6 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
  7. Step 7 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
  8. Step 8 Enter the name of the Start menu container to create, like Aternity Dashboard Server 11.0.
    Select the folder for the program's shortcuts
  9. Step 9 Select Next > Install to start.
  10. Step 10 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
  11. Step 11 Select Servers.
    Access the Dashboard Server configuration
  12. Step 12 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

  13. Step 13 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
  14. Step 14 Verify it selects the Launch the Aternity Dashboard Server Monitor, and select Finish.
    Select to launch the server automatically
  15. Step 15 Enter the activation key for the Tableau Server in Aternity 11.

    Right-click the Tableau Server's system tray icon and select Manage product keys > Activate. Enter the new key TS1E-AFF9-2A60-C12B-CBF5, then select Activate.

    Add a key to the Tableau Server
    Note

    This step is only necessary for users who set up a new server or upgrade from Aternity on-premise 9.x.

  16. Step 16 Verify the setup succeeded, by checking the status of the system tray icon.

    Right-click and select Display Status to verify it is Running.

    Verify the Aternity Dashboard Server

    If the Tableau server does not start, open a command prompt and enter tabadmin status –v. If the status is DEGRADED, check your computer has the required resources dedicated for Tableau.

  17. Step 17 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, stop the Tableau service by opening a command prompt as administrator and entering tabadmin stop.

      Navigate to <setup_dir>\Tableau\Tableau Server\<version>\bin then enter tabadmin stop

      Stop the server on the main Dashboard Server
    3. c Configure SSL by selecting Start > All Programs > Aternity Dashboard Server > Configure Tableau Server > SSL.
      Open the Tableau Server Configuration window
      Field Description
      Use 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 chain file

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

    4. d Select OK.
    5. e On the Dashboard Server, start the Tableau service by opening a command prompt as administrator and entering tabadmin start.

      Navigate to <setup_dir>\Tableau\Tableau Server\<version>\bin then enter tabadmin start

      Start the Dashboard Server