Orca msi editor руководство

I from time to time like many have needed to customize an MSI installer to preset certain properties, normally so I can perform a silent install with some sort of software deployment tool such as SCCM, Intune, or even via an Active Directory Group Policy. In this guide, I will cover the basics of using Microsoft free MSI editor Orca.

Table of Contents

• Overview
• Installing and Running Orca
• Creating a new MST File
• MSI Table Overview
• Adding and Removing Features
• Changing the default Answer to Prompts
• Saving the Transform File (MST)
• Making Further Changes to the MST File in Future
• Running and MSI with a Transform file

Overview

An MSI loosely follows a relational database structure holding all of the installation parameters and settings including.

• Available features
• Components
• Relationship between features and components
• Necessary registry settings
• User interface for the application

This mini-guide will introduce how to customize an MSI installer to pre-answer prompts during an installation and create a transform file MST (transforms file). In this example, we will be customizing the IBM Lotus Notes 7.0.3 install to not install the feature “Client Single Logon” and to change the install directory and data directory. But the same principles will apply to other MSI’s.

It is best practice to create an MST file to hold configuration changes rather than changing the original MSI. An MST file acts as an extension to an MSI file, so the original MSI file never gets changed and you can have several MST files with different settings for different purposes.

You can obviously buy software that will give you a nice easy GUI for making these changes however Microsoft has released a free tool as part of the Windows Installer SDK called Orca which allows you to go in and change data in the MSI database or create a separate transforms MST file.

Installing and Running Orca

1. To install and run the Orca editor, follow these steps:
2. Download the Windows Installer SDK samples, tools, and documentation from the following Web page: https://developer.microsoft.com/en-gb/windows/downloads/windows-10-sdk/
3. Install the Orca editor by double-clicking the Orca.msi file in the \Microsoft SDK\bin folder.
4. Click Start, point to Programs, and then click Orca.
5. On the File menu, click Open, and then browse to the .msi file that you want to edit.

Creating a new MST File

Once you have opened the MSI with Orca you should create a new MST so any changes you make will be stored separately to the MSI (best practice)

1. Got the Transform menu
2. Select New Transform

If you need to you can now go into the Transform menu and change the Transform Properties for things such as “Product version lower”

MSI Table Overview

The main tables of interest are probably;

Feature:   What features to install

Control:   Holds everything to do with the installer’s interface

Property:   Answers to prompts within the installer

Registry:   Any changes to the registry

Shortcut:   Any shortcuts created by the Application

Adding and Removing Features

Before going into the feature table we need to go into the property table and make a note of the value for the property INSTALLLEVEL, in my case it is 100 (normally the standard)

Now if we go into the feature table you should see there is a Level column, all features will a level value below or equal to INSTALLLEVEL will be set to install by default and all features will a value above will not be installed by default.

So if you want to change the feature to be installed change the Level value to one equal or lover than INSTALLLEVEL or set it higher to prevent it from being installed.

So using my example with Lotus Notes I am going to change the Level of the ClientSingleLogon feature from 101 to 1 so it does not get installed

Some things to watch out for here, items in the condition table can override these settings if the listed condition is met then the Level is set to the one listed. An MSI author can define install level values that represent specific installation options, such as Custom, Typical, or Minimum

Changing the default Answer to Prompts

When setting the default value for a prompt we need to look at two tables, the Control table, and the Property table.

If you open the Control table first, we are interested in the columns Dialog, Control, and Property.

The Dialog column shows us the internal name of the current window during the install wizard, so this will give us a clue if we are in the right place

The Control column again will give us a clue we have found the correct control

The Property column is the really important one, you should notice that some controls have a property set and some do not. When the installer runs it will set the default value of the control to whatever is set for that property in the Property table

For example, in my Lotus Notes MSI’s Control table I have a control called InstallPath with the Property value of DATADIR

If I look in the Property table I can see a record for DATADIR with a value of “C:\program files\lotus\notes\data”

So if I want to change the Lotus Notes data directory I just need to edit DATADIR in the Property table.

Sometimes you will find that a corresponding record does not exist in the Property table, if that happens you can just right-click in the table a select Add Row.

Note on Radio Buttons. If the control you want to set is a Radio Button then the value you need to enter in the Property table can be found in the RadioButton table in the Value column.

Saving the Transform File (MST)

Once you have made your changes it is time to save.

1. Open the Transform menu
2. Select Generate Transform
3. Select were to save the MST file

Making Further Changes to the MST File in Future

1. Open the MSI file with Orca
2. Go to the Transform Menu
3. Select Apply Transform
4. Find and open your transform
5. Orca will highlight change to the original MSI

Running and MSI with a Transform file

Msiexec /i “<MSI path and file>” TRANSFORMS=”<MST path and file>”

