Skip to content

Design Time

Use mobile transaction bridge Recorder to create and manage recordings of user interaction flows in SAP Transactions.

Mobile Transaction Bridge Recorder

At design time, a collection of user interaction flows belonging to a specific transaction can be recorded, modified, deleted or published for consumption via OData services. For this, the Recorder tool of the mobile transaction bridge can be used. The tool requires a SAP GUI for HTML back-end system which will be opened in a controlled manner directly in the browser and which the Recorder connects to. The SAP GUI for HTML back-end systems to be used for recording need to fulfill some prerequisites and the user accessing the system needs to have the necessary roles assigned and the required settings enabled.

Steps to Open Recorder

  1. In SAP mobile service cockpit, select Settings > mobile transaction bridge

  2. Click on the Open Recorder button in the top right corner.

  3. Log in to mobile transaction bridge Recorder.

    • The recorder will load the default back-end system configured in the SAP mobile service cockpit
    • If there is no back-end system configured, an error message will be displayed
  4. Log in to the SAP GUI for HTML

  5. Confirm dialog question to enable access to the WebguiConnector.

  6. The connector icon in the top pane next to the title is now connected and green

    • If the icon stays disconnected and red and the left pane displays error message No WebGUI Connection, please check all prerequisites are fulfilled

    • Optionally, you can use a different back-end system, by selecting another entry in the top-right drop-down box.

  7. Start a supported SAP Transaction in the SAP GUI for HTML, for example SU01

  8. The left pane has now the add button enabled and displays a list of existing recordings for the current SAP Transaction in the SAP GUI for HTML

Create Recording

Use the Recorder tool to group and capture user interaction flows. Use preview function to inspect OData metadata.

To organize the recordings in a meaningful way, the Recorder is using an internal structure and a set of rules.

Structure

App

  • Top level entity, linked to an SAP Transaction (cannot be created or exist without it)
  • Keeps together a group of recordings (user interaction flows)
  • As part of the mobile transaction bridge, it translates to an individual OData service

Sequence

  • Recording of a user interaction flow in the SAP GUI for HTML
  • Can contain input and output parameters
  • As part of the mobile transaction bridge, it translates to a Function/Action in the OData service

Step

  • An individual action and/or communication with the SAP GUI for HTML back-end
  • Can have input and output parameters attached

    Note

    the sum of all input/output parameters for all steps will translate to the input and output of the Sequence

  • It does not have any semantic for the OData service - all steps get bundled as part of a Sequence

Rules

  • There should be at least one Sequence starting on the initial screen of the SAP Transaction in the SAP GUI for HTML
  • Every recorded Sequence should be reachable from the initial screen of the SAP Transaction
    • Either it starts on the initial screen
    • Or there are other sequences leading to the screen where the sequence start

Steps to Create a Recording

  1. In mobile transaction bridge Recorder select add button in the header of the left pane to create an App
  2. In the "Create App" dialog enter the following data:
    • Name: name of the app (and implicitly of the OData service). For example User Maintenance.
    • Description: meaningful description for the group of recordings contained in this app
  3. Select the newly created app in the left pane
  4. Select add button in the header of the left pane again, this time to create a Sequence
  5. In the "Create Sequence" dialog enter the following data:
    • Name: name of the app (and implicitly of the OData Function/Action). For example Find User
    • Description: meaningful description for this user interaction flow.
    • Read Only: Expose sequence as OData Function. Read more about read-only sequences
  6. Select the newly created sequence in the left pane
  7. Select the record button in the left pane to start recording.

    Note

    • The canvas containing the SAP GUI for HTML application starts glowing in red, signalizing the recording mode
    • A Configure button appears on the left side of the top(header) pane and can be used to select input and/or output fields
    • Every interaction with the SAP GUI for HTML which results into a communication with the back-end will be recorded
  8. Perform the user interaction flow

  9. Toggle the Configure button every time you want to select input and output fields
  10. Select the Stop button to stop and save the recording
  11. Navigate to the list of Sequences by using the breadcrumb navigation on the top of the left pane and create a new recording (Step 4)
  12. Navigate to the list of Apps by using the breadcrumb navigation
  13. Select the Preview button for an app to inspect the metadata of the corresponding OData service

Read-Only Sequences

