Skip Headers
Oracle® Communications Network Integrity Developer's Guide
Release 7.1

E23701-03
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

17 Working with UI Parameters

Design Studio supports user interface (UI) parameters on its discovery, import, and assimilation action types. UI parameters become input fields in the Network Integrity user interface into which you enter values when defining scans. These values are passed to the scan's processors when the scans run. UI parameters allow scans for a specific action to be configured for different environments and situations. Network Integrity uses Studio data dictionaries to implement UI parameters. See Studio documentation for a description of data dictionaries.Data dictionaries contain data dictionary items. Data dictionary items are of two types, elements and structures. A UI parameter is defined by a data dictionary structure. A data dictionary structure is a complex type which can have multiple child elements and multiple child structures. Child elements can be of a variety of different types: string, int, boolean, and so on. When used for UI parameters however, the data dictionary structure is restricted to child elements, that is, it cannot contain child structure. In addition, elements are restricted to type string or an enumeration of base type string.

Associating Data Dictionary Item Types with Attributes

You use Studio to decorate data dictionary items with GUI display and control information so that the UI parameters can be rendered and given appropriate handling in Network Integrity.

Note:

UI attributes for top level elements are not used.

The following section lists UI attributes that can be associated with data dictionary item types:

Associating UI Attributes with Data Dictionary Structures

Structures can be decorated with the following attributes:

  • Label: this attribute specifies the label to be displayed in the UI

  • Tool Tip: this attribute specifies a short message to be displayed when the pointer hovers over the field

Associating UI Attributes with Data Dictionary Child Elements

Child elements can be decorated with the following attributes:

  • Label: this attribute specifies the label to be displayed in the UI.

  • Tool Tip: this attribute specifies a short message to be displayed when the pointer hovers over the field.

  • Control Type: this attribute specifies the control type to be used for the UI input field. Choose from:

    • Input Text. If this value is selected, the field accepts user entered text

    • Choice. If this value is selected, the user can select from a set of values

  • Mandatory: this attribute specifies whether it is mandatory to enter a value into the UI input field.

  • Default Value: this attribute specifies the default value for a UI input field.

  • Secret: this attribute specifies whether the UI field is given special handling such that its value is not displayed to the user. Secret is specified as true to provide special fields such as fields containing passwords.

  • Read Only: this attribute specifies whether a UI field is read-only.

Displaying UI Parameters in the Network Integrity User Interface

When UI Parameter data dictionary items are created, the Display Name field is copied into the UI Hints label. Subsequent changes to the Display Name field are not propagated to the UI Hints label.

UI Parameters are displayed on two different pages in the Network Integrity UI:

Studio defines the separate UI attribute settings for each of the pages.

Figure 17-1 shows the Create Scans page.

Figure 17-1 The Create Scans Page

Shows create scan page

Figure 17-2 shows the Scan Details page.

Figure 17-2 The Scan Details Page

Shows scan details page

Working with UI Parameters

Working with UI parameters involves three separate Studio areas:

You must perform several high-level steps to use UI Parameters in actions. See "Using UI Parameters in Actions".

About the UI Parameters Tab

For action types which support UI parameters, their editors contain a UI Parameters pane. The action types which support UI Parameters are:

  • The Discovery action

  • The Import action

  • The Assimilation action

The UI Parameters tab is used for choosing the data dictionary structures that become the UI parameters of the action.The UI Parameters tab is also used to navigate to the other areas of Studio related to UI parameters.

Figure 17-3 shows the UI Parameters tab for a Discovery action.

Figure 17-3 The UI Parameters Label

Shows UI parameters label

About the Data Dictionary

The data dictionary is used to define the following data dictionary items used by the UI parameters:

  • The UI parameter structure

  • The elements of the UI parameter structure

  • The enumerations types of the elements within the UI parameter structure

Figure 17-4 shows the data dictionary editor.

Figure 17-4 The Data Dictionary Editor

Shows data dictionary editor

About the UI Hints Tab

The cartridge editor's UI Hints tab is where UI attributes are defined for the data dictionary structures and child elements of the UI Parameters. Figure 17-5 shows the UI Hints tab.

Figure 17-5 The UI Hints Tab

Shows UI hints tab

Using UI Parameters in Actions

