Working with Global Entry Lists

Use

You can create global entry lists for use as input to controls in multiple models. A global entry list is a predefined list of entries (either dynamic or static) that can be used as input for certain control types in multiple models. You create the global entry list once, save it in the local repository or check it in to source control, and then reuse it multiple times in multiple models.

A global entry list is saved as a component in the location you specify. To use a global entry list as input for a control in a model, the global entry list component must reside in any development component in the shared repository or source control system, or reside in the same development component in the local repository as the model in which you want to use it.

You can create a global entry list in the following ways:

Create a global entry list from scratch
Edit an existing dynamic or static entry list, and save it as a global entry list. For information about creating static and dynamic entry lists, see Creating Entry Lists .

After you have created a global entry list, you can use it as input for a control.

Procedure

Creating a Global Entry List from Scratch

Choose Tools New Global Entry List . The Entry List Wizard opens.
In the Select Entry List Type page:
1. Enter a name for the global entry list.
2. Choose the type of global entry list that you want to create:
  - Static : An entry list in which you predefine each item as a static value.
  - Dynamic : An entry list that is populated dynamically from a data service at runtime, according to the input fields selected and the corresponding values that you assign.
3. In the Location area, specify where you want to create the global entry list:
  - From the Repository dropdown list, choose the repository type in which to store the service component. You can choose from the following options:
    - Local Repository : Stores the service component in a local repository with no source control. Service components in the local repository can be accessed only by the user who created them.
    - Source Control Repository : Stores the service component in the source control system. This option is available only if you have a supported source control system installed and configured for Visual Composer.
  - In the Software component field, choose the software component in which you want to save the service component.
  - In the Development component field, choose the location in which to save the service component. If there are no development components in the dropdown list, or if you want to create the model in a different development component, you can create one using the New button. More information: Creating a Model and Development Component .
4. In the Description area, enter a textual description of the entry list.
5. Click Next .
Perform one of the following, depending on your selection:
- If you selected Static :
  1. Click the button to add entries to the list.
  2. Define a unique value and display text for each entry. The unique value is the field value that is transferred to the data service at runtime. The display text is the value that is displayed in the control for selection at runtime.
  3. Select entries and use the and buttons to reorder the entries if required. This defines the order in which the entries are displayed in the list at runtime.
- If you selected Dynamic :
  1. Search for and select the data service from which you want to retrieve the entry values at runtime, and click Next . For more information about searching for a data service, see Discovering Data Services .
  2. From the Output port dropdown list, choose the data service port that returns the values used to populate the entry list.
  3. If the output port contains a clustered dataset, from the Cluster node dropdown list, select the source node that contains the field whose values you want to use for the entry list.
  4. In the Value field, specify the source field from which the field value should be taken. In the Display text field, specify the source field from which the display text should be taken (the value displayed in the entry list at runtime).
    Note
    - You can use the Additional entries checkbox to add static items to the entry list. Items defined in this way are displayed at the top of the entry list at runtime; they are not displayed alphabetically with the dynamically added items.
    - You can use the Global fields checkbox to define fields that can be used in other elements using the Dynamic Expression Editor dialog box.
Click Finish to finish defining the global entry list. The global entry list is displayed in the Manage task panel, under the Entry Lists node of the development component in which you chose to create it.

To edit a global entry list, right-click it in the Manage task panel and choose Open Entry List from the context menu.

Saving an Existing Entry List as a Global Entry List

Right-click a control that has a static or dynamic entry list defined for it, and choose Edit Entry List from the context menu. The Edit Entry List dialog box opens, showing the contents of the entry list.
Click Save As Global , and enter a name and description for the global entry list in the displayed dialog box.
Click OK . The selected control now uses the new global entry list, and the global entry list is displayed in the Manage task panel, under the Entry Lists node of the current development component.

Editing a Global Entry List

Choose one of the following methods to open a global entry list for editing:
- In the Manage task panel, double-click the global entry list that you want to edit. The Edit Entry List dialog box opens.
  
  Note
  If the global entry list is checked in to source control, you need to check it out before you can edit it, otherwise you will not be able to save your changes.
- Right-click a control that uses the global entry list that you want to edit, and choose Edit Entry List from the context menu. The displayed dialog box shows details about the entry list. Click Edit Global to open the Edit Entry List dialog box.
  
  Note
  For dynamic entry lists, you can also click Map Inputs to modify the input mappings to the global entry list for the specific usage (from the current control).
Edit the content of the global entry list. The available options are the same as when creating a global entry list using the wizard. For more information, see step 3 in Creating a Global Entry List from Scratch , above.

In addition, if you are editing a global dynamic entry list, you can click Reload Service to reimport the data service on which the entry list is based, if the service has been changed in the back end.

Using a Global Entry List as Input for a Control

On the Layout board, right-click the control for which you want to use a global entry list as input, and choose Entry List from the context menu.
Choose Global and click Next .
Search for and select the global entry list that you want to use, and click Next . The details of the selected entry list are displayed.
If the entry list is dynamic:
- Map the output port of the view element to the input port(s) of the global entry list by dragging from the icons on the left to the icons on the right.
- Define the mandatory values that you need to send to the global entry list to get the output values that you want in your list by entering the required Assigned Value for each Target Field .
Click Finish . The global entry list you selected is used at runtime to provide list entries for the selected control.

Note
You can remove the global entry list from the control by right-clicking the control and choosing Remove Entry List from the context menu. Note that this does not delete the global entry list; it simply removes it from use by the control.