Effectivity Definition Dialog Box | ||
| ||
Example Dialog Box
This screens shows an example of the Edit Effectivity Definition dialog box as defined by the EffectivityDefinitionDialog.jsp. This guide describes how this dialog box is defined; see the Configuration and Effectivity Services User's Guide for details on how a person uses this dialog box to build effectivity expressions.
URL Parameters To Pass to the Dialog
This JSP is used by Configuration and Effectivity Services, and should only be called by a custom application if a custom JSP is needed. This table lists the parameters that must be passed to the Effectivity Definition dialog box:
| URL Parameter | Description | Accepted Values/Examples |
|---|---|---|
| fieldNameActual | The field in the structure browser used to display the actual effectivity expression. Used only when invockedFrom=fromTable. | Valid structure browser field name. |
| fieldNameDisplay | The field in the structure browser used to display the display effectivity expression. Used only when invockedFrom=fromTable. | Valid structure browser field name. |
| fieldNameEffExprActual | The field that displays the actual effectivity expression. Used only when invockedFrom=fromForm. | Valid field name. |
| fieldNameEffExprActualList | The field that stores the actual expression list when re-editing an expression. Used only when invockedFrom=fromForm. | Valid field name. |
| fieldNameEffExprActualListAc | The field that stores the actual expression list when re-editing an expression. Used only when invockedFrom=fromForm. | Valid field name. |
| fieldNameEffExprDisplay | The field that displays the effectivity expression. Used only when invockedFrom=fromForm. | Valid field name. |
| fieldNameEffExprOID | The field that stores the binary filter expression. Used only when modetype=filter and invockedFrom=fromForm. Required if modetype=filter | Valid field name. |
| fieldNameEffTypes | The field on the above form that holds the check boxes to define the type of effectivity allowed for the context object. Used only when invockedFrom=fromForm. | Valid field name. |
| formName | The form where the effectivity expression should be populated. Used only when invockedFrom=fromForm. | Valid form name. |
| invockedFrom | Required. Defines the type of object that invoked the dialog box. |
|
| modetype | Required. Defines the type of dialog used when the dialog is invoked. |
|
| objectId | Only required when modetype=edit. Provides the objectId of the object for which the expression is being edited. | Valid objectId. |
| postProcessCFFURL | Defines a JSP page to call when the dialog box is dismissed. See Post Process URL for an Editable Form Page in the Business Process Services Administrator's Guide for details. If the user cancels from the invoked page, the user is returned to the Effectivity Expression Definition; if the invoked page is submitted successfully, the Effectivity Expresion Definition dialog continues with the submit process. | ..\engineering\emxVerifyModStack.jsp |
| showAnd | Shows or hides the AND button for use in building the effectivity expression. If there is a single effectivity type, AND does not make sense, and if used, creates an invalid expression. Hiding the button in this use case prevents this problem. True shows the button. If this parameter is set for the dialog box JSP and the command (see Type Menu and Mode Menu), then the command's value overides the JSP value. |
true (default) false |
| showContext | If true, pre-populates the tale used by the Effectivity Selector with the context objects defined by the current Effectivy Expression. This parameter has no effect if format=date for the command in the type menu. | true false (default) |
| showOr | Shows or hides the OR button for use in building the effectivity expression. True shows the button. If this parameter is set for the dialog box JSP and the command (see Type Menu and Mode Menu), thenthe command's value overides the JSP value. | true (default) false |
Type Menu
Configuration and Effectivity Services provides a menu named CFFEffectivity (labeled Type) that includes the CFFEffectivityDate effectivity command. Each implementor of effectivity should define custom commands and connect them to this menu as described in Effectivity Menu. They also control whether the Mode menu and Insert as Range check box display. See Effectivity Menu for details on the settings used to configure a command for the Effectivity menu.
The Insert as Range check box only displays if the allowRange setting on the selected command in the Type menu is set to true. The table is defined by the selected item in the Mode menu (see Mode Menu).
Note: When allowRange is false, the check box does not display. However, users can still manually enter range values, including ranges that may not exist.
Mode Menu
The Mode menu only displays on the Edit Effectivity Definition dialog box if the selected command in the Type menu has a value specified for its Mode setting. As installed, Configuration and Effectivity Services does not provide any mode menus and associated commands; the application developers must define these admin objects.
If defining a custom command for the Mode menu, use the settings defined in this table:
| Setting Name | Description | Accepted Values/Examples |
|---|---|---|
| allowRange | If true, the Insert as Range check box displays; if false, the check box does not display. |
|
| expandProgram* | Used to expand context objects in the Effectivity Selector table. Either the relationship or expandProgram setting must be defined. If both settings are defined, expandProgram is used. Used to expand the context objects in the Effectivity Selector table. | emxUnresolvedPart:getMODStacks |
| Label | The string resource value used to display the name of the command in the Type menu. | Effectivity.EffectivityType.Builds |
| Registered Suite* | The application the UI component belongs to. The system looks for files, such as string resources and properties, in the registered directory for that application, which is specified in emxSystem.properties. | Effectivity |
| relationship* | Used to expand context objects in the Effectivity Selector table. Either the relationship or expandProgram setting must be defined. If both settings are defined, expandProgram is used. Used to expand the context objects in the Effectivity Selector table. |
|
| selection | Specifies if the table shown in the Effectivity Selector field includes radio buttons (for single selections) or check boxes (for multiple selections). |
|
| showAnd | Shows or hides the AND button for use in building the effectivity expression. If there is a single effectivity type, AND does not make sense, and if used, creates an invalid expression. Hiding the button in this use case prevents this problem. True shows the button. If this parameter is set for the dialog box JSP and the command, then the command's value overides the JSP value. |
|
| showOr | Shows or hides the OR button for use in building the effectivity expression. True shows the button. If this parameter is set for the dialog box JSP and the command, then the command's value overides the JSP value. |
|
| table | The table to show in the Effectivity Selector field when the corresponding mode is selected. If not specified, the default table is used. If categoryType=sequence, then the table must have a column for SequenceSelectable containing the sequence value for that row, and it can be a hidden column. Values in this column must match the sequence syntax rules. | CFFDefinitionTable (default) |
*Required settings.
You must include one of these settings to define how the table is expanded:
- relationship
- expandProgram
If both settings are passed, the expandProgram is used. If neither setting is passed, the relationship setting is used with the default value "all".
Effectivity Expression
The dialog box includes tools to help the user build the effectivity expression. See the Configuration and Effectivity Services User's Guide for details. Although the user can define the expression by selecting data and clicking buttons, the user can also directly enter an expression. When the user clicks Validate, Configuration and Effectivity Services validates the syntax of the expression only; it does not validate that any specified objects in the expression exist. For example when entering Builds, 1-100 is a valid range even if the highest build number is only 50.