Installation Guide | PUBLIC

Document Version: 1.0 – 2020-11-06

SAP Shop Floor Manager Configuration Guide

© 2021 SAP SE or an SAP affiliate company. All rights reserved.

THE BEST RUN

Content

1 Document History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2 SAP Shop Floor Manager Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.1 Supported Back-End Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 SAP Shop Floor Manager Functional Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Supported SAP Transaction Codes for SAP Shop Floor Manager. . . . . . . . . . . . . . . . . . . . . . . . . 7

3 SAP Mobile Add-On for the SAP Configuration Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3.1 Accessing the SAP Mobile Add-On for SAP Configuration Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.2 Configuration Panel Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Standard Operations in the Configuration Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Mobile Application Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
OData Channel Integration Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Change Detection Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Technical Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Mobile Authorization Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

4 Mobile Add-On Configuration Panel Common Procedures. . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

4.1 Mobile Application Configuration Procedures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Configuring Notification Catalog Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Configuring Document Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Enabling and Disabling Features Per User Through SAP Authorization. . . . . . . . . . . . . . . . . . . . 46
Configuring Mobile User Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
4.2 OData Channel Integration Settings Procedures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Copying an Object to the Customer Namespace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Working with oData MDO Filter Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
Filtering Equipment Records by Equipment Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Configuring an Equipment Status Filter for an Equipment Table. . . . . . . . . . . . . . . . . . . . . . . . . 56
Retrieving Additional Data for OData Mobile Data Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

5 Setting up an OData Mobile Data Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

5.1 Supported OData Features for SAP Mobile Add-On. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
5.2 Setting the OData Mobile Data Object Service Assignment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
5.3 Setting the OData Mobile Data Object Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
5.4 Setting the OData Model Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65

6 Data Distribution Model Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

6.1 Data Distribution by Assignment Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

SAP Shop Floor Manager Configuration Guide

2 PUBLIC Content
6.2 Common Filters for SAP Shop Floor Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

7 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
7.1 SAP Gateway Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74
7.2 SAP Gateway Error Logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
7.3 SAP Gateway Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
7.4 SAP Gateway Tracing Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

SAP Shop Floor Manager Configuration Guide

Content PUBLIC 3
1 Document History

Before you begin reading this guide, be sure that you have the latest version.

The following table provides an overview of the most important document changes.

Document Version Date Description of Changes

1.0 OCTOBER 2020 Original release of the SAP Shop Floor

Manager guide, version 2010

SAP Shop Floor Manager Configuration Guide

4 PUBLIC Document History
2 SAP Shop Floor Manager Overview

The SAP Shop Floor Manager Configuration Guide is intended for system administrators, technical architects,
implementation team members, and IT personnel involved in the installation, setup, and configuration of
software for the application.

It is assumed that the personnel performing the installation and setup are familiar with SAP installation
guidelines. SAP setup knowledge is helpful while carrying out the steps for the mobile setup of SAP.

Use the SAP Shop Floor Manager along with appropriate SAP documentation. Note that this guide only covers
setting up and enabling the SAP Shop Floor Manager mobile application.

2.1 Supported Back-End Systems

SAP Shop Floor Manager Version 1.0 supports the following back-end systems:

● SAP S/4HANA 1610 FPS 03 or higher

 Note

For SAP S/4HANA on-premise 1909 systems, no ABAP add-on installation is required. Check 2493602
, including the prerequisites section. For the SAP S/4HANA on-premise 1909 release, SAP Shop
Floor Manager is only available in SAP S/4HANA 1909 FPS01 and above releases.

● SAP Enhancement Package 7 for SAP ERP 6.0 Support Package 14 or higher
● SAP Enhancement Package 8 for SAP ERP 6.0 Support Package SP07 or higher

The same functions are available for both back-end systems.

For detailed information, see the following guides:

● Mobile Add-On for ERP Installation Guide

● Mobile Add-On for S/4HANA Installation Guide

2.2 SAP Shop Floor Manager Functional Overview

SAP Shop Floor Manager is a mobile solution for managing production orders, notifications of the following
types: quality, maintenance, and shift notes.

Regardless of connectivity, SAP Shop Floor Manager allows remote employees to access, complete, and
manage their assigned production orders and notifications through their mobile devices. With SAP Asset
ManagerSAP Shop Floor Manager, they have SAP back end data readily available. Armed with more
information, employees work smarter, have more work time, improve their first-time fix rates, and extend asset
lives by conducting more preventative maintenance.

SAP Shop Floor Manager Configuration Guide

SAP Shop Floor Manager Overview PUBLIC 5
SAP Shop Floor Manager comes packaged with a mobile add-on for SAP ERP and a mobile add-on for SAP
S/4HANA. They offer tight integration and easier deployment without interference to or from your existing SAP
system customizations or standard SAP objects. They provide you with full configuration, administration, and
monitoring features that allow you to manage the SAP Asset ManagerSAP Shop Floor Manager application
from within your SAP system infrastructure.

The main features and functions available in SAP Asset ManagerSAP Shop Floor Manager include the following.

Production Orders and Notifications

SAP Shop Floor Manager supports the following standard SAP Plant Maintenance productionorder
functionalities on the mobile device:

● Download production order based on assigned area of responsibility

● Display production orders and their details
● Edit production orders and their details

The following standard SAP notification functionalities are supported on the mobile device:

● Download notification based on its start date

● Display notifications and their details
● Edit notifications and their details
● Create notifications and their details
● Complete notifications and update their status

Single Sign-On (SSO)

Single Sign-On (SSO) allows the user to log into the SAP Shop Floor Manager application from the client using
SSO credentials without having to enter their back end user name and password. In addition, once logged in
with SSO, you can access another mobile application without the need to log in again.

Documents

SAP Shop Floor Manager supports viewing of master data or transaction data attachments on the mobile
device. Documents include Microsoft Office files, PDFs, and other commonly used business documents,
including videos, pictures, and audio files.

Downloading and uploading documents are supported for the following objects:

● Notifications

The following standard SAP document storage options are supported:

● SAP Business Document Service (BDS)

● SAP Generic Object Service (GOS)
● SAP Document Management System (DMS)

SAP Shop Floor Manager Configuration Guide

6 PUBLIC SAP Shop Floor Manager Overview
2.2.1 Supported SAP Transaction Codes for SAP Shop Floor
Manager

SAP Shop Floor Manager uses the SAP back end and specific SAP ERP transaction codes to help configure the
application.

Transaction Codes Definition

IW21 Create notifications

IW22 Edit notifications

IW23 Display notifications

IW31 Create work orders

IW32 Edit work orders

IW33 Display work orders

IW51 Create service notification

IW52 Change service notification

IW53 Display service notification

CAT2 Record time entries

IE03 Display equipment

IL03 Display functional location

MM03 Display material

IW41 PM confirmation create

MIGO Goods issue for work orders

EG30 IS utility meter management - device full replacement

EG31 IS utility meter management - device full installation

EG32 IS utility meter management - device full removal

EG33 IS utility meter management - device technical installation

EG36 IS utility meter management - device technical removal

EL28 IS utility meter management - meter reading result single entry

SAP Shop Floor Manager Configuration Guide

SAP Shop Floor Manager Overview PUBLIC 7
Notification Maintenance Limitations

The current version of SAP Shop Floor Manager has the following limitations with Notification maintenance:

● Shift Notes: Reference Production Order ID cannot be changed for the existing Shift Note
● Quality Notifications: Partner determination must not be mandatory, otherwise Quality Notification cannot
be created

SAP Shop Floor Manager Configuration Guide

8 PUBLIC SAP Shop Floor Manager Overview
3 SAP Mobile Add-On for the SAP
Configuration Panel

The SAP Mobile Add-On provides integration services for SAP Shop Floor Manager. A central configuration tool
known as the SAP Configuration Panel is provided to perform all configuration tasks related for the mobile
application. The Configuration Panel is a browser-based application based on Web Dynpro ABAP.

3.1 Accessing the SAP Mobile Add-On for SAP

Configuration Panel

Context

You can access the Configuration Panel either through SAP Customizing or using a transaction code directly.
First, log into your back-end system, and then you can choose from the following two options:

Procedure

1. To access the ConfigPanel through Customizing, enter the transaction spro to open the Customizing:
Execute Project screen. Select the SAP Reference IMG tab. Using the SAP Customizing Implementation
Guide list, select Agentry SAP Framework Configuration System Settings Define Mobile
Applications .
2. To access the ConfigPanel using a direct transaction code shortcut, enter /n/syclo/configpanel.

Results

The Mobile Application Integration Framework home page is displayed in a browser.

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 9
3.2 Configuration Panel Overview

All configuration activities for the SAP Mobile Add-On are performed through the ConfigPanel.

Customization changes you make via the ConfigPanel can significantly impact the behavior of the SAP Mobile
Add-On and the SAP Shop Floor Manager application. Always follow SAP best practices, make changes and
test them in the development and quality control systems before you transport the changes into your
production landscape.

3.2.1 Standard Operations in the Configuration Panel

While configuration for each mobile application is unique, certain toolbar functions in the Configuration Panel
are common and are available for all applications.

Mobile Application Filter

If more than one mobile application is available in the same system, you can use the filter function to only view
items for a specific application. Find the filter option on any page where multiple applications are displayed.

To filter by application, click the arrow to the right of the Defined Mobile Applications field, and select the
appropriate mobile application. To remove the selection and view all items for all mobile applications in the
system, click in the field again and select the asterisk ( * ) symbol.

Creating, Copying, Deleting, and Changing Items

The following standard actions are available to configure different components and items within your mobile
application setup:

● Create: Creates a new item. All modifiable fields are empty.

● Copy: Copies the item that was highlighted and creates a new item. All modifiable fields are filled in with
the information from the existing item and are available for changes before saving.
● Delete: Deletes the highlighted item.
● Change: Allows you to change the highlighted item in the modifiable fields.

Saving or Canceling Changes for an Item

Once you click the Create, Copy, or Change button, the Save and Cancel buttons are displayed. After you
change the configuration of the item, click Save to save the changes or Cancel to discard the changes.

SAP Shop Floor Manager Configuration Guide

10 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
  Note

If the Save and Cancel buttons are active, the Home link for the ConfigPanel is not available. Either save
your changes or cancel out of the changes to return to the main Configuration Panel page

Message List

Certain actions can generate system messages. These messages can be error messages or informational
messages. If you perform an action that prompts a system message, a message bar appears above the main
panel with a brief description of the message.

Click the Show List button to display the detailed view of the message list.

3.2.2 Mobile Application Configuration

The Mobile Application Configuration page allows you to configure general settings for the entire mobile
application.

The Mobile Application Configuration page contains the following tabs:

● General
● Conversion Exit Setting (not used in SAP Shop Floor Manager)
● System Components (not used in SAP Shop Floor Manager)
● Parameters
● Client Globals (not used in SAP Shop Floor Manager)
● User Attributes (not used in SAP Shop Floor Manager)

General Tab

Use the General tab to create or change basic information about a mobile application.

● Basic Data section: Enter the name of the mobile application in the <Mobile Application> field, which
is limited to 40 characters. Select the type of application in the <Type> field. Note that for SAP Shop Floor
Manager, the type is <oData Applications>. Enter a brief, easy to understand description in the
<Description> field, limited to 60 characters. Type in the release number of the application in the
<Release> field.
● User Management Setting: When the <Disable Automatic User Creation> box is checked, a new
user GUID is not automatically created when a new mobile client is detected in the system. Manually create
and maintain mobile users through the Administration portal.
● Server Management Setting: When the <Disable Automatic Server Registration> box is
checked, a new server GUID is not automatically created when a new server is detected in the system. You
must manually create and maintain servers through the Administration portal.
● Life-cycle management: When the <Application Blocked> box is checked, the mobile application is
disabled. The mobile user can no longer connect to the back-end system for the mobile application, and

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 11
 the xChange process is also disabled. The <Effective Date> and <Time> fields flag when the change
