Managing procedures

If you want to use a set of steps in multiple requests, you can create a procedure from the steps and add the procedure to the requests. In this context, a procedure is a reusable group of sequential steps. You can create a procedure only after you have created a request and then added steps to it.

You can add procedures in series to a request. You need not create individual steps and add them one by one. When you add procedures serially, the system enables you to use existing procedures. After you have added the procedures, you can reorder steps within the procedures.

Conditional procedures are those procedures whose execution depends on the conditions that you set. You can set conditions that depend on the property or the runtime phase for a particular step or set conditions that depend on the environment or the environment type for the whole request.

 

This topic describes how to create and use procedures:

• To create a procedure
• To add a procedure
• To reorder steps in a request
• To add a serial procedure step
• To organize steps and procedures in a request
• To create a conditional procedure
• To manage a procedure
• To select a different application for a procedure
• To reorder steps of a procedure
• Related topics

To create a procedure

A procedure is a reusable group of sequential steps. After you create a procedure, you can add it (as many times as you want) into a particular request. It is assumed that you have steps in your request.

1. Click the Requests tab.
2. Click a request to which you want to add a procedure.
3. Click Create Procedure on the right.
4. In the Name field, type a name for the procedure.
5. (Optional) Add a description in the description field.
6. Click Create Procedure.
7. (Optional) To rename a procedure, click the procedure name, enter the required procedure name and click Save.

After you have created a procedure, you can add it to the request.

To add a procedure

1. Click the Add Procedure button.
   A dialog box with the list of the procedures is displayed.
2. Click Add next to your required procedure in the list.
   The procedure is added to the request.

To reorder steps in a request

Reordering steps in a request can be divided into two workflows. One is (i) to reorder steps of a procedure and (ii) to reorder steps within a procedure.

To reorder the steps of a procedure

1. Click the Reorder Steps button.
2. When the steps list appears, drag and drop the steps to reorder according to the needs of the release.
3. Click Done Reordering.

To reorder steps within a procedure

You may have added more procedures to your request by following the To add a procedure process. There may be multiple steps within the procedure. You may have a need to rearrange or reorder the steps within this procedure.

1. Click the Reorder Steps button.
   The steps list appears.
2. Click the arrow on a step box that has multiple steps within it (the number of steps within a step box is displayed).
3. When the step box opens, drag and drop the steps to reorder according to the needs of the release.
4. Click Done Reordering.

To add a serial procedure step

1. From the Requests tab, click the request to which you want to add steps.
2. Assuming that you already have existing procedures and steps and now want to add a serial procedure, click the add serial procedure step link for which you want to add a serial procedure.
3. Add the entries in the various fields.
   When you select a component from the Component list, the version field opens.
4. Select the required version for the component.
5. Click the appropriate button:
   • Save Step to add a single step
   • Save and Add New to add more serial procedure steps

To organize steps and procedures in a request

1. Select the project on the Projects tab.
2. In the projects list, click open the project.
3. Click the Requests tab.
4. Click the relevant request.
5. Click Reorder Steps.
6. Perform one of the following actions:
   1. To add a procedure, drag the procedure from the list of procedures on the right and drop it into the list of steps. You can place it before, after, under, or above any other step or procedure.
   2. To reorder a step or procedure, drag the step or procedure to any new position in the request — before, after, under, or above any other step or procedure - and drop it.

7. Click Done Reordering.
   The new arrangement of steps and procedures is displayed for the request.

   Warning

   Note

   If the step is associated incorrectly with a component, indicated by red broken links are displayed. If this happens, modify the Component attribute in the offending step by selecting a different component. Alternatively, perform the following actions:

   1. In the Search field of the Steps pane, type the component name that you want to change and click Search.
   2. Click the Visible link (top of the Steps pane).
   3. Click Modify App Component (top of the Steps panel).
   4. In the Modify Step Application and Component dialog box that appears, select the required application from the Application list.
   5. In the Component field, select the component.
   6. Click Update. The change is applied when the bulk procedure is run.

To create a conditional procedure

1. For the request opened, click Conditional Procedure Execution  next to the step.

2. Set the appropriate option:

   • Property Value
     1. In the Edit Condition dialog box, select the required step from the Step list.
     2. Select the property from the list.
     3. In the Required Value field, enter the required value.
   • Runtime Phase
     1. In the Edit Condition dialog box, select the required step from the Step list.
     2. From the Runtime Phase list, select the runtime phase.
   • Environment
     1. From the Environment list, select one or more environments.

   • Environment type
     1. From the Environment Type list, select one or more environment types.
3. If you had set any earlier condition and want to remove it, then deselect the Remove Condition field.

4. Click Add Condition

   Warning

   Notes

   The Conditional Procedure Execution icon changes depending on the  conditional procedure applied to the step:

   • — No conditional procedure applied to the step
   • — The applied conditional procedure matches the values for the current step or request
   •  — The applied conditional procedure does not match the values for the current step or request

   For conditional procedures applied to a step or a request, move the pointer over the Conditional Procedure Execution icon to see the applied conditions and their type.

To manage a procedure

1. Select Environment > Metadata > Manage Procedures.
2. Click open the procedure that you want to manage.
3. Perform the following action:
   • Change the name or description of the procedure.
   • Select a different application to associate with the procedure.
   • Change the order of steps in the procedure.
   • Modify the steps added under the procedure. You can modify details such as the component associated with the step. The list of components is displayed irrespective of the application to which the step's request is associated.
4. After you finish, click Update.

To select a different application for a procedure

1. Select Environment > Metadata > Manage Procedures.
2. Click open the procedure that you want to manage.
3. In the Application field, select a new application.
4. Select multiple procedures if required by using the Ctrl key.
5. Select Update.

To reorder steps of a procedure

1. Click open Environment > Metadata > Manage Procedures.
2. Click open the procedure for which you want to reorder the steps (it is assumed that your procedure has multiple steps or that you have added multiple steps for a procedure).
3. Click the Reorder Steps button.
4. When the steps list appears, drag and drop the steps to reorder.
5. Click Done Reordering

Related topics

Managing-requests

Managing-steps