To use UI Parameters in actions:

  1. In the action editor, select the UI Parameters tab.

  2. Select an existing data dictionary structure or create a data dictionary structure.

    Note:

    Although data dictionary structures for UI Parameters can be created directly in the data dictionary editor, this is not recommended for Network Integrity. Data dictionary structures for UI Parameters should be created using the UI Parameters tab.
  3. Navigate to the data dictionary to define the child elements of the structure.

  4. Use the data dictionary to define top level elements for enumeration types.

  5. Go to the UI Hints tab for the cartridge to add UI attributes to the UI Parameter data dictionary structures and elements.

About the Action Editor UI Parameters Tab

The Action editor UI Parameters tab contains the following buttons:

  • New. Click to create a data dictionary structure for use as a UI parameter. A Create Data Dictionary Item dialog appears. This is a standard Design Studio dialog. To use this dialog, see Design Studio documentation.

  • Select. Click to select an existing data dictionary UI Parameters structure. A Data Item Selection dialog appears. This is a standard Design Studio dialog. To use this dialog, see Design Studio documentation.

  • Remove. Select the data dictionary structures to be removed from the list used by the Action, and then click Remove. The data dictionary structures are not removed from the data dictionary.

  • Move Up. Select the data dictionary structure to move up the list. Click Move Up. The list order does not affect the presentation order in the Network Integrity UI.

  • Move Down. Select the data dictionary structure to move down the list. Click Move Down. The list order does not affect the presentation order in the Network Integrity UI.

The UI Parameters list also has a popup menu which supports the following functions:

  • Select UI Parameter from Data Dictionary. This menu item provides the same functionality as the Select button:

    Click to select an existing data dictionary UI Parameters structure. A Data Item Selection dialog appears. This is a standard Design Studio dialog. To use this dialog, see Design Studio documentation.

  • Create new UI Parameter in Data Dictionary.This menu item provides the same functionality as the New button:

    Click to create a data dictionary structure for use as a UI parameter. A Create Data Dictionary Item dialog appears. This is a standard Design Studio dialog. To use this dialog, see Design Studio documentation.

  • Open UI Parameter in Data Dictionary.This menu item opens the selected UI Parameter in its data dictionary.

  • Open UI Parameter in UI Hints. This menu item opens the selected UI Parameter in the cartridge UI Hints tab.

  • Remove. Select the data dictionary structures to be removed from the list used by the Action, and then select Remove. The data dictionary structures are not removed from the data dictionary.

  • Expand. This menu item expands the structure of the selected UI Parameters.

  • Collapse. This menu item collapses the structure of the selected UI Parameters.

About the Data Dictionary Editor

Use of the data dictionary editor is described in Design Studio documentation. When used for UI Parameters, the data dictionary structure can contain only child elements. It cannot contain child structures. Elements are restricted to type string or an enumeration of base type string.

About the Cartridge Editor UI Hints Tab

By selecting a UI Parameter in the action editor UI Parameters tab, and then selecting the Open UI Parameter in UI Hints menu item, you can navigate to this tab with the selected UI Parameter in focus.

Assign UI attributes to the data dictionary structures and child elements using the fields at the right of the tab.

When assigning UI attributes to data dictionary elements, you must first select the appropriate Network Integrity page where the UI attributes are used. This is done using the Page/Panel list at the top right of the tab. The valid choices are:

  • For data dictionary structures, chose Default. These UI attributes apply to all Network Integrity pages. The only UI attributes used are Label and Tool Tip.

  • For data dictionary elements, choose Create Scan/Plug-in Panel or Scan Detail/Plug-in Panel. You must define the UI attributes for both Network Integrity pages.

    There is a third option, which is Default. This should never be used for Network Integrity UI Parameters.

The valid choice for structures and elements of other entity types is Default/Default. The only UI Structures used are Label and Tool Tip.

Working with UI Parameter Examples

This section describes how to perform some common operations using UI Parameters:

Creating and Using UI Parameters