takes effect.
● xChange Setting: When the <Disable Change Detection> box is checked, the change detection
process, or xchange process, for the application is completely disabled.
● Inbound Transaction Management: Not used in the SAP Shop Floor Manager application.
● Multi Backend Setting: When checked, enables a specific mobile application to connect to multiple SAP
systems, consisting of one host server and one or more satellite servers.
● System Role: Dropdown menu where you can select either Host or Satellite.
A Host system is the connection between SAP and the SAP Shop Floor Manager application in the SAP
Cloud Platform. The host server provides the logic to the application and functions as the bridge to the
satellite server or servers. There can only be one host server per system.
Satellite servers communicate with SAP through the host server. To complete multi backend configuration,
configure the host and back-end servers using the System Components tab. See that section for more
details.

Parameters Tab

The Parameters tab defines system parameters.

● Mobile Application Info: The <Mobile Application> field is read only and is the name of the mobile
application. The <Mobile Application Description> is read only and is a brief description of the
mobile application. The <Release> field is read only and is the release number of the application.

SAP Shop Floor Manager Configuration Guide

12 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
● Application Parameters: Use the <Add> and <Delete> buttons to create and delete parameters.
● Parameter Detail: The <Parameter Group> is the group to which the parameter belongs. Groups are
how you organize parameters. References to a parameter include both the group name and the parameter
name. The <Parameter Name> is the unique name of the parameter.
The <Parameter Value> is the currently configured value of the parameter. References to the parameter
return the configured value. Use the <Language Specific Value> checkbox to select which
parameters you wish to be language dependent. The checkbox and the corresponding Language Specific
Values tab are only active after you have clicked the Change button. Note that the language available in the
Language Specific Values tab, Value List table, depends on the language you are using to log into the mobile
client. You must manually maintain each parameter that you wish to control for a language specific value
separately.
Set the <Parameter Scope> to one of the following options:
○ Mobile Application: Value for all users of the application
○ Mobile User: Value you can override for individual users. To override a parameter value of a user, see
the Administration & Monitoring Portal on parameters

 Note

For information on setting user parameters, see the following security guides, depending on your
back end system:
○ Mobile Add-On for S/4HANA Security Guide
○ Mobile Add-On for ERP Security Guide

The <Rule ID> field contains the rule used at runtime. If you check the <Use Rule> box, the rule in the
<Rule ID> field is active.
Check the <Active Flag> box to ensure that the parameter is used by the mobile application. Inactive
parameters are not used by the application. When you check the <No Runtime Change> box, you cannot
override the value of the parameter. The configured value is always the value. If the box is not checked, the
parameter values can be overridden at runtime through synchronization processing.

3.2.3 OData Channel Integration Settings

[Link] OData Service Assignment

Gateway OData services implemented using the Mobile Integration Framework for SAP are different from the
typical Gateway OData services.

The following requirements must be met for the Gateway OData services:

● Define the Gateway OData technical model using the generic model provider class of the Mobile Integration
Framework /MFND/CL_CORE_ODATA_V2_MPC. You can maintain the OData technical model with
transaction /IWBEP/REG_MODEL.
● Define the Gateway OData technical service using the generic data provider class of the Mobile Integration
Framework /MFND/CL_CORE_ODATA_V2_DPC. You can maintain the OData technical service with
transaction /IWBEP/REG_SERVICE.
● Assign the Gateway OData technical service to a mobile application by choosing the OData Service
Assignment in the ConfigPanel.

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 13
● Do not define the Gateway OData technical model using the Gateway Service Builder. The model is
determined and generated dynamically by the generic model provider class /MFND/
CL_CORE_ODATA_V2_MPC based on the model configuration settings defined in the ConfigPanel.
● The generic data provider class /MFND/CL_CORE_ODATA_V2_DPC doesn’t provide the required business
logic for the Gateway OData technical service. Business logic is provided by OMDOs. Assign every OData
business request to the service to an OMDO. The assigned OMDO performs the necessary business logic
for the business request.

Service Assignments

You can define the following settings for the OData service assignment:

● OData Version: OData version 2.0 is supported.

● OData Service: The Gateway OData technical service that is assigned to the mobile application. You can
only assign a single mobile application to a Gateway OData technical service. Assignment to multiple
mobile applications is not supported.
● Active: If the Active checkbox is checked, both the OData model and OData service are supported. If the
checkbox is not checked, no OData model is generated for the service, and the data request to the service
is not supported.
● Defer Batch Response: This setting is only relevant if you have an SAP S/4HANA back-end system. If the
checkbox is checked, the Gateway runtime deferred batch response is enabled, which can improve
performance during read request processing.
● Max Payload Records: Maximum number of records in the response payload to a read request. In case the
read request is a batch request with multiple read requests, this setting defines the total number of records
allowed in the overall payload, which is the aggregation of individual read request responses.
● Cache Handshake: When checked, the Gateway runtime metadata cache handshake is enabled for the
service.
● Technical Service Name: Read-only information. Gateway OData technical service name.
● Service Version: Read-only information. Gateway OData technical service version.

Composition Settings

With service component composition, you can compose a complex service using component services.

SAP Shop Floor Manager Configuration Guide

14 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
In the following example, service /MERP/SAP_PROD_SUPERVISOR version 0001does not include
component services..

To define a component composition, define the following:

● Parent OData Service and Version: Parent OData service. Entity model of a child OData service is included
in the parent entity model. Association and navigation properties can be defined between parent service
and component service.
● Component OData Service and Version: Child OData service
● Enabled: If the checkbox is not checked, the entity model of the component service is not included in the
entity model of the parent service.

[Link] OData Model Configuration

OData service implemented using the Mobile Application Integration Framework does not use the Gateway
Service Builder to define the OData model. Define the OData model using the OData Model configuration tool in
the ConfigPanel. The runtime OData model is generated dynamically based on the configuration settings. The
OData model configuration is mobile application-specific. You cannot share OData models across mobile
applications.

Define the OData model configuration settings through the following screens:

Entity Set Tab

Entity configuration defines the OData entity type. Entity set configuration defines the OData entity set. In an
OData model configuration, each entity type is limited to one entity set. Reuse of entity types by multiple entity
sets or by different OData services is not supported.

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 15
The following attributes are available for the Entity Type definition:

● Entity Type Name: Case-sensitive name of the entity type. The name must be unique within the OData
service.
● Active Flag: If unchecked, the entity type is not included in the generated OData model
● Entity Type ID: Internal ID generated by the system to identify the entity type
● Mobile Application: Mobile application for the entity type. The OData model configuration is defined for
individual mobile applications. You can reuse the entity type name in different mobile applications.
● Internal OData Service ID: Internal OData service ID that identifies the OData service for which the entity
type is defined
● Service: Gateway technical service name of the OData service. Information is read-only.
● Version: Gateway technical service version. Information is read-only.
● OMDO ID: OMDO that provides business logic for the entity type and its entity set
● OMDO Entity Type: Technical entity type of the OMDO that is mapped to the OData entity type. Data for
the OData entity type is supplied by the OMDO entity type.

The following attributes are available for the Entity Set definition:

● EntitySet Name: Case-sensitive name of the entity set. Must be unique within the OData service.
● Creatable: If checked, creation (POST) request for the entity set is supported
● Updatable: If checked, update (PUT / PATCH / MERGE) request for the entity set is supported
● Deletable: If checked, deletion (DELETE) request for the entity set is supported
● Pageable: If checked, paging is allowed for the entity set read request
● Filter Required: Not applicable for SAP Shop Floor Manager

Property List

SAP Shop Floor Manager Configuration Guide

16 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
You can configure the following on the Property List tab:

● Property Name: Case-sensitive name of the property

● OMDO Field Name: Field name of the OMDO technical entity type mapped to the property. The value of
the property is supplied in the <OMDO Entity Type> field.
● EDM Type: Standard EDM type for the property
● Key Indicator: If checked, the property is the key property of the entity type
● Creatable: Not applicable for SAP Shop Floor Manager
● Updatable: Not applicable for SAP Shop Floor Manager
● Sortable: If checked, the property can be used for sorting
● Nullable: If checked, the property can have NULL value
● Filterable: If checked, the property can be used for filtering
● Content Type: If checked, the property value can represent content type
● Max Length: Maximum allowed length of the property value
● Precision: Decimal precision of the property, if relevant
● Scale: Decimal scale of the property, if relevant
● ETag: If checked, the property serves as the <ETag> field. You can set only one field as an <ETag> field in
an entity type.
● Conversion Exit: Conversion exit for the property

Association & Set List Tab

An association defines the relationship between two entity types, with one entity type as the principle entity
type, and the other as the dependent entity type. An association set defines the relationship between the two
entity sets of the respective entity types in the association. In an OData model configuration, associations and
association sets are child objects of an entity type, and each association can have only one association set
defined.

When you define an OData model to use with OData offline SDK client application, you also define referential
constraints for the association. Only key fields of the principle entity type can be used in referential constraints.

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 17
You can configure the following in the Association Info section:

● Association Name: Case-sensitive name of the association

● External Association: By default, the parent entity type of the association is the principle entity type.
However, if the External Association flag is checked, the parent entity type of the association is the
dependent entity type. An external association is commonly used when defining associations between
entity types across component services.
● Association ID: A read-only internal GUID generated by the system that identifies the association
● Principle Entity Type ID: Lead entity type of the association
● Principle OMDO ID: Read-only OMDO ID to which the principle entity type is mapped to
● Principle Tech Entity Type: Read-only technical entity type of the OMDO ID to which the principle entity
type is mapped to
● Principle Cardinality: Cardinality of the lead entity type
● OnDelete Cascade (Principle): If checked, the dependent entity type and entity set are automatically
deleted when the principle entity type and entity set are deleted
● Dependent Entity Type ID: For standard associations, the dependent entity type can be any entity type
belonging to the same OData service or child component service
● Dependent OMDO ID: Read-only OMDO ID to which the dependent entity type is mapped to
● Dependent Tech Entity Type: Read-only technical entity type of the OMDO ID to which the dependent
entity type is mapped to
● Dependent Cardinality: Cardinality of the dependent entity type
● Dependent OnDelete Cascade: If checked, the principle entity type and entity set are automatically
deleted when the dependent entity type and entity set are deleted

You can configure the following in the Association Set Info section:

● Association Set Name: Case-sensitive name of the association set

● Association Set ID: Read-only internal GUID generated by the system that identifies the association set
● Principle Entity Set Name: Read-only entity set name of the principle entity type. Each entity type in the
OData model configuration can only have one entity set.

SAP Shop Floor Manager Configuration Guide

18 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
● Dependent Entity Set Name: Read-only entity set name of the dependent entity type. Each entity type in
the OData model configuration can only have one entity set

You can configure the following in the Referential Constraints section (not pictured in detail in the example
screenshot):

● Principle Entity Type: Read-only principle entity type of the association

● Principle Property: Principle property of the referential constraint. The principle property is the key field of
the principle entity type.
● Dependent Entity Type: Read-only dependent entity type of the association
● Dependent Property: Dependent property of the referential constraint. The dependent property can be
any field of the dependent entity type that has a foreign key relationship with the principle property.

Navigation Property List Tab

A navigation property represents a link from the parent entity type to a related entity types.

You can define the following attributes for a navigation property in the Entity Type Navigation Properties table:

● Navigation Property Name:

● Technical Name: Case-sensitive name of the Internal technical name of the navigation property. The
technical name is not case-sensitive.
● Association: Association for the navigation property. The navigation represents the link between the
principle entity type and the dependent entity type.
● Principle Entity Type Name: Read-only principle entity type name of the association used by the
navigation property
● Dependent Entity Type Name: Read-only dependent entity type name of the association used by the
navigation property

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 19
Additional Setting Tab

You can define the following additional settings for the OData model:

● Media Flag: If checked, the entity type is a media entity type

● Enable Structure Conversion Exit: If checked, the gateway automatically performs conversion exits for
the entity type at runtime for both the request payload and the response payload

OMDO Assignment Tab

The OMDO Assignment tab only supports substitution configuration scenarios.

Use the following screenshot as an example. When a user posts a meter reading from their client, by default the
reading is posted to the default OMDO, which here is SAM<XX>_METER_READING. However, if the user is
reading a periodic meter, the reading is posted to the SAM<XX>_MR_PERIODIC OMDO, which is substituted for
the default OMDO through the use of custom headers.

[Link] OData Mobile Data Object Configuration

An OData mobile data object (also known as OMDO) provides business logic for a business object used in an
OData-based mobile application. An OMDO provides both technical implementation and configuration support