More detailed information on the MSI Database

http://msdn.microsoft.com/en-us/library/cc185688%28v=VS.85%29.aspx

As always please comment if you need some assistance.

The Orca MSI Editor, which is part of the Microsoft Windows SDK for Windows 7, allows you to edit an MSI file to change various settings and disable features.

Customizing MSI packages has gotten much easier over the years with the help of vendor-provided packaging and deployment guides. But many of these guides leave out how to disable features and settings that would be useful to systems administrators, such as disabling automatic updates and cleaning up shortcuts. In this guide, I am going to go over the process of customizing MSI packages using Orca.

Installing the Orca MSI editor

First, download the Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 SP1. You will need Microsoft .NET Framework 3.5 installed as a prerequisite. Run through the installer, and on the Installation Options page, uncheck everything except the Windows Development Tools (it will automatically install the subcomponents too).

When the installation finishes, it places the installer for Orca under C:\Program Files\Microsoft SDKs\Windows\v7.0\Bin. Run the installer and choose the Complete option. Orca should now be installed and accessible from both the Start menu and the right-click menu for MSI files.

Customizing an MSI package

For this guide, I am going to customize Cisco WebEx Recorder and Player. Right-click the downloaded MSI package and select the Edit with Orca option. This will open the MSI package in Orca for editing. For this guide, we are going to edit the MSI package to achieve the following:

• Place the application shortcut in its own Start menu folder
• Do not create an application shortcut on the desktop
• Disable automatic and manual updates

Before you start editing the MSI file, you need to create a transform to apply during the installation. Per best practice guidelines, you should never edit an MSI package directly. Instead, generate a transform that will apply the customizations to avoid a broken installation. Navigate to the menu bar and go to Transform > New Transform.

A «()» will appear next to the name of the MSI package in the window title bar to show it has generated a transform. Looking at the Tables navigation pane, you will notice there are several options.

With most MSI packages, you are only going want to focus on the following: CheckBox, Directory, Launch Condition, Property, and Shortcut. CheckBox controls the settings checked by default when running the installer both attended and unattended.

Directory controls the settings that define all the directories the installer uses. Launch Condition controls the conditions or prerequisites needed before the installer can run. Property controls application options during and after installation. Application vendors will often publish guides that list supported properties you can modify through the command line. Shortcut controls where the installation creates shortcuts.

Navigate to the Tables column and select the CheckBox table. Set the properties ISCHECKFORPRODUCTUPDATES, LAUNCHPROGRAM, and LAUNCHREADME to 0. Note that 0 = No and 1 = Yes.

While still in the Tables column, select the Directory table. You will notice there are quite a few directories. Fortunately, you don’t need to worry about any of them as you will be creating your own. Go to the menu bar and select Tables > Add Row, and then add the following to each field:

• Directory: WebExStartMenu
• Directory_Parent: ProgramMenuFolder
• DefaultDir: Cisco WebEx Utilities

Directory refers to the name of the directory row you added; you will use this later when customizing shortcuts. Directory_Parent refers to the root directory where it will add your directory, which in this case is the %PROGRAMDATA%\Microsoft\Windows\Start Menu\Programs directory. DefaultDir refers to the actual name of the directory you would like to create, which in this case is Cisco WebEx Utilities.

While still in the Tables column, select the Property table. Set the properties listed below to the following values:

• AgreeToLicense = Yes
• ISCHECKFORPRODUCTUPDATES = 0
• RebootYesNo = No

By setting these values, you are suppressing any first-run EULAs, disabling the application from checking for updates after installing, and preventing the application from telling Windows it needs to restart.

Finally, while still in the Tables column, select the Shortcut table. Right-click the two rows that have DesktopFolder as the directory and select the Drop Row option. This will prevent the installation from generating desktop shortcuts.

For the remaining two rows, replace the newfolder1 directory with WebExStartMenu (the name of directory we added earlier).

With all the customizations specified, it is time to save the transform file. In the menu bar, go to Transform > Generate Transform. Save the transform as something memorable and short, such as WebEx_Custom.mst.

Now it is time to install the application using the generated transform. Open a command prompt as an administrator and cd to the directory where your MSI and transform are located. Enter the following command:

msiexec.exe /i “atrecply.msi” /qb /norestart /L*v C:\Cisco_WebEx_Utilties.log TRANSFORMS=WebEx_Custom.mst

When the installation finishes, you should notice there are no desktop shortcuts, and that it has created the application Start menu shortcuts in the Cisco WebEx Utilities folder.

Wrap-up

Although there are numerous MSI packages with different properties, shortcuts, and directories, the customization process is essentially the same. The benefit of using Orca to generate transforms is that it eliminates the need for lengthy batch scripts that perform actions such as deleting shortcuts and editing the Windows Registry to disable settings post-installation.