To create and use a UI Parameter:

  1. Create a data dictionary structure:

    1. From the UI Parameter tab for the action, click New.

      A Create Data Dictionary Item dialog appears.

    2. In the Name field, enter the name of the UI Parameter. Default values are valid for all of the other fields.

    3. Click Save. A data dictionary structure is created.

    4. Save the action.

  2. Define the fields for the UI parameter:

    1. From the UI Parameter tab for the action, double-click the new data dictionary structure.

      The data dictionary editor opens with the focus on the relevant structure dialog.

    2. If an enumerated set of values is required for a child element in the data dictionary structure, define a top level element, of type string, and define the enumerated values using the Enumerations tab.

      This element defines a new type to define structure child elements in the next step.

    3. Define the child elements for the UI Parameters structure. Enter values for the Name, the Display Name and the Type fields. Defaults values are valid for the remaining fields.

      Only string type or enumerations of base type string for UI Parameter elements are valid. For child elements that should be restricted to an enumerated set of values, specify the type to be the same as the type defined in the previous step.

    4. Save the data dictionary.

  3. Define the UI hints for the UI parameter:

    1. From the UI Parameter tab for the action, navigate to the Cartridge editor UI Hints tab by right-clicking the UI Parameter, and then selecting Open UI Parameter in UI Hints.

    2. Define the Label and Tool Tip UI attributes for the UI Parameter structure.

    3. Define UI attributes for each element in the UI Parameter. Do this for both the Create Scan and Scan Detail pages.

      For each element, perform the following:

      Select the Create Scan page, and set all of the UI attributes.

      Select the Scan Detail page, and set all of the UI attributes.

    4. Save the cartridge.

Using Existing UI Parameters

To use an existing UI Parameter:

  1. Select an existing data dictionary structure:

    1. From the UI Parameter tab for the action, click Select.

      A Data Item Selection dialog appears. See Design Studio documentation for information on configuring this dialog.

    2. Select the required UI Parameter. Click OK.

    3. Click OK. The UI Parameter is selected.

    4. Save the action.

  2. Define the UI hints for the UI parameter:

    1. From the UI Parameter tab for the action, navigate to the Cartridge editor UI Hints tab by right-clicking the UI Parameter, and then selecting Open UI Parameter in UI Hints.

    2. Define the Label and Tool Tip UI attributes for the UI Parameter structure.

    3. Define UI attributes for each element in the UI Parameter. Do this for both the Create Scan and Scan Detail pages.

      For each element, do the following:

      Select the Create Scan page, and set all of the UI attributes.

      Select the Scan Detail page, and set all of the UI attributes.

    4. Save the cartridge.

Editing UI Parameters

To modify an existing UI Parameter:

  1. Modify the UI Parameter's data dictionary structure:

    1. Double-click the UI parameter. The data dictionary editor appears.

    2. Edit the details of the data dictionary structure.

    3. Save the changes.

  2. Modify the UI hints for the UI parameter:

    1. From the UI Parameter tab for the action, the UI Parameter, and then selecting Open UI Parameter in UI Hints.

    2. (Optional) Edit the Label and Tool Tip UI attributes for the UI Parameter structure.

    3. (Optional) Modify the UI attributes for each element in the UI Parameter. Do this for both the Create Scan and Scan Detail pages.

      For each element, do the following:

      Select the Create Scan page, and edit UI attributes.

      Select the Scan Detail page, and edit UI attributes.

    4. Save the cartridge.

Defining a UI Parameters Enumerated Values Example

To define UI Parameters with enumerated values:

  1. In the data dictionary, create a top level element of type string:

  2. Select the Enumerations tab.

  3. Set the code and the description. The code becomes an enumerated value UI Parameter. The description becomes the label displayed in the Network Integrity UI.

  4. On the UI Parameter element, change the type to the type of the top level element you have defined.

Deleting a UI Parameter

To delete a UI Parameter:

  1. Remove the UI parameters from the action:

    1. From the UI Parameter tab for the action, select the UI parameters to be deleted.

    2. Click Remove.

    3. Save the action.

  2. If no other actions in the cartridge use the UI Parameter deleted in step 1, remove the UI hints for the UI parameter:

    1. From the UI Parameter tab for the action, navigate to the Cartridge editor UI Hints tab by right-clicking the UI Parameter, and then selecting Remove all UI Hints for the Selected Elements.

    2. Save the cartridge.

    3. Click Clean UI Hints.

    4. If no other cartridges use the UI parameter, and if you do not expect to use it again in the future, remove the UI Parameter from the data dictionary.