Skip to end of banner
Go to start of banner

Configuration

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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

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

For every button you can do the 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 you add a step to a given button, a new line will be added in the configuration table showing this step. For this new step you can also configure the scripts, change the description or rename it.

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


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 start with the word "Step" and its position in the list. This is an non-editable data.

You can change the description of the step by clicking on the Change Description button. 

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

Configuring a 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 you add a new action, it will have the following default condition script.

number ENABLED = 1;
number DISABLED = 2;
number HIDDEN = 3;
 
return ENABLED;


The script should return one of the predefined variables: ENABLED, DISABLED, or HIDDEN. The main difference between the condition script for a button and the condition script for a step is how we interpret the DISABLED / HIDDEN values.

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

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

number ENABLED = 1;
number DISABLED = 2;
number HIDDEN = 3;
 
if(<some_condition>){
    return ENABLED;
}
if(<some_other_condition>){
    return DISABLED;
}
return HIDDEN;


Sharing values between wizard screens

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

  • No labels