SAP Shop Floor Manager Configuration Guide

20 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
for the represented business object, including all aspects of related operations such as object creation, update,
deletion, or read and downloading. The OMDO also supports configuration such as data distribution rules for
data download.

OData requests for a business object are mapped to an OMDO object. The OMDO handler then processes the
requests for the OMDO object. For read requests, the OMDO handler considers and enforces the data
distribution rules and other configuration settings, and determines the proper output response. For create,
update, and delete requests, the OMDO handler creates or updates the SAP BusinessObjects in the back-end
system as requested in the OData requests, and provides the relevant response.

General Setting Tab

You can set the following attributes on the General Setting tab:

● OMDO ID: ID of OData Mobile Data Object; limited to 40 characters. The OMDO ID must be unique in an
SAP client, across all mobile applications, as namespace restriction is enforced. A customer-defined
OMDO ID must use the Y or Z namespace.
● Description: Short description of the OMDO, limited to 60 characters
● Mobile Application: Mobile application of the OMDO. An OMDO always belongs to a single mobile
application.
● OMDO Handler: An ABAP OO class that provides the technical implementation for the OMDO object. The
OMDO handler must be a subclass of /MFND/CL_CORE_OMDO_HNDLER_BASE. You can reuse an OMDO
handler to provide technical implementation for multiple OMDO objects.
● Process Flow: Determines how the OMDO handler processes OData entity set read requests. Based on the
process flow setting, different OMDO handler methods are invoked at runtime. The OMDO handler
determines which process flow it supports.

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 21
 ○ Standard Flow using Key List: Typically used by the OMDO handler to support complex SAP
BusinessObjects with multiple entity types, complex relationships between entity types and data
distribution rules, and with change detection support. Examples of SAP BusinessObjects that use the
standard flow include transaction data objects such as work orders or notifications; and master data
objects such as equipment or functional locations.
○ Basic Flow without Key List: Typically used by the OMDO handler to support simple SAP
BusinessObjects with a single entity type and no change detection support. Examples of SAP
BusinessObjects that use the basic flow without key list include customizing data, such as plant or
order type. OMDO handlers that only support basic flow are typically subclasses from /MFND/
CL_CORE_OMDO_BASIC_HNDLR.
● Exempt Read Entity Request: If checked, the entity read request is handled by the
READ_ENTITY_REQUEST_PROC method. The method supports on-demand entity read requests without
interference with client state tracking for entity set read requests.
● Enable Client State Tracking: If checked, the client state records are maintained for each entity set read
request. Client state tracking enablement is required for other features such as key list calculation using
client state history, periodic refresh support, and optimized client state reuse.
○ Client State: Captures the list of calculated object keys that are sent to the mobile client for the entity
set read requests, the data distribution rules used for the calculation, and the time of the calculation.
By enabling client state management, the system has a record of the objects distributed to the mobile
client. Enabling client state management also allows the system to calculate the list of objects to be
removed from mobile client via tombstones.
At runtime, the client state info generated during client synchronization can be displayed using the
client state monitor through the Administration & Monitoring Portal.
● Enable Periodic Refresh: If checked, every entity set delta sync read request is checked if it qualifies for
periodic refresh. A periodic refresh means that if time between an entity set initial sync or last period
refresh read request and current read request has exceeded the defined frequency, all objects from the
client are removed and a new object key list is calculated based on the current data distribution rules.
● Refresh Frequency (Hour): Defines the periodic frequency refresh in number of hours
● Optimal Client State Reuse: If checked, the system tries to reuse previous client state records whenever
possible instead of generating new client state records. Reuse of previous client state records can improve
runtime performance. Whether a client state record can be reused depends on the object key list and data
distribution rules. If both items remain unchanged compared to the previous client state, the client state
record can be reused.
● Support Delta Sync: If checked, a delta token is generated and returned in response to the entity set read
request
● Key Calculation using Client State History: This setting is effective only if client state tracking is enabled.
If checked, the object key list is taken from current data distribution calculation, and the list is compared
against the object key list from the previous client state. Also, objects that should be removed from the
client are automatically identified, and downloaded to the client again.
● Data Distribution Mode: Controls when data distribution key calculation is performed for delta sync entity
set read requests. It’s only relevant if OMDO handler supports the Standard Flow using Key List process
flow. There’s overhead associated with data distribution key calculation. You can reduce the number of key
calculations during sync to improve performance. However, the potential performance gain has to be
measured against the correctness of the response. If the object key list from data distribution changes
frequently, skipping the calculation can lead to incorrect results.
○ Always perform distribution key calculation: Perform the data distribution key calculation for every
read request

SAP Shop Floor Manager Configuration Guide

22 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
 ○ Distribution key calculation if change or dependent queue detected: Perform data distribution key
calculation only if there’s data change detected in the back-end system, or if there are new dependent
queue entries inserted
○ No distribution key calculation. Delta calculation only: Always skip data distribution key calculation
in delta sync
● Delta Object Key List Set up Mode: Used in standard flow to determine how the delta object key list is
initialized. The delta object key list determines the list of objects that are included in the delta sync
response.
○ Same as Data Distribution Key List: Default delta sync object key list is the same as the data
distribution key list. If change detection is supported by the OMDO, we recommend using this setting.
Remove objects that do not have changes since the last delta sync from the delta object key list to
prevent unnecessary download and to improve performance.
○ Difference of Current and Last Data Distribution Key List: The current data distribution key list is
compared to the object key list from the last client state. The only objects that are not included in the
last client state object list are included in the delta sync object key list. If no change detection is
supported by the OMDO, we recommend using this setting.
● Enable Paging: If checked, server-side paging is activated. When paging is active, response from the
OMDO to the OData request is limited to the specified paging package size. If the number of records in the
response exceeds the paging package size, the response is divided into separate pages. The $skiptoken
identifies the next page that is generated and included in the response to the client. The client then sends a
follow-up request with the skip token to retrieve the next page. This process continues until the client
retrieves all pages.
● Paging Package Size: Maximum number of records that can be included in a page for the response of the
OMDO. For read requests in a batch, the maximum payload records number defined for the OData service
assignment is also considered. If the overall number of records in the batch response has reached the
maximum payload records number, the number of records in the individual request response can be less
than the paging package size specified.
● Sync Session Max Idle Time (Second): Estimated maximum duration of a sync session for a single
OMDO. For requests belonging to the same OMDO, the response can be calculated beforehand for all
requests once and then reused. When the requests are received separately, as long as the requests are
received within the defined sync time duration, the response calculated beforehand can be used, instead of
calculating it again. Calculating a response beforehand can improve performance. If the sync session max
idle time is set to 0, each request triggers the calculation for the response.
● Sync Priority: Represents the processing sequence for read requests in a batch, where 0 has the first
priority sequence. For OMDO objects with the same sync priority, OData read requests for these OMDO
objects are processed based on the sequence in the batch.
● Enable Localization Setting: When checked, brings data associated with the OMDO fetch translated to the
language specified in the <Language> field irrespective of what logon language is used for the connection.
All other OMDOs that don’t have Enable Localization Setting enabled use the logon language.
● Language: Used when the <Enable Localization Setting> box is checked. Select your desired
language from the dropdown list.

Technical Model Info Tab

The Technical Model Info tab is a display only tab. This tab displays the technical entity model supported by the
OMDO handler.

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 23
● Technical Entity Type: Technical entity type that the OMDO handler supports
● Lead Entity: Indicates whether a technical entity is the lead entity type supported by the OMDO handler.
The lead entity type represents the header record of a business object. An OMDO operates on a business
object level. For an OMDO CREATE operation, a create request (POST request) for the lead entity type is
required. If the lead entity already exists, a CREATE request (POST request) for nonlead entity types are
considered as OMDO UPDATE operations.
● Reference Structure: Data dictionary structure of the technical entity type
● Field Name: Field name from the data dictionary structure
● Field Description: Field description
● Data Type: Field data type
● Conversion Exit: Assigned conversion exit for the field

Data Filter Tab

An OMDO handler can declare data filters and parameters supported by its CRUD (CREATE / READ /
UPDATE / DELETE) operations. These filters are displayed on the Data Filter tab.

SAP Shop Floor Manager Configuration Guide

24 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
● Defined Filters: The Defined Filters navigation area displays the list of supported filters for the OMDO,
grouped by operation and filter group. There are two types of filters available, though both types may not
be available for every OMDO:
○ Standard Filter: A standard filter is a single field filter that references a table or structure field that is
displayed in the <Object Name> field and the <Reference Field Name> field
○ Table Filter: A table filter is a structured filter that references a table or structure that is displayed in
the <Object Name> field.
● Rule Editor: Details for a filter are displayed in this section when you select a filter from the Defined Filters
section.
● Filter Rule Type: You can select one of the four types of rules to define:
○ Static Value in Range Table Format: Static rule, with the rule value defined at design time in the
configuration
○ User Profile Parameter: Dynamic rule, with the rule value evaluated at runtime based on the runtime
profile parameter value of the user. You can display and maintain the user profile parameter value with
the transaction code SU3.
○ Mobile User Attribute: Dynamic rule, with the rule value evaluated at runtime based on the runtime
mobile user attribute of the user. You can display and maintain the mobile user attribute in the
Administration & Monitoring Portal, which you can access with the transaction /SYCLO/ADMIN. Then
select Administration User Management .
○ Filter Handler: Dynamic rule, with the rule value evaluated at runtime by a filter handler. A filter
handler is an ABAP subclass of /MFND/CL_CORE_OMDO_RULE_BASE.

Field Selection Tab

An OMDO handler can declare field catalogs supported for the READ operation. If there is a READ operation, by
default, all of the fields from the database tables related to the OMDO object are selected. Using the field
catalog, customers can control which fields are selected, and improve performance, as typically a mobile
application doesn’t require all of the fields.

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 25
Change Detection Tab

You can enable change detection for the OMDO using the Change Detection tab.

● Check xChange Info: Applies to standard flow processing only. If checked, change detection info is
checked to determine the delta sync object key list.
● Lead xChange Object: xChange object that supplies the change detection information for the OMDO.
Information from the xChange table of the xChange object is read and used for the calculation of the delta
sync object key list.

Dependent Object Tab

Define settings related to dependent objects on the Dependent Objects tab.

In some business cases, the read request sequence for the OMDOs or SAP BusinessObjects is important, since
the data distribution object key list of a subsequent OMDO depends on the results or outputs of the precedent
OMDOs. The subsequent OMDO is treated as a dependent object of the precedent OMDO. The leading OMDO
is the source OMDO, as the output of the lead OMDO supplies information for the dependent OMDO.
Dependent object key information generated by the leading OMDO is stored in the dependent object queue,
and is used by the dependent OMDO during its read request processing.

For example, SAP Shop Floor Manager downloads detailed information for equipment and functional locations
used in production orders assigned to a technician. To fulfill this requirement, read requests for production

SAP Shop Floor Manager Configuration Guide

26 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
order assignments occur first, and equipment and functional locations are set up as dependent objects for the
production order OMDO.

You can define the following settings for a dependent object of the current OMDO:

● Source Technical Entity Type: Source OMDO technical entity type that contains information required by
the dependent object
● Dependent OMDO ID: ID of the dependent OMDO
● Dependent Technical Entity Type: Receiving technical entity type of the dependent OMDO, for which
information from the source technical entity type is transferred
● Key Calculation Mode: Select the way the keys are passed to the OMDO. Key calculation is a dependent
object concept; how you set up your dependent object is based on your source object.
○ Source Entity Output: Input for the dependent key. Keys are calculated based on the source entity type
output.
○ Source Entity Type Distribution Key List: Dependent Object Key construction comes from the
distribution key list of the source entity type. Using this option always collects all the valid keys from
the source entity type.
○ Source Entity Type Output + Target Entity Type Client State: Similar to Source Entity Output plus the
previous client state of the target entity type. Here, what is being created for dependent object
collection is a combined collection of the source entity type output and the target entity type client
state records from the previous sync.
● Active Flag: Enable or disable a dependent object definition

You can define the following settings for the mapping info of dependent object keys in the Dependent Object
Keys tab:

