Managing requests

 The main unit of deployment in BMC Release Process Management (RPM) is a request. A request represents the deployment of the application components into an environment. It incorporates the tasks that need to be done during the deployment process, such as putting an application into the 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 a package) using one of the automation modules. Requests and steps can be assigned to the specific users as well as scheduled for a specific date and time.

Requests have duration, planned date, and due date. They follow a series of states and transitions from Planned to Complete. You can execute requests as a part of a project, part of an application plan process, or release plan. If you associate a request with an application that has Strict plan control, the request cannot be created, updated, or started unless it has an assigned plan and plan stage.

NEW IN 5.0.01.00 Starting with RPM 5.0.01.00, you can define request properties that are used as inputs in the request steps.

This topic consists of the following sections:

Request access permissions

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 has only the View Requests list permission. Permission to view the Created requests is added separately with the View created Requests list permission and applies to all Request lists visible in the application, including the Dashboard. For example, if a user does not have permission to view the Created requests, they are not displayed on the My Requests and Currently Running Steps subtabs of the Dashboard. Users who do not have access to the Requests list cannot view the requests in any Requests lists, including the Dashboard.

By default, on the Dashboard and Requests tabs, you can see requests created in the last two months. To find older requests, you need to do a search or use filters.

For more information about defining user permissions for requests, see Managing access permissions.

_{Back to top}

Creating a request 

You can create a request in several ways, including from an existing request template. 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.

The overall process of creating a request consists of the following steps:

1. Create a request.
2. Add steps to the request.
3. (Optional) Define and add the request properties.

You can create a request in one of the several ways:

• Creating a request from the Requests tab
• Creating a request for an existing plan
• Creating a request from a template
• Cloning a request
• Creating a request for the Allow Deployment Window

Creating a request from the Requests tab

1. On the Requests tab, at the right side, click Create Request.
2. Under Core Attributes, in the Name box, enter a request name.
3. In the Requestor list, select a user who creates or initiates the request.
4. In the Owner list, select a user who will be responsible for the on-going tasks in the request.
5. In the Plan list, select a plan for the request.
6. In the Stage list, select a plan stage for the request.
7. In the Application list, select an application for which you create the request.
8. In the Environment list, select one or more environments for the request:

   1. Click Multi-select environments, and then click Add Environments.

      Note

      When selecting 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. 

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

      Note

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

   3. To save your environment selections, click Select.

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

      

9. In the Business Process list, select the business process for your request, and then enter a description of the business process.
10. In the Description box, enter a short description of the request.
11. In the Release Tag list, select the applicable release.
12. NEW IN 5.0.05 Switch on the Continue Execution On Failure option.
    
    When this option is switched on, the Continue On Failure function for this request is activated. You can see the status of this option is displayed as Yes or No as follows:
    
    The request will continue execution even when a step within the request has failed.
    By default, this functionality is deactivated.
    When this function is activated for a request, the  icon is displayed on the status tab of the request, as shown in the following figure:
    
13. Next to Extended Attributes, click Show, and then enter the appropriate attributes, if any.
    The available attributes are Project, Package Contents, Wiki, and Uploads.
14. Under Scheduling and Estimation, perform the following steps:
    
    1. In 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) To start the request automatically at the specified Planned Start date and time, select the Start Automatically check box.

    4. In 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 the Due by boxes, enter the end 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.
    6. In the Notes box, enter notes, if any.

15. 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.

    Note

    The request ID is visible in the upper-left corner.

    

Creating a request for an existing plan 

1. On the Plans tab, click the appropriate plan name.
2. Scroll down, if needed, and then, on the Stages tab, click Create Request for the appropriate stage.
3. On the Requests page, create a request for the selected stage:
   • To create a new request:

     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.

        NEW IN 5.0.05 In the Core Attributes section, toggle the Continue Execution On Failure option, if you want to activate the Continue On Failure function for this request.

     2. Click Create Request.
   • To create a new request based on an existing request template:
     1. On the right pane, click Choose Template. 
        For information about templates, see Managing request templates. 
     2. In the last column of the appropriate template, click Create Request, and then 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.

   Note

    When you create a request for a specific plan, the request inherits the release tag parameter from the relevant plan.

_{Back to top}

Creating a request from a template 

1. Click the Requests tab, and then, on the right pane, click Create Request.
2. Under Core Attributes, in the Name box, enter a name for the request.
3. In the Requestor list, select the user who creates or initiates the request.
4. In the Owner list, select the user to assign on-going responsibilities for the request.
5. On the right pane, click Choose Template.
   The Available Templates appear above the Core Attributes.
   For information about templates, see Managing request templates. 
6. 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, and then click Create Request.

7. NEW IN 5.0.03.005 In the Create request from <name> template dialog box, select the application to which you want to assign this request. 

   Notes

   If you do not have the required permissions to create a request for an application, that application does not appear in the list.

8. In 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. In 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, you cannot select the environment.

   3. To save your environment selections, click Select.

      Notes

      • The environments you selected and saved appear in the Environments list.
      • If you change the set in the request template, request that had no server associations in the request template automatically get all available server assignments for the selected environment in the new request.
9. Select the Plan and Stage for your request.

10. In 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.

11. In the Estimate list, select the estimated time required for the request.

12. 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.

13. NEW IN 5.0.05 You can toggle the Continue Execution On Failure option, if you want to activate the Continue On Failure function for this request.

14. 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.

_{Back to top} 

To create a request from the metadata using a request template 

1. Go to Environment > Metadata > Manage Request Templates.
2. Next to the needed template, in the last column, select to include All versions and assignments specified in the request template, only the specified Versions, or only the specified Assignments.
   For information about templates, see Managing request templates. 
3. Click Create Request.