By default, each sequence is exposed as OData Action which has to be invoked by an HTTP POST request. To simplify the integration effort and allow additional scenarios you can mark a sequence as read-only. This affects the way you have to invoke the sequence:

  1. Read-only sequences must be invoked by an HTTP GET request instead of a HTTP POST. Therefore, all input parameters have to be provided inside the URL. Read about how to invoke OData Functions.
  2. They do not require any session information as they come with implicit login/logout. For each invocation a new, separate session will be created and afterwards invalidated.

Limitations

  1. For security reasons, make sure that your recording will only be used to retrieve data and do not have any side effects as creating, updating or deleting data.

  2. Because read-only sequences come with implicit login, they have to start at the beginning of the SAP Transaction, as they can't depend on previous user interaction.

  3. According to the OData standard, an OData Function has to be invoked with all its parameters, including the nullable ones. However, it is possible to set the value of nullable parameters to null.

Pause Recordings

An active recording can be paused anytime. Once paused, none of the interactions with the SAP GUI for HTML will be recorded until the recording is resumed.
This can be used to retrieve required input data during the recording.

Note

  • A recording can only be resumed at the screen where it has been paused at.
  • Make sure that none of the actions executed during the pause cause any side-effects to the subsequent steps. Otherwise the recording might break.

Steps to Pause a Recording

  1. During a recording, select the Pause pause button in the left pane to pause the recording.
  2. Perform additional actions which should not be recorded.
  3. Return to the screen where the recording was paused.
  4. Select the Resume play button in the left pane to resume the recording. Further interactions with the SAP GUI for HTML continue to be added to the sequence.

Replay and Update Recordings

After a recording has been created, the Replay function can be used to check what has been recorded and also to modify/enhance the recording by adding/removing input and/or output fields.
In addition, it is possible to resume the recording at any step to modify the sequence flow.

Note

  • The replay function uses the data entered during recording. Therefore use with caution for recorded flows which add, modify or delete data in the SAP Transaction.
  • Published recordings can only be replayed but not modified - for that a new version needs to be created.

Steps to Update a Recording Fields

  1. In mobile transaction bridge Recorder select an app in the left pane
  2. Select a sequence in the left pane
  3. Select the media-play button in the left pane to enter the replay mode

    Note

    • The canvas containing the SAP GUI for HTML application starts glowing in blue, signalizing the recording mode
    • The Configure button appears on the left side of the top(header) pane and can be used to add/modify/remove input and output fields
  4. Select the Step over button in the left pane to move from step to step

  5. Toggle the Configure button to select input and output fields as wanted
  6. Select the Stop button to stop and save the replay
  7. Navigate to the list of Apps by using the breadcrumb navigation.
  8. Select the Preview button for the app created in Step 2 to observe how the metadata for the corresponding OData service has changed

Steps to Update the Recording Flow

  1. In mobile transaction bridge Recorder select an app in the left pane.
  2. Select a sequence in the left pane.
  3. Select the media-play button in the left pane to enter the replay mode.
  4. Use the media-forward button in the left pane to move from step to step.
  5. Once you are at the step where you want to edit the flow, select the record button to start the recording.
    • This deletes all following steps. Confirm the message dialog to proceed or cancel the operation.
  6. Perform the user interaction flow. Any interaction is added to the recording.
  7. Select the color-fill button to stop and save the recording.

Test Recordings

Before publishing the recording, you can test the OData service. This provides a preview of the published result and allows you to adjust the recording if needed.

  1. In mobile transaction bridge Recorder navigate to the list of Apps in the left pane (by using the breadcrumb navigation).
  2. Select the More overflow button of the recording you want to test.
  3. Select the Test OData Service lab button in the popover menu.
  4. Select the destination used to execute the sequences. If no destination is available create a new one as described here.
  5. Select the sequence you want to test.
  6. Based on the selected sequence, fill out the input form.
  7. Select the Execute button.

The result page will occur. The tab bar allows to switch between different views:

  • The Parsed Response tab renders all output properties including tables as visible controls
  • The Raw Response tab displays the plain JSON response received from the OData service

By selecting the Back arrow-left button you can modify the input values or execute other sequences. When you are done, select Close.

Note

During the live time of the dialog all requests share a single SAP GUI for HTML session. This allows to execute sequences depending on each other. By closing the dialog the current session will be terminated.

Publish Recordings

After a recording has been created the Publish function can be used to expose the flows via OData.