● Source Type: Use option By Field Name if the information comes from a field of the source technical entity
type. Use option By Value if a constant value is used.
● Source Value: Constant value for a dependent object key field. This field is only relevant if the source type
is set to By Value.
● Source OMDO Field Name: Name of the source technical entity type field that supplies value for the
dependent object key. This field is only relevant if the source type is set to By Field Name.

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 27
● Dependent Object Key Field Name: Field name of the dependent technical entity type that receives the
value from the source technical entity type field

You can define the following settings for the mapping info of origin object keys in the Origin Object Keys tab (not
shown in detail in the example screenshot). The origin object key identifies the source OMDO object that has
generated the dependent object key.

● Source Type: Use option By Field Name if the information comes from a field of the source technical entity
type. Use option By Value if a constant value is used.
● Source Value: Constant value for an origin object key field. This field is only relevant if the source type is
set to By Value.
● Source OMDO Field Name: Name of the source technical entity type field that supplies value for the origin
object key. This field is only relevant if the source type is set to By Field Name.

You can display the dependent object queues generated during client synchronization at runtime using the
Dependent Queue Monitor on the Administration & Monitoring Portal.

Transaction Settings Tab

You can define settings related to transactions (CUD requests) on the Transaction Settings tab.

● Enable Transaction Merge: If checked, transaction requests for the same object that are received in the
same changeset are merged. Therefore, the number of requests processed by the OMDO handler is
reduced. The sequence of the transaction requests in the changeset is respected, with the attribute value
of the last transaction request as the final value for the attribute.
For example, for Object 123 the requests are as follows:

Requests in Changeset Requests Processed by OMDO

Request #1 CREATE 123 None

Request #2 UPDATE 123

Request #3 DELETE 123

Request #1 CREATE 123 Request #1 CREATE 123 (attribute values from Request
#2 and Request #3 are merged into Request #1)
Request #2 UPDATE 123

Request #3 UPDATE 123

SAP Shop Floor Manager Configuration Guide

28 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
 Requests in Changeset Requests Processed by OMDO

Request #1 UPDATE 123 Request #1 UPDATE 123 (attribute values from Request
#3 merged into Request #1)
Request #2 UPDATE 123

Outbound Trigger Assignment

An outbound trigger performs a function that is implemented by the outbound trigger handler. Outbound
triggers can be assigned to an OMDO. The assigned outbound triggers are invoked after OMDO processing has
been completed, based on the sequence of the assignment.

You can set the following attributes when assigning an outbound trigger to an OMDO:

● Technical Entity Type: Optional. If defined, the outbound trigger is invoked only if the specified technical
entity type was processed by the OMDO.
● OMDO Operation: Optional. If defined, the outbound trigger is invoked only if the specified OMDO
operation is processed.
● Outbound Trigger ID: Assigned outbound trigger ID
● Process Mode: Only the Always Run mode is supported
● Active: Enable or disable an outbound trigger

3.2.4 Change Detection Settings

Change detection settings are used to define and configure how the mobile application, such as SAP Shop
Floor Manager, communicates with SAP and the object tables contained within SAP

The following areas are used to configure backend change detection:

● Exchange Object Configuration: Change detection rules for SAP data objects, such as master data and
transaction data, defined for each mobile application
● EFI Assignment: Enhancement framework implementation trigger assigned to exchange objects

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 29
  Note

Create tables and objects in SAP and the Mobile Development Kit before you can create or configure
information in the ConfigPanel.

[Link] EFI Assignment

Enhancement Framework Implementation (EFI) source code plug-ins are implemented by the SAP Mobile Add-
On for each business object where you configure change detection.

The source code plug-in is provided as an ABAP include file. Each exchange object is assigned to a plug-in to
handle the actual change detection process. EFIs are typically available across multiple mobile applications
running on the same system.

EFIs collect before and after images of data in an SAP object that was created, modified, or deleted. The EFI
then hands those images to the exchange object, which continues with the data processing. Therefore, link the
EFIs to their corresponding exchange objects.

Enhancement Implementation Includes Section

The Enhancement Implementation Includes section is a tree of the include file list in the package. To expand
the list, click the arrow to the right of the item.

SAP Shop Floor Manager Configuration Guide

30 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
General Tab

Use the General tab to view and modify the general settings for chosen EFI file.

● EFI Type: Select one of two options; Standard EFI Include or EFI Event Handler. Choosing Standard EFI
Include is the traditional way to implement EFI and configure the EFI assignments. Selecting EFI Event
Handler implements EFI using an ABAP class-based approach.
When you use a class-based approach, EFI implementation is developed as a subclass of /SMFND/
CL_CORE_EFI_EVENT_BASE. Available EFI event handler classes are displayed in the dropdown field. The
EFI class-based approach provides a more robust functionality and is recommended for a new EFI
implementation.
● EFI Include Name: File name of the source code plug-in
● Description: Short description of the EFI. The description field is automatically populated when you select
the EFI include name and is read only.
● Package: Package where the EFI is located. The package field is automatically populated when you select
the EFI include name and is read only.

Assignment Tab

Use the Assignment tab to modify the EFI assignments.

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 31
● EFI Information fields: The EFI information fields at the top of the Assignment tab, like <EFI Type> and
<EFI Event Handler>, are taken from information in the General tab and are read only.
● EFI Assignment List: Table that displays the plug-ins that are assigned to a specific include file. All column
information is replicated in the Assignment Detail section directly below the table.
● Mobile Application: Read-only name of the specific mobile application
● Exchange Object: Name of the exchange object to which the EFI include file is assigned
● Exchange Object Description: Read-only description of the exchange object
● Exchange Object Handler: Read-only name of the class handler from the repository responsible for
updating the exchange table
● Active Flag: When checked, the exchange object is in an active state. If unchecked, the EFI isn’t linked to
the assigned OMDO.
● Use in Linkage Processing Only: When checked, the xChange object is only allowed during linkage
processing. If not checked, the original EFI is triggered during xChange processing.

[Link] Exchange Object Configuration

The exchange object defines what in the exchange table is updated in the exchange persistent layer, what class
handler is called to update the exchange table, and what fields are related to the change detection.

Use the Configuration Panel to specify which changes are relevant to the mobile application and what
conditions to satisfy for so that an update action is triggered. The Exchange Object Configuration panel has the
following tabs:

● Technical Settings
● Change Detection Field Selection
● Change Detection Condition Filter
● Data Segment Settings
● Linkage Settings

SAP Shop Floor Manager Configuration Guide

32 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
● Push Settings

Technical Settings Tab

Use the Technical Settings tab to configure basic settings for an exchange object.

Use the <Exchange Object> field for the ID of the exchange object, limited to 40 characters. Type in a
description in the <Exchange Object Description> field, limited to 60 characters. The <Mobile
Application> field contains a dropdown where you can select your mobile application. The <Application
Area> classifies the exchange object based on standard SAP application areas using a dropdown selection
field.

The <Reference Business Object> is the standard SAP business object. The <Exchange Table Name>
is the name of the table stored in SAP that contains the technical data. The <Exchange Table
Description> is a brief description of the exchange table. The <Exchange Lock Object> field is used
when updating the exchange table. Type in how many days you want to keep historical data in the <Days to
Keep History> field. Check the <No Exchange Table Update> checkbox to not write the record to the
exchange table in SAP when the record is changed.

● Handler Setting: Type in the name of the class handler from the repository that is responsible for updating
the exchange table in the <Exchange Object Handler> field.
● Collective Run Settings: Define the condition where xChange processing is executed asynchronously as a
V3 run by selecting one of the following mode options:
○ Dynamic: The collective run mode is determined at runtime by the xChange handler method
DETERMINE_EXEC_MODE
○ Not Allowed: Not allowed to switch to collective run mode
○ Activated: Always execute asynchronously in V3 collective run mode
○ By User Parameter ID: Switch to V3 collective run mode for runtime user with the specified user
parameter value set in the user profile
● Activation Setting: Check the <Active Flag> checkbox to ensure that the exchange object is in an
active state. If unchecked, the exchange object performs no actions. When the <Use in Linkage
Processing Only> checkbox is checked, the xChange object is only allowed during linkage processing
and not if the original EFI was triggered during the xChange process.

The following screenshot shows an exchange process enabled for MATERIAL. Any changes for the MATERIAL
master data are recorded in the exchange table and are transmitted to the client during the next transmit.

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 33
Change Detection Field Selection Tab

The Change Detection Field Selection tab lets you optimize the change detection process for a mobile
application. If a value change is detected for any fields within the group, the object identifier is written to the
exchange table, indicating that a change was made. If the <Active Flag> is not checked for a field, any value
changes made to that field are not detected and recorded to SAP during the exchange process. By default, all
fields are initially checked.

The Exchange Object by Application tree lists all application areas and the exchange objects linked to each
application area. Expand the tree by clicking on the arrows to the right of the application area to display the
exchange objects associated with it.

● Exchange Object Info: The <Exchange Object> field is read only and is the ID of the exchange object.
The <Exchange Object Description> is read only and is a brief description of the exchange object.
The <Exchange Object Handler> field is read only and is the name of the class handler from the
repository that is responsible for updating the exchange table.
● Exchange Object Field Selector: The <Field Catalog> column is comprised of non-editable rows of all
fields that are detected by the class handler when changes are made. These fields are grouped by the
technical table name of the SAP business object.
When the <Active Flag> checkbox is checked, either the table or a field within the table is active. Any
value change to the selected field is detected by the class handler. Note that if you check the Active Flag
checkbox on a table row, it selects all the rows within the table.
The <Short Description> is a read only field that contains a brief description of the table or of a field
withint the table.
● Selection Proposal: In a typical mobile application installation, you do not want to have all fields marked as
active for change detection. Rather, only the fields that are active on the odata mobile data object that are
brought down to the mobile device will also be active in the exchange object. Based on odata mobile data
object usage in the application, the selection proposal examines the active flags that are checked for an
exchange object's table fields and provides recommendations to the administrator on which fields should
be checked or unchecked.

SAP Shop Floor Manager Configuration Guide

34 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
See the following screenshot for an example of the enabled exchange object MATERIAL, where the properties
of the object are captured and recorded in the exchange table. The properties that trigger the exchange are
defined on this Change Detection Condition Filter tab, as seen in the checked <Active Flags>:

Change Detection Condition Filter Tab

The Change Detection Condition Filter tab lets you restrict change detection based on data content. For
exchange handlers to support this feature, define data filter conditions for which the underlying SAP business
object must qualify before the change detection process is triggered. The condition is defined at the table field
level and is in the SAP range table format.

● Exchange Object Info: The <Exchange Object> field is read only and is the ID of the exchange object.
The <Exchange Object Description> is read only and is a brief description of the exchange object.
The <Exchange Object Handler> field is read only and is the name of the class handler from the
repository that is responsible for updating the exchange table.
● Exception Settings: When the <Ignore Data Creation> checkbox is checked, newly created records
and data are not processed to the exchange table. When the <Ignore Data Deletion> checkbox is
checked, deleted records and data are not processed to the exchange table. When the <Ignore Data
Update> checkbox is checked, updated records and data are not processed to the exchange table.
● Defined Filters: Lists all the data filters supported by the class handlers.
● Rule Editor: The <Filter Name> is read only and is the name of the filter as defined by the class handler
developer in the class handler method. The <Reference Table Name> is read only and is the technical
name of the SAP database table field where the filter is applied as defined by the class handler developer.
The <Reference Field Name> is read only and is the technical name of the SAP database table field
where the filter is applied as defined by the class handler developer. The <Data Filter Rule Key> is an
internal technical key used by the framework at runtime.
Use the values in the Enter Range Value section to set the range. The <Sign> field is the value for the SAP
range table column SIGN. The <Option> field is the value for the SAP range table column OPTION. The

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 35
 <Low Value> field is the value for the SAP range table column LOW. The <High Value> field is the value
for the SAP range table column HIGH. When the <Active Flag> checkbox is checked, the rule is active.
The Rule List is a table that displays a list of rules that are defined using the values in the Rule Editor and
the Range Value sections.

The following screen shows that any exchange detected for the exchange object NOTIFICATION will be
considered only if the notification is maintained in one of the roles defined in the NOTIF_CATG criteria.

3.2.5 Technical Settings

Technical settings affect all components of the framework.

The following fields make up the Technical Settings page:

