Skip to main content

Use Command-Line Options

Command-line options are provided for IT departments to install and activate Alteryx without the need for user intervention. This can be helpful for installs to large user bases, software updates pushed to computers on a regular schedule, or automated setup of new desktop machines.

Install and License Alteryx Products

The AlteryxActivateLicenseKeyCmd.exe is stored in the bin directory of the Alteryx install. This command performs certain licensing functions described below.

Install Designer

AlteryxInstallx64_.exe [options]

Run the command-line options from the directory where the Alteryx install executable is saved.

Important

As of the 2022.3 release, Alteryx Designer, Server, and the R Predictive tools use new installer technology. The updated installer detects your operating system language and installs Alteryx products in that language (if applicable). It installs the English version otherwise.

  • In order to upgrade to the 2022.3 version, you must be on version 2020.3 or newer. If you are currently on a version that is older than 2020.3, you must first upgrade to at least 2020.3 before you can upgrade to 2022.3.

  • You can't roll back from the 2022.3 version to a prior version automatically. You must first manually uninstall 2022.3. This will not be a limitation going forward.

  • R is not automatically uninstalled when you upgrade or uninstall Designer and Server. This is not an issue if you upgrade your R version at the same time as Designer and Server.

    • If R is detected when you install Designer and Server, the installer will notify you.

    • If you uninstall Designer and Server, you'll be reminded to remove R.

Designer Version 2022.3 and Newer

Option

Parameters

Description

-x

/x

N/A

Uninstall the product.

AlteryxInstallx64_2022.x.x.xxxxx.exe -x

-s

/s

N/A

Silent install or uninstall of the product. If you don't use this option, the installer user interface opens.

AlteryxInstallx64_2022.x.x.xxxxx.exe -s

-d

/d

"<path>"

Specify the install location (directory). Quotes are required.

AlteryxInstallx64_2022.x.x.xxxxx.exe -d "C:\PROGRAM FILES\Alteryx"

-m

/m

"<path>"

Create MSI log file (typically used for troubleshooting). Specify a file name and a location to save the file. Quotes are required.

AlteryxInstallx64_2022.x.x.xxxxx.exe -m "C:\temp\msi_install.log"

-l (L)

/l

"<path>"

Create a bootstrapper log file (typically used for troubleshooting). Specify a file name and a location to save the file. Quotes are required.

AlteryxInstallx64_2022.x.x.xxxxx.exe -l "C:\temp\bootstrapper.log"

Designer Version 2022.2 and Older

Option

Parameters

Description

/s

Suppresses all dialogs.

AlteryxInstallx64_2020.x.x.xxxxx.exe /s

RInstaller\RInstaller_2020.x.x.xxxxx.exe /s

/l

"<path>"

Creates a log file with information about the install.

Include the full path name including the drive letter and existing folder name.

/l="C:\temp\install.log"

Log files might increase installation time.

REMOVE

TRUE

FALSE

(Optional) If True, only the uninstall of an existing product is performed. If False or blank, previous versions are uninstalled before the install of the new product proceeds.

SERIAL_NUM

"Serial Number"

(Optional) Quotes are required. Sets the serial number (email address) on the machine.

Should be set to an email address the license will be registered to during licensing.

SERIAL_NUM="serial number"

TARGETDIR

"<path>"

(Optional) Quotes are required. Sets the install directory for Alteryx, Data Products, Scheduler, and Core Components.

TARGETDIR="<path>"

Default Designer/Server Installs: C:\Program FIles\Alteryx

Designer Non-Admin: C:\Users\<current user>\AppData\Local\Alteryx

Example:

AlteryxInstallx64_2020.x.x.xxxxx.exe /s /l="C:\temp\install.log" TARGETDIR="C:\Program Files\Alteryx"

ALLUSERS

"TRUE"

"FALSE"

(Optional) Quotes are required. Allows shortcuts to install for all users on the system.

ALLUSERS="TRUE"

Default: "FALSE" for Non-Admin installs and "TRUE" for Admin installs.

CMD_LANGUAGE

"English"

"Français"

"Deutsch"

"Português" "Español" "Japanese"

