Guided Procedure Overview

Guided Procedures in Focused Run provide an easy way to document and optionally automate reoccurring operational activities as guided procedures. These guided procedures help the user to execute reoccurring administrative activities or alert reaction procedures in a guided and reproducible way. In addition, it is possible to automate the activities inside guided procedures and to execute them automatically without or with minimal manual involvement.

Guided procedures help to reduce TCO and improve IT operations quality through:

  • Step-by-step execution
  • Detailed activity description
  • Central access to required managed system functions
  • Automation
  • Logging of every activity
  • Predefined content that can be customized

A guided procedure consists of one or several steps. Each step has one or multiple activities. The following different activity types are supported:

  • Manual activities consist of a description, a documentation text that describes, in detail, what the user must do and, optionally, a context sensitive navigation link into the relevant application in Focused Run or the managed system. The user processing manual activities can read the documentation and open the navigation link to jump into the relevant application to execute the activity. Once the activity is executed, the user needs to document this by changing the status and, optionally, writing a comment.
  • Automated or plug-in activities. Automated activities execute certain predefined tasks automatically in the background. Once executed, they return a log message indicating success or failure of the activity and, optionally, a table or other graphic with more details. Automatic activities can be triggered by a user. Guided procedures with automatic activities can be executed fully automatically in the background. SAP delivers a set of plug-in activities that can be customized and plugged into customer defined guided procedures. It is also possible to develop customer specific automated activities in ABAP and plug them into your own guided procedures.
  • Custom step activities or plug-in step activities are Web Dynpro applications that can be reused in guided procedures to execute complex tasks which require user input. Currently, no custom step activities or plug-in step activities are delivered with Focused Run FP2 but it is possible to define customer specific custom steps.

The result of a guided procedure execution can be exported into a HTML result report and sent via e mail.

Guided Procedures for Advanced System Management (ASM)

Guided Procedures for Advanced System Management allow you to define and automate regular administrative tasks.

One example for this is the System Health Check for ABAP Systems. It performs several health checks on ABAP systems and sends out a result report with all findings to interested parties. It can be executed manually or scheduled to execute automatically at regular intervals.

The System Health Check for ABAP Systems covers ABAP availability, performance, exceptions and host checks. It can be executed as is or easily customized and enhanced by other activities which are available in the guided procedure plug-in repository. For example, you could add HANA database checks or include measured system availability and outages from Service Availability Management into the health check.

Guided Procedure Catalog for Advanced System Management

The guided procedure catalog for Advanced System Management is the central entry point to create, edit and run guided procedures. You can execute  guided procedures either manually or plan them for automatic background execution. The catalog shows the guided procedures available for Advanced System Management. You have the following options:

You can customize the content of the guided procedure  per your needs. For example, you could add HANA database checks or include measured system availability and outages from Service Availability Management. For some plug-ins, you can change their behavior, for example, if they should check for the last day instead of last three days or that the result should be displayed as a bar chart instead of a table.

The following describes how to create and adapt a customer specific guided procedure based on the example of the System Health Check for ABAP Systems. The description is applicable for other Guided Procedures as well. 

How to create a customer specific guided procedure using the System Health Check for ABAP systems as a template

  1. Open the Focused Run Launchpad
  2. Select Advanced System Management, then Guided Procedure Catalog
  3. Select the System Health Check for ABAP Systems guided procedure
  4. Optional: Set the Hidden flag if the SAP delivered template should not be used any more
  5. Select Create by Copy
  6. Enter the following data:
    1. Specify a meaningful name and description for the guided procedure or keep the existing one.
    2. Specify a customer-specific ABAP package with the right transport layer if you want to transport the guided procedure from a Focused Run development system to a QA and production system. The package is required to know in which transport route the guided procedure will be released. If you do not want to transport the guided procedure, you can choose Temporary Package.
    3. Set the Productive flag if the guided procedure is to be transported to a production system. If the guided procedure is for testing purposes on the local system or will be imported into a test system manually, do not set the flag.
    4. Select OK to open the Guided Procedure Maintenance .