● Application Logging Level: Defines the logging level for all framework components. Logging entries are
recorded in the SAP application log database under the object /syclo/. The logging levels are:
○ No logging
○ Abort

SAP Shop Floor Manager Configuration Guide

36 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
 ○ Error
○ Warning
○ Info
○ Debug
○ Trace
● Enqueue Wait Time (Sec): The Enqueue Wait Time parameter controls the number of seconds the
underlying component should continue to try to access a locked SAP object in intervals of 1 second during
an update by a mobile device. The update process aborts if accessing the locked object is still unsuccessful
after the wait time.
● Internal Conversion Exit Active: When checked, the framework runtime data manager performs a
standard SAP external-to-internal format conversion exit for all inbound BAPI parameters. The option is
enabled by default. An application developer should only change this setting as it has a direct impact to the
SAP Shop Floor Manager application.
● External Conversion Exit Active: When enabled, the framework runtime data manager performs standard
SAP internal-to-external format conversion exit for all outbound BAPI parameters. This option is enabled
by default. An application developer should only change this setting as it has a direct impact to the SAP
Shop Floor Manager application.
● Range Parameter Check Active: When enabled, the framework runtime data manager performs checks
on all SAP range parameters of inbound BAPI parameters. The SAP range parameter has the structure of
SIGN, OPTION, LOW and HIGH. If SIGN and OPTION are not specified, a check routine sets SIGN to I and
OTPION to EQ. This option is enabled by default. An application developer should only change this setting
as it has a direct impact to the SAP Shop Floor Manager application.
● Collection Mode: Collection mode determines how system statistic records are written to the database.
Two modes are supported currently: Synchronously and Asynchronously. When you select Synchronously,
the statistics record is written to the database in real-time during BAPI calls. However, selecting this option
incurs a performance penalty. Selecting Asynchronously means that statistics are collected in-memory
and written asynchronously to the database at the end of the BAPI call.
● Statistic Collection Active: When enabled, the framework records all runtime statistics associated with
the BAPI calls between the middleware server and SAP. This collection provides data for the KPI statistics
collections found in the Administration portal. An application developer should only change this setting as
it has a direct impact to the SAP Shop Floor Manager application.
● Created By, Creation Time Stamp, Last Changed By, Changed Time Stamp: The user ID and time
stamps are automatically logged when a record is created or changed.

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 37
3.2.6 Mobile Authorization Settings

You can define security rule settings for the Mobile Integration Framework for SAP and mobile applications as
well.

All security checks are carried out by the Mobile Integration Framework at runtime, with checks performed at
the following levels:

● System
Application independent. Applies to all components built on the Mobile Integration Framework.
● Product
Security at the mobile application and product level
● Mobile Data Object Handler
Specific to a Mobile Data Object class handler
● OData Mobile Data Object Handler
Specific to an OData Mobile Data Object class handler

The following types of security rules can be defined:

● User Role
Rules based on predefined user roles

SAP Shop Floor Manager Configuration Guide

38 PUBLIC SAP Mobile Add-On for the SAP Configuration Panel
● Authorization Profile
Rules based on predefined authorization profiles.
● Authorization Object
Rules based on predefined authorization objects.

Special Security Role with System Indicator

You can define special security rules using user roles. These security rules can be assigned with system
indicators. These special security rules with system indicators are used to limit access to the ConfigPanel and
Administration & Monitoring tools. The following system indicators are available:

● System Administrator
If security rules are defined, only users with the required user role can have full access to the
Administration & Monitoring tool.
● System Administration – View Only
If security rules are defined, only users with the required user role can have read access to the
Administration & Monitoring tool.
● System Configurator
If security rules are defined, only users with the required user role can have full access to the ConfigPanel.
● System Configuration – View Only
If security rules are defined, only users with the required user role can have read access to the ConfigPanel.

SAP Shop Floor Manager Configuration Guide

SAP Mobile Add-On for the SAP Configuration Panel PUBLIC 39
4 Mobile Add-On Configuration Panel
Common Procedures

4.1 Mobile Application Configuration Procedures

4.1.1 Configuring Notification Catalog Types

Use parameters to configure the notification catalog types.

Context

Code groups that belong together in terms of content are grouped in catalogs. These catalogs are identified by
the catalog type (a number or a letter). For example, in this way, you combine:

● All code groups for particular problems for a catalog type

● All code for causes for another catalog type and
● All code groups for activities for a further catalog type

Use the CATALOGTYPE parameter group and the following parameters within the group to configure your
catalog types for notifications in SAP Shop Floor Manager:

● CatSubjectCoding: Default is 9
● CatTypeActivities: Default is A
● CatTypeCauses: Default is 5
● CatTypeDefects: Default is C
● CatTypeObjectParts: Default is B
● CatTypeTasks: Default is 2
● CatalogProfileOrder: Default is Equipment

The CATALOGTYPE parameters correspond to the rules found in the OData mobile data object
SPSV10_CATALOG_CODES. You can add a new data filter rule to your customer namespace, or change the
existing parameter-rule association to a new parameter-rule association.

Procedure

1. Using the ConfigPanel, navigate to Mobile Application Configuration Parameters tab . In the left
column, Defined Mobile Applications, select your application.

The Parameter List populates with a list of all parameters available for the application.

SAP Shop Floor Manager Configuration Guide

40 PUBLIC Mobile Add-On Configuration Panel Common Procedures
2. The CatType[xxx] parameters are found in the CATALOGTYPE group. You can scroll down to find the
parameter, or perform a search using the Search box. Highlight the parameter you want to configure and
click the Change button.

3. Make your desired parameter association changes, or change the value of a parameter to Z, a custom
activity catalog type.
4. Check the <Active> flag to ensure that the parameter is used by the mobile application. If desired, and if
not already checked, check the <No Runtime Change> box to ensure that the value of the parameter is
not overridden at runtime through synchronization processing.
5. Save your changes.

6. If you are creating a custom activity value type, navigate to OData Mobile Data Object Configuration
Data Filter Tab SPSV10_CATALOG_CODES Operation - READ Standard Filter CATALOG_TYPE .
7. Click the Change button. Add the new value. For information on working with rules, see Working with oData
MDO Filter Rules [page 54].
8. Save your changes.

SAP Shop Floor Manager Configuration Guide

Mobile Add-On Configuration Panel Common Procedures PUBLIC 41
4.1.2 Configuring Document Types

Use parameters to configure Document types for Notification-related Document Link Object

Context

To provide a proper Notification attachment functionality, Document Link Object has to be configured.

To configure Document Link Object:

Procedure

1. Go to ConfigPanel Mobile Application Configuration Parameters tab . In the Defined Mobile

Applications on the left, select your application.

The Parameter List displays a list of all available parameters for the application. Relevant parameters are in
the DOCUMENT group.
2. From the DOCUMENT group, either scroll down to find the parameter or use the Search. Select the
parameter you want to configure, then select Change.

3. Make changes to the parameter association or change the value of a parameter to Z (a custom activity
catalog type).
4. Check the Active flag to ensure that the parameter is used by the mobile application. If it is not selected,
check the No Runtime Change box so that the parameter value is not overridden at runtime during
synchronization processing.
5. Save your changes.

SAP Shop Floor Manager Configuration Guide

42 PUBLIC Mobile Add-On Configuration Panel Common Procedures
6. Go to OData Mobile Data Object Configuration Data Filter Tab SPSV10_DOCUMENT Operation -
READ Standard Filter CLASS_NAME .

7. Select the Change button. Add the new value for Object Type. For information on working with rules, see
Working with oData MDO Filter Rules [page 54].

SAP Shop Floor Manager Configuration Guide

Mobile Add-On Configuration Panel Common Procedures PUBLIC 43
8. If you are creating a custom activity value type, go to Data Mobile Data Object Configuration Data Filter
Tab SPSV10_DOCUMENT Operation - READ Standard Filter DOC_LINK_OBJECT .

9. Select the Change button. Add the new value for the Object link. For information on working with rules, see
Working with oData MDO Filter Rules [page 54]

SAP Shop Floor Manager Configuration Guide

44 PUBLIC Mobile Add-On Configuration Panel Common Procedures
10. If you are creating a custom activity value type, go to Data Mobile Data Object Configuration Data Filter
Tab SPSV10_DOCUMENT Operation - READ Data Segment DOCUMENT_SWITCH .

11. Select the Change button. Add the new value for a new Object Type and relevant Object Link, select relevant
Document Types. For information on working with rules, see Working with oData MDO Filter Rules [page
54].

SAP Shop Floor Manager Configuration Guide

Mobile Add-On Configuration Panel Common Procedures PUBLIC 45
12. If you are creating a custom activity value type, go to Data Mobile Data Object Configuration Data Filter
Tab SPSV10_DOCUMENT Operation - CREATE_MEDIA Standard Filter CLASS_NAME .

13. Select the Change button. Add the new value for a new Object Type and relevant Object Link, select relevant
Document Types. For information on working with rules, see Working with oData MDO Filter Rules [page
54].
14. Save your changes.

4.1.3 Enabling and Disabling Features Per User Through SAP

Authorization
Using parameter framework configuration, configure parameters to enable or disable various features per the
authorization of the user in the back end.

Each mobile user is connected to a back end SAP user. The back-end SAP user can be assigned one or more
roles. These roles grant their holders authorizations within the back end system. Through parameter
configuration, SAP provides a standard rule handler that performs a TCode authorization. SAP also provides
new globals that can turn on and off new features.

If a parameter is enabled to use a rule instead of a global, and the user role has an authorization to run a
specific transaction code, then that specific feature is enabled for that SAP user. If the user has the

SAP Shop Floor Manager Configuration Guide

46 PUBLIC Mobile Add-On Configuration Panel Common Procedures
authorization' for a specific transaction code, then the specific feature is disabled for that mobile user.
Therefore, depending on the authorization of the SAP user, the feature now either works or doesn’t work,
displays, or doesn’t display (depending on the feature function), rather than is turned on or off for all users.

Features Available Through SAP Authorization

The following features are available for you to enable or disable. Use the following subsection to learn how to
use the ConfigPanel to enable or disable a feature based on the authorization of the user.

Back-End Param­
Component Functionality Category TCODE eter Comments

SHOP FLOOR Create work order Work Orders IW31 [Link] Includes opera­
tions and suboper­
MANAGER
ations

SHOP FLOOR Create Notification Notifications IW26 [Link] Includes items,

tasks, and activi­
MANAGER
ties

SHOP FLOOR Edit Notification Notifications IW22 [Link] Includes items,

tasks, and activi­
MANAGER
ties (except local)

SHOP FLOOR Edit FLOC Functional Loca­ IL02 [Link] Includes adding
tion characteristics
MANAGER
(except local)

SAP ASSET MAN­ Edit equip Equipment IE02 [Link] Includes adding
AGER characteristics, in­
stall, and disman­
tle (except local)

SHOP FLOOR Measurement Measurement IK11 [Link]

readings
MANAGER

SHOP FLOOR Equip attachment Attachments N/A [Link] See the Generic
upload Authorization
MANAGER
Check section in
this topic

SHOP FLOOR FLOC attachment Attachments N/A [Link] See the Generic
upload Authorization
MANAGER
Check section in
this topic

SHOP FLOOR Allow time record­ CATS CAT2 [Link]

ing
MANAGER

SHOP FLOOR Allow confirma- Confirmation IW41 [Link]­

tions ate
MANAGER

SAP Shop Floor Manager Configuration Guide

Mobile Add-On Configuration Panel Common Procedures PUBLIC 47
 Back-End Param­
Component Functionality Category TCODE eter Comments

SHOP FLOOR Allow final confir- Confirmation N/A [Link]­ See the Generic
mation [Link] Authorization
MANAGER
Check section in
this topic

How to Enable or Disable Features Per User Through Parameters

1. Using the ConfigPanel, navigate from the main screen to Mobile Application Configuration Parameters
tab . In the left column, Defined Mobile Applications, select your application.
The Parameter List table populates with a list of all globals available for the application.
2. Perform a search for the parameter you want to enable or disable as a feature by user role by using the
table in this topic to ensure that the parameter is available in the parameter framework for configuration.
Search for your parameter in the Parameter List using the Search box. All user authorization parameters
are found under the <Parameter Group> name of USER_AUTHORIZATIONS. Select your parameter and
click the Change button.
3. The rule /SMFND/CL_CORE_TCODE_CHECK_RU - TCode Authorization Check is already selected for you in
the <Rule ID> field. When you check the <Use Rule> checkbox, the rule is active.
4. Change the <Param. Scope> dropdown selection from Application to User.
5. If needed, select the appropriate <Dependent Parameter ID> from the dropdown list.
6. Check the <Active Flag> checkbox to ensure that your new parameter is active for the user role. Save
your changes.

