Building an Installation Package

From OriginLab Wiki

(Difference between revisions)
Jump to: navigation, search
Revision as of 15:58, 6 December 2011 (edit)
Barb (Talk | contribs)

← Previous diff
Revision as of 21:43, 10 February 2012 (edit) (undo)
Barb (Talk | contribs)

Next diff →
Line 49: Line 49:
Once you have your Origin installation package prepared, you can use a software distribution environment / software such as NetInstall or SMS to distribute the MSI package or the template installation. Once you have your Origin installation package prepared, you can use a software distribution environment / software such as NetInstall or SMS to distribute the MSI package or the template installation.
-==Preparing an MSI installer==+==[[MSI_Installation|Preparing an MSI installer]]==
-[http://www.originlab.com/restricted/file_download.aspx?site=MA&file=/restricted/download_files/Origin851Sr2Setup.msi Origin 8.5.1 Service release 2 MSI download]<br>+
-Please review the previous section to learn about settings you can pre-configure in your MSI installer. +
- +
-===Example that pre-sets the User Files Folder and FLEXnet server===+
-[http://www.originlab.com/restricted/file_download.aspx?site=MA&file=/restricted/download_files/MSI_Transform_Example.zip Example MSI transform and batch file download]<br><br>+
-This example is provided for use with the '''Concurrent Network package'''. The MSI transform pre-sets the FLEXnet server license, and also pre-sets the User Files Folder. <br>+
-The transform pre-sets the FLEXnet server license by copying the use_server.lic file to the Origin program folder \License folder. <br>+
-Before using this use_server.lic file, you must edit it and then save the file in the same folder as the MSI and MST files.<br>+
-The example transform also pre-sets the User Files folder to the default path:<br>+
-C:\Users\<user log in name>\My Documents\OriginLab\851\User Files\<br><br>+
-You can also create your own transform instead of using the example provided by OriginLab. +
- +
-===Running an MSI Installer with a transform===+
-Simply include the optional TRANSFORMS statement in the command line+
- TRANSFORMS="<transform1>.Mst [<transform2>.Mst]"<br>+
-For example, to use the example transform Origin851Sr2MSITransform.MST, run this command: +
- >msiexec /i "Origin851Sr2Setup.msi" '''TRANSFORMS="Origin851Sr2MSITransform.MST"''' /passive INSTALLDIR="<destination directory>" USERNAME="<client user/computer name>" COMPANYNAME="<company/department name>" PIDKEY="<serial number>"<br>+
-It should all be on '''one''' line, scroll to see all. You need double quotes around each input. You must also put any support files the transform needs like use_server.lic in the same folder as the MSI and MST files.+
- +
-===Using a BAT file===+
-You can put the command into a batch file, so there is a single file to click. Suppose you put the MSI and other files into a shared location, named say '''\\Share\OriginSetup\'''+
-Then create a batch file named say '''MSIInstallOrigin851Sr2Sample.bat''' with just one line (scroll to see all)+
- call msiexec.exe /i "\\Share\OriginSetup\Origin851Sr2Setup.msi" TRANSFORMS="\\Share\OriginSetup\Origin851Sr2MSITransform.MST" /passive INSTALLDIR="<destination directory>" USERNAME="<user name>" COMPANYNAME="<company/department name>" PIDKEY="<serial number>"+
- +
-Notice that this needs to be one line. The shared folder path \\Share\OriginSetup\ appears twice, once for the MSI and once for the MST. +
-The name of the MSI for this example is Origin851Sr2Setup.msi+
-and the MST name is Origin851Sr2MSITransform.MST. These are example names, and in the real case must agree with the file names you have.+
-Then when a user browses to \\Share\OriginSetup\ and clicks the batch file MSIInstallOrigin851Sr2Sample.bat, their command window will open to say+
- c:\Windows>...the command in the batch file will show here...+
-The user does not need to enter any information during the installation, since it is preset in the batch file.+
==Preparing a Template installation== ==Preparing a Template installation==

Revision as of 21:43, 10 February 2012


Go back to Multi-user Site Deployment

Contents

Things to consider before getting started

Methods for distributing Origin

There are two ways you can build an Origin installation package for distribution:

  • Preparing an MSI Installer: In this case you can use an MSI transform to pre-set the license management, the User Files Folder, registration, and other properties. You can include a batch file to run the MSI and the transform.
  • Template Installation: In this approach, you can install Origin on a "template" machine and then prepare an Origin package for distribution. As with the MSI package, you can pre-set the license management and other properties.

Post installation settings you can pre-configure in your distribution package

It is optional to configure the following settings in your installation package:

User Files Folder

The User Files Folder is the default file open and save location in Origin.
You can pre-set the User Files Folder by editing the Path key in the [User Files] section of the Origin.ini file, located in the Origin program folder. Comments are provided in the Origin.ini file to assist you.
If you do not pre-set the User Files Folder in your installation package, then each Origin user (each log in user) will be asked to select their own User Files Folder when they first start Origin. The user's Windows log in account does NOT need Administrator permissions to complete this step.

License management

If you have the Multi-seat Node Locked (Group) package, then you cannot pre-set the license management because each Origin computer requires a computer-specific license. The license is obtained from the OriginLab website using a dialog that opens when you run an unlicensed Origin. You can thus skip this section.
If you have the Concurrent Network package, you can pre-set the location of the FLEXnet license server so that the Origin users are not asked to specify this when they start Origin.
To configure this in your installation package, you must first create a text file named use_server.lic. You must then have your installation package install this text file into the Origin program folder \License folder that is created on the user computer by your installation package.
The use_server.lic text file you create must have the format:

SERVER <FLEXnet server Host Name or IP Address> ANY
USE_SERVER

Example:

SERVER main_server ANY
USE_SERVER

If you do not pre-set the location of the FLEXnet license server in your installation package, then when each user runs Origin on their computer, they will see a license dialog asking them to enter the Host Name or IP address of the FLEXnet server. The user's Windows log in account must have Administrator permissions to complete this step.

Registration

If you have the Multi-seat Node Locked (Group) package, registration occurs automatically when you license Origin on each computer. Thus you would not register Origin in your installation package. You can thus skip this section.
If you have the Concurrent Network package, you can register the Origin in your installation package so that Origin users are not asked to (optionally) register their Origin at start up.
To configure this in your installation package, you must first create a registration file using Origin. To do this, install Origin with your Concurrent Network serial number and then start Origin and connect to your FLEXnet server. Then select Help:Register Online. Complete the registration process by entering or pasting your Registration ID back into the Registration dialog. When you do this, Origin creates a registration file named RegID.lic. You can then locate this file on your computer, and include it in your installation package you plan to distribute. To find the RegID.lic file that Origin created, in Origin, open the Script window (Window:Script Window) and type in the following command and then press ENTER:

system.path.license$=

Origin will return the path to the License folder. The RegId.lic file is in the folder right above the License folder.
For example, on Vista/Win 7, if the License path is

C:\ProgramData\OriginLab\86\License\

then the RegId.lic file is in the path

C:\ProgramData\OriginLab\86\

Once you locate the RegID.lic file, then prepare your Concurrent Network installation package so that this RegID.lic file is written to the Origin program folder.
If you do not register Origin in your Concurrent Network installation package, then when each user runs Origin, they will see a Registration dialog requesting that they register Origin. Registration is optional - the user can choose not to register. If they do want to register, the user's Windows log in account must have Administrator permissions to complete this step.

The Origin Group Leader

The Group Folder / Group Leader feature allows you to set up a group leader which can serve as a source for distributing custom Origin files and patches to members of the group. Then once you have done this, you can set up the Origin in your installation package so that it is predefined to receive updates from the group leader.

Distributing your Origin installation package

Once you have your Origin installation package prepared, you can use a software distribution environment / software such as NetInstall or SMS to distribute the MSI package or the template installation.

Preparing an MSI installer

Preparing a Template installation

This section shows how you can prepare a template Origin installation, for use in "snap shot roll out" distributions.

Procedure to clean a machine of Origin 8.5.1

When preparing a template installation, you should start with a "clean" machine - one that has not previously had Origin 8.5.1 installed on it. This is because although you can un-install a previous Origin 8.5.1 installation, the un-install program does not delete all the Registry entries written by the Origin setup. So when you record or prepare your Origin distribution package from a second Origin 8.5.1 installation, you may not include some needed Registry entries if they already exist (and thus were not changed by the second installation).
If you have already installed Origin 8.5.1 on a computer, and would like to "clean" it, then do the following:

  1. Keep Origin installed, or re-install Origin. Run Origin to set default User Files Folder.
  2. Run system.path.appdata$= in Script window to find where the folder is. Record this folder so you can delete it later.
  3. Run system.path.license$= in Script window to find where the license folder is. Record this folder so you can delete it later.
  4. Open a DOS window and change directory into the Origin folder.
  5. Run the following commands one by one from the DOS prompt (make sure you have Administrative privileges).
    regsvr32 /u vsFlex8L.ocx
    regsvr32 /u GSpcIOLib.dll
    regsvr32 /u OSoap.dll
    regsvr32 /u tx4ole12.ocx
    regsvr32 /u ActiveQueryBuilderXControls.ocx
    This will unregister the DLLs that Origin registered. You must have Origin installed to unregister them, because these files are installed into the Origin directory.
  6. Now uninstall Origin and remove the install directory if it still exists..
  7. Delete the AppData folder you stored earlier.
  8. Delete the License folder you stored earlier. In Vista/Win7, please check if there is Compatibility Files folder and also go above one level above License and check if there is Compatibility Files folder there. If so, delete them.
  9. Go to the Origin program folder in the Start menu and find the User Files Folder link. Click it to find the User Files Folder. Delete the User Files Folder. Then delete the link.
  10. Click the autosave shortcut, and delete the folder. Then delete the shortcut.
  11. Delete the whole Origin Start folder.
  12. Open the registry key HKEY_CURRENT_MACHINE/Software/OriginLab
  13. Check the following registry key: HKEY_CURRENT_USER\Software\OriginLab\Origin 8.5.1\. If found, delete it.
  14. Run a registry editor with administrative privileges, and search and delete all the occurrences of the string vsFlex8L.

Installing Origin

Your Origin distribution package must include all the files installed by the Origin setup, as well as the Registry entries written by the Origin setup. When running the setup, please keep the following points in mind:

  • On the Origin Setup | Customer Information page, the User Name and Company Name that you enter will display in the About Origin dialog box for all users you distribute to.
  • On the Origin Setup | All Users or Current User? page, select All Users.

Post-installation settings

Please review the Post installation settings you can include in your package above to learn about settings you can pre-configure in your template installation.

Final notes

At this point your Origin template installation package should be ready to distribute. If you started Origin and selected a User Files Folder, you can omit your User Files Folder from the package.