Managing requests

The main unit of deployment in BMC Release Process Management is a request. A request represents the deployment of the components of an application into an environment. It describes the work to be done in the deployment process, such as putting an application in an environment, adding attributes, and packaging and deploying the software. A request is composed of steps, which can be manual (for example, Check logs for errors) or automated (for example, Deploy package) using one of the automation modules.

You can assign requests and steps to users and schedule requests in the calendar. Requests have a duration, a planned date, and a due date. They follow a series of states and transitions from planned to complete.

You can execute requests as part of a project, or as part of an application plan process or release plan. If you associate a request with an application when the Strict plan control setting is turned on, the request cannot be created, updated, or started unless it has a plan and a plan stage assigned.

This topic consists of the following sections:

Requests and access permissions

You can create a request in several ways, including from existing request templates. Request templates are particularly useful when you know that some steps will be repeated in several requests. Instead of constructing the steps over and over, you can take the request that has a complete set of information and steps and create a request template. For more information, see To create a request template and a request using the new template.

If a request is created from a template, you can see the actual template for the request in the Created from field in Requests > <Request name>. You can also create a new request by cloning an existing request.

On the Dashboard tab, users can see requests assigned to their application only. However, requests in the Created state are not visible if the user only has permission to view Requests lists. Access permission for Created requests is added separately and applies to all Requests lists visible in the application, including the Dashboard. For example, if a user does not have permission to view Created requests, Created requests are not visible in the My Requests and Currently Running Steps subtabs on the Dashboard. Users who do not have access to the Requests list cannot view the requests in any Requests lists, including the Dashboard.

Startin with BMC Release Process Management 4.6.00.06, on the Dashboard and Requests tabs, you can see requests created in the last two months by default. To find an older request, you need to do a search or use filters.

_{Return to top}

Creating a request

You can create a request in several ways as described in the following sections:

• To create a request from the Requests tab
• To create a request template and a request using the new template
• To create a request from the Requests tab using a request template
• To create a request from the metadata using a request template
• To create a request for an existing plan
• To create a request for the allow deployment window from metadata
• To create a request for the allow deployment window from a calendar report
• To clone a request

When creating new requests or requests based on a request template, you can select one or more environments. If you select multiple environments, requests are created for each environment with the same data (for example, name, application, time estimate, start date, and so on). The number of requests created is equal to the number of selected environments. For example, if you create a request and select three environments, three requests are created with the same data.

_{Return to top}

To create a request from the Requests tab

1. Click the Requests tab, and then on the Requests page, click Create Request on the right pane.
2. Under Core Attributes, enter a Name for the request.
3. Select the user to designate as the Requestor and Owner of the request.
4. From the Plan list, select the plan for your request.
5. From the Stage list, select the plan stage for your request.
6. From the Application list, select the application for your request.
7. From the Environments list, select the environment for your request or for multiple environments, perform the following steps:
   1. Click Multi-select environments and Add Environments.

   2. From the list of available environments on the left, click the appropriate environment and click > to move the environment to the list on the right. Repeat this step for each environment you want to assign to this request.

      Note

      If you do not have the required permissions to create a request for an environment, the environment is not selectable.

   3. Click Select to save your environment selections.

       The environments you selected and saved appear in the Environments list.

      

8. From the Business Process list, select the business process for your request and add a description of the business process.
9. In Description, enter a short description for the request.
10. From the Release Tag list, select the applicable release.
11. Click the Show link next to Extended Attributes and enter the appropriate attributes, if any.
    The available attributes are Projects, Package Contents, Wiki, and Uploads.
12. Under Scheduling and Estimation, perform the following steps:
    
    1. From the Estimate list, select the estimated time for the request.
    2. In Planned Start, enter the start date and time for the request.
    3. (Optional) If you want to start the request automatically at the specified Planned Start date and time, select the Start Automatically check box.

    4. From the Deployment window list, select the deployment window for the request.

       Note

       The Deployment window list appears only when you associate a request with an environment that has a closed deployment policy. For more information about deployment policies for environments, see Managing environments.

    5. In Due by, enter the end date and time for the request, and any Notes you would like to make.

       Notes

       • If you use deployment windows and different deployment policies for environments, all parameters from the Scheduling and Estimation section are required to start the request. Ensure that the estimated time frame for the request matches the deployment window event for the associated environment.
       • When you create a new request, only the Planned Start and Estimate parameters are required if you selected the Deployment Window parameter.

       • If you set valid Scheduling and Estimation parameters, you can start a request manually at any time. To avoid any possible issues caused by deployment during a different time frame, start a request according to the Planned Start and Estimation time frame.

