Component Help

Detailed online help is avaliable for every component. This information explains the component's purpose, parameters, parameter values, ports, and more. This help is intended to help protocol designers configure new components. It is also available at run time to help end users of protocols set run-time parameter values.

Tip: Each component collection also includes a user guide that provides more background information on using a collection. Many guides also include step-by-step lessons for building example protocols.

Getting Information about Components

There are different ways to get component reference help.

To read a tooltip about a component in the Explorer window:

• Point your mouse over the item in the Explorer window and read the tooltip.

  

  Tooltip help for Custom Manipulator (PilotScript) component

To read detailed help about a component before opening it:

• Single-click the item in the Explorer window. The component help is displayed in the Help window in the lower-left.

  

  Component help displayed in left-hand Help window

To get help for a component open in the workspace:

• Single-click the component icon in the workspace. The component help is displayed in the Help window in the lower-left.

  

  Help for component selected in the workspace

To get help for a parameter in a component:

1. Click the component icon in the workspace. The available parameters for the component are displayed in the Parameters window (lower-right).

   

   Parameters for the selected component

2. From the list of parameters, click the one for which you want help. The Help window (lower-left) displays help for the selected parameter.

   

   Help for a parameter

To browse component help in the Help Center:

1. Open the Help Center.
2. Click the Users tab.
3. From the contents tree (on left), open the book titled "Component Collections".
4. Open the collection that contains the component help you want to peruse (e.g., "Generic").
5. Click a component name from the tree (e.g., "Custom Manipulator (PilotScript)"). Its content is displayed on the right.

   

   Component help displayed in Help Center

See Also:  Pipeline Pilot Help Center  |  Customer Support