Quickly Update the Aternity Management Server

Update your Aternity on-premise for a significant step forward in new features and resolved issues.

During your update of each Aternity server, you can choose between the express update, or a custom update.

Important:

Always check the sizing before updating. This version uses different database sizes, dashboard requirements and new servers. Learn more.

  • If you are keeping the same topology or security, choose the express update, which keeps your legacy settings in the updated servers.

  • If you are changing your topology or security, choose the custom update.

For example, if the updated requirements for your sizing state you must have a new standalone Aggregation Server, you must use the custom update to remove the legacy embedded Aggregation Server from within the Management Server, then run the setup again on a standalone server to a fresh setup of a new Aggregation Server there.

Use the updated sizing to determine whether a component is embedded or standalone
Tip:

If your sizing requires you to update or create a standalone server, run the setup on each standalone computer.

Remove an embedded component during upgrade, then run setup on a standalone server

Before you begin

Before updating the Management Server:

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

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

  • To setup the Aternity Management Server, you must register with Aternity's online activation form. Enter your contact details and serial number to send an activation key to your email (learn more).

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

  • Ensure that the Aternity schema user in the Oracle Database Server has the MANAGE SCHEDULER privilege for the duration of the upgrade. Otherwise, the Aternity Management Server upgrade will fail. This privilege can be removed once the upgrade is completed. Learn more.

  • Aternity requires you set up one or more new Vertica Database Servers, depending on the size of your deployment. Learn more.

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

  • Make sure the hardware and operating system of the Aternity Management Server conform to the following requirements:

    Attribute Requirement

    Hardware

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

    Network

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

    Operating system for Management Server and Data Warehouse Server

    Windows Server 64 bit 2016 or 2012 R2 64 bit. Set the date and time formats to Control Panel > Regions > Formats > English (United States).

    Both servers set up and use Apache Tomcat 8.5.69.

    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.

    Permissions

    Ensure you have local administrator privileges on this computer.

Procedure

  1. Step 1 Access the Aternity Management Server computer.
  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 Stop the AternityPlatform service.
    To stop the service, you must sign in to the computer as an administrator, and access the Windows Services screen. If the service does not stop within a minute, go to the Task Manager and select End Task for the Java process running on the machine.
  4. Step 4 Select the Aternity_windows-x64_12.1.0.<build number>.exe setup file, which you downloaded as part of the Aternity on-premise server setup package.

    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 (Optional, recommended) Backup your existing server settings, as they may be useful for support and troubleshooting purposes.

    The size of the backup is roughly equal to the size of the deployment, but does not include raw data files and archived reports.

    Backup to a subfolder under updates, like D:\data\Aternity\updates\backup_20160323-182419. We recommend that you use the default folder. Do NOT save the backup in the parent Aternity folder, D:\data\Aternity\.

    Backup the existing settings of the server
  7. Step 7 Select Express (Use Existing Settings).
    Important:

    Always check the sizing before updating. This version uses different database sizes, dashboard requirements and new servers. Learn more.

    • If you are keeping the same topology or security, choose the express update, which keeps your legacy settings in the updated servers.

    • If you are changing your topology or security, choose the custom update.

    Select the express setup
  8. Step 8 To setup the Aternity Management Server, you must register with Aternity's online activation form. Enter your contact details and serial number to send an activation key to your email (learn more).

    Aternity requires a live email address for every production deployment of Aternity on-premise, to properly honor our commitments of royalty payments to vendors of third party software.

    Go to https://activation.aternity.com.

    When completed, Aternity sends the activation key to the email you provided.

    Retrieve an activation key to continue the setup
    Field Description
    Company Name

    Enter the name of your enterprise which purchased Aternity.

    Contact Email / Confirm Email

    Enter your work email address which you can access. Aternity sends the activation key to this address.

    Important:

    You must check the inbox of this account for the activation key. You cannot continue setup without this key.

    Serial Number for your Aternity Purchase

    Enter the exact serial number of the latest Aternity purchase.

    Environment Type

    Define the purpose of your system, for identification purposes only. Selection options are Production, Test, and Trial-POC.

    Release

    Select the version Aternity which you want to activate.

  9. Step 9 Enter the activation key which you received via email from the online activation form.

    Copy all characters in the key, including the 'equals' (=) signs at the end.

    During update, the old key will automatically appear in the field, but will probably be expired. Enter the valid key you received. The setup validates the key and in case it is a wrong one, will prevent the setup from continuing.

    Enter the activation key
  10. Step 10 Review the settings from the existing server, and start the update.

    If it reports that the existing setup is corrupted, cancel the update and contact Customer Services.

  11. Step 11 (Optional) If you previously defined custom attributes and mapped them to a system attribute, you can change the mapping if required.
    Tip:

    Typically, you would not change these settings.

    For example if you had an attribute called MyCompanyPlace which you previously mapped to office, you can change the mapping to location by choosing MyCompanyPlace for the Location field.

    Change your legacy custom attribute mappings to Aternity 's attributes
    Field Description
    Frontline / Originating

    Displays whether Aternity obtains this attribute from the frontline client (like the remote desktop), or from the originating virtual server which hosts the virtual session.

  12. Step 12 Make sure that Start AternityPlatform service is NOT selected, and then select Finish.

    Only start the AternityPlatform service AFTER you publish or update dashboard layouts, to avoid generating unnecessary errors in the setup log files.

    Do not start the AternityPlatform service