Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The wizard is implemented as a list of steps starting that start from the main button. They can all be configured You can configure each of them directly from the custom field configuration page of the custom field.

The configuration page displays a list of buttons with all their steps. A button is actually the first screen of a the wizard.

For every button you can do the next following operations:

  • edit the scripts

...

  • – condition, screen, and action

...

  • change the description

...

  • rename it

...

  • add or remove a step

...

  • reorder the steps to suit your needs. 

When adding you add a next step to a given button, a new line will be added in the configuration table , containing the itshowing this step. For this new step we you can also configure the scripts, change the description or rename it.Image Removed

The steps of a button can be reordered inside the button.

Image Added


Adding new steps

In order to add a new step all you need to do is press the "Add Next Step" button (the "+" icon) for the desired button. A new line containing the new step will be added into the table. 

The name of the step will always be built from start with the word "Step" and its position in the list. This is an non-editable data.

The You can change the description of the step can be changed by clicking on the "Change Description" button. 

Note
The You can reorder the added steps can be reordered within the button, but the steps step names will be always retain the current position of the step.

...

The condition script for a step is similar to the one for a button. This means that it still allows you to decide whether an action will be available for the user , or not. 

By default, when adding you add a new action, it will have the following default condition script.

...

The script should return one of the predefined variables: ENABLED, DISABLE, or HIDDEN.

...

 The main difference between the condition script for a button and the condition script for a step is how we interpret the DISABLE / HIDDEN values.

  • Enabled actions are available for the user to execute.
  • Disabled actions mean that the screen for the action will not be visible at all and thus not available unavailable for the user to execute.
  • Hidden actions mean that the screen for the action will not be visible at all but the action script will still be executed.

Of course, since we are using SIL, the return value of the script can be conditional.

...

Sharing values between wizard screens

Since some values from a screen of Certain values on the wizard may screen might depend on other values from another screens, therefore we implemented some implemented additional routines that should help with the sharing mechanism.