How to edit a customer specific guided procedure

  1. Open the Focused Run Launchpad.
  2. Select Advanced System Management, then Guided Procedure Catalogue.
  3. Select the guided procedure then click the Edit Button to open Guided Procedure Maintenance.
  4. Guided Procedure Maintenance provides the following options: 
  • Add a step: To add a step, click New, and select the step type in the menu. You can also reuse an existing step. A new step will be inserted below the selected step, in the Steps tree. Step types can be standard, parent, plug-in or complete. For the automated health check, use case-only standard steps and complete steps are relevant.
  • Create help text: The step help text provides detailed information about each step, such as what is checked, and what will happen in the background. The New button in the help text section opens the Create New Document pop-up window which allows you to define documentation for a step or an activity. You can create a new HTML document or upload a PDF. If the HTML result report needs to also show the documentation in line, choose HTML.
  • Add a complete step: The Complete step is the last step in the guided procedure, which provides an overview of the execution status of the previous steps. If the guided procedure is being executed manually, the HTML result can be generated only from the complete step. If the guided procedure does not have a complete step yet, add it.
  • Remove a step: Select the step and click Remove to remove obsolete steps.
  • Add activities. Each step must have one or more activities. The following activity types are supported:
    • Manual: Manual activities consist of a description and either no navigation link, or a navigation link to a UI in Focused Run, in the managed system, or an external link. The navigation link can be configured.
    • Custom UIs: Some tasks to be carried out in the step of a guided procedure require input values and a more complex logic in the back end. Such steps usually need their own user interface for the user to input values. These tasks can be performed by custom steps. A custom step in a guided procedure is a step that contains its own user interface and own logic which is implemented in a back end Web Dynpro component.
    • Automatic: Automatic activities are activities that can be carried out in a guided procedure without user interaction or manual steps. If you have developed a suitable automatic activity, you can include it in your own guided procedures.
    • Plug-In: Plug-ins are automatic activities that can be customized during guided procedure creation time. SAP delivers many plug-ins that can be easily customized and included in your own guided procedures.
  • Add plug-in activity: Guided procedures executed in background schedule such as System Health Check for ABAP Systems should contain only plug-in activities or customer specific automatic activities. The following describes how to add plug-in activities to the guided procedure:
    • Select the relevant Standard step
    • Select Automatic Activity then click New.
    • Choose Select a Plug-in and select the required plug-in from the value help
    • Rename the activity
    • Maintain the plug-in attributes per your requirements
    • Click OK
    • With the new activity selected, click Help Text then click New
    • Enter a name for the documentation
    • Enter suitable documentation text
    • Click Save
    • Use the Move up or Move down button to change the order of activities in the step
  • Remove activity: Select the relevant activity then click Remove to remove the relevant activity if it is obsolete.
  • Change activity: Select the relevant activity then click Edit. Change the plug-in attributes per your requirements.
  • Set the guided procedure HTML report configuration:
    • In the Guided Procedure Maintenance UI, click the Report Configuration button.
    • Here you define which options are visible to the end user when creating the HTML report and you define which options are selected by default: GP Structure, Include Step and Activity Status Information, Include Help Documentation, Include Navigation Links, Include Log Messages, Include Summary and Statistics.
    • Click OK then click Save.
  • How to activate a customer specific health check guided procedure:
    • Click the Check button then fix any errors reported by the check.
    • Click the Activate button.
  • How to transport the customer specific health check guided procedure:

    Proceed as follows If the health check guided procedure was edited in a development system and needs to be transported to QA and production systems :
    • Click the Transport button.
    • Add the guided procedure to a new transport request or choose an existing transport request.
    • Release and import the requests per your transport rules.

 

