Customize your Update of the Aternity Management Server for Aternity v9.0 / 9.0.1

Update your Aternity on-premise to version 9.x from v7.1.x or 8.x for a significant step forward in new features and a new look.

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

  • If you keep 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.

This article describes the custom upgrade.

Important:

Always check the sizing before ANY update. Even minor Aternity upgrades like from 9.0 to 9.0.x have updated sizing, hence you may need to change your topology and hardware even with the same number of devices.

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 freshly install a new Aggregation Server there.

Use the updated sizing to determine whether a component is embedded or standalone
  • (Trial demo deployments less than 100 devices) The Management Server PC can also have the Database Server, Analytics Server, Data Warehouse Server, and Aggregation Server, all on the same PC.

  • (Small deployments less than 3,000 devices) The Database Server is standalone. The Management Server PC has ALL the following: the Analytics Server, Data Warehouse Server, and Aggregation Server.

  • (Mid-sized deployments less than 25,000 devices) The standalone servers are: Database Server and Aggregation Server. The Management Server PC has ALL the following: Analytics Server and Data Warehouse Server.

  • (Larger deployments above 25,000 devices) The standalone servers are: Database Server, Data Warehouse Server and Aggregation Server. The Management Server PC should only have the Analytics Server.

Tip:

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

Uninstall an embedded component during upgrade, then run setup to install it on a standalone server

Before you begin

