Customer Center
Help Topics
Self-Help Guides
Home > Archive > Support > New Users > Reference Guide > Command Line Installation for Hosting Partners

Command Line Installation for Hosting Partners

Overview

The SmartVault Desktop software (also known as the “SmartVault client”) can be installed using command-line options. These options allow SmartVault Hosting partners to modify the installation behavior of the SmartVault Desktop software.

If you are a SmartVault Hosting partner, please review the following information before you begin using the SmartVault Desktop software command-line options:

Before you Begin

Before running the SmartVault Desktop software installer in silent mode, review all command-line options to ensure the installer will use the settings you want. Some command-line options are targeted for usage by specific partner types.

  • If you run the install file without reviewing/editing the command-line options, any pre-existing settings may be replaced.
  • If you need to change settings specified during an installation, you can reinstall to change the settings, or in some cases, directly change the settings by editing registry values.
  • If you have questions about the command-line installation, please contact SmartVault Support.

Understanding the SmartVault Desktop Software Installer

The SmartVault Desktop Client installation package is created using Install Aware Studio software. Packages created by Install Aware Studio can be installed in a silent (quite) mode using a command line /s switch. Install Aware Studio does not support the concept of an answer file for silent installation, but it does allow some standard and custom variable values to be passed as arguments to the installer.

If there is any instance of SmartVault Desktop client running on the computer, the installer will exit without installing.

By default, quiet mode expects the target install directory to already exist, unless you specify FOLDERANS=YES. For more information about this option, see FOLDERANS=YES/NO.

SmartVault Desktop Software Command Line Options

The SmartVault Desktop software supports the command-line options listed in this section.

 

Note: Program file locations are different for 32-bit and 64-bit hosts. 64-bit Windows uses%programfiles(x86)%SmartVault for 32-bit applications. Any registry key values referred to in this section may be located in the Wow6432Node registry path on computers running 64-bit Windows.
 

/s — Recommended option. This option runs the SmartVault Desktop software installation in silent mode. (No installation UI displays.)

 

/l="<drive:path><filename>" — Recommended option, especially when running in silent mode. This option enables logging to the specified path and file location.


/DISABLEUPDATES — Recommended for SmartVault Hosting partners only. If used, this switch disables the automatic update feature for the SmartVault Desktop software. NOTE: This switch also disables the menu that includes the Fix QuickBooks Registration option.


Notes:

  • This adds the registry entry at: HKLMSoftwareSmartVaultDisableUpdates with a value of = 1.
  • Existence of the key, regardless of data, disables updates.
     

TARGETDIR ="<Custom_path>" — This option specifies the target directory for the installation.

Note: If the target directory does not exist, you must supply FOLDERANS=YES to create it.

 

FOLDERANS=YES/NO — Recommended value: YES. If ‘yes’, the installer creates the target directory if it does not already exist. If ‘no’ and path doesn’t exists, installer exits.

 

ALLUSERS=TRUE/FALSE — Recommended value: TRUE. Specifies the application access mode, other than default.

 

INBOXSHORTCUT=TRUE/FALSE — Recommended value: TRUE. Specifies whether or not to create a SmartVault Inbox shortcut on the Windows Desktop.

 

LAUNCHPADSHORTCUT=TRUE/FALSE — Recommended value: FALSE. Specifies whether or not to create a SmartVault Launchpad shortcut on the Windows Desktop.

 

PORTALSHORTCUT=TRUE/FALSE — Recommended value: TRUE. Specifies whether or not to create a SmartVault client portal shortcut on the Windows Desktop.

 

OPENLAUNCHPAD=TRUE/FALSE — Recommended value: FALSE. Specifies whether or not to open the SmartVault Launchpad after the installation is complete.


SHOWSIGNUP=TRUE/FALSE — Recommended value: TRUE. This value enables or disables the ‘Sign Up’ capability from the SmartVault Desktop client. If not specified, the value defaults to FALSE.

 

SHOWSIGNUPTOALLUSERS=TRUE/FALSE — Recommended value: TRUE. This value works in conjunction with theSHOWSIGNUP option. It enables or disables the ‘Sign Up’ capability from the SmartVault Desktop client for all Windows users. If False, only the installing user will see signup. If True, every Windows user will see sign up. If not specified, the value defaults to False.

 

Notes:

  • This affects the registry entry at: HKLMSoftwareSmartVaultSignUpShowSignup, where ‘False’ = disabled, ‘True’ = ‘enabled’ and non-existence = ‘False’.
  • This affects only one user unless combined with the SHOWSIGNUPTOALLUSERS option.
  • This affects the registry entry at: HKLMSoftwareSmartVaultSignUpShowSignupToAllUsers, where ‘False’ = disabled, ‘True’ = ‘enabled’ and non-existence = ‘False’.
  • When enabled, each user has a registry key to determine whether or not to show for that specific user. For more information about this option, see SHOWSIGNUPTOALLUSERS Option Additional Information.

 