13. Click Create Request.
    The request is created and the request details are displayed. At this point, you can add steps to the request. For more information, see To add steps to a request.

    The request ID is visible at the top left corner.
    

_{Return to top}

To create a request template and a request using the new template

With BMC Release Process Management you can save time by creating request templates from existing requests. You can use the new template for as many additional requests as needed.

1. Click the Requests tab.
2. From the requests list, click the appropriate request from which you want to create a template.
3. Click Create Template on the right pane.
4. In the dialog box, enter a Name for the template.
5. Click Create Template.

6. (Optional) To make the request template available for other users, perform the following steps:

   1. Go to Environment > Metadata > Manage Request Templates.

   2. Change the status for the request template to a state other than Draft by clicking the appropriate state in the Actions column. For more information about the status of objects and available states for request templates, see Using status of objects.

7. (Optional) To create a request based on this template, select from the following options:

   • All — Include all versions and assignments specified in the request template.
   • Versions — Include only the versions specified in the request template.
   • Assignments — Include only the assignments specified in the request template.
8. Click Create Request.

To create a request from the Requests tab using a request template

1. Click the Requests tab and click Create Request on the right pane.
2. Under Core Attributes, enter a Name for your request.
3. Select the user to designate as the Requestor and Owner of the request.
4. Click Choose Template on the right pane.
   The Available Templates appear above the Core Attributes.
5. In the last column of the appropriate template, select to include All versions and assignments specified in the request template, only the specified Versions, or only the specified Assignments.
6. Click Create Request.
7. In the dialog box, from the Select environment list, select the required environment for the request or for multiple environments, perform the following steps:
   1. Click Multi-select environments and Add Environments.

   2. From the list of available environments on the left, click the appropriate environment and click > to move the environment to the list on the right. Repeat this step for each environment you want to assign to this request.

      Note

      If you do not have the required permissions to create a request for an environment, the environment is not selectable.

   3. Click Select to save your environment selections.

      The environments you selected and saved appear in the Environments list.

      Notes

      Starting with BMC Release Process Management version 4.6.00.02 and later, if you change the environment set in the request template, request steps that had not server associations in the request template automatically get all available server assignments for the selected environment in the new request.

8. Select the Plan and Stage for your request.

9. From the Deployment window list, select the deployment window for the request.

   Note

   The Deployment window list appears only when you associate a request with an environment that has a closed deployment policy. For more information about deployment policies for environments, see Managing environments.

10. From the Estimate list, select the estimated time required for the request.

11. In Planned Start, enter the start date and time for the request.

    Notes

    • If you use deployment windows and different deployment policies for environments, all parameters from the Scheduling and Estimation section are required to start the request. Ensure that the estimated time frame for the request matches the deployment window event for the associated environment.
    • When you create a new request, only the Planned Start and Estimate parameters are required if you selected the Deployment Window parameter.

    • If you set valid Scheduling and Estimation parameters, you can start a request manually at any time. To avoid any possible issues caused by deployment during a different time frame, start a request according to the Planned Start and Estimation time frame.

12. Click Create Request.
    The new request is created and the request details are displayed. At this point, you can add steps to the request. For more information, see To add steps to a request.

_{Return to top}

To create a request from the metadata using a request template

