Show TOC

Procedure documentationEditing a Guided Procedure

 

To compose a guided procedure, you can use various types of steps and predefined content. When designing the guided procedure, use the Overview of GPA Step Types and Content Types.

Prerequisites

  • You have created a GP. For more information, see Creating a Guided Procedure.

  • Optional: To add a custom activity or screen component, you have created one of the following:

    • To add a custom automatic or manual activity, you have created a custom class to implement it.

    • To put a custom view in a step, you have created a custom Web Dynpro screen component to implement the interface WD_IF_SISE_STEP.

    For more information, see Creating Custom Activities and Screen Components.

Procedure

  1. Enter/edit the a title and description of the step.

    The title is the name of the roadmap step title when the guided procedure runs. The description is a tooltip when the user positions the mouse on the step.

  2. Select the type and content of the step.

    For more information, see Overview of GPA Step Types and Content Types

  3. To add a help text describing the use of a step, do the following:

    1. Select the step.

    2. Under Step Help Text Name, choose New .

      A dialog box appears.

    3. Enter data as required.

    4. Add meaningful information. For more information, see Editing Help Texts For Custom Guided Procedures.

    5. Save your entries.

      Your document is stored in the package you selected when creating the guided procedure.

    Alternatively, you can reuse an existing SE61 help text object.

  4. Add an activity to a step, according to the step type specified. For more information about the types of activities, see Overview of GPA Step Types and Content Types, you have the following options:

    • To add a custom automatic activity to an automatic step, do the following:

      1. Select the step.

      2. Under Activities, choose the New pushbutton.

        A dialog box appears.

      3. In the Activity Name field, enter the name to be displayed in the activity list.

      4. Specify the name of the class implementing your automatic activity.

        For more information, see Implementing Custom Automatic Activities.

    • To add a simple manual activity to an manual step, do the following:

      1. Under Activities, choose New.

        A dialog box appears.

      2. In the Activity Name field, enter the name to be displayed in the activity list.

      3. In the Type field, choose Simple.

      4. To add a navigation link to the your manual activity, choose New.

        A dialog box appears.

      5. Specify the target system and the URL type of the GUI in which the manual activity is to be performed.

      6. To provide a tooltip for the link, enter a description for the URL.

        Example Example

        Call transaction SU01.

        End of the example.
      7. To specify a static URL (http://help.sap.com, for example), enter the URL in the Path field.

      8. Enter the parameter according to the URL or transaction to be called.

        Example Example

        To call transaction SU01, you specify the following parameter and value to be appended to the function call:

        • Key = -transaction

        • Value = SU01

        End of the example.
      9. Choose the Check pushbutton.

        A link with the description of the URL is displayed.

      10. To verify that the URL can be accessed, choose the link.

      11. To confirm, choose OK.

    • To add an expert manual activity calling a custom-developed class (to redirect the user to another link, for example), do the following:

      1. Under Activities, choose New.

        A dialog box appears.

      2. In the Activity Name field, enter the name to be displayed in the activity list.

      3. In the Type field, select Expert.

      4. Specify the class you have created.

      5. To confirm, choose OK.

      For more information, see Implementing Custom Manual Activities.

    • To add an automatic activity to an automatic step, do the following:

      1. Select the step.

      2. Under Activities, choose the New pushbutton.

        A dialog box appears.

      3. In the Activity Name field, enter the name to be displayed in the activity list.

      4. Specify the name of the class implementing your automatic activity.

        Alternatively, you can select an existing automatic activity.

        For more information, see Implementing Custom Automatic Activities.

    • To mix either manual or automatic activities or manual and custom, or automatic and custom activities in a step, do the following:

      1. Select the step and specify the type and content (type Mixed and content Custom & Auto, Custom & Manual, or Auto & Manual).

      2. If you have selected the Custom & Auto or Custom & Manual content option, under Custom UI Details, specify the Web Dynpro screen component you have created, or the step you want to reuse:

        1. Select the component.

        2. Select the view. By default, the main view (V_MAIN) is selected.

        3. Enter a description. In the guided procedure step, the description is displayed as the name of the frame in which the custom UI component is displayed.

        4. To add a manual or automatic activity (depending on the mixed step type selected), under Activities, choose New.

          For more information, see Creating Custom Activities and Screen Components.

    • To reuse an existing step, or integrate a custom Web Dynpro screen component, do the following:

      1. Select the step.

      2. In the Type field, select Custom.

      3. Under Custom UI Details, specify the Web Dynpro screen component you have created.

        Alternatively, you can reuse an existing step.

      For more information, see Creating Custom Activities and Screen Components.

  5. Under Activity Help Text, add a help text. For more information, see Editing Help Texts For Custom Guided Procedures.

    When an activity help text is created, a Display link is displayed in the Documentation column of the activity list of the step.

  6. Optional: To preview the step and check whether the activity can be performed, choose the Preview pushbutton.

    The runtime view is opened in a new window. In the roadmap, navigate to the step containing the activity you have created.

    Note Note

    You can only preview a step when you have assigned at least one activity to each step of the guided procedure.

    End of the note.
  7. To test the guided procedure in the system in which the guided procedure was created, choose the Preview pushbutton.

  8. To test the guided procedure in a different system, do the following:

    1. Select the system from the embedded work center.

    2. Launch the guided procedure browser.

    3. Select your guided procedure and execute it, or open the GP, to preview it in the Guided Procedure Maintenance screen.

  9. After having tested the guided procedure, activate it and transport it into the production system. For more information, see Activating a Guided Procedure and Editing Attributes.

    After activation, you cannot edit the guided procedure anymore. To edit the GP, create a new version.