Installer - Screens And Actions Groups

  Screen and action groups can be configured on the screens & and actions tab.
  Actions and screens can be grouped in the tree of installer elements. Groups of the same type can be nested, meaning that you can put a screen group into a screen group or an action group into an action group.

You can nest as many levels of groups as you wish. Next to the label of the screen or action group in the tree of installer elements, the number of all contained screens or actions is shown in bold font. Elements in nested groups are counted as well.

  Grouping offers the following:
  • Organization
    If you have many screens or actions, groups emphasize which elements belong together. You can add a common comment to the group.
  • Common condition
    Groups have a "Condition expression" property that allows you to skip the group with a common condition instead of having to repeat the condition for each contained element.
  • Single link target
    If you want to reuse a set of adjacent screens or actions in a different part of your project, you can put them in a group and add a single link to that group instead of linking to each element separately.
  • Looping
    A group has a "Loop expression" property that allows you to execute the group repeatedly until the loop expression returns false.
  • Jump targets (screen groups only)
    When you jump to a screen programmatically (with context.gotoScreen(...)), it is more maintainable to jump to a group instead of to a single screen. You can think of the group as taking the function of a label in this case.
  The configurable properties of screen and action groups are:
 Screen group
     
A screen group contains multiple screens that can be disabled with a single condition expression on the group.
Properties:
  • Action elevation type [Privileges]
    If any contained actions should run in the elevated helper process, if their "Action elevation type" property is set to "Inherit from parent".An elevated helper process is available on Windows and macOS if the process has been started without admin privileges and the "Request privileges" action has been configured to require full privileges.
  • Style [GUI Options]
    The default screen style for this installer application. Screens and screen groups can override this style.
  • Customize title bar
    A form component in the selected style is configured to allow customization of selected properties.
  • Custom watermark
    A form component in the selected style is configured to allow customization of selected properties.
  • Customize banner image
    A form component in the selected style is configured to allow customization of selected properties.
  • Condition expression [Control Flow]
    This expression is evaluated just before the screen is displayed. If the expression or script returns false, the entire screen group will be skipped.
  • Loop [Control Flow]
    If selected, the screen group will be looped. With the child properties you can set an expression that terminates the loop and configure a loop index that is available inside the loop.

    Note: If actions should be repeated in a loop, their "Can be executed multiple times" property has to be selected. If form components in a screen should be re-initialized on each loop, their "Reset initialization on previous" property has to be selected.
  • Loop index start value
    The start value for the loop index variable that is passed to the "Loop expression"

    Note: This property is only visible if "Loop" is selected.

  • Loop index step
    The step for the loop index variable that is passed to the "Loop expression". At the end of each loop, this step is added to the loop index. It is added before the "Loop expression" is evaluated. To decrement, specify a negative value.

    Note: This property is only visible if "Loop" is selected.

  • Loop expression
    This expression is evaluated when the end of the screen group is reached. If it returns true, all screens will be repeated. If you leave the expression empty, no loop will be performed.

    Note: This property is only visible if "Loop" is selected.

  • Loop index variable name
    If you want to use the loop index in a screen that is contained in the group, you can optionally save the value to an installer variable. Specify the variable name to which the value should be saved as a java.lang.Integer.

    Note: This property is only visible if "Loop" is selected.

 Action group
     
An action group contains multiple actions that can be disabled with a single condition expression on the group.
Properties:
  • Action elevation type [Privileges]
    If any contained actions should run in the elevated helper process, if their "Action elevation type" property is set to "Inherit from parent".An elevated helper process is available on Windows and macOS if the process has been started without admin privileges and the "Request privileges" action has been configured to require full privileges.
  • Condition expression [Control Flow]
    This expression is evaluated just before the action is executed. If the expression or script returns false, the entire action group will be skipped.
  • Loop [Control Flow]
    If selected, the action group will be looped. With the child properties you can set an expression that terminates the loop and configure a loop index that is available inside the loop.

    Note: If actions should be repeated in a loop, their "Can be executed multiple times" property has to be selected. If form components in a screen should be re-initialized on each loop, their "Reset initialization on previous" property has to be selected.
  • Loop index start value
    The start value for the loop index variable that is passed to the "Loop expression"

    Note: This property is only visible if "Loop" is selected.

  • Loop index step
    The step for the loop index variable that is passed to the "Loop expression". At the end of each loop, this step is added to the loop index. It is added before the "Loop expression" is evaluated. To decrement, specify a negative value.

    Note: This property is only visible if "Loop" is selected.

  • Loop expression
    This expression is evaluated when the end of the action group is reached. If it returns true, all actions will be repeated. If you leave the expression empty, no loop will be performed.

    Note: This property is only visible if "Loop" is selected.

  • Loop index variable name
    If you want to use the loop index in a action that is contained in the group, you can optionally save the value to an installer variable. Specify the variable name to which the value should be saved as a java.lang.Integer.

    Note: This property is only visible if "Loop" is selected.

  • On error break group [Error Handling]
    If selected, and one of the contained actions returns with an error, the control flow will step out of the action group and continue with the next element after the group. This behavior only takes effect if the problematic action has its failure strategy set to "Continue on failure".
  • Retry expression
    If this expression is set and returns true, the action group is repeated. If the action group is configured to loop, the loop index will not be incremented.

    Note: This property is only visible if "On error break group" is selected.

  • Failure strategy
    The failure strategy that should be chosen if the action group fails. The "Error message" property will be used for the option dialog. If you also define a "Default error message", you will get two option dialogs, the first one from the action that causes the failure.

    Note: This property is only visible if "On error break group" is selected.

  • Error message
    If the action group fails, this error message is displayed to the user, otherwise the action group fails silently.

    Note: This property is only visible if "On error break group" is selected.

  • Default error message [Error Handling]
    A default error message used by all actions that have no dedicated error message.