Upgrade Analytics Hub

Version:
2020.4
Last modified: December 09, 2020

This article walks you through the steps to upgrade Analytics Hub. Only follow these steps if you are upgrading. For the initial installation, see the Install and Configure article.

Download the Installer

Download the Analytics Hub installer from the Alteryx Downloads and Licenses portal. Follow these steps:

  1. Go to the Alteryx Downloads and Licenses portal at licenses.alteryx.com.
  2. Sign in or select Don’t have an account? Create one now. If you’re creating a new account, register with the email address associated with your Alteryx License.
  3. Under Product Downloads, select Alteryx Analytics Hub.
  4. On the Download Products page, select the version of the product you want to download. The latest version is available on the New Versions tab. Access previous versions on the Previous Versions tab.
  5. To download the file, select the link for Analytics Hub in the File Name column.

Before You Upgrade

  • Make sure you know the username and password for the Platform Admin that was created during the initial installation.
  • Make sure you know the username and password for your database. This is the same username and password that was created for the Postgres admin during the initial installation of Analytics Hub.
  • LDAPS:// is not checking for certificates in 20.2 or 20.2.1. If you're using LDAPS://, make sure to have a local (non-LDAP) Platform Admin account set up before you upgrade in case LDAP authentication fails after upgrade due to the cert issue. 
  • Make sure that there are no users currently using the platform or schedules running. 
  • (Optional) Do a full backup. See the Back Up and Restore article. 
  • Check your Analytics Hub Version. If you're upgrading from 2020.2.1, start here. If you're updating from 2020.2.0.1e045fcf, start here.
  • In 20.2 and 20.2.1, Port was an optional parameter when creating a data source. In 20.4. it’s a mandatory parameter (default port is set if field is left blank). To prevent a Data Catalog error after upgrade, check all data sources used for sync operation on each site for a Port value. To do so, go to Data Sources and select a data source to open the details page. If any of your data sources are missing the port information (or was missing during the time of sync operation), we recommend you delete all Data Catalog assets loaded by that data source. Adding the port now does not prevent the error. In case this doesn’t work, we’ve included steps to resolve the error state in the After Installation sections of this article.​​​​​​​
    Screenshot showing Data Source details page with Port highlighted

Analytics Hub 20.4+ no longer supports saving Analytics Hub files in a Postgres database. All AAH files are now saved to your machine’s file system. Before you upgrade to 20.4, back up your Postgres data folder (default location: INSTALL_LOCATION\Alteryx Analytics Hub\Postgres\data). To do so, follow steps 4, 5, and 6 or your own method. 

AAH will migrate your Postgres files to the machine's file system during the first run after upgrading. This can take a while depending on your database size. For a successful migration, have 3 times as much free space on your hard drive as the size of your Postgres folder.

Troubleshooting

If the system runs out of free space, it will restart. Check the logs located in INSTALL_LOCATION\Alteryx Analytics Hub\Backend\analytics-hub-server.log. If you see the message “info: performing migration 0004_db,” stop the AAHBackend service and increase free hard drive space. Then, restart the AAHBackend service. Migration should resume automatically.

Upgrade from 2020.2.1

Install

  1. Run the Analytics Hub installer as an administrator. 
  2. Select Next.
  3. Select a Run Mode.
  4. Select Next.
  5. Wait for the installation to complete. The progress bar might pause near 75% complete for an hour. A long pause doesn't mean the install has failed.

After Installation

  1. Wait 5 minutes to allow the upgrade to complete.
  2. Sign into Analytics Hub and check your user licenses. The upgrade process sets all users to the Analytics Hub User license type. You might see an "Invalid license" error and a negative number in the Available column. To resolve the error, reassign the correct license types.
  3. Check the Data Catalog on all sites. If an error displays (Request failed with status code 400), run this SQL script on your Postgres database to resolve the issue.
  4. If previously installed, reinstall Alteryx Intelligence Suite, YXI tools, and Predictive and R tools.
  5. After upgrade, Site Admins should check previous setting values on the Site Admin > Settings page. They should also check the new site settings for Run PriorityData Preview for Data Catalog, and File Upload Restrictions.

Next, upgrade your Analytics Hub Engine Workers.

 

Upgrade from 2020.2.0.1e045fcf

Before You Install

