Skip to content

Configuring Mobile Augmented Reality

(Native/MDK only) Use the Mobile Augmented Reality feature to manage client augmented reality resources that can be accessed from mobile applications. For example, a training or museum app may be annotated to provide access to detailed information.

This feature requires:

  • The Version 2 SAP mobile service cockpit (Version 1 is not supported).

  • The native/MDK application must be configured for augmented reality:

    • A reference anchor must be defined in order for discovery to detect a scene.

    • Annotation anchors must be defined in order to modify language or annotations.

When the developer has annotated a mobile application properly, you can add or delete language translations, edit and delete scenes, and edit annotations from SAP mobile service cockpit (with limitations).

Keep in mind the following:

  • You can see list and detail views for scenes, edit scenes, and delete them. You cannot create new scenes from SAP mobile service cockpit.

  • You cannot create or delete annotation anchors from SAP mobile service cockpit.

  • For a single-app cockpit, you can see the list and detail views for scenes, but cannot edit or delete them from SAP mobile service cockpit.

To configure an augmented reality app in SAP mobile service cockpit:

  1. In SAP mobile service cockpit, select Mobile Applications > Native/MDK.

  2. Select an application, then select Mobile Augmented Reality under Assigned Features (or add it first).

  3. Select Scenes to view a list of scenes associated with the application. The scenes appear in the order they were created. Use filtering and sorting features to find the scenes in which you are interested. To manage the scenes, see Editing an Augmented Reality Scene.

    Augmented Reality Scene Properties

    Property Description
    Scene ID The identifier associated with the augmented reality scene. An anchor reference is required to detect a scene.
    Alias An understandable name associated with the scene.
    Creator The person who created the scene.
    Create Time (UTC) The date and time the scene was created, in YYYY-MM-DD HH:MM:SS:SSS format.
    Update Time (UTC)
    Languages The date and time the scene was last updated, in YYYY-MM-DD HH:MM:SS:SSS format.
  4. Select Info to see feature details, such as useful URLs, and to export data in JSON format.

Editing an Augmented Reality Scene

Manage augmented reality scenes for the selected application.

The developer creates the application with language codes, scenes, and entities. Language codes must be ISO 639-1 standardized two-letter codes.

A scene represents a real word with multiple entities. For discovery, a scene must include a referenceAnchor. The default is an image, for example a qrCode. Entities can be placed relative to the position of the referenceAnchor. Such an entity is called an annotationAnchor. The position is visually represented by a marker (icon) and associated information is visually represented in the form of a card. To learn more, see the SAP Fiori for iOS Design Guidelines for augmented reality (AR) topics. Both iOS and Android apps support augmented reality.

From SAP mobile service cockpit, you can modify some of the augmented reality properties and set the languages for the scenes, as described in Configuring Mobile Augmented Reality.

  1. For the selected application, navigate to Mobile Augmented Reality Scenes.

  2. Select a scene from the list. Use the search and sort options to narrow the search to a specific scene or scenes.

  3. Under Language, one or more languages are listed for each scene, separated by commas.

    Select add to add one or more language to the scene.

    1. In Add a language for Scene, select a language and then set each annotation anchor for the scene.

    2. Click Finish to save. The language appears in the Language column.

    Select X to remove a language from the scene. Note that you must keep at least one language.

    1. In Remove language for Scene, confirm that the language shown (the ISO-639-1, Native, and English names appear) should be removed for the scene.

    2. Click OK to save. The language no longer appears in the Language column.

  4. Under Actions, select Detail to view details about the scene. You can select another language to verify that the annotation anchor is available in a language.

  5. Under Actions, select Edit to edit the scene. Currently you can edit the Alias and the Marker and Card properties for each of the Annotation Anchors.

    1. In Edit Scene, you can modify the Alias and select a Language.

    2. Under Annotation Anchors, select one of the available annotations to see its Marker and Card details, for example Battery.

    3. Under Marker, select icons to represent various functions, such as Play. You can select common icons that can be used for both iOS and Android, or platform-specific icons for iOS and Android. For information, see AR Markers.

      Marker Icon properties

      Icon Description
      Icon Select an icon from a common set supported by both SDKs. For example, a common icon for Play.
      iOS Icon Select a platform-specific icon for iOS (icon-ios).
      Android Icon Select a platform-specific icon for Android (icon-android).
    4. Under Card, fill out the Card properties. The Action Type, Action Data, and Action Text together form the action button on the card. For example, a Play Video button might be configured to open a training video. For information, see AR Cards.

      Card Properties

      Property Description
      Title The title for the Card, for example Jump Car Battery.
      Description The title and subtitle for the Card, such as Instructional Video, and Car Batteries.
      Action Type For an Action Button, the Action Type informs the SDK how to handle the action after the user clicks the button. For example, to open a link or video, or to make a call.
      Action Text For an Action Button, the Action Text is the text that appears on the action button, such as Play Video.
      Action Data For an Action Button, the Action Data could be a link URL, video URL, or phone number.
      Image The image associated with the Card.
    5. Click Save, or select another Annotation Anchor to modify its properties.

  6. Under Actions, select Delete to remove the scene from the selected application, and select Yes to confirm.


Last update: March 10, 2022