Before updating the Management Server:

  • If you are running a version that predates v7.1.x, update to v7.1.x before updating to v9.x.
  • Check the correct sizing for your deployment before updating any of your Aternity servers.

  • If your legacy Agents communicate over TCP, you must first test then switch from TCP to HTTP(S).

  • Update the Aternity Database Server by verifying and then updating the Oracle database..

  • Update the Dashboard Server by uninstalling the previous version of Tableau and then running the setup to install the new version.

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

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 Download the latest version of Aternity on-premise from our website.

    The setup package is for all Aternity servers.

    Download Aternity on-premise from the website
  4. Step 4 Stop the AternityPlatform service.
  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 installation, 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 Custom (Change Existing Settings).
    Important:

    Always check the sizing before ANY update. Even minor Aternity upgrades like from 9.0 to 9.0.x have updated sizing, hence you may need to change your topology and hardware even with the same number of devices.

    • If you keep 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 installation
  8. Step 8 Review the existing Installation Location and select Next.

    The setup displays the settings of the existing deployment on this computer.

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

  9. Step 9 If any Aternity Agents on existing monitored devices report to Aternity with TCP, you must first update them to HTTP(S).

    Cancel the setup and test your new configuration of Agents in HTTP or HTTPS.

    Only proceed after all devices report to Aternity with HTTP(S)
  10. Step 10 Select the servers you want to update on this computer, based on the sizing of your deployment.

    The setup displays the settings of the existing deployment on this computer. Selecting a server adds its component to this computer. Deselecting it disables it from this computer.

    Important:

    Only deselect a server if you are planning to disable it from this computer, due to a change in topology.

    Select the servers to install on the computer during the upgrade
    • (Trial demo deployments less than 100 devices) The Management Server PC can also have the Database Server, Analytics Server, Data Warehouse Server, and Aggregation Server, all on the same PC.

    • (Small deployments less than 3,000 devices) The Database Server is standalone. The Management Server PC has ALL the following: the Analytics Server, Data Warehouse Server, and Aggregation Server.

    • (Mid-sized deployments less than 25,000 devices) The standalone servers are: Database Server and Aggregation Server. The Management Server PC has ALL the following: Analytics Server and Data Warehouse Server.

    • (Larger deployments above 25,000 devices) The standalone servers are: Database Server, Data Warehouse Server and Aggregation Server. The Management Server PC should only have the Analytics Server.

    Add more components on the same Management Server PC

    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 freshly install a new Aggregation Server there.

    Uninstall an embedded component during upgrade, then run setup to install it on a standalone server
    Tip:

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

  11. Step 11 Review the hostname of this computer which it presents to other components when they want to connect.

    The setup displays the settings of the existing deployment on this computer.

    Important:

    If you change this value during an upgrade, it would require changing all components which connect to this server.

    Review the Management Server address
    Field Description
    Hostname

    Select the hostname or IP address from the drop-down list, or enter it manually. This is the listening address when other components connect to the Management Server.

    There are several entries if this computer has more than one network card (NIC) or several virtual IPs.

    For example, when the Aggregation Server sends data to the Management Server, it must send to this address.

    Tip:

    In rare cases when the Aternity Dashboard Server's URL is not visible to Aternity users (due to firewall or other topology reasons), you can add its address directly to the Management Server.

    Select the Gear Icon > Settings > Advanced Settings > tableau > externalAddress.

    Enter the full URL (protocol and address) of the Aternity Dashboard Server. For example, https://myaternity-dashboards.company.com.

  12. Step 12 (Only for small deployments, if the Aternity Aggregation Server is also on this computer) Define the properties of this Aggregation Server.
    Select the device types which may connect to Aternity
    Field Description
    Device Types

    Select whether this Aggregation Server accepts connections from mobile and Windows monitored devices, or just Windows devices.

  13. Step 13 Select the size of your deployment as the number of devices you expect to monitor.

    This defines the storage and memory settings for the Database Server and the Data Warehouse Server. A smaller deployment saves storage and memory space, while a larger size improves performance.

    Select your deployment size
  14. Step 14 Verify the connection details of the Management Server with the Database Server (the Oracle database)

    The setup displays the settings of the existing deployment on this computer.

    Important:

    Only change these values if you have moved the Aternity Database Server or if you have changed the structure of the database.

    Typically you enter details in the Connection tab, but if you have a custom database connection URL, use the Advanced Properties tab.

    Confirm or edit the Management Server's connection with the Database Server
    Field Description
    Database Server hostname/IP address

    Enter the hostname, IP address, or DNS name of the Database Server.

    Database Service Name

    Enter the database service name (usually Aternity). This is the alias to the instance of the Aternity database.

    Database Port

    Enter the port required to access the Database Server (default is 1521).

    Use the Advanced Properties if you have a custom database connection URL. This overrides any settings in the Connection tab.

    Configure your custom database connection URL
    Field Description
    Customize URL

    Select to enter your own custom connection string to the database. Ask your DBA if you have a custom database implementation which requires a custom URL.

    Tip:

    If you have Oracle RAC (Real Application Clusters) deployed, configure the connection string of Aternity's database service to use only a one single instance in the cluster. You can configure the failover option to use another server if required.

    Therefore Aternity does NOT support RAC's load balancing and high availability features. Contact Aternity customer service teamĀ before implementing connection strings with any RAC elements or other advanced features.

    Custom Database URL

    Enter the custom database connection URL, like (DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVER = DEDICATED)(SERVICE_NAME = ATERNITY)))

  15. Step 15 Review the credentials to access the schema of the existing database.

    The setup displays the settings of the existing deployment on this computer.

    Important:

    Only change this information if your DBA changed the credentials of the schemas.

    Enter the name and password of the two database schemas
    Field Description
    Platform Database Credentials

    Displays the name of the ATERNITY schema (often Aternity and its password).

    The business data schema which stores the performance measurements and device data over the past year or two, along with contextual data, like device details and user details.

    Configuration Database Credentials

    Displays the name of the GR schema (often GR and its password).

    The system settings schema which stores Aternity's system settings, username details, roles and so on.

  16. Step 16 Review the tablespaces of the Aternity database.

    Your DBA already set this information in the database itself.

    DBA can confirm the database tablespaces
  17. Step 17 Review the web security when accessing Aternity.

    The setup displays the settings of the existing deployment on this computer.

    Secure the Management Server
    Tip:

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

    Select to access Aternity via HTTP or HTTPS
    Field Description
    HTTP or HTTPS

    Select HTTPS if you want any connection to this server to be via HTTPS.

    Tip:

    To see the Aternity's system-wide security settings, view the security overview of all components.

    Port

    Enter the port required to receive data from the monitored devices. The default for HTTPS is 443.

    Custom keystore

    Enter the pathname of the system's keystore containing your enterprise's certificate.

    You must add your certificate to the system's Java keystore file (.jks) using Java's keytool utility (see Oracle's keytool documentation).

    Custom keystore password

    Enter the password required to access the system's keystore file.

  18. Step 18 Configure the memory allocation size of your deployment, and confirm the timezone of the Aternity servers on this computer.
    Configure the memory allocation and time zone
    Field Description
    Java Virtual Machine memory

    Configure the JVM heap size according to the values listed for the size of your deployment.

    You can tweak this value later on if required.

    Customize Timezone

    Select a time zoneĀ if you want to override the timezone settings of the operating system.

    Important:

    The time zones of the Database Server, Dashboard Server, Management Server, and Data Warehouse Server must all be identical.

    JMS Memory Maximum

    Enter the ActiveMQ JVM heap size according to the value listed for this server for the size of your deployment.

    You can tweak this value later if required.

  19. Step 19 (Optional) Personalize the Aternity login screen.
    Optionally add a logo to the Aternity login screen
    Field Description
    Use Custom Logo

    Select to enter your own logo.

    Local File

    Enter the pathname to the PNG or JPG logo file stored locally on this computer.

    Remote URL

    Enter the web URL to the PNG or JPG logo file stored on the internet.

  20. Step 20 Review the settings from the existing server, and select Install to start the update.

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

  21. Step 21 Shut down all processes of the server before continuing the update.

    Select Close processes to end them manually, or wait for them to end normally and select Retry.

    Close processes to continue with update
  22. Step 22 (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 the system obtains this attribute from the frontline client (like the remote desktop), or from the originating virtual server which hosts the virtual session.

  23. Step 23 Select Start AternityPlatform service and select Finish.
    Start the service of the Management Server

    The AternityPlatform service is the Management Server. You can verify it is running in the Windows Task Manager.

    Tip:

    If the setup completes but the AternityPlatform service did not start, verify you have local administrator privileges on the computer.