SAP Shop Floor Manager Configuration Guide

48 PUBLIC Mobile Add-On Configuration Panel Common Procedures
See the following screenshot for an example of a configured user role parameter:

4.1.4 Configuring Mobile User Attributes

The User Attributes tab in the Mobile Application Configuration page of the ConfigPanel allows you to maintain
multiple values for a selected attribute.

Context

There are three core configuration steps to implement mobile user attributes:

1. Create the user attribute using the ConfigPanel

2. Define and activate the new user attribute through the Admin Portal
3. Define how to consume the data in the OMDO through the ConfigPanel

SAP Shop Floor Manager Configuration Guide

Mobile Add-On Configuration Panel Common Procedures PUBLIC 49
Procedure

1. Create the user attribute using the ConfigPanel:

a. From the home page of the ConfigPanel, navigate to Mobile Application Settings Mobile
Application Configuration and select the User Attributes tab.
b. Click the Change button. Create your user attribute using the following fields. See the screenshot for
an example:

○ <Attribute Name> and <Description>

○ In the <Reference Structure Name> field, create or use an existing reference structure such
as AOR_PLANT or AOR_PLANT_WORK_CENTER.
○ The <Reference Field Name> is optional. Maintain if you’re referring to a single field from the
structure.
○ Create a <ValueSet Provider Class> to populate possible values for your new user attribute.
Use handler /MERP/CL_PP_USRATTR_VALUESET as a reference. Subclass from the base class /
SMFND/CL_CORE_USRATTR_VS_BASE.
c. Click Save to save your changes.
2. Define and activate the new user attribute through the Admin Portal:
a. Access the Admin Panel from the SAP GUI using transaction code /n/SYCLO/ADMIN.
b. From the main page of the Admin Portal, navigate to Administration User Management and
select the User Attributes tab in the Mobile User Detail section of the screen.
c. Select your desired mobile application from the dropdown. Search for available users connected to
your selected application.
d. Click the User Attributes tab. Then click the Change button.
e. Click the Add button. Add the values created in Step 1. Repeat this step for all values you created. See
the following screenshot for an example.

SAP Shop Floor Manager Configuration Guide

50 PUBLIC Mobile Add-On Configuration Panel Common Procedures
3. Define how to consume the data in the OMDO through the ConfigPanel:

a. From the main page of the ConfigPanel, navigate to OData Mobile Data Configuration Data Filter
tab .
b. Select the OMDO filter to which you're adding the new user attribute from the user attributes defined
in the Mobile Application Configuration page in the ConfigPanel.
c. Choose your filter from the Defined Filters list. Click Change.
d. Assign your user attribute to the OMDO filter using a dynamic rule. The value is evaluated at runtime
based on the runtime mobile user attribute of the user.
e. Select Mobile User Attribute as the <Filter Rule Type>. See the following screenshot as an
example.

SAP Shop Floor Manager Configuration Guide

Mobile Add-On Configuration Panel Common Procedures PUBLIC 51
4.2 OData Channel Integration Settings Procedures

4.2.1 Copying an Object to the Customer Namespace

When you modify either an oData mobile data object or an exchange object, first make a copy of the object and
place it in the customer namespace.

Context

The following procedure provides information on making a copy of an oData mobile data object (OMDO) or
exchange object within SAP Mobile Add-On. In any of the procedures provided in this guide where an OMDO or
an exchange object is copied, refer to this procedure for instructions. When you copy either an OMDO or an
exchange object, you can roll back any changes you make to the application if necessary without changing the
original objects.

Once you copy an OMDO and modify the object, you may adjust the oData model definition to reference the
new OMDO. Similarly, when you copy and modify an exchange object, you may need to change the EFI trigger
assignment to the new exchange object. These procedures are covered separately.

Procedure

1. Log into the ConfigPanel of the SAP Mobile Add-On.

2. Click either Exchange Object Configuration or oData Mobile Data Object Configuration from the home page.

The Object Detail panel opens.

 Note

Figures shown in this procedure are taken from the Exchange Object configuration page. Screens may
look different when configuring an oData mobile data object. For either, the ability to copy is provided.

SAP Shop Floor Manager Configuration Guide

52 PUBLIC Mobile Add-On Configuration Panel Common Procedures
3. Select the object to copy from the list of OMDOs or exchange objects and click Copy.
4. In the main object <ID> field, add a <Z> to the beginning of the object name.

5. Click Save to save the object copy.

A copy of the original object is created in the customer namespace. Now you can modify the object, with
the original object as a back-up for rollback purposes, if necessary.

SAP Shop Floor Manager Configuration Guide

Mobile Add-On Configuration Panel Common Procedures PUBLIC 53
4.2.2 Working with oData MDO Filter Rules

Filter rules specify a single field within the database tables from which data is retrieved. Filter rules also specify
under which conditions records are included in the operation based on the value of the field.

Data filters are part of the configuration of an oMDO. If you make configuration changes to SAP Shop Floor
Manager, you may need to adjust the rules for one or more of the oMDO filters.

Many of the filters in SAP Shop Floor Manager either do not contain active rules or contain rules that you can
adjust. A filter only effects the synchronization behavior when it has one or more active rules.

The following procedure instructs you on how to adjust a filter using the ConfigPanel.

[Link] Changing oData MDO Filter Rules

Many of the common configuration changes made for an SAP Shop Floor Manager implementation involve
modifying or adding one or more filter rules in an oData MDO.

Context

In SAP S/4HANA, each user is assigned a role based profile with authorization permissions on viewable data
and available activities. For example, a user working in one plant should not be able to view data for a different
plant. When business activities performed by a user are mobilized through the mobile application, the ability to
extend the same restrictions to the mobile application is necessary. Data filter rules provide the function to
restrict data access for mobile applications.

Use the following procedure to modify a data filter rule for an oMDO. The changes you make to the settings of a
given rule vary depending on your mobile application implementation requirements. Subsequent procedures in
the Configuration Guide refer to this procedure and provide detailed values and settings for filter rules involved
in the specific change.

Procedure

1. Access the ConfigPanel through SAP Mobile Add-On.

2. From the ConfigPanel Home page, click the oData Mobile Data Object Configuration link.
3. At the top of the oData Mobile Data Object Configuration page display, in the Mobile Application Filter field,
choose your mobile application from the dropdown menu. Choosing your mobile application is not a
necessary step, but it eliminates objects that are not part of your mobile application from the object list.
4. Click the Data Filter tab.
5. Expand the oData Mobile Data Object List tree so you can see all of the oData mobile objects.
6. Select the oData mobile data object that requires filter modification from the list.

The current rule filter settings are displayed in the Rule Editor section. All existing rules for the filter are
displayed in the Rule List table.

SAP Shop Floor Manager Configuration Guide

54 PUBLIC Mobile Add-On Configuration Panel Common Procedures
7. To add a new rule, edit an existing rule, or delete a rule from the filter, click Change.

Many of the fields in the rule editor become editable, and the buttons Add Row and Delete Row appear.
8. Set or modify any editable fields desired according to your mobile application needs.
9. Set the Active Flag to <True> for each added or edited field before saving changes. Inactive filter rules have
no effect on synchronization processing.
10. Click Save to apply your changes.

[Link] Notification Assignment Options

By default, the SAP Shop Floor Manager application determines the assignment of a notification associated
with the notification header. However, you can make minor configuration changes to support several other
assignment models for the notification object.

The following assignment types are supported for the notification object:

● Assignment Type 9: Free Search

Perform the following steps to change the assignment type used in a deployment:

1. On the ConfigPanel home page, select OData Mobile Data Object Configuration. Make sure to select your
desired mobile application in the Mobile Application Filter field at the top of the page.
2. In the OData Mobile Data Object List select SPSV10_NOTIFICATION, and then the Data Filter tab.
3. Expand the Defined Filters list as follows; Operation - READ Data Distribution and click
NOTIF_ASSIGNMENT_TYPE. Click the Change button.
4. Set Low Value with the desired assignment type as defined by the assignment type model.
5. Save your changes.

4.2.3 Filtering Equipment Records by Equipment Status

A large set of records could affect performance on the SAP Shop Floor Manager client. Therefore, you can
employ more filtering based on the status of equipment.

By default, SAP Shop Floor Manager filters records through a user-dependent rule based on the planning plant
of the user.

To filter records on the status of equipment retrieved for the table stored on the SAP Shop Floor Manager
client, modify the SPSV10_EQUIPMENT OMDO. Specifically, in the following procedure, you will configure the
EQUI_INCL_SYS_STAT filter with a rule that specifies which status or statuses to include. After you configure
the rule, only the equipment records with the specified statuses are retrieved by the application for download
to the clients.

A common equipment status is INST. However, the INST status is only one example of many options. You can
configure other filters, either with this example, or in place of it.

For your given SAP Shop Floor Manager implementation, thoroughly review the equipment data stored in the
database before deciding which filter rules to configure. After your equipment review, create the appropriate
filters within the SPSV10_EQUIPMENT OMDO.

SAP Shop Floor Manager Configuration Guide

Mobile Add-On Configuration Panel Common Procedures PUBLIC 55
4.2.4 Configuring an Equipment Status Filter for an
Equipment Table

Prerequisites

Address the following items before performing the procedure:

● Know the status or statuses that you are filtering on for equipment synchronization, as they are used in the
procedure
● Have access to the ConfigPanel and permissions to change configuration settings

Context

Use the following procedure to create a filter rule for the OMDO, SPSV10_EQUIPMENT. Specifically, you are
adding a rule to the filter EQUI_INCL_SYST_STAT. After you add the filter rule, only the equipment records that
match the ones configured in the rule are downloaded to the SAP Shop Floor Manager client.

Procedure

1. Navigate to ConfigPanel Home OData Mobile Data Object Configuration .

2. Select your application in the Mobile Application Filter field.

Selecting an application filters the OData Mobile Data Object by Mobile App choices in the left panel with
only OMDOs available in your application.
3. View the new OMDO copy by selecting it in the OData Mobile Data Object by Mobile App list.
4. Select the Data Filter tab.

5. In the Defined Filters list, click the Operation - READ Standard Filter EQUI_INCL_USER_STAT node.
6. Add a rule to the filter with the following configuration settings:
○ Filter Rule Type: Static Value in Range Format
○ Sign: Inclusive
○ Option: =
○ Low Value: Equipment status to filter on
○ Active Flag: Checked
7. Repeat the previous step to include additional statuses in the filter.
8. Save your changes.

Results

When you finish the procedure, the equipment records downloaded by the SAP Shop Floor Manager
application are filtered to only include records with the status or statuses configured in the filter rules.

SAP Shop Floor Manager Configuration Guide

56 PUBLIC Mobile Add-On Configuration Panel Common Procedures
Next Steps

You may need to filter equipment according to additional criteria. Test that the status filters created during this
procedure are performing as expected before creating additional filters for the same data set. Regardless of
additional changes, test the synchronization of the equipment data thoroughly after you modify the
application.

4.2.5 Retrieving Additional Data for OData Mobile Data

Objects

The default implementation of SAP Shop Floor Manager includes the typical data values required by most
users and at most implementation. However, it is a common requirement that additional values are retrieved
and stored.

[Link] Adding New Retrievable Values for OData Mobile

Data Objects

Prerequisites

Address the following before performing this procedure:

● Determine and note the field values as well as any table values you want to add, as well as which tables the
desired fields reside in Mobile Add-On Integration Framework
● You must have access to the ConfigPanel and permissions to change configuration settings within it

Context

Use the following procedure to add new fields to OData mobile data objects.

Procedure

1. Navigate to ConfigPanel Home OData Mobile Data Object Configuration . Select the desired OMDO
from the list on the left of the current configuration page.
2. Click the Field Selection tab, then click the Change button.

The Field Active column is enabled.

