Show TOC

Redefine Ports/Reload Component/Reload Data Service/Replace Component Dialog BoxLocate this document in the navigation structure

Use

The Redefine Ports / Reload Component / Reload Data Service / Replace Component dialog boxes all contain similar options.

You use these dialog boxes to view or modify the ports and fields that you want have available on a data service or a nested component, so that you can connect to and from the ports when defining the data flow between elements. You can also view and resolve any potential conflicts that may occur due to configuration changes caused by the operation you are performing.

In addition, you can open the Redefine Ports dialog box at any time to change the ports that are displayed on the component. If new ports have been added to the component since you referenced it from your model, you can see them, and optionally select them.

If the component was created using Visual Composer, the latest port information is automatically retrieved from the cache of the latest checked-in version of the component and displayed in the dialog box. If the component was created outside Visual Composer, the dialog box automatically shows the ports from the component version in the cache.

You display the Replace Component dialog box by dragging and dropping a component over an existing component on the Design board. You display the Reload Component , Reload Data Service , or Redefine Ports dialog box by right-clicking the relevant icon on the Design board and choosing the relevant item from the context menu. The Redefine Ports dialog box may also open automatically when you drag a data service, which contains a large number of ports, to the Design board.

More information: Modifying Referenced Components

Note

You can define the number of ports required to open the Redefine Ports dialog box automatically in the Model group of the Options pane ( Start of the navigation path Tools Next navigation step Options End of the navigation path).

More information: Options Pane - Model Group

The Redefine Ports / Reload Component / Reload Data Service / Replace Component dialog boxes contain the following items:

Area

Item

Description

Search area

Search for...

The string that you want to search for in nodes and fields in the data set.

Search

Searches for the string defined in the Search for... field in nodes and fields in the data set, according to the selected Advanced Search Options .

Advanced Search Options

Enables you to refine the search using one or more of the following options:

Search in Selected Node Only : Restricts the search to the node currently selected in the tree, together with all of its child nodes.

Find Whole Names Only : Restricts the search to finding fields or nodes with the exact name that you specify in the Search for... area (no partial matches are displayed).

Search in Name and Description : Searches for the specified string within node and fields names, as well as in field descriptions (if any exist).

Show tree hierarchy

Displays the data structure nodes in a hierarchical tree.

Show field descriptions

Displays the Description column in the Define Data dialog box, as described above.

Node Area

Copy Node

Copies the currently highlighted node to the Clipboard so that you can paste it for use in another dialog box (for example, the Define Data dialog box). You can use this option to choose to Copy Node or Copy Node and Children .

Select All

Selects all the input and output ports in all nodes and sub-nodes in the list.

Deselect All

Deselects all the input and output ports in all nodes and sub-nodes in the list.

Dataset tree

Lists the names of all ports used as input and output to the data service, and enables you to select or deselect the ports you want to be available on the data service.

Choose which fields to display for each port of a data service, in addition to choosing which ports to display. Filtering out unneeded ports streamlines service consumption.

Field Area

Copy Fields

Copies the currently highlighted field to the Clipboard so that you can paste it for use in another dialog box (for example, the Define Data dialog box). You can use this option to choose to Copy Single Field or Copy All Fields in the node.

Select All

Selects all the fields in the list, together with the node that contains these fields.

Deselect All

Deselects all the fields in the list (does not deselect their node).

Fields list

Displays the fields in the dataset or the fields in the selected node of the dataset (and the field descriptions if defined in the back-end system), and enables you to select or deselect the fields you want to use. If the field is a complex field, you can expand and collapse the complex field to show and hide its fields.

Filtering out unneeded fields streamlines service consumption.

Show All

Enables a scrolled display of the list of fields, if the number of fields is large.

Conflicts Area

 

Displays any conflicts that may occur due to any changes in the port or field configuration. You can click on a port or field name in the Conflicts area to find any references to that element. You can also choose to replace a field with another field, by clicking the replace with link and choosing a new field from the list provided.