1. Navigate to Environment > Metadata > Manage Request Templates, and select the template that you want to use.
2. In the last column of the template, select to include All versions and assignments specified in the request template, only the specified Versions, or only the specified Assignments.
3. Click Create Request.
4. In the dialog box, from the Select environment list, select the required environment for the request or for multiple environments, perform the following steps:
   1. Click Multi-select environments and Add Environments.

   2. From the list of available environments on the left, click the appropriate environment and click > to move the environment to the list on the right. Repeat this step for each environment you want to assign to this request.

      Notes

      • If you do not have the required permissions to create a request for an environment, the environment is not selectable.
      • The environments you selected and saved appear in the Environments list.

      • If you change the environment set in the request template, request steps that had not server associations in the request template automatically get all available server assignments for the selected environment in the new request.

   3. Click Select to save your environment selections.

5. Select the Plan and Stage for your request.
6. From the Estimate list, select the estimated time required for the request.

7. In Planned Start, enter the start date and time for the request.

8. Click Create Request.
   The new request is created and the request details are displayed. At this point, you can add steps to the request. For more information, see To add steps to a request.

To create a request for an existing plan

1. From the Plans tab, click Plans.
2. Click the appropriate plan name.
3. Scroll down, if needed, and from the Stages tab, click Create Request for the appropriate stage.
4. On the Request page, create a request for the selected stage:

• • To create a new request:

  1. 1. Provide the appropriate information for Core Attributes, Extended Attributes, and Scheduling and Estimation.

        Note

        Under Scheduling and Estimation, you can also select a deployment window for the request. The Deployment window list only appears when you associate a request with an environment with the closed deployment policy. For more information about deployment policies for environments, see Managing environments.

     2. Click Create Request.

• • To create a new request based on an existing request template:
  1. 1. Click Choose Template on the right pane.
     2. Click Create Request in the last column of the appropriate template, and provide the appropriate information.
     3. Click Create Request.

The new request is created and the request details are displayed. At this point, you can add steps to the request. For more information, see To add steps to a request.

To create a request for the allow deployment window from metadata

1. Go to Environments > Metadata > Manage Deployment Windows.
2. From the Deployment windows list, locate the appropriate deployment window series.
3. Depending on the deployment window series type, complete the following actions:
   • For a one-time deployment window series:
     1.  From the Environments column, click the environment for which you want to schedule a request.
     2. Click Schedule request in the dialog box.
   • For recurring deployment windows series:
     
     1. Click Occurrences for the appropriate deployment window series.
     2. From the Occurrences list, locate the appropriate deployment window series event.
     3. From the Environments column, click the environment for which you want to schedule a request.
     4. Click Schedule request in the dialog box.
4. In the Schedule Request dialog box, specify the following parameters for the request:
   1. In Name, enter the name for the request.
   2. From the Plan list, select the plan for your request.
   3. From the Stage list, select the plan stage for your request.
   4. From the Application list, select the application for the request.
   5. From the Estimate list, select the estimated time for the request.
   6. In Planned Start, enter the start date and time for the request.
   7. From the Request template list, select the template for your request.
5. Click Schedule to save the request.

_{Return to top}

To create a request for the allow deployment window from a calendar report

1. From Reports > Calendars, click Deployment Windows Calendar on the right pane.

2. On the Deployment Windows Calendar, perform the following steps:

   1. Locate the appropriate environment.

      Tip

      Use filters at the top of the Deployment Windows Calendar Report window to find the appropriate environment.

   2. Click the corresponding deployment window event for which you want to schedule a request.

   3. Click Schedule Request from the dialog box.

3. In the Schedule Request dialog box, specify the following parameters for the request:
   1. In Name, enter the name for the request.
   2. From the Plan list, select the plan for your request.
   3. From the Stage list, select the plan stage for your request.
   4. From the Application list, select the application for the request.
   5. From the Estimate list, select the estimated time for the request.
   6. In Planned Start, enter the start date and time for the request.
   7. From the Request template list, select the template for your request.
4. Click Schedule to save the request.

_{Return to top}

To clone a request

1. Click the Requests tab.
2. When the request list appears, click the appropriate request.
   The request details open.
3. Click Clone Request on the right pane.

4. In the Edit Cloned Request dialog box, change the request parameters as needed.

   Note

   Starting with BMC Release Process Management version 4.6.00.02 and later, if you change the environment set in the request template, request steps that had not server associations in the request template automatically get all available server assignments for the selected environment in the new request.