SAP Shop Floor Manager Configuration Guide

Mobile Add-On Configuration Panel Common Procedures PUBLIC 57
3. In the Field Selection Detail pane, expand the Handler Method and the Table to search for the fields that you
wish to activate. Fields that are already active are marked with a check in the checkbox.
4. Check the fields that you wish to activate and uncheck any active fields you wish to deactivate. Save your
changes when finished.

Results

After completing the procedure, one or more new values are retrieved as part of the data for the object. The
new values are displayed, edited, searched on, or used in other manners on the mobile client.

In the example screenshot in the procedure, the OData mobile data object used is
SPSV10_PRODUCTION_ORDER. To make other OMDO configuration changes to the object, navigate to the
ConfigPanel home page, then click the OData Model Configuration link. On the left panel, find the corresponding
EntityType to make any additional configuration changes. In this procedure example, the entity type is
ProductionOrder. See Setting up an OData Mobile Data Object [page 59] for more information.

SAP Shop Floor Manager Configuration Guide

58 PUBLIC Mobile Add-On Configuration Panel Common Procedures
5 Setting up an OData Mobile Data Object

For OData troubleshooting information, see OData API in the SAP Cloud Platform documentation.

5.1 Supported OData Features for SAP Mobile Add-On

The following table lists the OData features that SAP Mobile Add-On supports.

OData Feature Status

Create Maps to HTTP POST method

Read Maps to HTTP GET method

Update Maps to HTTP PUT method

Delete Maps to HTTP DELETE method

Query Maps to HTTP GET method

$select Specifies a subset of properties to return

$top Determines the maximum number of records to return

$skip Sets the number of records to skip before it retrieves records

in a collection

$filter Specifies an expression or function that must evaluate to

true for a record to return to the collection

$count Returns the number of records in a collection

$orderby Determines which values are used to order a collection of re­

cords

$expand Specifies that related records must be retrieved in line with

the record or collection being retrieved. For example, use
$expand to retrieve a customer and all orders placed by that
customer in a single query.

$inlinecount Supported

$skiptoken Supported

SAP Shop Floor Manager Configuration Guide

Setting up an OData Mobile Data Object PUBLIC 59
OData Feature Status

$format Supported

Navigation Supported

Delta token Supported

Tombstone Supported

Complex types Supported

$batch Supported

Deep insert Supported via single post operation and through $batch re­
quest using content ID referencing

Custom query options Not supported

$link Not supported

$value (media links or attachments) Supported

ETags / concurrency control Supported

$filter Details

String functions Partially supported

● Supported:
○ bool substringof(string p0, string p1)
● Not Supported:
○ string trim(string p0)
○ string concat(string p0, string p1)
○ int length(string p0)
○ int indexof(string p0, string p1)
○ string replace(string p0, string find, string replace)
○ bool endswith(string p0, string p1)
○ bool startswith(string p0, string p1)
○ string toupper(string p0)
○ string substring(string p0, int pos)
○ string substring(string p0, int pos, int length)
○ string tolower(string p0)

Date functions Not supported

Math functions Not supported

Arithmetic operators Not supported

SAP Shop Floor Manager Configuration Guide

60 PUBLIC Setting up an OData Mobile Data Object
 OData Feature Status

Type functions Not supported

$filter supported on complex type properties within an entity

 Note
For related constraints, see SAP Note 1830712 .

5.2 Setting the OData Mobile Data Object Service

Assignment

You can assign SAP system aliases to a service. With the assignment, an OData request from an SAP Gateway
consumer can be routed to the corresponding back end service.

Context

Assign OData services to the SAP Shop Floor Manager application using the Service Assignments tab.

Build a hierarchy between assigned services using Composition Settings. To utilize OData entities from a
different service such as the Crew Management and Field Operations Worker component service, add the

SAP Shop Floor Manager Configuration Guide

Setting up an OData Mobile Data Object PUBLIC 61
relevant OData services (/MERP/SAP_CREW_MANAGER_<XX> and /MERP/
SAP_FIELD_OPER_WORKER_<XX>) under the SAP Asset Manager service as shown in the following example:

Procedure

1. Ensure that your mobile application is selected in the Mobile Application Filter field at the top of the page.
2. Expand the Mobile Application List in the left pane and select your mobile object.

Your chosen mobile application OData service assignment details are displayed in the main window on the
Service Assignments tab.
3. Click the Change button to change the existing mobile service assignment details or to add a new mobile
service assignment.
4. To add a new mobile service assignment, click the Assign OData Service button.
a. Select an OData Version, if there is more than one to choose from, from the dropdown menu.
a. Select an OData Service, or system alias, from the dropdown menu.

The corresponding back-end server is populated in the Service field.

b. To Defer Batch Response, mark the checkbox. That is, you are setting the OData service to process all
of the CHANGESET operations at once (deferred processing).
c. To activate your new service assignment, check the Active checkbox.

SAP Shop Floor Manager Configuration Guide

62 PUBLIC Setting up an OData Mobile Data Object
 5. On the Composition Settings tab, build a hierarchy between your OData services to include all metadata
from different child services. You can add and remove component assignments depending on your service
needs.
6. To add a component assignment, choose Add Component Assignment.
a. Select a Parent OData Service from the dropdown list.
b. Select Component OData Service from the available list to make it a child service for the parent OData
service.
c. To activate the new component assignment, check the Enabled checkbox.
7. To remove the component assignment, select the service component you want to remove and choose
Remove Component Assignment.

The hierarchy relationship with its parent service component is removed.

Next Steps

Perform the following procedures:

● Setting the OData Mobile Data Object Configuration [page 63]

● Setting the OData Model Configuration [page 65]

5.3 Setting the OData Mobile Data Object Configuration

Prerequisites

If you are setting up a new OData mobile data object, or changing an OMDO, read and perform the following
procedures before performing this procedure:

● Setting the OData Mobile Data Object Service Assignment [page 61]

SAP Shop Floor Manager Configuration Guide

Setting up an OData Mobile Data Object PUBLIC 63
Context

Procedure

1. Navigate to and click the Mobile Application Integration Framework Configuration Home OData Mobile
Data Object Configuration link.

The OData Mobile Data Object Configuration Detail page displays.

2. Select your application in the Mobile Application Filter field. Selecting an application filters the OData
Mobile Data Object by Mobile App choices in the left panel to only those available in your chosen
application.
3. If you are copying an OMDO, which is recommended, choose your OMDO from the OData Mobile Data
Object by Mobile App list on the left and copy it to your customer namespace. See the Copying an Object to
the Customer Namespace [page 52] procedure for more details. Do not modify the original OMDO.
4. Enter an OMDO ID in the field with customer namespace.
5. Select a Mobile Application from the dropdown list.
6. Select an OMDO Handler from the dropdown menu. The OMDO handler is the name of the handler as
defined in the system.

The OMDO handler will provide the data source for the entity record.
7. Enter a short Description of your new OData mobile data object.
8. Choose one of two settings for the Process Flow in the Read Request Process Flow section:
○ Standard Flow Using Key List

SAP Shop Floor Manager Configuration Guide

64 PUBLIC Setting up an OData Mobile Data Object
 ○ Basic Flow without Key List
9. You can keep the Client State Settings from the original OMDO, or change it depending on your business
needs. and from the original OMDO, or change it depending on your business needs. and Delta Sync
Settings from the original OMDO, or change it depending on your business needs. and from the original
OMDO, or change
10. Check the Enable Paging checkbox to set the package size for the SAP Cloud Platform Mobile Services.
Type in a number for the default package size in the Paging Package Size field.

Next Steps

Continue to Setting the OData Model Configuration [page 65].

5.4 Setting the OData Model Configuration

An OData model gives detailed information about each object in an OData feed. You can define a new data
model in your application to suit your requirements based on the data you want expose at runtime.

Prerequisites

Complete the following procedures:

● Setting the OData Mobile Data Object Service Assignment [page 61]
● Setting the OData Mobile Data Object Configuration [page 63]

Context

Entity Sets are used to group instances of an entity type together with instances of any type that are derived
from this particular entity type. You can access the OData entity details from the ConfigPanel home page by
choosing OData Model Configuration.

You can define properties for entity types on the Property List tab. Properties define the characteristics of data
that an entity type instance contains at runtime.

An association is a named relationship between different entities. An association defines a peer-to-peer

relationship between participating entity types, and it can also support different multiplicities at both ends. You
can define associations between current and dependent entities on the Association & Set List tab. An
association set groups association instances, and specifies the relationship between two entity sets based on
the respective entity types of the underlying association.

Navigation properties describe the association relationship between two entities. The navigation property is
tied to an association, and it allows the navigation from one end of the entity type, which declares the

SAP Shop Floor Manager Configuration Guide

Setting up an OData Mobile Data Object PUBLIC 65
navigation property, to the other related end. The entity types include one or more navigation properties and
can be defined on the Navigation Property List tab.

Finally, you can set the bind structure conversion exits and the Media flag for entity type on the Additional
Setting tab.

 Note

Optional steps are included to explain the required fields when creating a new OData model. These fields
are grayed out when you are working with a copied OData model and you can ignore them in the procedure.

Use the following steps as a guide to change an existing OData model:

Procedure

1. Navigate to and click the Mobile Application Integration Framework Configuration OData Model
Configuration link.

The Mobile Application OData Model Detail page displays.

2. Select your application in the Mobile Application Filter field. Selecting an application filters the OData
Model Entity Type by Mobile App choices in the left panel to only those available in your chosen application.
3. Once you have selected the mobile application, select OData Service ID from the drop-down list.

Note that you cannot share models between OData services. Each service has its own model.
4. If you are creating a new OData model, click on Create button on the top and type an entity type name in
the field. The entity type name represents the structure or a single record.
5. Select an OMDO ID from the drop-down list. The OMDO ID is the object that is providing the data for the
record.
6. Select an OMDO Entity Type from the drop-down list. The OMDO entity type is the source that provides
information to the OData model. When a service request for the entity type occurs, the OData model
invokes the selected OMDO ID and the related handler method.
7. Type an EntitySet Name into the field. While an entity type describes a data structure, an entity set
contains the instances of the given structure. Therefore, a best practice for an entityset name is to create a
plural of an entity type name. For example, if an entity type name is Test, the entityset name will be Tests.
8. Check any of the following checkboxes to enable additional OData features. Note that some may require
additional configuration on other tabs or links.
○ Createable: Similar to a POST request in REST

SAP Shop Floor Manager Configuration Guide

66 PUBLIC Setting up an OData Mobile Data Object
 ○ Pageable: Enables data staging. See Setting the OData Mobile Data Object Configuration [page 63],
General Setting tab, Server Side Paging Setting section, for more information.
○ Updateable: Similar to a PUT or MERGE request in REST
○ Filter Required: When checked, the entityset cannot be accessed directly. That is, the entityset is only
valid within its containing entity and is not visible in the service document. You cannot query the
entityset without using a $filter expression. If you try to access the entity set without using a
$filter expression, a message displays that explains which filter expressions are required, at a
minimum.
○ Deletable: Similar to a DELETE request in REST
9. Click the Property List tab.

10. To add a new property to the entity type, click the Add button.
a. Type the property name into the <Property Name> field.
b. Select an oMDO Field Name from the dropdown list.
c. Select the appropriate EDM Type (Entity Data Model) from the dropdown list.
d. Check the Key column for Key fields.
e. Define the attributes of the new property depending on the scope of the entity type.

If you use the Datetime Edm Type and its related properties as an optional field, set the attribute Nullable to
true.
11. Click the Association & Set List tab.

SAP Shop Floor Manager Configuration Guide

Setting up an OData Mobile Data Object PUBLIC 67
 Define associations between entities to express relationships between entities.

Associations themselves are freestanding. Specify on top of the associations, which of the entities
participating in the relationship can navigate over the association to the other entity using the Referential
Constraints tab.
12. Click the Add Association button to add a new association. Associations define a peer-to-peer relationship
between participating entity types, and can support different multiplicities at both ends.
a. Type a name for your new association in the Association Name field.

