Grouping Scalar Parameters using Structured Elements

You can group ASAP scalar parameters using the structured schema element feature. The structure element is a container that holds ASAP parameters. For example the following scalar groups can be defined using two levels of structure elements:

Structure element1
     Structure element2
              Scalar1
              Scalar2
Structure element3
     Structure element4
              Scalar3
              Scalar4

In a real world scenario, these structure could be as follows:

Person
     Name
         First_name
         Last_name
Place
     Address
         Number
         Street

The structure elements used in Design Studio are converted into individual ASAP scalar parameters by absorbing the structured element names into the scalar parameter name. The example used above describing a person and place would by default look as follows as ASAP parameters:

Person_Name_First_name
Person_Name_Last_name
Place_Address_Number
Place_Address_Street

The default character used to separate the elements in the ASAP parameter names is the underscore (_). It is possible to change this character. See "Defining Design Studio Activation Preferences" for more information.

To group scalar parameters:

From the Studio menu, select Show Design Perspective.
Click the tab for the Dictionary view.
Right click in the Dictionary view and select Add Structured Schema Element.

The Create Data Schema Structure wizard appears.
Enter the following:
1. In the Entity field, enter the name of the project to which you want to add a scalar parameter.
2. In the Name field, enter an element name.
3. In the Display Name field, enter a display name. The Data Schema editor supports multiple languages for this field. The field adjacent to Display Name displays your language. You can define a Display Name field value for any language you select from the list. For more information, see the Oracle Communications Design Studio Help.
4. In the Multiplicity field, select one of the following:
  - Required: This attribute makes the parameter mandatory.
  - Optional: This attribute makes the parameter optional.
  - Range: Any ranged parameter with a Minimum value greater than 0 is considered a mandatory ASAP parameter. Any ranged parameter with a Minimum value of 0 is considered an optional ASAP parameter.
Click Finish.

The new parameter appears in the Dictionary view. You may need to expand the schema for your cartridge to see it.
Double-click the new parameter to open the Data Schema editor with that parameter selected.
Click the Activation subtab.
From the Runtime type list, select SCALARS.
Right click the new parameter in the Dictionary view and select one of the following:
- Add Simple Child Schema Element: Select this attribute if you want to immediately define xml or scalar parameters within the first structured element. If you select this option, go to step 10.
- Add Structured Child Schema Element: Select this attribute if you want additional structured child schema elements below the first structured element. If you select this option, repeat steps 4 to 9.
Enter the following:
1. In the Name field, enter an element name.
2. In the Display Name field, enter a display name. The Data Schema editor supports multiple languages for this field. The field adjacent to Display Name displays your language. You can define a Display Name field value for any language you select from the list. For more information, see the Oracle Communications Design Studio Help.
3. In the Multiplicity field, select one of the following:
  - Required: This attribute makes the parameter mandatory.
  - Optional: This attribute makes the parameter optional.
  - Range: Any ranged parameter with a Minimum value greater than 0 is considered a mandatory ASAP parameter. Any ranged parameter with a Minimum value of 0 is considered an optional ASAP parameter.
Click Finish.
Repeat steps 10 to 11 for any additional parameters to be included in the scalar or XML parameter group.