MAKEMSI quickly and reliably creates MSI files in a non-programmatic way\Source CodeCommandsJsCaSetup

---

The "JsCaSetup" Command

This command is used to schedule a preexisting JSCRIPT custom action (its already in the "Binary" table). It also sets up the "Action Text" which gets displayed in the progress bar even if your script does not update the bar itself.

You would normally create the script with "JsCa" but this is not required.

If you have an existing Windows Scripting Host (WSH) script which you want to use, use the "ExeCa" command to invoke "WSCRIPT.EXE". All parameters will typically be passed on the command line and no logging will take, in my mind good reasons why this should be avoided at nearly all costs. I recommend rewriting to use the "JsCa" command instead.

This command takes these parameters:

• Binary (required)
  This is the key into the "Binary" table (of the script).

• Entry (required)
  This is the name of the "entry point" you wish to execute. If you created the binary resource using "JsCa" then this function must have been created with the "JsCaEntry" command.

• Data (optional)
  This parameter should only be used on a deferred custom action. The parameter specifies the name of a previously generated 2 column "#data" structure.

  If this parameter is supplied then the setting up of the data uses the sequence number provided and the VBS takes the next "slot". You would not need to use the "KEY" parameter to specify any specific value to pick up the "CustomActionData" if this parameter is used.

• Seq (required)
  Actions are executed in sequence number order and some actions (or types of) are only allowed at certain "locations". This parameter allows you to specify when this action should be executed in relation to others. The fact that MAKEMSI successfully sequences your action at a particular location should not be assumed to mean that it is valid for it to be there.

  There will typically be a lot of standard actions at known fixed locations (which may however differ in sequence number or even order relative to one another with different templates). Click here for the default "InstallExecuteSequence" and "InstallUISequence" sequencing details.

  Normally you try not to duplicate sequence numbers but it is probably OK to do so as long as you don't care which one executes first! One possible exception would be deferred custom actions where the custom action data needs to be setup before execution. You should get a validation message to indicate a duplicated number (note that validation can't know whether custom action conditions are mutually exclusive etc).

  The sequencing information (see some default sequencing) can be supplied in a number of formats:

  • An Integer
    If you supply a number such as "1001" then this is a literal numeric value which generally should not duplicate any other in the same table. I suggest you only use this format as a last resort!

  • A VBSCRIPT Expression
    If the value you supply starts with "@" then what follows is the name of a VBSCRIPT variable or expression which will evaluate to a sequence number.

  • A MAKEMSI Expression
    MAKEMSI has its own syntax which describes the characteristics of the desired sequence number but leaves the actual value up to MAKEMSI to determine.

    Basically you describe a range of valid values and whether you prefer the value to be chosen from the lower (default) or higher end.

    The range should be specified in the format "lower - higher". Either value can be omitted, be specified as an integer such as "1000" or the name of an action such as "InstallFiles". The default value for the lower end is "1" and for the higher "32767" and leading and trailing spaces for each are stripped. The minimum and maximum values can be returned as the range is inclusive.

    By default MAKEMSI will choose a number as close as possible to the lower end, if you wish it to be as high as possible then begin the specification string with "<".

    Some Examples:

    • InstallFiles-
    • -InstallFiles
    • <-InstallFiles
    • < 1000 - 2000
    • AppSearch - CostFinalize

    You should of course be aware of what your script does, for example if it moves a custom action that you have already sequenced other actions relative to then that would probably be "bad"!

• Key (optional)
  This is the key for the custom action. If not supplied a default is chosen, however if you wish to have the same action occur more than once within a table you need to define a unique key. You would also define the KEY if you were setting up "CustomActionData".

• SeqTable (optional)
  This is the sequence table or tables you wish to use ("InstallExecuteSequence" table by default). The most common other table you might wish to use would be "InstallUISequence" table). Use space as a delimiter if more than one table.

  Note that you can supply an empty list (no tables) but you must confirm this by supplying a sequence number of 0 (zero) on the "SEQ" parameter.

• Description (optional)
  This will appear in any MSI log as well as progress bar line #1 (when deferred).

• Condition (optional)
  This identifies the conditions under which the code should be executed. By default it will always execute.

  I have captured a large number of "sample properties" which could be used in any conditions. Note that the values of some properties may not be available at all times and in some cases are modified during processing.

  You can also use any of the following predefined conditions:

  #define? CONDITION_ALREADY_INSTALLED Installed                          ;;Repair, uninstall etc.
  #define? CONDITION_INSTALL_ONLY      not Installed                      ;;Doesn't include a repair, uninstall etc!
  #define? CONDITION_UNINSTALL_ONLY    Installed and REMOVE~="ALL"        ;;Complete uninstall  - HIGHLY RECOMMENDED at you read the "REMOVE" properties MAKEMSI doco!
  #define? CONDITION_EXCEPT_UNINSTALL  not (<$CONDITION_UNINSTALL_ONLY>)  ;;Install, Repair etc (all but complete uninstall)
  #define? CONDITION_IS_WIN2000        VersionNT = "500"                  ;;Is OS WIN2000?
  #define? CONDITION_IS_WINXP          VersionNT = "501"                  ;;Is OS WINXP?
  #define? CONDITION_IS_VISTA          VersionNT = "600"                  ;;Is OS WINDOWS Vista?
  #define? CONDITION_UI_NONE           UILevel = 2                        ;;Silent Install
  #define? CONDITION_UI_BASIC          UILevel = 3
  #define? CONDITION_UI_REDUCED        UILevel = 4
  #define? CONDITION_UI_FULL           UILevel = 5                        ;;"Normal"
  #define? CONDITION_UI_NO_DIALOGS     UILevel <> 5                       ;;Don't bother user with popup dialogs, opening readme files etc.
  #define  CONDITION_PER_MACHINE       Version9X or (ALLUSERS = 1)        ;;True if per-machine install.
  #define  CONDITION_PER_USER          not (<$COND_PER_MACHINE>)          ;;True if per-user (not per-machine) install.

• Type (optional)
  This parameter may not be required for all custom action types, it provides a mechanism to override, update or undo any options that MAKEMSI may have decided to use.

  This parameter accepts one or more space separated attributes which are processed in left to right order. Available attributes are (not all may apply):

  1. Deferred
     This indicates that the custom action should be run deferred (not immediately). The opposite to the "Immediate" attribute and the default for most custom action types. If its deferred the "Description" will be displayed in the progress bar (line 1).

     A deferred (in-script) custom action must be sequenced between the "InstallInitialize" and "InstallFinalize" actions (or you will get a 2762 error) and data is passed via the "CustomActionData" property.

     All deferred actions are executed in a single pass by the server "MSIEXEC.EXE" service (a separate process) after being combined in a "script".

  2. Immediate
     The "immediate" attribute is the opposite of "deferred".

     All immediate custom actions scheduled between the "InstallInitialize" and "InstallFinalize" actions (reguardless of their sequence number) are executed before deferred ones.

  3. Sync
     This indicates that Windows Installer should wait for the custom action to complete. The opposite to the "ASYNC" attribute and this is the default.

  4. ASync
     The opposite to the "SYNC" attribute..

  5. Rc0
     This indicates that the SCRIPT indicates success by returning a return code of 0. The opposite to the "AnyRc" attribute.

  6. AnyRc
     The opposite to the "Rc0" attribute. The return code should be ignored.

     This should only be used as a last resort when executing some poorly written piece of "cr*p" (or perhaps if it's success is not critical to the install).

  7. Commit
     This indicates that the custom action is a "commit" custom action.

  8. Rollback
     This indicates that the custom action is a "rollback" custom action. It should be sequenced before the custom action being rolled back and have the same condition.

     Rollback custom actions (and so also the "worker" custom action) must be "deferred" and sequenced between "InstallInitialize" and "InstallFinalize".

  9. Impersonate
     The custom action should be run under user-level privileges. This is the default. The opposite to the "System" attribute.

     There are circumstances where a custom action may still run with system privileges.

  10. System
      The custom action should be run under the system account (elevated). The opposite to the "Impersonate" attribute.

      Lack of this attribute on deferred custom actions is a common reason for failures on Vista.

  11. FirstSequence
      No effect in UI sequence. If the "UI sequence" did run and this action is in the "Execute sequence" then it won't run (whether or not your custom action is sequenced in the UI)

  12. OncePerProcess
      Execute once per process if in both sequence tables. Skips action in execute sequence if UI sequence has been run in same process, for example both run in the client process. Used to prevent actions that modify the session state, such as property and database data, from running twice

  13. ClientRepeat
      Execute only if running on client after UI sequence has run. The action runs only if the execute sequence is run on the client following UI sequence. May be used to provide either/or logic, or to suppress the UI related processing if already done for client session.

  14. 64BitScript
      This is a 64-bit script based custom action.

  15. HideTarget
      The installer is prevented from writing the value in the Target column of the CustomAction table into the log file.

      The CustomActionData property is also not logged when the installer executes the custom action.

      Because the installer sets the value of CustomActionData from a property with the same name as the custom action, that property must be listed in the "MsiHiddenProperties" property to prevent its value from appearing in the log.

  16. TSAware
      Not sure, Microsoft don't document it (good one). If you have any issues with MSIs under terminal services then I'd guess this would be a good flag to try!

  17. PatchUninstall [4.5+]
      Used to define a custom action that only runs during the uninstallation of a patch.

  18. +[0x]Number
      A value beginning with "+" indicates that you wish to set (add) an attribute.

      If the number begins with "0x" (case insensitive) then the number is being supplied as a hexadecimal value otherwise its interpreted as being in decimal.

      You may need to supply a numeric value such as "+0x0001" is I haven't provided a suitable alias above...

  19. -[0x]Number
      A value beginning with "-" indicates that you wish to reset (remove) an attribute.

  20. =[0x]Number
      A value beginning with "=" indicates that you wish to set the custom action type to a specific value. This will completely override any other attributes that may have been previously specified internally by the MAKEMSI command or by you. This should rarely if ever be required

EXAMPLE

;--- Create a JSCRIPT and add to the binary table ---------------------------
<$JsCa Binary="SimpleCa.js">
    var some = 1

    <$JsCaEntry "Install">
    {
        try
        {
            CaMsgBox("E", "test of the error box")
        }
        catch(e)
        {
            CaDebug(0, "Install_1 function: trapped")
        }
    }
    <$/JsCaEntry>

    <$JsCaEntry "UnInstall">
        UserFunction("Uninstalling...")
    <$/JsCaEntry>

   //==========================
   function UserFunction(Text)
   //==========================
   {
       CaDebug(0, "Doing something...")
       CaMsgBox("I", Text)
       CaDebug(0, "Finished doing something...")
   }
<$/JsCa>

;--- Call the above script during install and uninstall ---------------------
<$JsCaSetup Binary="SimpleCa.js" Entry="Install"    Deferred=Y Seq="InstallFiles-" CONDITION=^<$CONDITION_INSTALL_ONLY>^>
<$JsCaSetup Binary="SimpleCa.js" Entry="UnInstall"  Deferred=Y Seq="InstallFiles-" CONDITION=^<$CONDITION_UNINSTALL_ONLY>^>

Please email me any feedback, additional information or corrections. See this page online (look for updates) MAKEMSI© is (C)opyright Dennis Bareis 2003-2008 (All rights reserved). Thursday August 28 2008 at 11:28am Visit MAKEMSI's Home Page