(Optional) Quotes are required. Sets the language of the install.

Default: English

Example:

AlteryxInstallx64_2020.x.x.xxxxx.exe /s CMD_LANGUAGE=”Français”

Install Data

DataInstallCmd.exe [options]

Run the command line DataInstallCmd.exe from the directory where the data install executable is saved.

Option

Parameters

Description

/Install

all,

<product>:<dataset name>, <product>: all

For example, /Install all, is /Install AlteryxMap:all

Installs all products available in the co-located DataInstall.ini file or a subset specified by specific product and/or dataset name.

D:\Data\DataInstallCmd.exe /s /Install all

/Uninstall

all,

<product>:<dataset name>, <product>:all

Uninstalls the given datasets.

D:\Data\DataInstallCmd.exe /s /Uninstall "CASS:CASS - October 2010"

/Replace

all, <product>: <dataset name>, <product>:all

Replaces older vintages of datasets with new versions specified in the DataInstall.ini file.

/Path

<install_path>

Requires quotes if the path contains spaces. Sets the path for the installed data.

DataInstallCmd /s /Install "Portfolio:US Census Data" /Path "C:\Alteryx\Data"

/Log

<log file>

Sets the file name for the install log.

\\network\path\DataInstallCmd /s /RegisterNetwork /Log

"C:\temp\logfile\log1.txt"

/PrepareNetwork

Prepare a Network install. This requires that /Replace or /Install be used to identify the installation files and /Path <install path> be set. It cannot be used in conjunction with /RegisterNetwork. It has no meaning with /Uninstall.

DataInstallCmd /s /PrepareNetwork /Replace "CASS:all" /Path "C:\Alteryx\Data" /Log "C:\temp\logfile\log1.txt"

/RegisterNetwork

Register from a Network Location. This requires that a /PrepareNetwork has been done and is being run from the Net location described by the /Path in /PrepareNetwork. It cannot be used with /Install, /Replace, or /Uninstall. /Path has no meaning in this context.

Valid Products include AlteryxMap, CASS, Calgary, Explorer, Guzzler, Portfolio, StreetWare, Zip9Coder, CanadaCentroidCoder. The DataInstall uses datasets specified in DataInstall.ini that are located in the same directory as the executable.

Standard License System

Activate License Online

AlteryxActivateLicenseKeyCmd.exe

The Alteryx command-line executable AlteryxActivateLicenseKeyCmd.exe is stored in the bin directory (for example, C:\Program Files\Alteryx\bin) of the Alteryx install.

Usage

Syntax/Example

Description/Parameters

*Activate a license key on a machine.

AlteryxActivateLicenseKeyCmd.exe [license key] [email address]

Activates a license key for a machine.

Required: license key, email address

*Activate multiple license keys on a machine.

AlteryxActivateLicenseKeyCmd.exe [license key] [license key 2] [license key n] [email address]

Activates one or more license keys for a machine.

Required: license key, email address

*Internet access is required.

Activate License Offline (File Activation)

AlteryxActivateLicenseKeyCmd.exe

The Alteryx command-line executable AlteryxActivateLicenseKeyCmd.exe is stored in the bin directory (e.g., C:\Program Files\Alteryx\bin) of the Alteryx install.

Usage

Syntax/Example

Description/Parameters

Generate license request file.

AlteryxActivateLicenseKeyCmd.exe [license key 1] [license key 2] [license key n] [email address] createRequest [filename].

The system creates a request file. The request file is used to create an activation (.bin) file.

Alteryx creates a request file with the extension .req as shown in this example:

name@company.com.req

  • Required: license key, email address

  • Optional: filename

Include the full path name, including drive letter and existing folder name:

AlteryxActivateLicenseKeyCmd.exe 111a-12ab-aa12-3abc-12a1-1234-1ab1-123c name@company.com createRequest c:\temp\name@company.com.req

Upload the request file to the Alteryx Downloads and Licenses portal.

  1. Sign in to the Alteryx Downloads and Licenses portal at http://licenses.alteryx.com/

  2. On the Home page, select Upload Activation Request.

  3. Select Browse to find and select the request (.req) file.

  4. Select to upload the request (.req) file.

