Set Up a New Aternity Dashboard Server

This article describes how to set up a new 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.

Create the Dashboard Server which contains the Tableau Server and other components

The Dashboard Server must be a separate computer which contains the following components:

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

    Tableau is the engine which processes the data into intuitive dashboards, as defined by the Aternity dashboard definitions.

  • The Dashboard Gateway acts as the interface between the Dashboard Server and the Aternity Management Server, performing background tasks like preprocessing the data for display in the dashboards, and maintaining logs, audits and cleanup. It must be on the same computer as the Dashboard Server. While it has no user interface of its own, it is crucial to the proper functioning of Aternity.

  • The Aternity dashboard definitions describe the layout and format of the Aternity dashboards which present the data to users.

Tip:

Air-gapped networks make offline Tableau setup very lengthy. You must upload and download several files in sequence as a challenge response. Tableau does not allow this in one action. We do not control their setup procedures.

Before you begin

Before creating the Dashboard Server:

  • Complete setting up the Aternity Oracle Database Server.

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

  • Make sure the hardware and operating system of the Aternity Dashboard Server conform 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

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

    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.

  • In air-gapped networks: Contact Aternity Customer Services to get the key for the offline activation.

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 Download the latest Aternity on-premise's main setup package from the Aternity Support Site (learn more).

    Sign in to Aternity Support Site, then go to Product Downloads > Aternity Server > Version and select the required version to download. Note that only logged in users with certain permissions can see the download option.

    The setup package is for all Aternity servers.

    Download Aternity on-premise from the website
    There are also entries in the Additional Packages which are required for database setup and others:
    • Tableau Package

    • Oracle Packages

    • Install Scripts

    • DB Schema Scripts

    Refer to Additional Packages for the necessary Oracle images and other setup packages.
  4. Step 4 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.

  5. Step 5 Right-click the setup and select Run as administrator to begin.
  6. Step 6 Deploy Tableau on drive C:. Tableau 2019.3.10 cannot run properly if installed on drives other than C:.
    Select the location to place the Tableau files

    Select Next. The system starts extracting the files and verifying if the server meets the minimum requirements. If verification passes, select Next.

  7. Step 7 Select Create new Aternity Dashboard Server and then Next.
    Create newAternity Dashboard Server
  8. Step 8 Select Install. The system starts extracting the files.
    Wait until the setup opens the browser and starts the TSM.
    Use TSM to configure the server

    The URL address of the TSM web UI is http://<machine_hostname>:8850. Port 8850 is used by default for Tableau administration and configuration. In case you want to access the TSM from a different device, the port 8850 should be open on the device where Tableau was deployed. Learn more.

    You can also open the TSM later from the desktop shortcut.

    Sign in to Tableau Services Manager
  9. Step 9 Sign in to the Tableau Services Manager with the Windows host administrator user on that device.

    Now configure the Dashboard Server using Tableau Services Manager.

  10. Step 10 Activate Tableau.

    Enter Aternity's license key for Tableau: TS1E-AFF9-2A60-C12B-CBF5, and select Activate License.

    Activate Tableau
  11. Step 11 Register Tableau.
  12. Step 12 Set up Tableau.
    1. a In the Identity Store section, select Local and NOT the other option.

      On the right side you can read additional information.

      Set up the Identity Store as Local
    2. b In the Run As Service Account section, select NT Authority.
      Set up the Service Account
    3. c In the Gateway Port section, enter 80, the default Tableau HTTP port.
      Set the gateway port for Tableau communication

      Other sections are optional.

  13. Step 13 Select Initialize to complete the setup.

    This process can take a while. Note that you will need to create a Tableau Server Administrator account when this process finishes.

  14. Step 14 In the new Tableau Server tab in the browser window which automatically opens, create a Tableau administrator account.

    Enter an administrator username and password for the Aternity Dashboard Server (Tableau). Make a note of it for when you add the Aternity Dashboard Gateway Server.

    Create a Tableau server administrator account
    Tip:

    If the browser does not automatically open, manually go to http://localhost:[port_for_Tableau].

  15. Step 15 In the Tableau Services Manager, in the Status tab, verify that all processes are Active.
    See at the bottom all possible statuses for the processes
    On the Tableau top bar, check the status of the server (running/stopped/degraded). If necessary, use the drop-down menu to start or stop Tableau.
    Restart or stop the Tableau server
  16. Step 16 In the Configuration tab, Topology page, set the topology.
    Enter the values according to the size of your deployment.
    Edit the process allocation for dashboard components
    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

    1

    1

    1

    1

    1

    1

    Data Server

    1

    2

    2

    2

    2

    2

    When you change the value(s), that value name becomes highlighted and the button Pending Changes appears.
    Configure Tableau performance according to the size of your deployment
    Click the button and see the list of changes. Check and click Apply Live Changes. The Tableau server will be restarted or restart it manually if prompted.
    Apply the changes
  17. Step 17 In the Configuration tab, License page, activate the license if not yet activated during the deployment process.
  18. Step 18 In the Configuration tab, Security page, External SSL tab, configure SSL for secure communication between Dashboard Server and clients (learn more).
  19. Step 19 (For air-gapped networks only) If this computer is not connected to the Internet, perform an offline activation.

    An offline activation can be time consuming. Plan in advance. Contact Aternity Customer Services to get the key for the offline activation.

    When you select Activate, it prompts you to save a file for activating Tableau offline (learn more)

    Note:

    If you set up 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.

    Tip:

    Air-gapped networks make offline Tableau setup very lengthy. You must upload and download several files in sequence as a challenge response. Tableau does not allow this in one action. We do not control their setup procedures.

    1. a Select Save to save the offline.tlq file, and then copy it to a computer with Internet connectivity.
    2. b Select Exit to close the activation window.
    3. c From a computer with online access, upload the file on the Tableau activation page.

      Select Choose File, select offline.tlq, and select Upload Activation File.

      It returns a .tlf file.

    4. d Save the activation.tlf file, and copy it to the Dashboard Server.
    5. e (On the Dashboard Server) Open a command prompt as an administrator.

      Search for cmd on your computer, right-click and select Run as Administrator.

      Open the computer's command prompt as an administrator
    6. f In the command prompt, navigate to <setup_dir>\Tableau\Tableau Server\<version>\bin. For example, D:\Program Files\Tableau\Tableau Server\2019.3\bin and run the following command:
      tabadmin activate --tlf <path>\activation.tlf

      where <path> is the location of the activation.tlf file you saved.

      Tip:

      The double hyphen is part of the command.

      Leave the command prompt open to use later in the procedure.

    7. g On the Dashboard Server, select Start > All Programs > Tableau Server 10.4.
    8. h Right-click Manage Product keys and select Run as Administrator.
    9. i Enter the activation key and select Activate the product. (Contact Aternity Customer Services to get the key for the offline activation.)

      It generates a second .tlq file.

    10. j Save the newly generated .tlq file.
    11. k From a computer with Internet access, open the Tableau activation page again and upload the second new .tlq file.

      It generates a new and separate .tlf file.

    12. l Save the new, second activation.tlf file, and copy it to a different location on the Dashboard Server, separate from the first activation file.
    13. m On the Dashboard Server, from the command prompt, run the command:
      tabadmin activate --tlf <path>\activation.tlf

      where <path> is the location of the second activation.tlf file you saved.

      Confirm the activation completed successfully.

  20. Step 20 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 the Tableau server does not start, open the TSM using the desktop icon and start it manually from the Tableau top bar.

  21. Step 21 If the process did not complete successfully, or one of the steps returned an error:
    1. a Go to http://<machine_hostname>:8850, and enter the machine local administrator's username and password (NOT Tableau administrator).

      Verify you see the TSM.

    2. b Check the internet connection for maps, by trying to access one of their maps.

      Open the Tableau Console, and go to http://{$hostname}/views/Sales/2013SalesGrowth (or use https if you configured a secure connection). If the geographic maps are empty, try to access http://mapvisual.tableausoftware.com. If you receive a 404 error message, check your firewall is not blocking network service, or configure Tableau to work with a proxy. Then restart Tableau and access the maps again.

      Tip:

      On air-gapped networks, edit the server's hosts file to ensure this points to a dummy address which is local, to improve performance of dashboard loads.

    3. c Check the logs located in the Tableau data folder (for example, D:\ProgramData\Tableau\Tableau Server\data\tabsvc\logs), or contact Aternity customer services.