SHOWOFFER=TRUE/FALSE — Recommended value: TRUE. This value works in conjunction with the SHOWSIGNUPoption. It shows or suppresses partner information on the Desktop client ‘Sign Up’ dialog. If True, partner information is shown. If False, it’s not shown. If not specified, the value defaults to FALSE.

Note: This affects the registry entry at: HKLMSoftwareSmartVaultSignUpShowOffer, where ‘False’ = disabled (show simplified dialog), ‘True’ = enabled (show Partner info), and nonexistence = ‘False’.

 

REFERRALCODE=<any_valid_partner_code> — For participants in SmartVault partner programs (SmartAffiliates, Solution Providers, Development partners, Hosting partners). When a Windows user signs up for SmartVault from thie SmartVault web site, this value gives referral credit to the owner of the code specified. If not specified, no referral is given.

Note: This affects the registry entry at: HKLMSoftwareSmartVaultSignUpReferralCode.

 

PARTNERNAME="<your_company_name>" — Works in conjunction with the SHOWOFFER option. If SHOWOFFER is True, this value is used in the Desktop client ‘Sign Up’ UI. If not specified, the UI defaults to use ‘SmartVault’.

 

Note: This affects the registry entry at: HKLMSoftwareSmartVaultSignUpPartnerName

LEARNMOREURL="<your_company_name>" — Works in conjunction with the SHOWOFFER option. If SHOWOFFER is True, this value is used in the Desktop client ‘Sign Up’ UI for the ‘Learn More’ URL. If not specified, the UI defaults to use http://www.smartvault.com/features.

Note: This affects the registry entry at: HKLMSoftwareSmartVaultSignUpLearnMoreUrl

 

FIRSTNAME="<some_first_name_value>" — Used by Development partners only.This is used when passing user information into the SmartVault Desktop installer to pre-populate some sign up information.

Note: This affects the registry entry at: HKLMSoftwareSmartVaultSignUpFirstName

 

LASTNAME="<some_last_name_value>" — Used by Development partners only. This is used when passing user information into the SmartVault Desktop installer to pre-populate some sign up information.

Note: This affects the registry entry at: HKLMSoftwareSmartVaultSignUpLastName

 

EMAIL="<some_email_address_value>" — Used by Development partners only. This is used when passing user information into the SmartVault Desktop installer to pre-populate some sign up information.

Note: This affects the registry entry at: HKLMSoftwareSmartVaultSignUpEmail.

 

PHONE="<some_phone_number_value>" — Used by Development partners only. This is used when passing user information into the SmartVault Desktop installer to pre-populate some sign up information.

Note: This affects the registry entry at: HKLMSoftwareSmartVaultSignUpPhone.

 

COMPANYNAME="<some_company_name_value>" — Used by Development partners only. This is used when passing user information into the SmartVault Desktop installer to pre-populate some sign up information.

Notes:

  • This value is used as the SmartVault account name when signing up.
  • This affects the registry entry at: HKLMSoftwareSmartVaultSignUpCompanyName

Option Additional Information

The SHOWSIGNUPTOALLUSERS option determines whether ‘Sign up’ is shown and tracked for a single user or independently for all users.

This capability is designed for Hosting partners deploying the SmartVault Desktop software on servers where multiple Windows users log in.

 

If SHOWSIGNUPTOALLUSERS is disabled, ‘Sign up’ capability is only shown to one user, and when that user completes sign up or sign in, future ‘Sign up’ prompts are suppressed.

If enabled for all users, sign up will be shown for every Windows users and tracked on a per-user basis in the user’s registry.

This is tracked by the registry entry at: HKey_Current_UserSoftwareSmartVaultSignUpShowSignup, where ‘False’ = doesn’t show sign up, ‘True’ = does show sign up, and non-existence = ‘True’.

Command-Line Options Specific to Hosting Partners

SmartVault Hosting partners leverage a subset of command-line options, many targeted at controlling the sign up capabilities available from the SmartVault Desktop software.

Before hosting partners install the SmartVault Desktop software from a command line, typically a few business and technical decisions must be made. SmartVault recommends that Hosting partners consider the following questions in order to help them design the SmartVault Desktop software deployment plan appropriate for their environment:

  • Do you want to allow your hosted users update the version of the SmartVault Desktop software? If no, then you’ll want to disable updates.
  • Do you want SmartVault Desktop software shortcut icons on every users desktop? If no, then you’ll want to disable each shortcut.
  • Do you want to enable SmartVault Desktop software ‘sign up’ capabilities? If yes, you want to showsignup.
  • When enabling sign up, which referral code should be used for sign ups?
  • When enabling sign up, do you want to show the ‘offer’ text? If yes, you’ll need a little company specific information.
  • When showing the offer, what URL do you want to use for the “Learn More” link?

