Skip to main content

Install Connect

Alteryx Connect is an add-on to Alteryx Server and must be installed on a separate node by a member of the Administrators group.

How to Install Alteryx Connect

  1. Review the System Requirements.

  2. Download the Alteryx Connect installation package and open the installer.

    If Connect is not a downloadable product option for your account, ask your Sales representative to grant you access.

  3. Run the installer on your designated Connect Server. Select Next.

  4. Review and accept the license agreement. To accept the license agreement, select the I accept the License Agreement checkbox. Then select Next.

  5. Provide the destination folder for the application.

  6. Enter the http Port, typically 80 for HTTP, and select Next.

    Port 80 is the default value.

  7. Select Next. Then select Install to install Alteryx Connect.

    After the installer runs, the AlteryxConnect and java.exe process will both be running in the Task Manager.

  8. After you install Alteryx Connect, you have the option to set up SSL:

    • If you don’t wish to set up SSL, select Skip SSL and then select Next.

    • To set up SSL, select Set Up SSL. For more information on how to set up SSL, go to the SSL Configuration section.

  9. Select Start the Alteryx Connect service now to start the Alteryx Connect service in the background.

    • After startup, you can access the Alteryx Connect instance at http://localhost.

    • You can start Connect at a later time manually in Services.

    • The window indicates progress for starting the service, loading the configuration, loading content, and starting the service. This step takes approximately 20 minutes to complete.

  10. Select Next.

  11. Access the Alteryx Connect instance at http://localhost:80 is selected by default. Select Finish. The default administrator credentials are:

    • Username: admin

    • Password: Conn3ct!

  12. Enter the Username and Password, and then Sign In.

SSL Configuration

To make the communication between the client and server much more secure, you can make Connect run on https protocol. During the setup process or if you have already installed Connect, you have the option to Configure SSL.

  1. Select Set Up SSL on the initial setup screen. Select Next.

    If Connect is running, you have to stop the service. Select Stop service and wait until another screen appears.

  2. You can either choose Upload Existing Certificate or Generate Self-Signed Certificate.

    1. Upload Existing Certificate: To use an existing keystore or create a new one, select Upload Existing Certificate and select Next. Then enter the following:

      • https Port: the default is set to 443 unless you specify a different value.

      • Keystore password

        Note

        If you want to import a password protected PFX certificate, the password must match the keystore's password, otherwise Tomcat can't read it. If you used different values for 'srcstorepass' and 'deststorepass' parameters, you have to change the certificate password.

        keytool.exe -keypasswd -alias mypfx -keystore "c:\Program Files\AlteryxConnect\connect.keystore"

      • Keystore File Name

      • Path to Keystore. You also have the option to browse for the keystore.

      • Redirect http communication (optional): By default, you are redirected to use https if currently using http.

      Select Next.

    2. Generate Self-Signed Certificate: If you already have a keystore with a certificate, skip this step. To generate a self-signed certificate, enter the following and select Next.

      • Alias: Required. Name of the certificate in the keystore; can be a random value.

      • Domain Name: baseurl of your Connect instance; the domain name should match the URL you will use to access Connect.

      • Organizational Unit

      • Organizational Name

      • City or Locality

      • State or Province

      • Two-Letter Country Code

      • Validity Period (Days)

  3. To allow Connect to create a new signing request, enter the following and select Next. You can skip this step, for example, if you already use an existing keystore with a certificate.

    1. Alias

    2. CSR File (Certificate Signing Request file)

    3. Path to File

    All fields are required.

  4. To Import certificates, you need to manually enter the following information and select Next:

    1. Alias

    2. Certificate File

    3. Path to File

    All fields are required.

  5. On the next page, leave the checkbox Start the Alteryx Connect service now selected and select Next.

  6. You will get a notification that the service is up and running. Select Next.

  7. On the next page, select Finish to open Connect in your browser.

For a more detailed description of how to set up SSL, go to the Community article How To: Enable SSL in the Connect Installer. It is valid for versions 19.1 and higher.

Import a PFX Certificate

Currently, the Connect installer only supports self-signed certificates.

Prerequisites

  • Connect version 19.1 or higher.

  • PFX file containing both private key and public key.

  • If you do not have a PFX file, see Installation Troubleshooting.