Your Association can be either internal or external when adding a new association; by default the
current entity will be the principle entity. If you want to add an external association where the current
entity is treated as dependent entity, select the External Association checkbox.
b. Select the dependent entity from the Dependent Entity Type drop-down menu for internal association,
whereas select the Principle Entity Type Id from the drop-down for external association.
c. Choose the Principle Cardinality and the Dependent Cardinality. Both use the following cardinality
rules. Note that many-to-many relations are not supported in SAP Shop Floor Manager
○ 0..1: Only one instance occurs; zero is also allowed
○ 1: One-to-one relations. Exactly one instance occurs
○ 0..n: Zero-to-many relations. Zero or more instances occur
○ 1..n: One-to-many relations. One or more instances occur
d. Select the Principle/Dependent OnDelete Cascade checkbox, if you want to delete an associated
collection when a principle or related parent entity got deleted from the mobile device. This feature
only works with local objects.
e. Type the name of your association set in the Association Set Name field under Association Set.
13. Click the Referential Constraints tab to add or change a referential constraint.

SAP Shop Floor Manager Configuration Guide

68 PUBLIC Setting up an OData Mobile Data Object
 Referential constraints ensure that the principle entity that is referenced always exists. You can use a
referential constraint to specify the foreign key relationship for a 1:1 relationship or a 1:n relationship.

You have to match the key properties of the principle entity type with the properties from the dependent
entity type that correlates to the key property of the principle type. Populate all key properties from the
principle entity type.

a. Click the Add Constraint button to add a new referential constraint.

b. Select the Principle Property and the Dependent Property from the drop-down menus. As mentioned
earlier, the entities must be identical and all key properties must be populated from the principle entity.
14. Click the Navigation Property List tab to create a navigation property for entity types.

The navigation property is tied to an association, and it allows the navigation from one end of the entity
type that declares the navigation property to the other related end.

 Note

If you add a new navigation entity, first add a new association for it through the Association & Set List.
Set the association cardinality for both principle and dependent entities.

15. Click the Add Navigation Property to add a new navigation property.

You can create a navigation property for both principle and dependent entity type using the same
association so that link will be created in both directions.

SAP Shop Floor Manager Configuration Guide

Setting up an OData Mobile Data Object PUBLIC 69
 a. Type a name into the Navigation Property Name field.
b. Type a technical name into the Technical Name field.
c. Choose an Association (coming from the Association & Set List tab) from the drop-down menu.

The Dependent OMDO ID and Dependent Tech Entity Type cells are populated based on which
association entity you choose.
d. Repeat these substeps to create the navigation property on the remaining principle or dependent
object.
16. Click the Additional Setting tab.

a. Select the Media Flag checkbox for media-related entity types to trigger the download of media
content on the entity set collection.
b. Select the Enable Structure Conversion Exit checkbox to allow the SAP Shop Floor Manager application
to access the OData channel. The OData channel delegates handling of conversion exits, currency,
currency amounts, units of measurement, and unit amount conversions to the SAP Gateway
framework.

Results

Once the model is fully defined, when a client makes an HTTP request, it is calling for the metadata for an
OData service. The SAP Gateway returns an XML string to the client, which is also reflected in the ConfigPanel.

SAP Shop Floor Manager Configuration Guide

70 PUBLIC Setting up an OData Mobile Data Object
6 Data Distribution Model Overview

A data distribution model defines how and what back end data are downloaded to the mobile devices.

Data distribution models consider various factors when determining what backend data should be downloaded
to the mobile client and to the mobile user. Some common criteria are:

● Relevant business processes and business rules

● User business roles in the organization
● Last mobile client synchronization time with the back-end system
● Backend data changes and the time of the changes
● Current state of data objects on the mobile device

For the initial synchronization from the mobile device to the back-end system, the first two bullet points are
considered when determining what data should be downloaded to the mobile device and for the requesting
user. For subsequent delta synchronizations from the mobile device to the back-end system, all bullet points
are considered when determining what data should be downloaded to the mobile device for the requesting
user.

The following data distribution models are supported for the SAP Shop Floor Manager application:

● OMDO Filters
Object data collection entirely depends on OMDO filter conditions.
● Dependency Queue
Object data collection entirely depends on Dependency Queue objects, and no filter conditions are applied
for the fetch criteria.
● Dependency Queue + OMDO DOF Filters
Object data collection is based on dependency queue objects, and the OMDO DOF filters are applied for the
result set.
● Other (Custom BAdI)
You can implement your own distribution logic using a BAdI.

SAP Shop Floor Manager Configuration Guide

Data Distribution Model Overview PUBLIC 71
By default, the SAP Shop Floor Manager application determines object data collection based on distribution
model by using OMDO filters. In some cases, both OMDO filters and Dependency Queue are used depending on
the business use case. You can choose the appropriate distribution model based on your specific business
processes and requirements.

To change the data distribution model for a particular OMDO object, complete the steps below:

1. On the ConfigPanel home page, choose OData Mobile Data Object Configuration.
Make sure you select your desired mobile application in the Mobile Application Filter field at the top of the
page.
2. From the OData Mobile Data Object List select the desired OMDO object, such as SPSV10_MATERIAL, and
then click on the Data Filter tab.
3. Expand the Defined Filters list under Operation - READ Data Distribution
OBJECT_DISTRIBUTION_MODE . Choose the Change button from the menu.
4. Set the distribution model.
5. Save your changes.

6.1 Data Distribution by Assignment Types

By default, the SAP Shop Floor Manager application determines the assignment of production orders and
notifications using the production orderID at header level.

6.2 Common Filters for SAP Shop Floor Manager

The filters listed in the following table are common to all SAP Shop Floor Manager distribution rules. See the
specific rules for details on filter requirements for those rules.

SAP Shop Floor Manager Configuration Guide

72 PUBLIC Data Distribution Model Overview
Common Filters: Back End Data Filter Matrix

Common Filters: Back End Data Filter Matrix

Filter Name Type Value Comments

ORDER_CATG Data Distribution, Optional See specific rule Restricts production order distribu­
for value tion based on production order cate­
gory. For productionorders, it should
be value 1.0.

ORDER_TYPE Data Distribution, Optional Any Restricts production order distribu­

tion based on production order type.

ORDERID Data Distribution, Optional Any Restricts production order distribu­

tion to a specific production order
number.

PLANT Data Distribution, Optional Any Restricts production order distribu­

tion based on the plant of the pro­
duction order.

DOC_GOS_RELTYPE Standard Filter, Optional Data Segment, Op­ Determines whether the GOS at­
tional tachment is supported based on a
GOS relationship.

DMS_DOC_TYPE Standard Filter, Optional Data Segment, Op­ Determines whether the DMS at­
tional tachment is supported based on the
DMS document type.

DOC_LINK_OBJ Standard Filter, Optional Data Segment, Op­ Determines whether the DMS at­
tional tachment is supported based on the
linked SAP object.

SAP Shop Floor Manager Configuration Guide

Data Distribution Model Overview PUBLIC 73
7 Troubleshooting

This section describes the various troubleshooting activities that you can perform in error situations, or the
app users can perform on a regular basis to ensure the smooth running of the mobile application. It is also
explains how to monitor the different components of SAP Gateway, how to use the logs, and how to carry out
maintenance activities.

7.1 SAP Gateway Client

You can use the SAP Gateway Client (transaction code: /IWFND/GW_CLIENT) to test your OData service
provider without an OData consumer, such as the SAP Shop Floor Manager mobile client. This tool is especially
useful to test your OData service from the back end to identify service-related issues before a service is used by
the mobile application.

For more information about how to work with the SAP Gateway Client, see SAP Gateway Client in the SAP
Gateway Technical Operations Guide.

SAP Shop Floor Manager Configuration Guide

74 PUBLIC Troubleshooting
7.2 SAP Gateway Error Logs

Error logs provide detailed context information about errors that have occurred at runtime, enabling you to
perform root cause analysis, as well as reproducing and correcting errors.

You can launch the error log with transaction /IWFND/ERROR_LOG in Gateway Hub systems. Launch the error
log with transaction /IWBEP/ERROR_LOG in your back-end system.

The SAP Gateway error logs reveal basic details about errors and show errors from all users for a given client.
Business logic errors are often displayed in this error log due to improper business logic. Other errors displayed
include the HTTP code to indicate the type of error.

Note that based on the security level setting, advanced details or the replay function may be hidden or
disabled. Note also that these error logs will not show generic authorization errors if users fail to properly
authenticate.

You can navigate to different sections from the Error Context area as shown above. Choose Replay to reproduce
and correct errors. Choose from the following two replay options:

● SAP Gateway Client

● Web Browser

Use option SAP Gateway Client to reproduce runtime situations that led to a particular error without accessing
the application from the actual mobile client, and to simulate a service at runtime to identify and resolve
potential issues.

For more information about how to configure the error log, see Configuration Settings for the Error Log in the
SAP Gateway Technical Operations Guide.

SAP Shop Floor Manager Configuration Guide

Troubleshooting PUBLIC 75
In addition, use the Application Log Viewer to display more technical error details by using transaction /
IWFND/APPS_LOG.

7.3 SAP Gateway Statistics

You can use the SAP Gateway Statistics (transaction code: /IWFND/STATS) to display the request statistics
and aggregated statistics. Each successful OData request has an entry in the statistics records, which is kept
for 7 days by default, however, you can extend the period to 30 days. Request statistics can be aggregated, in
which case they are kept for 90 days by default, however, you can extend the period to 365 days.

SAP Gateway Statistics aggregates the entries by various entities, for example, client, namespace, service
name and version. With the /IWFND/STATS transaction you can verify details, such as processing time,
response size by entity, and other statistics about the complete request.

7.4 SAP Gateway Tracing Tools

The SAP Gateway provides tracing tools (transaction code: /IWFND/TRACES) to trace on a particular user for
both performance and payload.

Performance trace enables you to monitor performance at service call level for both the SAP Business Suite
and the SAP Gateway. Payload trace enables you to monitor the service calls with request and response data,
and to replay and simulate the service calls without accessing the application from the mobile client.

Traces display detailed request and response data coming into the SAP Gateway. Traces are active for only a
short time, and are purged on a regular basis.

SAP Shop Floor Manager Configuration Guide

76 PUBLIC Troubleshooting
With this tool, you can verify the exact content of the request header and body that is sent from the mobile
device, and also check the response from the SAP Gateway.

For information about how to configure and activate the payload trace tool, see Tracing Tools: Configuration in
the SAP Gateway Technical Operations Guide.

SAP Shop Floor Manager Configuration Guide

Troubleshooting PUBLIC 77
Important Disclaimers and Legal Information

Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:

● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:

● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.

● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such
links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.

Videos Hosted on External Platforms

Some videos may point to third-party video hosting platforms. SAP cannot guarantee the future availability of videos stored on these platforms. Furthermore, any
advertisements or other content hosted on these platforms (for example, suggested videos or by navigating to other videos hosted on the same site), are not within
the control or responsibility of SAP.

Beta and Other Experimental Features

Experimental features are not part of the officially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by
SAP at any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use
the experimental features in a live operating environment or with data that has not been sufficiently backed up.
The purpose of experimental features is to get feedback early on, allowing customers and partners to influence the future product accordingly. By providing your
feedback (e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.

Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.

Gender-Related Language
We try not to use gender-specific word forms and formulations. As appropriate for context and readability, SAP may use masculine word forms to refer to all genders.

SAP Shop Floor Manager Configuration Guide

78 PUBLIC Important Disclaimers and Legal Information
SAP Shop Floor Manager Configuration Guide
Important Disclaimers and Legal Information PUBLIC 79
[Link]/contactsap

© 2021 SAP SE or an SAP affiliate company. All rights reserved.

No part of this publication may be reproduced or transmitted in any form

or for any purpose without the express permission of SAP SE or an SAP
affiliate company. The information contained herein may be changed
without prior notice.

Some software products marketed by SAP SE and its distributors

contain proprietary software components of other software vendors.
National product specifications may vary.

These materials are provided by SAP SE or an SAP affiliate company for

informational purposes only, without representation or warranty of any
kind, and SAP or its affiliated companies shall not be liable for errors or
omissions with respect to the materials. The only warranties for SAP or
SAP affiliate company products and services are those that are set forth
in the express warranty statements accompanying such products and
services, if any. Nothing herein should be construed as constituting an
additional warranty.

SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.

Please see [Link] for

additional trademark information and notices.

THE BEST RUN