Getting Started SIB
Getting Started SIB
Getting Started SIB
Contents
Introduction .................................................................................................................................................. 4
Silent Install Builder Overview ...................................................................................................................... 4
System Requirements ............................................................................................................................... 4
Installation ................................................................................................................................................ 4
User Interface ............................................................................................................................................... 6
Main Window............................................................................................................................................ 6
Package Properties Page ........................................................................................................................... 6
Package Features ...................................................................................................................................... 8
Feature Page ............................................................................................................................................. 9
Files Editor........................................................................................................................................... 10
Registry Editor ..................................................................................................................................... 12
Actions on Install/Uninstall Page ........................................................................................................ 14
Install Application Dialog ................................................................................................................ 15
Uninstall Application Dialog ............................................................................................................ 16
Run EXE file Action Dialog ............................................................................................................... 17
Run CMD file Action Dialog ............................................................................................................. 18
Run Script file Action Dialog ............................................................................................................ 19
Close Application Action Dialog ...................................................................................................... 20
Build Dialog ............................................................................................................................................. 21
Installed Apps Dialog............................................................................................................................... 22
Repackager.............................................................................................................................................. 23
Portable Repackager Dialog ................................................................................................................ 23
Repackager Options Dialog ................................................................................................................. 24
Manuals....................................................................................................................................................... 25
Create silent installation ......................................................................................................................... 25
Silent Installation with command line options ....................................................................................... 25
Repackaging an Installation .................................................................................................................... 26
Repackaging installation on another computer...................................................................................... 28
Record UI Automation Script .................................................................................................................. 29
2
Silent Install Builder Getting Started guide www.apreltech.com
3
Silent Install Builder Getting Started guide www.apreltech.com
Introduction
This is a Getting Started guide describing how to create silent (automatic) application installation
packages with the Silent Install Builder.
System Requirements
Hardware:
Hard Disk Space: 25 MB for installation files and sufficient disk space for the repackaged installations
Operating systems:
• Windows 10
• Windows 8.1
• Windows 7
Runtimes:
Privileges:
Administrative privileges on the system is required for Repackaging and UI Script Recorder.
Installation
The evaluation version of Silent Install Builder can be downloaded here:
https://www.apreltech.com/SilentInstallBuilder
Run the downloaded installation file (.msi) and complete all steps. An older installed version will be
updated during the installation.
4
Silent Install Builder Getting Started guide www.apreltech.com
After installation is completed you can find the Silent Install Builder shortcut on the desktop and in the
Start menu:
5
Silent Install Builder Getting Started guide www.apreltech.com
User Interface
Main Window
The Main window is divided on two parts: The Navigation Pane (A) on the left and the Content Pane (B)
on the right.
When you select the Navigation Pane node for a particular item, its properties appear in the Content
Pane area.
Product Name
Specifies a public name that describes an application when it is installed on a target computer. The
property is displayed as the description of the application or component in the Add/Remove Programs
dialog box.
Product Version
Specifies the version number of an installer.
6
Silent Install Builder Getting Started guide www.apreltech.com
Example: 1.0.0.0
MSI: Windows Installer uses only the first three fields of the product version. When the Version value is
changed, you should also update the Product Code property.
Company Name
Specifies the name of the manufacturer of an application or component, usually the name of the
company that developed it. The Manufacturer property is displayed in the Publisher field of the Support
Info dialog box, accessible from the Add/Remove Programs dialog box.
Description
Provides description text for the Setup Wizard and for the Add or Remove Programs in Control Panel.
Language
MSI: The Language setting also defines the Windows installer code page. It is recommended to use only
ASCII characters and then you can build a msi package with a neutral code page (en-US). Such a package
could be used by any language. If you must include extended characters, you should set the language for
the package before build.
Product Code*
MSI: A unique identifier for the particular product release, represented as a string GUID, for example
"{12345678-1234-1234-1234-123456789012}". This identifier must vary for different product versions.
Upgrade Code*
MSI: A GUID representing a related set of products. A set of different versions of the Product will have
the same Upgrade Code. This enables newer versions of your application to search and upgrade
previous versions installed on the same computer.
7
Silent Install Builder Getting Started guide www.apreltech.com
Launch Conditions*
MSI: Specifies the Windows Installer conditions required for installation on a target computer.
* The property is valid for MSI build and ignored for EXE build.
Package Features
The Package may contain one or more Features (Components). Each of these features can be installed
separately by user choice. The picture below shows the package containing three features and the
Choose Components page of the Setup Wizard.
8
Silent Install Builder Getting Started guide www.apreltech.com
Feature Page
Name
Specifies a name that will be displayed in the Select feature dialog.
Comment
Short description the feature. This string is listed as an item by the Selection Tree control of the Select
Feature Dialog.
Unselected by default
Install Conditions*
MSI: Specifies the Windows Installer conditions required for installation on a target computer.
9
Silent Install Builder Getting Started guide www.apreltech.com
Files Editor
The Files Editor displays a set of folders that represent the folder structure on a target computer. The
Files Editor is divided into two parts: The Folders Tree on the left and the Files list on the right. The
Folders Tree contains a tree of folders that represent the file system changes on a target computer.
When a folder item is selected in the tree, any file entries are displayed in the detail list.
Manage Folders
Add a System folder
2. On the Popup menu, select the System Folder that you want to add.
Create a subfolder
2. On the Popup menu, click New Folder. The new Folder will be added as the subfolder of the
previously selected folder item. The new folder is highlighted in the Folders Tree.
Rename a subfolder
10
Silent Install Builder Getting Started guide www.apreltech.com
1. Right click the folder and choose Rename from the popup menu.
Remove a folder
1. Right click the folder and choose Delete from the popup menu.
2. The selected folder will be deleted with all subfolders and files.
Manage Files
Add files
4. Right click on the Files list and choose Add Files from the popup menu. Browse for file dialog
will be appeared.
5. Select the Files that you want to add and click OK.
2. Right click on the Files list and choose Add Folder from the popup menu. Browse for Folder
Dialog will be appeared.
3. Select the Folder that you want to add and click OK.
Remove a File
1. Right click the item and choose Delete from the popup menu.
Manage Shortcuts
Create a shortcut
2. Right click the Files list and choose New Shortcut... from the popup menu. The Shortcut Dialog
will be appeared.
3. In the Shortcut dialog, select the target file for the shortcut and other properties. Click OK.
Remove a shortcut
1. Right click the shortcut and choose Delete from the popup menu.
11
Silent Install Builder Getting Started guide www.apreltech.com
Registry Editor
The Registry Editor specifies registry keys and values to be added to the registry of a target computer.
1. Right click on the item on the Registry tree and choose New Key from the popup menu.
2. The new Key will be added as the subkey of the previously selected registry key item. The new
key is highlighted in the navigation tree.
1. Right click the folder and choose Rename from the popup menu.
1. Right click the key and choose Delete from the popup menu.
2. The selected key will be deleted with all subkeys and values.
1. Right click on the key on Registry tree and point to New from the popup menu, select new value
node.
2. The new Value will be added into previously selected registry key item. The new value is
highlighted in the details list.
1. Right click the selected value in the Detail list and choose Modify from the popup menu. The
Registry Value Dialog will be appeared.
2. In the Registry Value dialog, enter a name for the value and other properties. Click OK to save.
1. Right click the value and choose Rename from the popup menu.
13
Silent Install Builder Getting Started guide www.apreltech.com
The Install/Uninstall actions Page defines the actions that will be executed during the package
installation or uninstallation. The actions will be executed sequentially from top to down of the list.
o Click the Add… button in the drop-down menu select the Action to add.
o Select the Action in the list then click the Delete button
o Select the Action then click the Up Arrow/Down Arrow on the right side of the list.
o Install Application
o Uninstall Application
o Run EXE file
o Run CMD file
o Run Script file
o Close Application
14
Silent Install Builder Getting Started guide www.apreltech.com
Installation File
Specifies the application Installation File path to be installed. It can be an .exe or .msi file.
• Attached File
o The Installation File is a part of the package content. Default location for attached files
is TempFolder\[FeatureName] folder. Content of this folder will be copied to %TEMP%
directory on a target computer. You can add other files and folders required for
installation in the Files Editor
• External File
o The Full Path to a file on a Local Computer. Example: C:\setup.exe
• Network Share
o The Installation File is located on a Network Share (UNC path). Example:
\\share\setup.exe
• Http(s) web path
o The Installation File is located on a web site. The File will be downloaded to a %TEMP%
directory on a target computer. Example: https://website.com/setup.exe
Install Conditions
Installation conditions allow you to specify the conditions under which an Application Installer will be
executed. For example, you might have two versions of an application, each designed to run on a
15
Silent Install Builder Getting Started guide www.apreltech.com
particular OS Platform. Rather than creating a separate installer for each version, you can set the
condition for each Application Installer and include them both in a single installer.
Specifies command line switches to initiate an unattended (silent) installation. Once the installer file is
selected, the program automatically detects most common Install system types and their command line
options. If the installer type is not detected, try to find the information you need in other sources: visit
software vendors website or contact them directly.
Automation Script
Use UI Script recorder to automate uninstallation process. It allows to manipulate controls such as edit
boxes, check boxes, list boxes, combos, trees, buttons. Use this method if the installer does not support
the silent installation or if you need to customize install options. Refer to Using UI Script Recorder
section to get info on how to record the script.
16
Silent Install Builder Getting Started guide www.apreltech.com
Uninstall Key
Uninstall Version
Uninstalls only specified version of the application. If the And Lower is checked, uninstalls the app if
lower or equal version found.
Automation Script
Use UI Script recorder to automate uninstallation process. It allows to manipulate controls such as edit
boxes, check boxes, list boxes, combos, trees, buttons. Use this method if the uninstaller does not
support the silent installation or if you need to customize uninstall options. Refer to Using UI Script
Recorder section to get info on how to record the script.
17
Silent Install Builder Getting Started guide www.apreltech.com
File to run
• Attached File
o The File is a part of the package content. Default location for attached files is
TempFolder\[FeatureName] folder. Content of this folder will be copied to %TEMP%
directory on a target computer. You can add other files and folders required for
installation in the Files Editor
• External File
o The Full Path to a file on a Local Computer. Example: C:\setup.exe
o The file name only, if file location is well-known. Example: notepad.exe
18
Silent Install Builder Getting Started guide www.apreltech.com
• Attached File
o The File is a part of the package content. Default location for attached files is
TempFolder\[FeatureName] folder. Content of this folder will be copied to %TEMP%
directory on a target computer. You can add other files and folders required for
installation in the Files Editor
• External File
o The Full Path to a file on a Local Computer. Example: C:\xx.cmd
o The file name only, if file location is well-known. Example: xx.cmd
Parameters
19
Silent Install Builder Getting Started guide www.apreltech.com
• Attached File
o The File is a part of the package content. Default location for attached files is
TempFolder\[FeatureName] folder. Content of this folder will be copied to %TEMP%
directory on a target computer. You can add other files and folders required for
installation in the Files Editor
• External File
o The Full Path to a file on a Local Computer. Example: C:\xx.vbs
o The file name only, if file location is well-known. Example: xx.vbs
Parameters
20
Silent Install Builder Getting Started guide www.apreltech.com
Process name
Condition*
MSI: Specifies the Windows Installer conditions required for run the action on a target computer.
Build Dialog
The Build Dialog provides options for package build.
Build Options
Do not register the package in the Add/Remove Programs control panel applet. This option
suppresses the package uninstallation.
• 64-bit package
Build a package as 64-bit. The files will be installed to the 64-bit ProgramFiles folder.
• Per-user installation
Disables UAC elevation on installation. Installation possible only to user profile and registry.
21
Silent Install Builder Getting Started guide www.apreltech.com
• Test UI Script
Dialog Options
• Setup Wizard
The package displays a Full user interface (Setup Wizard) with following options:
Displays the page that enables user to specify the installation folder
▪ Select features
• No Dialog
No dialogs displayed.
22
Silent Install Builder Getting Started guide www.apreltech.com
Select the application from list. Click the Uninstall button. Click Refresh button to update the list.
Repackager
Repackager is a tool designed to repackage an existing installation packages by capturing the System
changes. Yu can use the Repackager in two ways:
Repackaging an Installation
2. As a Portable tool
23
Silent Install Builder Getting Started guide www.apreltech.com
Output directory
• Snapshot Directory
Specifies the directory where snapshot files will be stored. Default location:
%LocalAppData%\SIB\Repackager
Defines the Monitoring File System Filters. Filters are used by Repackager to exclude specific
files and folders from monitoring.
• Registry filters
Defines the Monitoring Registry Filters. Filters are used by Repackager to exclude specific
registry keys from monitoring.
Monitoring Filters
24
Silent Install Builder Getting Started guide www.apreltech.com
You can use full path, wildcard or regex pattern for the Scan Filter value.
Manuals
Create silent installation
The Silent Install Builder provides the following options to create silent installation:
25
Silent Install Builder Getting Started guide www.apreltech.com
o Manage Files
o Install Application Dialog
o Build the Package
Repackaging an Installation
This is a tutorial on how to create a package based on capturing an existing installation. This method
commonly used to repackage an older legacy installation to the Windows Installer package (MSI).
4. The Repackager dialog will appeared and capturing process will be started
5. Wait for the System-state information will be saved. It may take 1-3 min depends on the OS type
and hardware performance.
6. Once the System-state information will be saved, the installation process started. Complete an
Installation and close the installer dialog.
7. The ‘Is Installation completed?’ message will be appeared. Click OK to continue.
27
Silent Install Builder Getting Started guide www.apreltech.com
12. The new package will be created and the Captured Installation will be imported to.
13. Examine captured files and registry entries. Remove items that were changed and captured but
are not part of installation.
o Manage Files
o Manage Registry Keys and Values
o Build the Package
28
Silent Install Builder Getting Started guide www.apreltech.com
o Manage Files
o Manage Registry Keys and Values
o Build the Package
3. Select the installation file you wish to wrap and click Next.
4. The installation file will be started and UI Script Recorder window will be appeared.
5. Use the Mouse to choose the Control for action, then use Ctrl + Mouse Click to select the
control.
6. When control is selected, the Script Step dialog will be appeared. The picture below shows the
Next button selected.
30
Silent Install Builder Getting Started guide www.apreltech.com
7. Click OK to save Script Step. The New Step will be added to the Script Recorder window.
8. Click the Next button in the Installer dialog to continue.
9. Pass through all installation steps.
31
Silent Install Builder Getting Started guide www.apreltech.com
13. A New package will be created. The package contains Install Application Action. An installation
file is included to TempFolder\[FeatureName] folder. You can add other files in this folder if
required.
o Manage Files
o Build the Package
32
Silent Install Builder Getting Started guide www.apreltech.com
33
Silent Install Builder Getting Started guide www.apreltech.com
64-bit OS VersionNT64
32-bit OS NOT VersionNT64
Silent Install (UI Sequence not run) UILevel <= 3
The directory that contains the installation SourceDir=”somepath”
package.
Windows 10 VersionNT = 1000 AND MsiNTProductType = 1
Windows Server 2016 VersionNT = 1000 AND MsiNTProductType = 3
Windows 8.1 VersionNT = 603 AND MsiNTProductType = 1
Windows Server 2012 R2 VersionNT = 603 AND MsiNTProductType = 3
Windows 8 and Server 2012 VersionNT = 602
Windows Server 2008 R2 VersionNT = 601 AND MsiNTProductType = 3
Windows 7 VersionNT = 601 AND MsiNTProductType = 1
Windows Server 2003 VersionNT = 502 AND MsiNTProductType = 3
Windows XP VersionNT = 501
Windows XP (64-bit) VersionNT = 502 AND MsiNTProductType = 1
The size of the installed RAM, in megabytes PhysicalMemory >= 1024
Default language identifier for the system SystemLanguageID = 1033
Environment variable value %TEMP
o >< contains
o << starts with
o >> ends with
Logical Operators
34
Silent Install Builder Getting Started guide www.apreltech.com
Comparison Operators
o = equals
o <> not equals
o > greater than
o >= greater than or equals < less than
o <= less than or equals
o ~= case-insensitive equals
35