Follow these steps to import a Certificate Authority (CA) signed certificate after enabling SSL with the Installer. Note that the values on your configuration might be different from those used here.

  1. Enable SSL as described in SSL Configuration or in the Community article How To: Enable SSL in the Connect Installer.

  2. Make sure your Connect instance is able to start and run using the https protocol.

  3. Open the command line and navigate to the folder containing keytool.exe:

    cd "c:\Program Files\AlteryxConnect\jre\bin" 

    To manipulate a file in Program files, you might have to Run the Command Prompt as Administrator to have the elevated permissions.

  4. List all keys in your keystore:

    keytool.exe -list -keystore "c:\Program Files\AlteryxConnect\connect.keystore" -storepass password 

    In the keystore you should see the private and public key.

    Note

    Before creating backup of the .keystore file and deleting the old certificate, it is necessary to stop Alteryx Connect service.

  5. To use a different private key, you have to remove the self-signed one first. Before removing, backup the keystore:

    copy "c:\Program Files\AlteryxConnect\connect.keystore" "c:\Program Files\AlteryxConnect\connect_bckp.keystore" 

  6. Remove the PrivateKeyEntry using the alias as identification:

    keytool.exe -delete -alias mycert -keystore "c:\Program Files\AlteryxConnect\connect.keystore" -storepass password 

  7. Verify the certificate has been removed by listing the content of the keystore as demonstrated in step 4.

  8. Import your PFX file.

    • The file is most likely password protected. Don't forget to change the value of 'srcstorepass' and 'deststorepass' parameters.

      Note

      The certificate password must match the keystore's password, otherwise  Tomcat will not be able to read it. If you used different values for 'srcstorepass' and  'deststorepass' parameters, you have to change the certificate password.

      keytool.exe -keypasswd -alias mypfx -keystore "c:\Program  Files\AlteryxConnect\connect.keystore" 

      You have to provide: Keystore password, password for the certificate, and new  password for the certificate. Then re-type the new password for the certificate.

    • You might need to change the 'srcalias' as your key might have a different one. The easiest way would be to omit both 'srcalias' and 'destalias' and list keystore. The alias will likely remain the same.

      keytool.exe -importkeystore -srckeystore "c:\mycerts\pkcs12\ServerName.pfx" -srcstoretype pkcs12 -destkeystore "c:\Program Files\AlteryxConnect\connect.keystore" -deststoretype JKS -srcalias 1 -destalias mypfx -srcstorepass servername -deststorepass password 

  9. Verify the certificate has been imported successfully. The type of the certificate has to be 'PrivateKeyEntry'.

  10. Restart the Alteryx Connect service. Connect will start using the new certificate from the PFX file.

It might be necessary to reopen web browser and clear browser cache to make new certificate works.

For more information, see the Community article How To: Import a PFX Certificate.

Configuration

  1. Enter the User name and Password and Sign In.

  2. Connect will then prompt you for initial configuration steps for:

    • Admin Password - enter a password for the default administrator

    • H2 Password - enter a password for the H2 user. For more information about Asset recommendation, Use CDN for JS & CSS Files, and other instance settings, visit the Settings help page.

    • Instance Settings - Enter the base URL to access the site. This may be the machine name or a DNS name.

    • SMTP Settings - Enter the SMTP Server Name, Protocol (SSL/TLS), default email to send mail as, and credentials to the SMTP server if required.

  3. Change the default administrator password:

    • Select your icon in the top-right of the screen and select My Profile.

    • In the Superadmin Information section, type the default administrator password and set and confirm a new password.

    • Select Save.

To load data asset metadata, configure users, and perform other administrative tasks, see Administer Connect.

Installation Troubleshooting

I can't access the Alteryx Connect URL.

Wait at least ten minutes for the Alteryx Connect service to initialize before trying to access Alteryx Connect. If you still cannot access the URL, check to see if the Alteryx Connect service is running:

  1. Open the Windows Task Manager.

  2. Select the Services tab.

  3. Find AlteryxConnect in the list. Its status should be "Running". If it shows "Stopped", proceed to the next step.

  4. Select Services.

  5. In the list of services, select Alteryx Connect.

  6. Select Start.

Alteryx Connect appears to be frozen.

Try the following:

  • Restart the AlteryxConnect service:

    1. Open the Windows Task Manager.

    2. Select the Services tab.

    3. Select Services.

    4. In the list of services, select Alteryx Connect.

    5. Select Restart.

  • Shut down and restart the Alteryx Connect server:

    1. Go to <installation_path>\bin. The default installation path is C:\Program Files\AlteryxConnect.

    2. Execute shutdown.bat, followed by startup.bat.

In this section: