We need you!

Icon

The IzPack documentation needs work, and you are invited to edit it!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: added link to jar jar example

...

This panel allows you to execute arbitrary files after installation.

You may also want to refer to the specific example of Executing a Java Class with ProcessPanel for a discussion of of a particular use case for the ProcessPanel.

ProcessPanel Specification File

The details for the compilation execution process are specified using the resource ProcessPanel.Spec.xml.

The XML file has the following format:

Code Block
languagehtml/xml
<processing>
  <job name="do xyz">
    <os family="windows" />
    <executefile name="$INSTALL_PATH/scripts/xyz.bat" workingDir="$INSTALL_PATH">
      <arg>doit</arg><arg>$variable</arg>
    </executefile>
  </job>
  <job name="do xyz">
    <os family="unix" />
    <executefile name="$INSTALL_PATH/scripts/xyz.sh">
      <arg>doit</arg><arg>$variable</arg>
    </executefile>
  </job>
  <job name="run on failure" catch="true">
    <os family="unix" />
    <executefile name="$INSTALL_PATH/scripts/run_on_fail.sh">
      <arg>doit</arg><arg>$variable</arg>
    </executefile>
  </job> 
  <job name="run always" final="true">
    <os family="unix" />
    <executefile name="$INSTALL_PATH/scripts/run_always.sh">
      <arg>doit</arg><arg>$variable</arg>
    </executefile>
  </job> 
 </processing>

Each job <job> may have an <os> attribute.In the following attributes and an <os> attribute:

AttributeDefaultDescriptionMandatory
name
(not set)name given to the step the jobyes
condition
(not set)IzPack condition ID for running the jobno
catchfalseJob runs only in the event of other jobs failingno
finalfalseJob runs always, whether previous jobs succeed or notno

Catch and Final jobs

The 'catch' and 'final' attributes for a process panel job are used to create a try/catch/final structure for your processes. If a standard job (one without catch or final) fails, the process panel will skip the remaining jobs and exit with a failure.

In the event of a failure of a normal job, any jobs marked with the 'catch' attribute will run. 

If a job fails and there is no 'catch' job, the process panel will skip the remaining jobs and exit with a failure.

The jobs marked with the 'final' attributes will always run regardless of success or failure.

In the example above, the "run on failure" job is only run if one of the "do xyz" jobs fails. The "run always" job is always run regardless of whether there is a previous failure or not.

Nested elements to <job>

<os> - Limit Job Execution Environment

See the IzPack OS Restrictions tag.

<executeFile>- Execute Shell Scripts

In addition to <arg> elements, the <executefile> element also accepts <env> elements to set variables in the environment of the target process. This can be useful if this process requires some environment variables, such as its installation directory, to work properly. An <env> element has the following syntax: <env>variable=value</env>. Note the value element supports variable substitution, for example: <env>MY_PRODUCT_HOME=$INSTALL_PATH</env>.  The

The workingDir attribute for the <executefile> element adds the ability to set the working directory of the process spawned by the ProcessBuilder object, much as <env> elements refer to the environment object of ProcessBuilder.

The ProcessPanel now also supports configurable behaviour for the panel's "Previous" and "Next" buttons. By adding <onFail> and <onSuccess> childs children to the <processing> element, you can define which buttons you want unlocked in case of failure and in case of success, respectively.

Code Block

<processing>
  <job name="do xyz">
    <executefile name="$INSTALL_PATH/scripts/xyz.bat">
      <arg>doit</arg><arg>$variable</arg>
    </executefile>
  </job>
  <onFail previous="true" next="false" />
  <onSuccess previous="true" next="true" condition="mycondition" />
  <onSuccess previous="false" next="true" condition="!mycondition" />
</processing>

...

It is also possible to execute Java classes from this panel. Here's what this feature's author (Alex Bradley) says:

> i've been able to work around my requirements by extending the ProcessPanelWorker functionality to run user-specified classes. i've extended the DTD of the ProcessPanel.Spec.xml to include a new element:

Code Block

<executeclass name="classname">
<args..../>
</executeclass>

> i've also added a new sub-class of Processable called executeclass. This will run a user-specified class in the context of the installer JVM with a single method :

Code Block

run( AbstractUIProcessHandler handler, String[] args]);

...

To use the executeclass facility, you will need to create a jar file with your class and then add it to the installer with the `The Jar Merging Element`.

See Executing a Java Class with ProcessPanel for details.

<executeForPack> - Only execute the job for certain packs

This can be be used to run the job only if the pack is enabled. For example, the batch file will if either the Sources or Executables packs are selected at install time.

Code Block

<processing>
 <job name="List files">
  <executeForPack name="Sources"/>
  <executeForPack name="Executables"/>
  <os family="windows" />
  <executefile name="$INSTALL_PATH\batch\ListFiles.bat" />
 </job>
</processing>

<logfiledir> - Output of the processPanel saved to a log

New with version 3.7 is the possibility to tee output Output that is written to the ProcessPanel's textarea into can be duplicated in an optional logfile. Using this feature is pretty much straightforward, you only have to add a line in Add a <logfiledir> element to the <processing> element of the  ProcessPanel.Spec.xml that will  to tell IzPack the location, where the logfile should be stored.

Variable substitution is performed, so you can use $INSTALL_PATH as  for example.

The name of the logfile is not (yet) configurable but should fit in most cases. It will be namedInstallnamed Install_V<$APP_VER><YYYY><MM><DD><hh><mm><ss>_<RandomId>.log
Here's an example:

Code Block

<processing>
  <logfiledir>$INSTALL_PATH</logfiledir>
  <job name="do xyz">
    <os family="windows" />
    <executefile name="$INSTALL_PATH/scripts/xyz.bat">
      <arg>doit</arg><arg>$variable</arg>
    </executefile>
</processing>

...

ProcessPanelWorker will write all output that is directed to stdout and stderr to this file if ProcessPanel.Spec.xml contains the logfiledir entry.

Please note that this one the same file is used for storing the complete output of all jobs and not a file for each job that is run.