You can install the Series 3 versions of the Excel Add-in via the command line. This is useful if you want to install the Excel Add-in for many users consistently.
The MSI file for the relevant version of the Excel Add-in is required to install the Excel Add-in via the command line. See Downloads.
You should be proficient with the command prompt before you install the Excel Add-in with it. This information is intended for IT teams who want to install the Excel Add-in for multiple users.
You must have administrator permissions for Windows Installer in order to install the Excel Add-in via the command line. Ensure that you open the command prompt as an administrator.
View the full list of installation options
A large number of installation options are available when you install the Anaplan Excel Add-in via the command line. You can use a universal Windows command to see the options in Windows Installer.
To view the full list of options:
- Open Command Prompt.
Right-click Command Prompt and select Run as administrator to ensure you have administrator permissions. - Navigate to the folder that contains the MSI file for the version of the Excel Add-in you want to install. This is the Downloads folder by default.
Alternatively, you can specify the full file path for the installer after themsiexeccommand in the next step. - Use the command
msiexecto run the MSI file.
The Windows Installer dialog displays. It contains a full list of the options you can use for your installation.
An example command for this procedure is msiexec "C:\Users\AnaplanUser\Downloads\AnaplanExcelAddin.Release.msi"
Useful installation options
This table contains some useful installation options from the full list. Some are universal options in Windows, and some apply only to the Excel Add-in.
| Installation option | Purpose | Example |
/i | Install the add-in. | msiexec /i "C:\Users\AnaplanUser\Downloads\AnaplanExcelAddin.Release.msi" |
/q | Perform a quiet installation of the add-in, with no installation wizard. | msiexec /i "C:\Users\AnaplanUser\Downloads\AnaplanExcelAddin.Release.msi" /q |
/qr | Perform a quiet installation of the add-in, with only a progress bar and no final window. Also enables installation without administrator permissions. | msiexec /i "C:\Users\AnaplanUser\Downloads\AnaplanExcelAddin.Release.msi" /qr |
/x | Uninstall the add-in. | msiexec /x "C:\Users\AnaplanUser\Downloads\AnaplanExcelAddin.Release.msi" |
APPDIR="" | Install the add-in to a specified directory. | msiexec /i "C:\Users\AnaplanUser\Downloads\AnaplanExcelAddin.Release.msi" APPDIR="C:/Users/Anaplan/Add-in Folder" |
AUTH_SELECTION="" TXT_SSONAME="" | Select authentication type (SSO or username and password) and provide SSO Friendly URL for installation. If you do not provide this option, installation defaults to username and password authentication. | Msiexec /i “C:\Users\AnaplanUser\Downloads\AnaplanExcelAddin.Release.msi” AUTH_SELECTION=“Auth_SSO” TXT_SSONAME="SSO Friendly URL" /qr |
ALLUSERS="" MSIINSTALLPERUSER="" | Specify which users in Windows to install the add-in for. Learn more about ALLUSERS and MSIINSTALLPERUSER. | Msiexec /i “C:\Users\AnaplanUser\Downloads\AnaplanExcelAddin.Release.msi” ALLUSERS="2" MSIINSTALLPERUSER="1" |
Command line installation with the MSI file
You can simply double-click the MSI file in Windows to perform a standard installation. However, if you use the command line, you can customize your installation with further options explained on this page.
Use this procedure as a basis for other types of installation:
- In the start menu, right-click Command Prompt and select Run as administrator.
- Locate the MSI file for the version of the Excel Add-in you want to install. This is the Downloads folder by default.
You can hold shift and right-click the file to copy its path. - Use the command
msiexecand additional tags to run the MSI file.
The type of installation depends upon the tags you use.
Quiet installation with reduced UI
you can perform a quiet installation of the add-in. This means that the Excel Add-in installs with no installation wizard, only a progress bar. This type of installation does not require administrator permissions.
Use the command msiexec and the additional tags /i and /qr to perform a quiet installation of the Excel Add-in with reduced UI. Only a progress bar displays, with no installation wizard, because the /qr tag is used.
An example command for this procedure is:
msiexec /i "C:\Users\AnaplanUser\Downloads\AnaplanExcelAddin.Release.msi" /qr
Installation to a specific directory
The default installation location of the Excel Add-in is C:/ProgramData/Anaplan/ExcelAddIn. However, you can install the Excel Add-in to any location.
Use the command msiexec and the additional tags /i and APPDIR="" to install the Excel Add-in to a specific directory. Enter the directory to install the Excel Add-in to between the quotation marks. When you execute the command, the ExcelAddin Setup wizard displays.
An example command for this procedure is:
msiexec /i "C:\Users\AnaplanUser\Downloads\AnaplanExcelAddin.Release.msi" APPDIR="C:/Users/AnaplanUser/Add-in Folder"
Install for all users with SSO preconfigured
It's possible to install the add-in for all users in a Windows configuration with SSO preconfigured. Use this to simplify configuration of the add-in for users.
Use the command msiexec and the additional tags /i, ALLUSERS="", MSIINSTALLPERUSER="", AUTH_SELECTION="Auth_SSO", TEXT_SSONAME="SSO Friendly Name" and /qr to run the MSI file. Replace SSO Friendly Name with the SSO Friendly Name for your SSO configuration. Only a progress bar displays, with no installation wizard, because the /qr tag is used.
An example command for this procedure is:
msiexec /i "C:\Users\AnaplanUser\Downloads\AnaplanExcelAddin.Release.msi" ALLUSERS="2" MSIINSTALLPERUSER="1" AUTH_SELECTION=“Auth_SSO” TXT_SSONAME=YourSSOFriendlyName /qr