1. Business Scenario
SAP Solution Manager 7.1 SP 05 contains a new function, Guided Procedure Authoring. It allows you to create a guided procedure similar to SOLMAN_SETUP, to support common and recurring tasks or exception handling procedures. This guide describes how you can create a simple custom guided procedure using guided procedure authoring in SAP Solution Manager 7.1.
2. Background Information
This is the first release of the tool and the How To guide. If you encounter issues when using the tool, open tickets on the component SV-SMG-GPF
Solution Manager 7.1 SP 05
4. Step-by-Step Procedure
This section tells you how to create and execute your own guided procedure.
4.1 Open the Guided Procedures Browser
A guided procedure is always associated with a consumer¹, which determines how the guided procedure is called. With SP 05, three consumers are supported:
- Technical Administration
- Exception Management
- Cross-Database Comparison
Currently, the consumer determines the guided procedure browser, and the search fields available there. The search fields, or criteria, allow you to create parameterable guided procedures. To be able to display/execute/change guided procedures, you need the following roles:
1 A consumer is a term used to explain how guided procedures are grouped, how they will be consumed, and by whom and in which area it will be used.
4.1.1 Open the Guided Procedure Browser for Technical Administration
Call the transaction SM_WORKCENTER, and go to the Technical Administration work center:
Select the technical system for which you want to open the guided procedure browser. The guided procedure browser for Technical Administration always opens for a selected technical system. This is important when you want to run a guided procedure.
The Guided Procedure Browser for Technical Administration:
It provides the following search attributes:
- System Type: ABAP, JAVA …
- Context Type: Technical System, Technical Instance, Database …
- Product ID: AIX, SAP ABAP Basis 7.00 …
You will only see the guided procedures that match the search criteria. If you want to see all guided procedures available for Technical Administration, clear all search fields and apply the empty query. Note: You cannot restrict by subset of the guided procedure search attributes only, e.g. if you search for “System Type = ABAP” you will not find guided procedures that have the search attributes “System Type = ABAP & Context Type = Technical System” This applies to all guided procedure browsers.
4.1.2 Open the Guided Procedure Browser for Exception Management
Call the transaction SM_WORKCENTER and go to the Root Cause Analysis work center:
Select the exception category, and an exception for which you want to open the Guided Procedure Browser. If you do not select an exception, the guided procedure browser will open and show all guided procedures for Exception Management.
The Exception Management guided procedure browser always opens for the technical system <Solution Manager ABAP Stack>
4.1.3 Open the Guided Procedure Browser for CrossDatabase Comparison
Call the transaction SM_WORKCENTER and go to the Business Process Operations work center.
In the next screen you can open the guided procedures.
The guided procedure browser for cross-database comparison offers the following search attributes:
4.1.4 Open the Guided Procedure Browser Directly (Expert Mode)
The ways of opening the guided procedure browser described, can be inconvenient, if you have to maintain several guided procedure types.
SP 05 contains no official expert access for the guided procedure browser, but you can proceed as follows:
Call the link: Error! Hyperlink reference not valid.
This link opens the guided procedure browser for Technical Administration. You can adjust the CONSUMER parameter in the URL:
- Technical Administration: CL_GPA_BRWSR_CNSMR_TO
- Exception Management: CL_E2EEM_GP_CNSMR
- Cross DB Comparison: CL_DSWP_CDC_GP_CNSMR
Note: Do not execute guided procedures for Technical Administration in this way, because the guided procedure browser always opens for the SAP Solution Manager ABAP system.
4.2 Create a New Guided Procedure
Open the guided procedure browser for the consumer, and apply search attributes.
Choose and press the “Apply” button. Press the “Create” button to create a new guided procedure.
Specify whether you want to copy an existing guided procedure, reference² an existing one or create a new one.
Enter the name, description and the initial step number (you can adjust this later in your guided procedure)
Select a transport request to transport the guided procedure later on:
At last make sure, that the search attributes are correct. Then click “Create” to create the guided procedure.
² If a guided procedure is referenced it means that the destination guided procedure is only allowed to change the order of steps and add new “own” steps. You cannot change the steps of the referenced guided procedure itself.
4.3 Maintain the Steps in your Guided Procedure
After the creation, the guided procedure opens in the maintenance view
The maintenance view contains the following elements:
- Main View: Main container for the steps
- Step Properties: Properties of the step, such as title and step type
- Step Help Section: Provides detailed information about the step, such as what needs to be done and what will happen in the background
- Activities: List of activities (automatic, manual) with navigation link and documentation
- Activity Help Section: Provides detailed information about the activity
Enter the step title and description first, and select the step type:
The following step types are available:
- Add activities that can be executed automatically
- Create your own automatic activities by implementing the class CL_SISE_ACTIVITY_AUTO
- Add activities that have to be performed manually
- Add link to navigate to transactions, BSPs, URLs
Custom & Auto/Manual
- Add automatic or manual activities to a custom GUI
The next step is to add a step help text. Press the “New” button in the step help section, to create a new text. You will be prompted in a popup for the package to be used, the document, and the document ID which should not be more than 20 characters long. The text can be maintained in a builtin Flash text editor³. You can add links, symbols, images etc. Save after editing your text.
This help text will later appear directly under the roadmap of the guided procedure .
³To be able to display the Flash text editor, make sure you have the latest version of Flash Player.
126.96.36.199 Add activities to a manual step
To add a manual activity, press the “New” button in the Activities section. Enter a description for the activity, and select an activity type. You can also reuse manual activities from other guided procedures.
You can use the type “Simple”, call an existing transaction, etc. (you do not need to do any coding), or you can use the type “Expert” and provide a class which implements more sophisticated manual tasks. For a simple manual activity select the target system for the call, and the URL Type:
Depending on the target, you can choose from among several URL types, by default:
Enter a description of the URL. Depending on the URL type, you can leave the field path empty. Enter the parameters of the URL type.
Press OK. Maintain the help text for your activity, in the Activity Help section. The URL jump-in (in column “Navigation”) and the help texts (in the column “Documentation”) will be displayed next to your activity in the step activity list, later.
188.8.131.52 Add activities to an automatic step
To add a new activity to a step that also contains automatic activities, press the “New” button in the Activities section. Enter an activity description, and select the class that implements your automatic activity
To develop these classes for automatic activities, create a new class that inherits from the class CL_SISE_ACTIVITY_AUTO, and implement the EXECUTE_CONFIGURATION method. See an example implementation in class CL_GPA_ACTIVITY_AUTO.
184.108.40.206 Add a custom UI and activities to a custom & auto/manual step
The step types Custom & Auto and Custom & Manual allow you to use your own UI elements. You can also add manual or automatic activities.
To create your own UI, you need to create a WebDynpro component that implements the interface WD_IF_SISE_STEP.
4.3.2 Add and Move Steps into the Guided Procedure
You can add predefined UI steps for special occasions and structures,as well as these standard steps. To insert such a step, use the “Insert Above”, “Insert Below” or the “Add Complete Step” buttons in the Steps section. Use the delete button to delete steps, and the arrow buttons to change the step sequence, by moving the selected step up and down.
There are the following predefined step structures:
Nested Guided Procedure
- Nest an existing guided procedure into your new guided procedure
- The nesting is seamless, so when you run the guided procedure, you do not see that another guided procedure is nested into the current one
- You can only nest to one level
- A parent step allows you to structure your guided procedure using substeps
- The parent step appears in the execution view of the guided procedure, as an expendable step. The substepsare below it
- A plug-in step is used for common tasks that are supported by a dedicated UI (that does not match the automatic or manual activities UI)
- With SP 05, the only plug-in type is the step for “SAP Note Implementation” that allows you to download and implement an SAP note.
- In future, more plug-in step types, such as steps for user generation and dynamic scope selection, are planned
- The Complete step marks the end of a guided procedure, and can only be added at the very end
- It contains an overview over all steps and their status during the guided procedure
- If a nested guided procedure also contains a Complete step, it is hidden at run time of the guided procedure in which it is nested
4.3.3 Activate the Guided Procedure
When you have finished your guided procedure, you must activate it to transport it to the production system.
When the guided procedure has been activated, it can no longer be edited, until the transport request that contains the guided procedure is released.
4.4 Execute your Guided Procedure
You can execute your guided procedure, in two ways:
- From the guided procedures browser
- From the Guided Procedure Maintenance view
4.4.1 Execute Guided Procedure from the Guided Procedures Browser
Open the guided procedures browser that contains your guided procedure, as described in section 4.1, then select your guided procedure and click on Execute. This opens a new window containing your guided procedure, with all the steps, activities and help texts documentation you have created.
4.4.2 Execute Guided Procedure from the Guided Procedure Maintenance View
Open your guided procedure in the Guided Procedure Maintenance view, as described in section 4.2, and click on “Preview”. This opens a new window containing your guided procedure with all the steps, activities and help text documentation you have created.
5. Additional Information