4. NEW IN 5.0.03.005 In the Create request from <name> template dialog box, select the application to which you want to assign this request. 

   

   Notes

   If you do not have the required permissions to create a request for an application, that application does not appear in the list.

5. In the Environment list, select the required environment for the request or for multiple environments:
   1. Click Multi-select environments, and then click Add Environments.

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

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

      Notes

      • If you do not have the required permissions to create a request for an environment, the environment is not selectable.
      • If you change the environment set in the request template, request steps that had no server associations in the request template automatically get all available server assignments for the selected environment in the new request.

   3. To save your environment selections, click Select.

6. In the Plan list, select the needed plan.
7. In the Stage list, select the needed stage.
8. In the Estimate list, select the estimated time required for the request.

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

10. Toggle the Continue Execution On Failure option to activate the Continue on Failure function for this request.
11. 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.

Cloning a request

When you clone a request, a complete replica of this request with the component versions, environments, tools, and configuration is created. If you clone a request with scheduled steps, the selected Set to Start at Scheduled Time check box and step start and end time are saved.

1. On the Requests tab, click the appropriate request.
2. On the right pane, click Clone Request.

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

   ^{(click the image to expand it)}
   
   

   Notes

   • If you change the environment set, request steps that had no server associations in the request template automatically get all available server assignments for the selected environment in a new request.
   • You can edit request properties after a request is cloned.
   • NEW IN 5.0.05 In the Core Attributes section, toggle the Continue Execution On Failure option, if you want to activate the Continue On Failure function for this request.

4. To create a new cloned request, click Clone.

   You can view the cloned component properties on the Property Summary tab of the request details page.
   ^{(click the image to expand it)}

   

_{Back to top}

Creating a request for the Allow Deployment Window

You can create a request for the Allow Deployment Window from metadata or a calendar report.

To create a request for the allow deployment window from metadata 

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

_{Back to top}

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

1. Go to Reports > Calendars.
2. On the right pane, click Deployment Windows Calendar.

3. On the Deployment Windows Calendar Report page, 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.

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

_{Back to top}

Starting a request

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 the 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.

Setting 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

You can change notification options for requests with the Created, Planned or Hold statuses.

1. On the Requests tab, click the appropriate request.
2. On the request page, click  expand .
3. Click Change Notification Options.

4. In the Notification Options for Request dialog box, in the Request events list, select the appropriate event request notification options.

   Note

   To send the request event notifications to all step owners, select Notify step owners.

5. In the Step events list, select the appropriate step notification options.

   Notes

   • If you select Notify all step owners from a request about the changes, step event notifications are sent to all step owners for all request steps.
   • If you select Notify request owner and requester about the changes, step event notifications are sent to the request owner and requester for all request steps.

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

   • To send the request event notifications to additional participants, select Notify of request events.

   • To send the step event notifications to additional participants, select Notify of step events.

   • In 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.

   • In 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 box, enter additional email addresses for the event notifications.
7. In Groups notification behavior, select one of the following:
   • To send notifications only to the specified group email address, select Group email only.
   • To send notifications to the specified group email address and every group user's personal email address, select Group email and member emails.
8. Click Update.

_{Back to top}

Editing a request

You can modify different request details if a request is not Started. To modify a Started request, you must put it on hold by clicking  at the right side.

1. On the Requests page, click the request that you want to modify.

2. On the request details page, next to the request status, click expand, and then do the following:
   

    To modify general request details

   1. At the bottom, click Modify Request Details.
      ^{(click the image to expand it)}
      
   2. Edit the required attributes as appropriate.
   3. Click Update.
    To modify notification options

   1. At the bottom, click Change Notification Options .
      

      ^{(click the image to expand it)}

      
   2. Edit email notifications as appropriate. For more information about how to set notification options, see Setting request event notifications .
   3. Click Update.
    To modify component versions

   1. At the bottom, click Edit Component Versions.
      

      ^{(click the image to expand it)}

      
   2. In the  Proposed environmentName column, next to the appropriate component, select a component version.
   3. (Optional) To view components and their versions used in other environments within the same application, in the View other environments for this application list, select the required environments.
   4. Click Submit.

_{Back to top}

 Assigning a request to a plan

_{Back to top}

Deleting requests using a rake task

If you no longer use any old requests, you can delete them using the following rake tasks. The rake tasks do not delete request templates associated with the requests.

The following video (4:11) demonstrates the steps to delete old requests using the rake tasks.
_{https://www.youtube.com/watch?v=ane4Ch1hupM}

1. Stop all RPM services.
2. From the same folder, run the . ./setenv.sh (for Linux) or . ./setenv.bat (for Windows) command.
3. Navigate to RLMhome\releases\productVersion\RPM, and then run the following rake tasks:
   • To delete requests older than 1 year, run jruby –S rake requests:delete_old.

   • To delete requests older than a specific date, run jruby –S rake requests:delete_old[dd/mm/yyyy].

     For example, if you specify [01/01/2016], then the rake task will delete all requests before this date. Requests created on January 1, 2016 will not be deleted.

4. Start all BRPM services.

Exporting a request

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

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

_{Back to top}

Importing a request

You can import a request from an XML file.

Before importing a request, consider the following:

• Application and environments that are used in the request must exist on the target RPM instance. If not, then do one of the following:
  
  • Export the application that is used in the request from the source RPM instance, and then import it into the target instance.
  • On the target BRPM instance, create an application and environments with the same names as used in the request.
• If you import a request that has the same name as the existing one, a new request with the same name but a different ID is created.
• Automation scripts used in the steps of a request are copied during the import. If the import file contains scripts that already exist on the target RPM instance but the existing script details are different than those in the import file, then during the import the existing details are not updated.

To import a request, do the following:

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

^{Back to top}