Follow these steps to back up some of your files. If you’d like to do a full backup, see the Back Up and Restore article. 

  1. Open File Explorer.
  2. Copy the following files to a safe location:
    1. SslCertificates folder (Default Location: C:\Program Files\Alteryx)
    2. CutlassSettings.yml (Default Location: C:\Program Files\Alteryx\Alteryx Analytics Hub)
    3. Settings.yml (Default Location: C:\Program Files\Alteryx\Alteryx Analytics Hub)
  3. Move vfs folder (Default Location: C:\Program Files\Alteryx) to a safe location.
  4. Open Windows Command Prompt and select Run as administrator.
  5. Use this xcopy command to back up your Postgres folder:
    xcopy "<InstallLocation>\Alteryx Analytics Hub\Postgres\data" "C:\moved\data" /O /X /E /H /K
  6. When prompted Does C:\moved\data specify a file name or directory name on the target (F = file, D = directory), select D on your keyboard to create a directory.
  7. Open regedit (Windows Registry Editor).
  8. Go to HKEY_LOCAL_MACHINE\SOFTWARE\Alteryx Inc.\Alteryx Analytics Hub\HubInstallKey.
  9. Double-click InstallKey and copy the key in the Value Data field. Save the key as a text file in a safe location.
  10. Uninstall Analytics Hub:
    1. In Windows, go to Settings > Apps & features
    2. Find Alteryx Analytics Hub and select Uninstall
    3. When the Alteryx Analytics Hub window opens, select Uninstall.
    4. Select Finish. 
  11. Some files remain after uninstalling. Open File Explorer. 
  12. Go to <InstallLocation>
  13. Delete everything in the <InstallLocation> folder (Default Location: C:\Program Files\Alteryx). Your folder might be named something else. Note that this removes Alteryx Intelligence Suite, YXI tools, and Predictive and R tools.

    Install

    1. Run the Analytics Hub installer as an administrator. 
    2. Enter the installation path where Analytics Hub was previously installed (Default Location: C:\Program Files\Alteryx).
    3. Select Next.
    4. Enter the Username and Password for your database. This is the same username and password that you created for the Postgres admin during the initial installation of Analytics Hub.
    5. Select Next.
    6. Enter the same credentials that you used for your original Platform Admin.
    7. Select Next.
    8. Select Finish.

    After Installation

    1. Open Services and stop these services:
      1.  AAHBackend 
      2. AAHFrontend 
      3. Alteryx Engine Worker
      4. Alteryx License Service
      5. AlteryxPostgreSql
    2. Open regedit (Windows Registry Editor).
    3. Go to HKEY_LOCAL_MACHINE\SOFTWARE\Alteryx Inc.\Alteryx Analytics Hub\HubInstallKey and replace the value of InstallKey with the key you saved.
    4. Return the files you copied or moved to the original locations:
      1. SslCertificates folder (Default Location: C:\Program Files\Alteryx)
      2. CutlassSettings.yml (Default Location: C:\Program Files\Alteryx\Alteryx Analytics Hub)
      3. Settings.yml (Default Location: C:\Program Files\Alteryx\Alteryx Analytics Hub)
      4. vfs folder (Default Location: C:\Program Files\Alteryx)
    5. Open Windows Command Prompt and select Run as administrator.
    6. Use this xcopy command to copy your Postgres data folder back:
      xcopy "C:\moved\data" "<InstallLocation>\Alteryx Analytics Hub\Postgres\data" /O /X /E /H /K
    7. Copy pg_hba.conf from <InstallLocation>\Alteryx Analytics Hub\pg_hba.conf to <InstallLocation>\Alteryx Analytics Hub\Postgres\data\pg_hba.conf.
    8. Open Services and restart these services:
      1.  AAHBackend 
      2. AAHFrontend 
      3. Alteryx Engine Worker
      4. Alteryx License Service
      5. AlteryxPostgreSql
    9. Wait 5 minutes to allow the upgrade to complete.
    10. Sign into Analytics Hub and check your user licenses. The upgrade process sets all users to the Analytics Hub User license type. You might see an "Invalid license" error and a negative number in the Available column. To resolve the error, reassign the correct license types.
    11. Check the Data Catalog on all sites. If an error displays (Request failed with status code 400), run this SQL script on your Postgres database to resolve the issue.
    12. If previously installed, reinstall Alteryx Intelligence Suite, YXI tools, and Predictive and R tools.
    13. After upgrade, Site Admins should check previous setting values on the Site Admin > Settings page. They should also check the new site settings for Run PriorityData Preview for Data Catalog, and File Upload Restrictions.

    Next, upgrade your Analytics Hub Engine Workers.

    SQL
    1. --SQL script to resolve Data Catalog error "Request failed with status code 400"
    2. DO $$
    3. DECLARE
    4.     meta RECORD;
    5.     meta_previous RECORD;
    6.     port integer;
    7. BEGIN
    8.     FOR meta IN SELECT metadata.*, entry.entry_path FROM platform.vfs_entry_metadata metadata
    9.                     INNER JOIN platform.vfs_entry entry
    10.                         ON metadata.meta_hash = entry.metadata_hash
    11.                                AND entry.entry_path LIKE '/DataCatalog/%' ORDER BY entry.entry_path
    12.         LOOP
    13.         IF meta.meta_data->'loaded'->'dataSource'->'parameters'->>'port' IS NULL THEN
    14.             CASE meta.meta_data->'loaded'->'dataSource'->>'technology'
    15.                 WHEN 'Oracle' THEN
    16.                     port := 1521;
    17.                 WHEN 'PostgreSQL' THEN
    18.                     port := 5432;
    19.                 WHEN 'SQLServer' THEN
    20.                     port := 1433;
    21.                 WHEN 'Snowflake' THEN
    22.                     port := 443;
    23.                 WHEN 'Redshift' THEN
    24.                     port := 5439;
    25.                 WHEN 'MySQL' THEN
    26.                     port := 3306;
    27.                 ELSE
    28.                     port := NULL;
    29.             END CASE;
    30.             RAISE NOTICE 'path = %', meta.entry_path;
    31.             IF meta.meta_data->'loaded'->'dataSource'->'parameters'->>'port' IS NULL
    32.                 AND port IS NOT NULL THEN
    33.                 UPDATE platform.vfs_entry_metadata
    34.                     SET meta_data = jsonb_set( meta_data, '{loaded, dataSource, parameters, port}', to_jsonb(port))
    35.                         WHERE meta_hash = meta.meta_hash;
    36.             END IF;
    37.         END IF;
    38.     END LOOP;
    39.     FOR meta_previous IN SELECT entry_previous.entry_path, metadata.meta_hash, metadata.meta_data FROM platform.vfs_entry_metadata metadata
    40.                     INNER JOIN platform.vfs_entry_previous entry_previous
    41.                         ON metadata.meta_hash = entry_previous.meta_hash
    42.                                AND entry_previous.entry_path LIKE '/DataCatalog/%' ORDER BY entry_previous.entry_path
    43.         LOOP
    44.         IF meta_previous.meta_data->'loaded'->'dataSource'->'parameters'->>'port' IS NULL THEN
    45.             CASE meta_previous.meta_data->'loaded'->'dataSource'->>'technology'
    46.                 WHEN 'Oracle' THEN
    47.                     port := 1521;
    48.                 WHEN 'PostgreSQL' THEN
    49.                     port := 5432;
    50.                 WHEN 'SQLServer' THEN
    51.                     port := 1433;
    52.                 WHEN 'Snowflake' THEN
    53.                     port := 443;
    54.                 WHEN 'Redshift' THEN
    55.                     port := 5439;
    56.                 WHEN 'MySQL' THEN
    57.                     port := 3306;
    58.                 ELSE
    59.                     port := NULL;
    60.             END CASE;
    61.             RAISE NOTICE 'path = %', meta_previous.entry_path;
    62.             IF meta_previous.meta_data->'loaded'->'dataSource'->'parameters'->>'port' IS NULL
    63.                 AND port IS NOT NULL THEN
    64.                 UPDATE platform.vfs_entry_metadata
    65.                     SET meta_data = jsonb_set( meta_data, '{loaded, dataSource, parameters, port}', to_jsonb(port))
    66.                         WHERE meta_hash = meta_previous.meta_hash;
    67.             END IF;
    68.         END IF;
    69.     END LOOP;
    70. END $$;
    Was This Page Helpful?

    Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support. Can't submit this form? Email us.