Procedure Management

Procedures define the order in which Capabilities are executed in a Recipe. Procedures can involve a very simple sequence of Capabilities or a more complex arrangement which execute in a combination of parallel branches and loops.

Configuring a Procedure

You can set up a Procedure using Capabilities from the Capability library as well as flow controls from the flow control library. When you open a Recipe Template details page, you can see a list of Capabilities under the Procedure tab, Flow Controls library, and a procedure container window.

The Procedure container is the editor where you can create a procedure using the Capabilities and the flow control library. You can see the full screen version of the procedure container by clicking the Full Screen icon. Click Exit Full Screen to revert to the standard view.

You can create a procedure in the Recipe Template editor page by dragging Capabilities or the flow controls from the flow control library to the procedure container within the Start and End element in the Procedure container window. The Flow Controls library consists of the transition, branch, branch leg, and loop controls. You can construct nested loops and branches.

NOTE: If you move a procedure item on to the Start element, then the procedure item is moved below the Start element. If you move a procedure item on to the End element or below the End element, then the token is moved above the End element. You cannot add a procedure item above the Start element or below the End element.

The dragged Capabilities/Transitions or controls are also known as procedure tokens. When you drag the procedure tokens in the procedure container window, the drop target is highlighted. A procedure can have multiple procedure tokens arranged and connected with each other in a sequential manner. You can drop the procedure tokens at the beginning, in the middle or at the end of the procedure sequence on the procedure container editor. You can also reorder procedure tokens in the procedure by moving it to some other location within the procedure container. Within a procedure, these procedure tokens will have a unique alias name.

You can add multiple instances of a Capability or transition to a procedure.

When you add a large number of procedure tokens in the procedure container, and the dragged procedure token is held over the top and bottom panel edge, the scroll bar moves up and down automatically. When the dragged procedure token is held over the right or left edge of the Procedure Container window, the scroll bar automatically moves to left and right respectively.

You can add instructions, label and an URL for a Capability instance at configuration time in Recipe Template. A Capability with the instructions is displayed with an indicator icon on the bottom right side in Procedure. For more information, refer to the Configuring Instructions and Documents for a Capability Instance.

You can also navigate to the Parameter map details page from the procedure page by selecting the Capability in the procedure container and then clicking the View Parameters button. The Parameter map page displays only the associated parameters for the selected Capability, and it also applies a temporary filter based on the clicked Capability. You can use this feature to map an unmapped Capability parameter with the Formula parameter.

You can click the X icon to remove the filter to view all the Capability parameters associated with the Equipment.

To set up a Procedure

1. From the Main menu, select Templates > Recipe Templates to show the Recipe Templates summary page. All existing Recipe Templates are shown as tiles.

2. Select and click the Recipe Template for which you want to define the procedure.

3. Click Check out and then drag the Capabilities or transitions available under the Procedure tab to the Procedure container window within the Start and End elements. The Capability is added and displays the Capability name and the alias name. All the Capability details in the procedure container window are left aligned.

   NOTE: You can filter the available Capabilities based on the Equipment selected using the Advanced Filter icon. By default, it only shows Capabilities that are valid based on the existing Capabilities in the procedure. This prevents you from creating a procedure that cannot be run anywhere. You can further filter the Capabilities by selecting a set of Equipment in the filter. For more information, see Filtering Capabilities/Variables From Equipment.

4. You can rename the alias names of the Capabilities that you have specified in the procedure container window.