Steps to Publish a Recording

  1. In mobile transaction bridge Recorder navigate to the list of Apps in the left pane (by using the breadcrumb navigation).
  2. Select Publish and confirm.
  3. Select Preview to observe the final metadata for the corresponding OData service.

    Note

    For accessing the newly published OData services, see Runtime - consume OData Services

Create a New Version

After a recording has been published, the New Version function can be used create a new version which can be modified or enhanced.

Note

  • new flows can be added.
  • old flows can be modified or deleted

Steps to Create a New Version

  1. In mobile transaction bridge Recorder select an app in the left pane
  2. Select the New Version button in the left pane
  3. The new version is available, app can now be modified/enhanced

Recording Revisions

After a recording has been published, the Show Version History function can be used to display and restore previous versions.

Note

Each app can only have one unpublished version at the same time

Steps to Access Recording Revisions

  1. In mobile transaction bridge Recorder select an app in the left pane.
  2. Select the More overflow button.
  3. Select the Show Version History button in the popover menu.
  4. Pick the revision you want to display from the list
  5. Inspect the sequences of the selected revision.
  6. In order to modify the app, select the New Version button in the left pane. This creates a new version of the app that is based on the revision selected in step 2.
  7. If you are happy with your changes, select the Publish button and confirm the dialog in order to expose your changes as OData service.
  8. Otherwise you can select the Discard App Version button to delete your current draft. This will reset the recorder state to the currently published version.

Delete Published Recordings

If a published recording is no longer needed, it can be removed. As a result, the recording will neither be accessible in the mobile transaction bridge Recorder nor at runtime.

Note

As soon as a published recording is deleted, the associated OData services become unavailable. Before deleting, please ensure that no application depends on any of the services. You can use the mobile transaction bridge OData feature to get a list of recordings with their associated destinations. However, mobile transaction bridge can't detect whether a recording is used in the Direct Consumption scenario.

A deletion always affects all revisions of a recording.

Steps to Delete a Published Recording

  1. In mobile transaction bridge Recorder navigate to the list of Apps in the left pane (by using the breadcrumb navigation).
  2. Select the More overflow button of the recording you want to delete.
  3. Select the Delete App delete button in the popover menu.
  4. A confirmation dialog is displayed.
  5. In order to continue, enter the name of the app into the input field and press the Delete App button.

Export Recordings

Administrators can export recordings to create backups or to transfer data between multiple instances.
Export bundles are encrypted and then downloaded to the local machine.

The export can either be created for all or a subset of recordings. Each recording then appears with all revisions, published OData services and drafts.

Only a user with the TransactionBridgeAdmin role can import or export recordings. See Configure Access Roles for more details on available roles and how to assign them.

Steps to Export Recordings

  1. In mobile transaction bridge Recorder click your user avatar in the top-right corner.
  2. Select the Import/Export product button in the popover menu.
  3. In the Export section, enter a password used for encryption. Enter the same password into the confirmation field as well.

    Note

    The export file is encrypted using the password. Upon import, the same password is required. In case you forget the password, the recordings of the export bundle can't be restored!

    The used password must be at least 8 characters long.

  4. Click the Select apps for export button. A table of all recordings will be displayed.

  5. Select the recordings you want to export.
  6. Click the Export button. The export bundle is generated and downloaded to your local machine.

Import Recordings

Administrators can import recordings previously exported according to Export Recordings.
After uploading the export bundle you can inspect the content and choose which recordings to import.

Only a user with the TransactionBridgeAdmin role can import or export recordings. See Configure Access Roles for more details on available user roles and how to assign them.

Steps to Import Recordings

  1. In mobile transaction bridge Recorder click your user avatar in the top-right corner.
  2. Select the Import/Export product button in the popover menu.
  3. In the Import section, select the export file. You can use the Browse button to browse your file system or drag and drop the file into the field.
  4. Enter the password used during export.
  5. Click the Upload button. A table of recordings will be displayed.
  6. Select the recordings you want to import. For each recording the status and import actions are displayed:

    • New: the recording does not exist in the target instance. If selected, the recording is created.
    • Updated: the recording already exists in an older version. If selected, all new revisions are created.
    • Conflict: the recording already exists and differs from the exported one. If selected, the existing recording is replaced by the exported one.
    • Recording exists: the recording already exists and is equal to the exported one.

    Note

    An imported recording refreshes its state from the export and affects all revisions, drafts and published OData services.
    When importing recordings marked as Conflict, existing OData services are updated or deleted!

  7. Click the Import button. The selected recordings are imported.


Last update: November 18, 2021