Note: (This section is valid as of FRUN 1.0 FP03. For FRUN 1.0 FP02, refer to the description below.

Guided procedures with automatic activities such as System Health Check for ABAP Systems can be executed automatically in regular intervals. After the execution, a result report is sent out to defined receivers.

Prerequisites:

  • Apply SAP Note 2566836 in Focused Run.
  • The managed ABAP systems for which the guided procedures are scheduled should be on ST-PI 740 SP4 /5 + SAP Note 2434114 or ST-PI 740 SP6.
  • Create service user FRN_BTC_GPA or similar per the Focused Run security guide. The user needs to have a valid e-mail address to be able to send out e-mails. Define that user FRN_BTC_GPA should be used for guided procedure background processing as explained in the Focused Run Master Guide. This activity needs to be carried out only once.
  • The guided procedure that is running automatically in the background needs to consist primarily of automatic activities. Manual activities or custom UIs will not be executed. The guided procedure must be active.
  • Define recipient lists in Central Notification Management. The recipient lists shall contain the e-mail ids or FRUN user ids of the recipients who shall receive the guided procedure execution reports.

To plan the automatic execution of a guided procedure in the background, proceed as follows:

  1. Open the Focused Run Launchpad.
  2. Select Advanced System Management, then Guided Procedure Catalogue.
  3. Select the guided procedure to be planned. For example, System Health Check for ABAP Systems.
  4. Select Create Plan > Background Schedule (Simple) if you want to schedule the execution of a guided procedure for some systems and do not need to define e-mail templates.
    Select Create Plan > Background Schedule (Expert) if you want to:
    • schedule the execution of a guided procedure for a high number of systems and want to control the job runtime and how many child jobs shall run in parallel
    • define specific e-mail templates
    • use a customer specific customization class that reformats the e-mail body in rich text format and allows for advanced receiver determination
  5. Enter the following data in Background Schedule (Simple) mode: 
  • Overwrite optionally the default plan name or add a description
  • Overwrite optionally the default job name
  • Choose whether the batch job should be executed immediately or at a certain start date and time and if the job should run once or recurrently
  • The Scope Details section allows you to determine the systems for which the guided procedures shall run. The parameters act as a filter that filter out relevant systems. Fill the section as follows:
    •  Customers and data center: If you want to restrict the execution of the guided procedures to systems assigned to certain customers and data centers, fill the data accordingly. If this restriction is not required, leave the customer network and data center empty.
    • Extended System ID: If the guided procedure shall be executed only for certain systems and the systems cannot be filtered otherwise, enter the system ids of these systems here. Otherwise you can keep this empty.
    • IT Admin Lifecycle Statuses: Here you can restrict systems that have a certain life cycle status. For example, choose Active if you want to schedule the guided procedure only for active systems.
    • IT Admin Priorities: Here you can restrict systems that have a certain priority. For example, choose Very High if you want to schedule the guided procedure only for systems with Very High priority.
    • IT Admin Roles: Here you can restrict on systems that have a certain role. For example, choose Production System if you want to schedule the guided procedure only for production systems and not for QA and Dev. 
    • System Type: Choose the system type that fits the guided procedure. For example, if you want to schedule the System Health Check for ABAP Systems guided procedure, choose the ABAP system type.
    • Database Type: If required, choose the database type so that the guided procedure shall be scheduled only for systems with a specific DBMS type.
  •  Click the Show systems button if you want to get a preview of the systems for which the guided procedure will be scheduled. 
  • Select the corresponding receiver recipient list containing the e-mail recipients that should receive the e-mail with the guided procedure result report. Recipients in the Customer independent recipient lists will receive the e-mail in all cases. Recipients in the Customer network specific recipient lists will receive the e-mail only for systems which are assigned to the same customer network.
  • Select the corresponding Admin recipient list containing the e-mail recipients that should receive an e-mail in case the guided procedure background processing jobs fail. Recipients in the Customer independent recipient lists will receive the e-mail in all cases. Recipients in the Customer network specific recipient lists will receive the e-mail only for systems which are assigned to the same customer network.
  • Click the Preview button if you want to get a preview of the guided procedure processing jobs that will be scheduled and the respective managed system.
  • Click the OK Button to create a new guided procedure background processing plan and schedule the relevant jobs.

In Background Schedule (Expert) mode you can additionally define the following data:

  • Customization Class: Select a customization class if you have the following needs:
    • The e-mail body of the result e-mail should be generated in HTML format and contain graphical elements
    • You need to determine the recipients for the result e-mails per custom rules

SAP delivers the CL_CUSTOM_EMAIL_BODY customization class that overwrites the e-mail body with a preview of the guided procedure activities and their status. Using this customization class, you can see the status of the different activities directly in the e-mail and need to open the attached result report only if you are interested in the details. With ABAP knowledge you can also create your own customization class. It needs to inherit from the CL_GPA_PLAN_CUSTOMIZATION class. You need to redefine the GET_EMAIL method if the guided procedure e-mail with the result reports attached must contain special html content like graphics, tables or logos. You need to redefine the GET_RECIPIENTS_FOR_SCOPE method if you have advanced needs to determine the right recipients for guided procedure reports for specific systems.

  • Job Control: Here you can define advanced settings to control the background execution of guided procedures.
  • Maximum global time duration: Specify here if the guided procedure background execution shall run only inside a specific time window. The job will stop when the duration specified here is reached regardless of whether the guided procedures have been processed for all relevant systems or not.
  • Maximum number of jobs in parallel: Here you can specify how many guided procedure batch jobs shall be scheduled in parallel. This number should be smaller than the number of available batch work processes.
  • Maximum number of systems per child job:Here you can specify how many systems shall be processed together in one child job. For each child job, one e-mail will be sent. The e-mail will contain one guided procedure report per system as attachment. Regardless of this setting, systems in different customer networks will always be processed in different jobs.

FRUN 1.0 FP02: How to schedule the system health check guided procedure(s) automatically in the background

Note: The following is only valid for FRUN 1.0 FP02. For FRUN1.0 FP03 or higher, refer to the description above.

Prerequisites:

  • Create the FRN_BTC_GPA user as per the security guide
  • Apply SAP Note 2566836 in Focused Run FP02
  • Managed ABAP systems subject to health check should be on ST-PI 740 SP4 /5 + SAP Note 2434114 or ST-PI 740 SP6

Guided procedures with automatic activities such as Regular System Health Check for ABAP Systems can be executed automatically in regular intervals. After the execution, a result report is sent out to defined receivers.

To achieve the automatic execution of guided procedure in the background, you must define a variant for the the PR_GPA_EXEC_PLANNER ABAP report and schedule this report with the variant in regular intervals.

How to define the variant

Call transaction SE38, enter the PR_GPA_EXEC_PLANNER report then click Execute.

Fill the parameters as follows:

  • Guided procedure ID: Select the guided procedure to be executed automatically.
  • Customers and data center: If you want to restrict the execution of the guided procedures to systems assigned to certain customers and data centers, fill the data accordingly. If not, leave the customer network and data center empty.
  • Long SIDs: If the guided procedure shall be executed for certain system ids, enter the system ids of the system here. Otherwise leave empty.
  • System type:  Enter the system type of the systems for which you want to execute the guided procedure. Choose the system type which fits to the contents of the guided procedure. For example, the Regular System Health Check for ABAP Systems can be executed only for ABAP systems and it does not make sense to schedule it for JAVA systems.
  • IT Admin attributes: Whether the guided procedures shall be executed only for production systems, test systems etc.
  • Types of database: Here you can define whether the guided procedure shall be executed only for systems with certain system database DBMS types (e.g.  systems with HANA Database or systems with SAP ASE Database)
  • The e-mail parameters allow you to define recipients of the result report and recipients in case the report execution failed. You can also define which Se61 texts to be used as e-mail templates.
  • The background job control parameters define how many child jobs can be processed in parallel, how many systems per job and the maximum permitted duration after which unprocessed child jobs are canceled. You can normally keep the default settings here.

Save the variant.

Execute the report online with the Simulation mode flag checked. It will provide an overview of how many systems the health check will be processed and how many child jobs will be scheduled.

Make sure that the Simulation Mode flag is disabled in the report variant that is used by the batch job.

Call transaction SM36. Create a new job with the PR_GPA_EXEC_PLANNER report and the previously created variant. The job should run under the FRN_BTC_GPA user. Schedule the job with the required periodicity.

  1. Switch to the system for which you want to execute the guided procedure in the scope selector on top (default is the Focused Run system)
  2. Select the guided procedure you want to execute and select Execute new instance if you want to start a new execution from the beginning or Existing instance if you want to continue a previous execution. Navigate through each step. Read the step and activity information. In case of automatic activities select Execute. Check the log section for log messages and detailed information. In case of manual activities, follow the instructions and set the execution status per your findings. You can optionally add a comment to each activity. Some activities provide a context-sensitive navigation link to an external tool, for example to the alert inbox or to the file system browser. Select the navigation link to open the external tool.
  3. Once you have completed all activities you can go to the complete step and generate a result report containing log messages and status for each activity.

Press the Display Execution Logs button to get an overview of the past executions of the selected guided procedure.

By default, it shows the guided procedure instances that were executed in the last week for the selected system scope and the selected guided procedure.

You have the following options:

  • Change the scope: Switch to the system for which you want to show guided procedure reporting by using the scope selector on top. The default scope is always the Focused Run system itself.
  • Switch time frame: Change the time frame of displayed guided procedure executions. The default is the last seven days.
  • Review the status of steps, logs and comments.
    Select a guided procedure execution to see its status, related log messages and comments.
  • Generate an HTML result report:
    Click the Export to HTML button then click Continue.

Guided Procedure Reporting for Advanced System Management

Guided procedure reporting provides an overview of how many guided procedures have been executed for the selected systems in the selected time frame, their statuses and log messages.

By default, it shows the guided procedure instances that were executed in the last week for the selected system scope.

You have the following options:

  • Change the scope: Switch to the system for which you want to show guided procedure reporting by using the scope selector on top. The default scope is always the Focused Run system itself.
  • Switch time frame: Change the time frame of the displayed guided procedure executions. The default is last seven days.
  • Review the status of steps, logs and comments: Select a guided procedure execution to see its status, related log messages and comments.
  • Generate the HTML result report:
    • Press the Export to HTML button then click Continue.
    • Choose which elements should be included in the report then click OK.