Everything You Need To Know About Installing The uPerform Editor

Installation Parameters and Properties

The parameters described in the following table can be used when running the delivered installation executable. Some of these properties exist in the .msi file and their defined value is used when the .msi file is run. Others are parameters that are passed to the Windows Installer service to control whether a log file is created or how much of the user interface is displayed.

Command-line options that require a parameter must be specified with no space between the option and its parameter. For example, ANCILE_uPerform_Client_5.XX.x.x.full.exe /v"ALLUSERS=2" is valid, while ANCILE_uPerform_Client_5.XX.x.x.full.exe /v "ALLUSERS=2" is not. Quotation marks around an option’s parameter are required only if the parameter contains spaces. If a path within a parameter contains spaces, you will need to use a slash character to escape the inner set of quotation marks, as in the following example:

ANCILE_uPerform_Client_5.XX.x.x.full.exe /v"INSTALLDIR=\"c:\My Files\""

Property Name	Possible Value(s)	Usage Example/Description
COMPANY NAME	The value for this field is provided by ANCILE Solutions, Inc. and is the company name under which uPerform was licensed.	COMPANYNAME="ANCILE Solutions, Inc." When passed on the command line to the setup package, the value should be wrapped in quotation marks if it contains spaces. This property populates the "Company Name" field on the Customer Information dialog.
PRODUCT_ID	The value for this field is provided by ANCILE Solutions, Inc..	PRODUCT_ID=XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX This property populates the "Product Key" field on the Customer Information dialog.
MIGRATION_ TOOL	Blank or 1	The Migration Wizard is installed by default. To not install the Migration Wizard, use MIGRATION_TOOL=\"\" To explicitly install Migration Wizard, use MIGRATION_TOOL=\"1\" NOTE: Even if this value = 1, the Administrator components of ANCILE Info Pak must be installed on the computer in order for the Migration Wizard to be installed.
APP_DESKTOP _SHORTCUT	Blank or 1	The desktop shortcut is installed by default. To not install the shortcut, use APP_DESKTOP_SHORTCUT=\"\" To explicitly install the shortcut, use APP_DESKTOP_SHORTCUT=\"1\"
MW_DESKTOP_SHORTCUT	Blank or 1	The Migration Wizard desktop shortcut is installed by default. To not install the shortcut, use MW_DESKTOP_SHORTCUT=\"\" To explicitly install the shortcut, use MW_DESKTOP_SHORTCUT =\"1\"
INSTALLDIR		INSTALLDIR=C:\Program Files\uPerform\ Defines the folder path where the application will be installed. A trailing backslash should be included. When passed on the command line to the setup package, the value should be wrapped in quotation marks if the path contains spaces. If upgrading from a version between 2.0 and 4.3x, the install location cannot be edited. The install will automatically detect the previous installation location.
APP LANGUAGE	ISO Codes are case-sensitive. Bulgarian (bg-BG) Catalan (ca-ES) Chinese (zh-CN) Chinese - Taiwan (zh-TW) Croatian (hr-HR) Czech (cs-CZ) Danish (da-DK) Dutch - Netherlands (nl-NL) Dutch - Belgium (nl-BE) English - US (en-US) English - UK (en-GB) Finnish (fi-FI) French - Canada (fr-CA) French - France (fr-FR) German (de-DE) Greek (el-GR) Hungarian (hu-HU) Indonesian (id-ID) Italian (it-IT) Japanese (ja-JP) Korean (ko-KR) Norwegian (nb-NO) Polish (pl-PL) Portuguese - Portugal (pt-PT) Portuguese - Brazil (pt-BR) Romanian (ro-RO) Russian (ru-RU) Spanish - Spain (es-ES) Swedish (sv-SE) Thai (th-TH) Turkish (tr-TR)	APP_LANGUAGE=en-US This property sets the default user interface language for the Editor application. NOTE: This selection does not change the user interface for the setup program.
/L		/Lv C:\test\install.log "/L" is the standard Windows Installer parameter used to ensure a log is created. This set of parameters would create a verbose log file with all available information using the filename install.log in the C:\test folder. Possible values include: i - Status messages w - Nonfatal warnings e - All error messages a - Start up of actions r - Action-specific records u - User requests c - Initial UI parameters m - Out-of-memory or fatal exit information o - Out-of-disk-space messages p - Terminal properties v - Verbose output x - Extra debugging information + - Append to existing log file ! - Flush each line to the log - Log all information, except for v and x options
/q [n\|b\|r\|f][+\|-][!]		Use any of the standard Windows Installer display option values. Windows Installer runs in full UI mode (/qf) by default. If you use any of the values other than "full UI" you must define values for the properties listed above in order for the install to succeed. Possible values include: /qn - no UI /qb - basic UI /qr - reduced UI /qf - full UI /qb+ basic UI with modal dialog at the end /qb- basic UI without a modal dialog at the end Use the ! parameter to suppress the Cancel button

Parameter Name	Usage Example/Description
/s : silent mode	Setup.exe/s Running the install executable in silent mode suppresses the initialization dialog and launches any needed pre-requisites in silent mode. To run the full install silently, use Setup.exe/s/v"/qn"
/v : pass arguments to Msiexec	setup.exe /v"/l*v c:\test.log MYPROPERTY1=\"value1\" /qb" Use the /v option to pass command-line options and values of public properties through to Msiexec.exe. Note: When you want to specify that a double quote character is not a delimiter for the command line but a delimiter for the property, use \" (as shown above).
/a : administrative installation	The /a option causes the installation executable to perform an administrative installation. An administrative installation copies (and uncompresses) your data files to a directory specified by the user, but it does not create shortcuts, register COM servers, or create an uninstallation log. If you want to extract the prerequisites from setup.exe, add a path after the /a parameter to extract the prerequisites to that location. Do not use a trailing backslash. A sample command is: setup.exe /a"C:\temp"
/b: cache installation locally	With the /b option, the user can specify the directory in which to cache the installation files. If you want to extract the MSI from setup.exe, specify the path after the /b parameter to extract the prerequisites to that location. Do not use a trailing backslash. A sample command is: setup.exe /b"C:\temp"
/w : wait	setup.exe /w The /w option forces the installation executable to wait until the installation is complete before exiting.
/x : uninstall mode	The /x option causes the installation executable to uninstall a previously installed product.

For more information about Windows Installer command line parameters, refer to the Microsoft Website at http://msdn2.microsoft.com/en-us/library/Aa367988.aspx.

These parameters can be used either in a setup.ini file or passed via the command line. When used in a setup.ini file, each parameter should be on a separate line in the file. If you pass the /v parameter at the command prompt when launching Setup.exe, any parameters that are specified for the CmdLine keyname in Setup.ini are ignored.

The proper format for the file data is VariableName=value. Do not include a space before or after the '=' sign.

Supported parameters are indicated by a Project Type of "Basic MSI."

Overview of the Editor Installation

The Editor installation is delivered as a single file wrapper or, in the Microsoft terminology, bootstrapper executable. The bootstrapper executable contains the Editor Microsoft Installer package (the .msi file) and the redistributable packages for various prerequisites. When the install is executed, a check is performed to ensure that the required prerequisites are installed on the computer.

NOTE:

For more information, refer to the Technical Specifications.

If a prerequisite is not present on the target computer, the installation extracts the pertinent Microsoft redistributable package to a local source folder and executes the package automatically.

After all prerequisite conditions are met; the Editor Microsoft Installer package is extracted to a temporary folder and executed.

Running the .msi File Directly

If you would prefer to run the .msi file directly, the .msi file and the prerequisite redistributables can be extracted to a local folder via an Administrative install. For example:

setup.exe /a"C:\uncompressed\prqs" /s /v"/qn TARGETDIR=\"c:\uncompressed\msi""

The above would extract the prerequisites from the bootstrapper executable to "C:\uncompressed\prqs". Then the uncompressed MSI would be extracted to "C:\uncompressed\msi". If you choose to run the .msi file directly, all prerequisites should be installed prior to the Editor application.

Installing the Editor Software

Insert the installation CD or navigate to the location of the setup.exe file.
If necessary, double-click on the .exe file to begin the installation.
Click Run.
Click Next.

Complete the following information:

NOTE:

If you choose to run the .msi file directly, you must install all prerequisites prior to the Editor application. For more information on prerequisites, refer to the Technical Specifications.

Field	Description
Company Name	Enter your company or organization name delivered with the software. This value should be entered exactly as provided.
Product Key	Enter the product key delivered with the software. This value should be entered exactly as provided.

Click Next.
Optionally, select Change to specify a destination folder other than the default.

Optionally, select the Include the Migration Wizard checkbox to install the Migration Wizard application. An administrator install of ANCILE Info Pak 5.51 or later must be installed on the computer for this option to display.

NOTE:

If you have existing Info Pak content, the Migration Wizard allows you to incorporate Glossary and Web Architect database information and links to Info Pak documents into your uPerform instance. In addition, the Migration Wizard will transform your existing Info Pak document to a uPerform document. For detailed information on using the Migration Wizard, refer to "Introduction to Incorporating Info Pak Content," in the companion manual Migration Wizard.

Optionally, select the Client checkbox to create a desktop shortcut for the application.
Click Next.
Select the desired interface language from the drop-down list.
Click Next.
Click Install.
Optionally, select the Show the Windows Installer log checkbox to display the install log.
Click Finish.

Implementing with Citrix

If you are planning to use the application in a Citrix environment, perform the following procedure to ensure a smooth implementation:

NOTE:

In order to optimize recording in a Citrix environment, uPerform and the target application must be presented to the user from the same server and contain the same settings.

If you need to change the resources directory due to Citrix restrictions, complete the following steps:
1. Close the Editor.
2. Locate your current uPerform > Resources directory using the START menu.
3. Note the templates directory.
  
  NOTE:
  
  The default location is C:\Users\[username]\AppData\Roaming\[applicationdirectory]\version [X.xx]\templates.
4. Navigate to the client install directory.
  
  NOTE:
  
  The default location is C:\Program Files\[applicationdirectory]\client.
5. Create a backup copy of the install.config file.
6. Edit the install.config file to add the new location for the resources directory you want to create. The area to be edited is displayed in bold below:
  (Example using D: drive:
  <?xml version="1.0" encoding=UTF-8?>
  <InstallConfig>
  <BaseAppData>D:\Resources</BaseAppData>
  <CompanyName>ANCILE</CompanyName>
  <Language>en-US</Language>
  <ProductId>XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX</ProductId>
  </InstallConfig>
7. Save and close the install.config file.
8. Start the Editor software.
  
  NOTE:
  
  The new resources directory will display similar to C:\[username]\[applicationdirectory]\version [X.xx].
9. Right-click on the Editor shortcut and update the Target field with the new location for the resources directory you entered in Step 6.
10. Copy the templates from the directory you noted in Step 3 into the new resources directory you entered in Step 6.
NOTE:

These steps will need to be performed after upgrading to a new version of Editor from a previous version that has been configured to work with Citrix.

Previous Article Next Article