The answers to these questions will determine which command-line parameters to use and Hoster specific values for them. Generally, SmartVault recommends using the following options:

  • DISABLEUPDATES – Hosting partners want to control software updates on hosts in most hosted environments. If this statement is true in your environment, disable SmartVault Desktop software updates. NOTE: This switch also disables the menu that includes the Fix QuickBooks Registration option.
  • OPENLAUNCHPAD=FALSE – Use this option so that SmartVault is not launched upon installation finish.
  • SHOWSIGNUP and SHOWSIGNUPTOALLUSERS – Use these options to enable Sign Up.
  • REFERRALCODE – Ensure sign ups are linked to your partner referral code.
  • SHOWOFFER – Use this option enable showing offer text on sign up dialog.
  • PARTNERNAME – Use this option to show your company’s name on the offer dialog.
  • LEARNMOREURL – Use this option to specify the web page you want to display when users click the Learn More link.

SmartVault recommends that you work with SmartVault Support and the SmartVault Hosting Program Manager to ensure you choose the parameters best for your business.

Command-Line Examples for SmartVault Hosting Partners

This section provides some command-line examples for SmartVault Hosting partners.

 

Example 1: Command-Line for a Hosting Partner Installing on 32-bit Windows

Highlights of this example are:

  • Disables updates, so hosted users are not prompted to update the SmartVault Desktop software
  • Places three shortcuts on every user’s desktop
  • Enables sign up for all users, so every windows user is shown the sign up prompt
  • Shows offer text on the sign up dialog, so Hosting company name is shown
  • Uses the partner’s referral code
  • Specifies a URL to the hosting partner’s web site


SmartVaultSetup /s /l="%TEMP%smartvaultinstall.log" /DISABLEUPDATES
TARGETDIR="%programfiles%SmartVault" FOLDERANS=YES ALLUSERS=TRUE
INBOXSHORTCUT=TRUE LAUNCHPADSHORTCUT=TRUE
PORTALSHORTCUT=TRUE OPENLAUNCHPAD=FALSE SHOWSIGNUP=TRUE
SHOWSIGNUPTOALLUSERS=TRUE SHOWOFFER=TRUE
REFERRALCODE=HostingPartnerCode PARTNERNAME="HostingPartnerName,
Corp." LEARNMOREURL="http://www.HostingPartner.com/learnm...utHostingandSV"

 

Example 2: Command-Line Installation for a Hosting Partner Installing on 64-bit Windows

Highlights of this example are:

  • Disables updates, so hosted users are not prompted to update the SmartVault Desktop software
  • Places three shortcuts on every user’s desktop
  • Enables sign up for all users, so every Windows user is shown the sign up prompt
  • Shows offer text on the sign up dialog, so Hosting company name is shown
  • Uses the partner’s referral code
  • Specifies a URL to the hosting partners web site

SmartVaultSetup /s /l="%TEMP%smartvaultinstall.log" /DISABLEUPDATES
TARGETDIR="%programfiles(x86)%SmartVault" FOLDERANS=YES
ALLUSERS=FALSE INBOXSHORTCUT=TRUE LAUNCHPADSHORTCUT=TRUE
PORTALSHORTCUT=TRUE OPENLAUNCHPAD=FALSE SHOWSIGNUP=TRUE
SHOWSIGNUPTOALLUSERS=TRUE SHOWOFFER=TRUE
REFERRALCODE=HostingPartnerCode PARTNERNAME="HostingPartnerName,
Corp." LEARNMOREURL="http://www.HostingPartner.com/learnm...utHostingandSV"

 

Example 3: Command-line for a Hosting Partner installing on 64-bit Windows

Highlights of this example are:

  • Disables updates, so hosted users are not prompted to update the SmartVault Desktop software
  • Places three shortcuts on every user’s desktop
  • Enables sign up for all users, so every Windows user is shown the sign up prompt
  • Does not show offer text on the sign up dialog, and thus does not display Hosting parnter name or Learn More URL


SmartVaultSetup /s /l="%TEMP%smartvaultinstall.log" /DISABLEUPDATES
TARGETDIR="%programfiles(x86)%SmartVault" FOLDERANS=YES
ALLUSERS=FALSE INBOXSHORTCUT=TRUE LAUNCHPADSHORTCUT=TRUE
PORTALSHORTCUT=TRUE OPENLAUNCHPAD=FALSE SHOWSIGNUP=TRUE
SHOWSIGNUPTOALLUSERS=TRUE SHOWOFFER=FALSE
REFERRALCODE=HostingPartnerCode


Retired SmartVault Desktop Software Command-Line Options

The options in this section are effectively retired and no longer used.

RESELLERID=<your_reseller_id> — This value should be your Reseller ID, and each Reseller has a unique value.

Notes:

  • This affects the registry entry at: HKLMSoftwareSmartVaultResellerId
  • Although this value continues to work, the Reseller Program from 2009 has been retired and this key is not needed.

 

Considerations

If you have questions regarding this page, please contact our support team.

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.