installer​.xml

The installer.xml file provides all the information needed by the Installer tool to perform an installation based on the content of the installdata folder.

• The installer node provides general information about the installation.

• The installer can contain one or more bundles that represents a set of installation activities.

• When the application is to be installed in different setups (such as player0, player1, instructor), the corresponding bundles can be created to perform only what is needed for each setup.

• Placeholders are available to use in specific node attributes to make the installer script contextual.

Code example

This is a code example of installer.xml.

<?xml version="1.0" encoding="utf-8"?>

<installer title="This is the title" PROJECT_NAME="PRJ_NAME" PATH_NAME="Eyesim" PROJECT_DIR="PRJ_DIR" VERSION="1.0" >

<bundle name="generic" description="Generic Installer">

<acceptText title="EULA" file="EULA.txt"/>

<pickDrive/> <copyDir from="data\code\" to="$DRIVE$\$PATH_NAME$\$PROJECT_DIR$\code\"/>

<shortcut name="MWPLConfigurator" location="StartMenu" folder="EYESIM Test Project" file="$DRIVE$\$PATH_NAME$\$PROJECT_DIR$\code\MWPLConfigurator.exe"/>

<shortcut name="MWPLPlayer" location="StartMenu" folder="EYESIM Test Project" file="$DRIVE$\$PATH_NAME$\$PROJECT_DIR$\code\MWPLPlayer.exe"/>

<shortcut name="UnInstall" location="StartMenu" folder="EYESIM Test Project" file="$DRIVE$\$PATH_NAME$\$PROJECT_DIR$\UnInstaller.exe"/> <copyDir from="data\PCLibsInstaller\" to="$DRIVE$\$PATH_NAME$\$PROJECT_DIR$\PCLibsInstaller\"/>

<launch file="$DRIVE$\$PATH_NAME$\$PROJECT_DIR$\PCLibsInstaller\PCLibsInstaller.exe"/>

</bundle>

</installer>

<installer>

The installer node contains general installation information, such as text to present in the Installer UI and destination folder name.

PATH_NAME\PROJECT_DIR is the base path for the installation and the user can only select the drive.

<bundle>

A bundle is a container that groups a set of sequential actions that define the installation.

Available actions for bundles

The following sections describe all available actions that can be included in a bundle installation sequence.

Some are mandatory, but others are optional. Some can be multiple, but others should be unique.

<acceptText> (optional, unique)

• Shows the EULA and requires the user to accept.

• If user does not accept the installation sequence ends.

• It has no attributes.

<pickDrive> (mandatory, unique)

• Asks the user to select on which machine drive to install the application.

• The <pickDrive> must be placed before any <copyDir> and <shortcut> node, because it creates the base installation directory and the uninstaller.

• It has no attributes.

<copyDir> (optional, multiple)

• Copies a folder with its files from installdata.dat to installation directory.

• From path is relative to installdata.dat position. It must usually start with \data because almost all project-related content is placed in that subfolder.

• You can copy files to fixed paths.

<copyFile> (optional, multiple)

• Copies a single file from installdata.dat to a defined installation filepath.

• From filepath is relative to installdata.dat position. It must usually start with \data because almost all project-related content is placed in that subfolder.

• You can copy a file to a fixed filepath.

• If a destination folder is not present, the copyFile will not copy file. If a folder needs to be created while copying file, then you need to add the attribute forciblyCreateDir = true.

<restrictDirPermission> (optional, multiple)

• Requires the requireAdmin installer parameter to be set to true to work.

• Restricts the user privileges on the specified path to Read and Execute, so that the user cannot modify the files in the path or create new ones.

• Restrictions are applied recursively to all specified path files and subfolders.

  Attribute	Use	Description
  path	Mandatory	The path of the folder on which apply the restrictions. Supports placeholders.

<shortcut> (optional, multiple)

• Creates a shortcut for a specific installed file. The shortcut creation happens after <copyDir> completion.

• Multiple shortcuts with different locations can be created for an unique file.

• Setting file to UnInstall creates a shortcut for the uninstaller.

<launch> (optional, multiple)

• Enables launch for external applications that are copied, such as the PCLibsInstaller.exe, or already available on the machine.

• It waits for the launched process to end before proceeding with the installation sequence.

<showContent> (optional, multiple)

• When executed triggers the opening of a content like a pdf or a web page in its default editor.

• It does not wait before proceeding to next step.

Placeholders

The Installer supports a few placeholder tags that can be used in several node fields to define paths in a contextual and not absolute way. As most of the placeholders depend on specific nodes to be valorized, it’s important not to use them before assigning.

Placeholders can be used to define a folder location in a contextual way.

<copyDir from="data\XRStudio\" to="$DRIVE$\$PATH_NAME$\$PROJECT_DIR$\"/>

Attributes supporting placeholders

The placeholders are supported by the following node attributes.