Load license activation file.

AlteryxActivateLicenseKeyCmd.exe [filename]

The system loads the license activation file and activates the license.

Required: filename

*Internet access is required.

Deactivate License

AlteryxActivateLicenseKeyCmd.exe

The Alteryx command-line executable AlteryxActivateLicenseKeyCmd.exe is stored in the bin directory (e.g., C:\Program Files\Alteryx\bin) of the Alteryx install.

Usage

Syntax/Example

Description/Parameters

*Delete a license key from a machine.

AlteryxActivateLicenseKeyCmd.exe [license key] delete

Removes a license key from a machine and frees up the license for use on another machine.

*Delete all license keys from a machine.

AlteryxActivateLicenseKeyCmd.exe delete

Removes all license keys from a machine and frees up licenses for use on another machine.

*Internet access is required.

List License Keys

AlteryxActivateLicenseKeyCmd.exe

The Alteryx command-line executable AlteryxActivateLicenseKeyCmd.exe is stored in the bin directory (for example, C:\Program Files\Alteryx\bin) of the Alteryx install.

Usage

Syntax/Example

Description/Parameters

List license keys on a machine.

AlteryxActivateLicenseKeyCmd.exe list

Displays the product name and license key for each active license.

Change License System

AlteryxActivateLicenseKeyCmd.exe

Note

You need administrative rights to run these commands.

You can use the command line to change the license system for a machine from standard to local license server (LLS). If you change the license system, the user of the machine will lose access to any active licenses for that license system. The licenses will be available to the user if you change the system back again.

For more information, visit Manage Licenses in Alteryx Designer.

The Alteryx command-line executable AlteryxActivateLicenseKeyCmd.exe is stored in the bin directory (for example, C:\Program Files\Alteryx\bin) of the Alteryx install.

Usage

Syntax/Example

Description/Parameters

Change to local license server for a machine.

AlteryxActivateLicenseKeyCmd.exe setLicenseServerSystem [URL] [email]

Sets the license system to local license server (LLS).

Required: Email

This is the email address or serial number associated with the machine.

Optional: URL

Sets the URL for the local license server (LLS). If not defined, the user enters the URL in the Manage Licenses window.

Change to standard license system for a machine.

AlteryxActivateLicenseKeyCmd.exe setStandardLicenseSystem

Sets the license system to standard.

Administer Alteryx License Server

Use License Server

flexnetls.bat

Run the -flexnetls.bat -help command from the server folder to view available commands:

C:\Program Files\Alteryx\LicenseServer\server>flexnetls.bat -help

flexnetlsadmin.bat

Run the -flexnetlsadmin.bat -help command from the enterprise folder to view available commands:

C:\Program Files\Alteryx\LicenseServer\enterprise>flexnetlsadmin.bat -help

Note

As of Alteryx License Server version 2021.4, admins can change the maximum borrow interval for a served seat to a client. This can be done with -config -set licensing.borrowIntervalMax=[n+u].

See the License Server Policy Settings from the FNE License Server Admin Guide for more details.

LicenseServerAdminCmd.exe

Run the LicenseServerAdminCmd.exe -help command from the enterprise folder to view available commands:

C:\Program Files\Alteryx\LicenseServer\enterprise>LicenseServerAdminCmd.exe -help

Use License Keys Mapped Onto a License Server

LicenseServerAdminCmd.exe

The Alteryx command-line executable LicenseServerAdminCmd.exe is stored in the enterprise folder (for example, C:\Program Files\Alteryx\LicenseServer\enterprise) of the Alteryx License Server install.

Usage

Syntax/Example

Description/Parameters

List license keys on a machine.

C:\Program Files\Alteryx\LicenseServer\enterprise>LicenseServerAdminCmd.exe -s [server URL] -u admin -p [admin password] -l

Example:

C:\Program Files\Alteryx\LicenseServer\enterprise>LicenseServerAdminCmd.exe -s http://BF-LT-192:7070 -u admin -p Admin1234# -l

Displays the product name and license key for each active license.

In this section: