Everything You Need To Know About Installing The uPerform Express Editor

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 following prerequisites are installed on the computer:

• Capturing Engine by ANCILE Solutions
• ANCILE JRE Configuration Utility
• Microsoft .NET Framework (required for JSharp to install)
• Microsoft Visual C++ Redistributable
• MSXML
• Visual JSharp .NET Redistributable Package
• Windows Automation API
• Windows Imaging Component (requirement for .NET)
• Windows Installer

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.

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\""

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."

Running the Install with a setup.ini File

If you are using a setup.ini file, you must run the installation with a special command line switch - /m=setup.ini. For example:

setup.exe /m=setup.ini

The installation (the .exe file) has only two user interface elements: an initial splash screen and a possible error message as described previously. The .msi file has a full user interface typically seen in an installation package. The QUIET parameter defined previously controls the user interface level of the .msi file. To set the .exe file to have no user interface (that is, hide the splash screen and any error messages), the .exe file must be run with a "/s" command line switch. For example:

setup.exe /s

To set the .msi to have no user interface when run from within the .exe file, the QUIET parameter must be used. All properties must be defined because the .msi will run without a user interface.

The parameters also may be used from the command line directly. In general, spaces are used to separate the parameters on the command line. Since some values may contain spaces, those particular values should be wrapped in double-quote marks. The preceding table identifies to which parameters this applies.

If you use the /S or /M switches that pertain to the .exe file, they must precede any of the other parameters on the command line.

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

1. Insert the installation CD or navigate to the location of the setup.exe file.
2. If necessary, double-click on the .exe file to begin the installation.
3. Click Next.
4. Complete the following information:

   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.

5. Click Next.
6. Optionally, select Browse to specify a destination folder other than the default.
7. Optionally, select the Client checkbox to create a desktop shortcut for the application.
8. Click Next.
9. Select the desired interface language from the drop-down list.
10. Click Next.
11. Click Install.
12. 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:

1. Close the Editor.
2. Locate your current uPerform Express resources directory. (Example: START > PROGRAMS >uPerform Express > uPerform Express Resources).
3. Note the templates directory. The default location is: C:\Users\[username]\AppData\Roaming\[applicationdirectory]\version X.xx\templates.
4. Navigate to the client program files. 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 you would like 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>

   NOTE:

   In Windows 7 or later environments, you must have Administrator rights in order to edit install.config.

7. Save and close the install.config file.
8. Start the Editor software.
9. The new resources directory will display similar to C:\[username]\ANCILE\uPerform Express\version X.xx.
10. On the Shortcut tab, update the Target field to reflect the location you noted in Step 6.
11. Copy the templates from the directory you noted in Step 3 into the new directory created in Step 9.
12. 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.