5. Click Clone to create a new cloned request.
   The cloned request details open.

_{Return to top}

Starting requests

After you provide the required information and create a request, you can execute the request. Change the request status from Created to Planned. When the planned request reaches its scheduled time, users with appropriate permissions can start the request execution. For more information about user permissions for managing requests, see Administering users, roles, and access permissions.

You can start a request manually or automatically at the scheduled time. The Start Automatically option is available for requests with a Planned or Hold status. After a request starts automatically, a note is added to the request specifying the request owner, request start date and time, and the Request auto started message.

If request parameters change and these changes prevent the request from starting at the planned start date and time, the request behavior is as follows:

• The request does not start automatically at the planned time.
• The request remains in the same state as it was before the planned start.
• A note is added to this request specifying the request owner, request start date and time, and the Request failed to start due: <reason> message.

Before you begin

Before you set the Start Automatically option for a request, ensure that the following requirements are met:

• The Planned Start date and time for the request is in future.
• The Planned Start and the Estimation time for the request match the deployment windows time frame.
• All parameters of the current request are valid for the time when the request starts.

Adding and changing request event notifications

As a request status changes, users assigned to the request can receive the appropriate email notifications. Notification options indicate the list of participants who are supposed to receive notifications for requests, changes in the request status, and so on. You can add or change the notification options for any request with a Planned or Created state.

Some users are notified about request changes automatically. For example, the request Owner and Requestor always receive event notifications for the selected Request Events. The step owner always receives notifications for the Step Events.

To change notifications options

1. On the Requests tab, click the appropriate request.
2. On the request page, click expand.
3. Click Change Notification Options.
   The Notification Options for Request dialog box opens.

4. From the Request's Events list, select the appropriate event request notification options.

   Note

   Select Notify Step Owners if you want to send the request event notifications to all step owners.

5. From the Step's Events list, select the appropriate step notification options.

   Note

   • Select Notify all Step Owners from Request about changes to send the step event notifications for all the request steps to all step owners. 

   • Select Notify Request's Owner/Requestor about changes to send the step event notifications for all the request steps to the request Owner and Requestor.

6. In Additional Participants, select additional notification recipient options:

   • From the Notify on Request events list, select options to send notifications for the request events.

   • From the Notify on Step events list, select options to to send notifications for the step events.

   • From the Users list, select additional users to receive event notifications.
     Only users that have access to the application associated with the request are available in the Users list.

   • From the Groups list, select the user groups to receive event notifications.
     Only groups that have access to the application associated with the request are available in the Users list.
   • In the Other Email Ids field, enter additional email addresses for the event notifications.
7. In Groups notification behavior:
   • Select Group email only to send notifications only to the specified group email address.
   • Select Group email + Member email(s) to send notifications to the specified group email address and every group user's personal email address.
8. Click Update.

_{Return to top}

To edit a request

1. From the Requests page, click the request that you want to modify.
2. When the request opens, click expand.
3. Click Modify Request Details on the bottom.
   The Edit Request dialog box opens.

4. Make the necessary changes to the request details.

5. Click Update to save your changes.

_{Return to top}

To edit component versions

As plans change, you might need to change the component versions associated with the request.

1. On the Requests tab, click the appropriate request.
2. On the request page, click expand.

3. Click Edit Component Versions on the bottom.

4. From the Proposed environment list, select the required component version.

   Note

   To  see components and their versions used in other environments within the same application, in View other environments for this application list, select the check boxes for the appropriate environments.

5. Click Submit.

_{Return to top}

To assign a request to a plan

_{Return to top}

To export a request

You can export and save a request on your local machine in XML, PDF, and HTML formats.

1. Click the Requests tab and click the request that you want to export.
2. From the right pane, click the desired export format option:
   
   • Export as XML
     
   • Export as PDF
   • Export as HTML
3. Save the file or download and save the file as appropriate.

_{Return to top}

To import a request

You can import a request from an XML file.

1. Click the Requests tab.
2. Click Import Request on the right pane.
3. Click Browse to select the desired XML file from your local machine.
4. Click Create Request.

^{Return to top}

Related topic

Managing steps