There are several ways to access the Guided Procedure Browser, as described here.
Before you create a new guided procedure, select the required application area. For more details, see this page. In the Guided Procedure Browser, the Create button opens the Create Guided Procedure wizard, to define basic settings for the guided procedure, before you edit the content. You can either create a new guided procedure, or copy the content of an existing one and adapt it to your needs, with Copy From. The original guided procedure is not changed.
The second step of the roadmap sets search attributes for the guided procedure (optional). You can leave the search attributes initially empty, and define them later if required. For more details about setting search attributes, see application areas.
The Guided Procedure Maintenance looks as follows:
To add a step, click on New, and select the step type in the menu, as shown below. 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.
The step help text provides detailed information about each step, such as what needs to be done, and what will happen in the background. The "New" button in the help text section opens the Create New Document pop-up, which allows you to define documentation for a step or an activity.
You can create a new HTML document or upload a PDF. Here is a documentation with an uploaded PDF:
In case you would like to reuse an existing document by selecting button "Reuse". If you reuse an SE61 document for the help text, you can either use it directly, or you can either maintain it directly in the guided procedure maintenance (in this case a copy of this SE61 documentation will be performed into a new HTML document).
The UI5 Document Editor has been enhanced to support accessibility, for instance, text-to-speech and navigation by keyboard.
Standard steps can be Automatic, Manual, Custom or Mixed, depending on the contained activity types.
Automatic steps are standard steps which contain only automatic activities.
Automatic activities are activities that can be carried out in a guided procedure without user interaction or manual steps. They are usually in a guided procedure step of type automatic or mixed. You can carry out several automatic activities in one step.
To create a backend class for the automatic activity, follow the steps described in the PDF
1. To add an automatic activity, select New --> Step --> Standard Step.
2. Select the "Automatic Activities" tab and click "New".
3. The Create New Activity pop-up opens:
4. Specify the Activity and Class Name.
5. Mark the activity as optional if you don't want its status to be taken into consideration in the step status calculation.
Manual steps are standard steps which only contain manual activities.
Two types of manual activities are supported:
Simple manual activities consist of a description and either no navigation link, or a navigation link to a UI in the SAP Solution Manager, in the managed system, or an external link. The navigation link can be configured. For almost all simple navigation links like calling a transaction or URL in the SAP Solution Manager or the managed system, you can use the simple manual activities provided. You can insert the required jump-ins without any programming, as described here.
Expert manual activities consist of a description and a navigation link to a UI in the SAP Solution Manager or in the managed system. The navigation link is calculated by an ABAP class that you develop. Simple activities are usually sufficient, but if you need to put some more logic in the URL generation (e.g. authorization checks or additional parameters), you need to create an ABAP class and an expert manual activity, as described here.
To add a manual activity, select the "Manual Activities" tab and click "New".
The Create New Activity pop-up opens:
If the activity type is "Expert", specify the corresponding Activity class. To create a backend class for the expert manual activity, follow the steps described here.
Click "OK" to create the activity. You can edit the activity properties after it has been created. You can also reuse an existing activity from the list displayed if you click on "Browse" when the Use Existing option is selected.
You can create the documentation either by clicking on Document does not yet exist, or via the New button in the help text section, as explained previously.
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 WebDynpro component. Deriving out of 7.20 SP5, To create a custom manual activity, for example to redirect the user to another link, you can implement custom classes. To create a custom step, follow the steps described here.
You can group a number of steps as sub-steps of a parent step. The parent step contains a list of sub-steps with the following information: status, description, managed objects, responsible, last changed on/by.
The Complete step is the last step in the guided procedure, which provides an overview of the execution status of the previous steps, so that the processor of the guided procedure can check whether he has performed all required activities. He can also generate an HTML report containing the documentation, status and logs of all activities in the guided procedure, and add a comment summarizing the overall execution status of the guided procedure. The comment in the Complete step will be displayed in the Guided Procedure Log.
A Complete step is optional, but strongly recommended.
In runtime view, the complete step looks like the screen shot below.
As a user with an Admin role, you can create a plug-in, register and customize it according to your preferences. In order to start the plug-in registration application, enter the transaction GPA_PLUGIN_MNGT.
The functionalities that can be performed in the plug-in registration application are:
Before creating the Plug-in step, a few prerequisites are needed:
In order to create a plug-in activity, there are some prerequisites that needs to be fulfilled:
Activity plug-ins can be used in automatic activities.
They offer a custom UI in the Maintenance view used to configure the plug-in.
They are delivered by SAP and can be reused by customers.
To integrate an activity plug-in:
Step plug-ins offer:
Step Plug-ins are delivered by SAP and can be reused by customers.
The following step plug-ins are delivered by SAP:
Perform the following steps to integrate a plug-in:
1. Select "Existing Step" from the "New" menu in the "Steps" section.
2. Select either Existing step "by copy" or "by reference".
2. Select a step from the list
3. Click OK.
You can reuse existing automatic and manual activities.
You cannot bundle several guided procedures (GP) into one transport.
A new version can only be generated if the current version is active.
1. In the maintenance UI, Click Edit.
2. A confirmation pop-up is displayed, to generate a new version or cancel.
3. Click Generate to create a new version of the guided procedure.
4. An inactive version 2 of the guided procedure is created.
Newly generated GP version:
The new GP in Guided Procedure Browser:
1. In the maintenance UI, click Edit --> Properties
2. Change the search attributes of the guided procedure
3. Go back to the browser, change the search attributes to match the new search attributes of the guided procedure.
4. Click Apply. Your guided procedure is listed.
The Guided Procedure Search Attributes in Guided Procedure Maintenance:
The Guided Procedure Search Attributes in Guided Procedure Browser:
To enter the runtime view, click on "Preview" in Guided Procedure Maintenance, or select the GP in the Guided Procedure Browser and click "Execute". The runtime view looks like the following.
Parent Step and Sub-Steps:
Plugin Note Sub-Step:
Soft Linear Dependency is a new behavior allowing to navigate to the next step even if previous step is not successful. Consequence: previous step could be Successful or Warnings, meaning all mandatory activities have been executed successfully or with warnings. In the opposite of Hard dependency which forbid navigation until the previous step was successfully executed. This feature is available starting from SP6.
Case of hard linear dependency:
Case of soft linear dependency:
Click on Display Execution Logs button to launch the log application.
This application provides all information required about the guided procedure instances execution, such as logs, step statuses, processor.
You can also display all GP instances executed on one or multiple systems, with Guided Procedure Log, in the Technical administration work center --> Guided Procedure Management. From the Log application, you can either continue to execute the existing instances of the GP, or create new instances.
You can also start new instances of one guided procedure, with Start New Instance in the Log, or from the Guided Procedure Browser, with Execute --> New Instance. A new instance is a new execution of the guided procedure, in which all status are grey (Not executed). Managed objects and processor can between instances of a guided procedure.