SAP Asset Manager Configuration Guide
SAP Asset Manager Configuration Guide
SAP Asset Manager Configuration Guide
12 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
12.1 SAP Gateway Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .189
12.2 SAP Gateway Error Logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
12.3 SAP Gateway Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
12.4 SAP Gateway Tracing Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Before you begin reading this guide, be sure that you have the latest version. Find the latest version at https://
help.sap.com/viewer/product/SAP_ASSET_MANAGER/p/en-US.
The following table provides an overview of the most important document changes.
The SAP Asset 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 Asset Manager Configuration Guide along with appropriate SAP documentation. Note that this
guide only covers setting up and enabling the SAP Asset Manager mobile application.
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 Asset
Manager 1911 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
SAP Asset Manager is a mobile solution for managing work orders, notifications, condition monitoring, and
material consumption. The application also performs time management and failure analysis.
Regardless of connectivity, SAP Asset Manager allows remote employees to access, complete, and manage
their assigned work orders and notifications through their mobile devices. With SAP Asset Manager, they have
SAP back end data readily available including task lists, repair histories, reference documents, and geospatial
data such as addresses and maps. 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.
The main features and functions available in SAP Asset Manager include the following.
SAP Asset Manager supports the following standard SAP Plant Maintenance Work order functionalities on the
mobile device:
The following standard SAP notification functionalities are supported on the mobile device:
The following data related to maintenance execution can be captured from the mobile device:
Time Management
Maintenance technicians can use SAP Asset Manager to trace their time efficiently and accurately by entering
the timesheet and the attendance records from the mobile device.
Single Sign-On (SSO) allows the user to log into the SAP Asset 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 Asset 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:
● Work orders
● Notifications
● Equipment
● Functional locations
Inspection rounds with routing is an optional feature available as the SAP Asset Manager Field Operations
Worker (FOW) component. FOW supports:
Route and stop definition is implemented via the standard work order inspection round functionality.
SAP Asset Manager supports work crew management. This feature supports:
SAP Asset Manager supports the industry solution for utilities meter management. The following standard
features are supported:
Asset Central links production systems and assets with manufacturing and maintenance business processes to
reduce operational and maintenance costs and increase asset uptime. Using Asset Central, you can use PdMS,
or Predictive Maintenance and Service equipment indicators that allow you to identify the health status of your
equipment.
SAP Asset Manager uses the SAP back end and specific SAP ERP transaction codes to help configure the
application.
The SAP Mobile Add-On provides integration services for SAP Asset 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.
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
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 Asset 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.
While configuration for each mobile application is unique, certain toolbar functions in the Configuration Panel
are common and are available for all applications.
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.
The following standard actions are available to configure different components and items within your mobile
application setup:
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.
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.
The Mobile Application Configuration page allows you to configure general settings for the entire mobile
application.
● General
● Mobile Status Setting
● Conversion Exit Setting (not used in SAP Asset Manager)
● System Components (not used in SAP Asset Manager)
● Parameters
● Client Globals (not used in SAP Asset Manager)
● User Attributes (not used in SAP Asset 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 Asset
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.
Use the Mobile Status Setting tab to map the available mobile statuses that an oData mobile data object
(OMDO) supports on the client side. If a user status also exists for the same object type, you can link it to the
mobile status and the system status through this tab.
● 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.
● Mobile Status Mapping: Use the <Add Status> and <Delete Status> buttons to create and delete
mobile status mappings. Fill out the <Object Type> with the specific object in the mobile application, for
example, <Notification>. The <Mobile Status> is the status defined by the mobile application. The
<Label on Mobile> is not used. The <User Status> is an SAP status code as defined in SAP. Note that
the status codes are language independent codes.
If the <Initial Status> checkbox is selected, the mobile status is displayed by default when you
download the object to the mobile device. To skip a specific mobile status update from a mobile device, use
the <Skip Update> checkbox corresponding to the mobile status object.
Use the Mobile Status Alias List table to define language-specific mobile status aliases.
In the following example screen, the highlighted row in the mapping table indicates that if a user sets a work
order to completed, the application sets the work order system status to I0045 in SAP.
If there is a user status specified but no status profile when the mobile user sets the mobile status, the app sets
that user status for the object, disregarding the status profile of that object.
If there is a user status and status profile specified when the mobile user sets the mobile status, the app sets
that user status if the object uses that status profile.
Parameters Tab
Note
For information on setting user parameters, see the following security guides, depending on your
back end system:
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.
A geographic information system (GIS) integrates hardware, software, and data for capturing, managing,
analyzing, and displaying all forms of geographically referenced information.
Note
GIS is enabled by default. See the Geospatial Service Definitions - GEF [page 22] topic if you are using GEF
(SAP Geographical Enablement Framework).
Geospatial data plays an important part in the daily operations of many organizations. By adding geospatial
data to the technical data of an asset, you get a full picture of that asset.
● General Data
● Object Type Assignment
● Parameter Settings
● Data Rules
Basic Data
● Service ID: Required field. Name of the geospatial service ID, limited to 40 characters, with namespace
protection. Use the Y or Z namespace.
● Description: Description of the geospatial service
● Mobile Application: Mobile application of the geospatial service. Every geospatial service is assigned to a
specific mobile application.
Activation
● Active Flag Check the checkbox to activate the GIS query service
Use the Object Type Assignment tab to define what type of SAP objects are assigned to the geospatial service.
You can define different geospatial services for different SAP object types.
For example, you can map equipment with polygon geospatial data to one geospatial feature layer. You can then
map equipment with point geospatial data to a different geospatial feature layer.
Use the Parameter Settings tab to define parameter settings for the service provider handler. The service
provider handler can declare the list of parameters that might require input. If parameters are declared, they
are displayed on this tab, and you can enter values for them.
Use the Data Rules tab to define data rules. A data rule is used to transform input data to the service provider
handler, before calling the geospatial service. For example, to dynamically assign values of object type, object
group, and object group 1 to input data, use a data rule. Using a data rule influences which geospatial service is
assigned to an input object.
The SAP Geographical Enablement Framework (GEF) enables the augmentation of business data with spatial
attributes for SAP S/4HANA applications. The framework allows SAP data to be used in GIS-based geo-
processing operations.
Note
GIS is enabled by default. See the Geospatial Service Definitions - GIS [page 17] topic if you’re using GIS
(Geographical Information System).
GEF reduces, and in some cases, eliminates the need for complex synchronization between SAPSAP and GIS
systems. Business data can be combined with engineering data in a single map view independent of the user
working with SAP tools or GIS tools, decreasing TCO, increasing the value of business data, and simplifying
user interaction.
The framework provides an embeddable map-based UI for SAP S/4HANA applications to quickly geo-enable
their business objects and support geospatial processes. It also exposes the geometries and attributes of geo-
enabled SAP business objects as feature classes to be consumed via standard GIS tools.
● General Data
● Object Type Assignment
● Parameter Settings
● Data Rules
As GEF is integrated directly to SAP S/4HANA systems, there’s no need to call REST APIs outside of SAP
S/4HANA. All information and coordinates are already stored as part of the system.
Basic Data
● Service ID: Required field. Name of the geospatial service ID, limited to 40 characters, with namespace
protection. Use the Y or Z namespace.
● Description: Description of the geospatial service
● Mobile Application: Mobile application of the geospatial service. Every geospatial service is assigned to a
specific mobile application.
Note
Activation
● Active Flag Check the checkbox to activate the GEF query service
Use the Object Type Assignment tab to define what type of SAP objects are assigned to the geospatial service.
You can define different geospatial services for different SAP object types.
For example, you can map equipment with polygon geospatial data to one geospatial feature layer. You can then
map equipment with point geospatial data to a different geospatial feature layer.
Assignment Info
● Logical System: Logical system of the SAP object. A logical system is required to properly identify the SAP
object if the mobile add-on aggregates data from different back-end systems. You can configure the
following fields on the
● Object Type: Type of the object as it is identified in the mobile add-on. For example, the standard object
type IEQ is used to identify the Equipment object.
● Object Group: Optional setting used to further group the objects in the same object type.
● Active: When the Active checkbox is marked, the assignment is active.
● Object Group 1: Optional setting used to further group objects of the same object type and object group.
Use the Parameter Settings tab to define parameter settings for the service provider handler. The service
provider handler can declare the list of parameters that might require input. If parameters are declared, they’re
displayed on this tab, and you can enter values for them.
The EAM Scenario parameter data mines the GEF scenario object. For each scenario, there’s a corresponding
business object:
You can assign different business objects for your system needs.
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.
● 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.
You can define the following settings for the OData service assignment:
Composition Settings
With service component composition, you can compose a complex service using component services.
● 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.
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.
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 Asset Manager
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.
You can configure the following in the Association Set Info section:
You can configure the following in the Referential Constraints section (not pictured in detail in the example
screenshot):
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:
You can define the following additional settings for the OData model:
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.
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
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.
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.
The Technical Model Info tab is a display only tab. This tab displays the technical entity model supported by the
OMDO handler.
● 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
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.
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.
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.
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 Asset Manager downloads detailed information for equipment and functional locations used
in work orders assigned to a technician. To fulfill this requirement, read requests for work order assignments
occur first, and equipment and functional locations are set up as dependent objects for the work 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.
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.
● 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.
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.
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 #1 UPDATE 123 Request #1 UPDATE 123 (attribute values from Request
#3 merged into Request #1)
Request #2 UPDATE 123
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
Change detection settings are used to define and configure how the mobile application, such as SAP Asset
Manager, communicates with SAP and the object tables contained within SAP
● 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
Note
Create tables and objects in SAP and the Mobile Development Kit before you can create or configure
information in the ConfigPanel.
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.
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 first item.
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.
Assignment Tab
● 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.
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
● Push Settings
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 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.
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>:
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.
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.
Push scenarios define the trigger conditions, type of data, the mobile users receiving the data, and the users
for the data.
A mobile client typically synchronizes with the SAP system by initiating a synchronization request to download
the latest application data from the SAP system. Some mobile applications require the SAP system to send
application data or push notifications to the client when certain trigger conditions are met. If these trigger
conditions are not present, the mobile client does not initiate the synchronization request.
You define trigger conditions through the creation of push scenario definitions. Use the tabs found in the Push
Scenario Definition page to configure a push scenario. The Push Scenario Definition page contains the following
tabs:
● General Data
● Event Setting
● Outbound Trigger
● Subscription Settings
You can define the following attributes in the General Data tab:
● Basic Data section: Enter the ID of the push scenario in the required <Scenario ID> field, which is
limited to 40 characters with namespace protection. Use either a Y or a Z namespace. Ensure that the ID is
unique in the SAP system. Enter the name of the mobile application in the <Mobile Application> field,
limited to 40 characters. Give an optional <Alias> to the push scenario. Multiple push scenarios can
share the same alias, to allow central processing on the client side.
● Source Setting section: The <Source Type> defines how to trigger the push scenario. Two options are
supported:
○ xChange Object: The push scenario is triggered when qualifying data is changed in the SAP system
and change conditions defined in the xChange object are detected.
○ Client on Demand Request: The push scenario is triggered based on a request from the mobile client.
No data change in the SAP system is required. The client on demand request is not available for OData
based mobile applications.
The <Source Object> applies to the source type of the xChange object. The xChange object determines
the data change trigger for the push scenario. The <Source Handler> is the xChange handler assigned
to your selected xChange object.
You can define the following attributes in the Event Setting tab:
● Background Event Setting Detail setting: If the Disable Background Event Trigger checkbox is not
checked, a background event is raised during push processing.
● Standard Event Setting: The <Event ID> is the background event ID that is raised. The <Event
Parameter> is the background event parameter.
● Rule Based Event Setting: The <Push Event Rule> is a routine that generates a dynamically formatted
event ID and parameter based on supported runtime variables.
● qRFC Setting Detail: If the Enable qRFC Processing checkbox is checked, push processing is handled in
the background as a qRFC call.
Outbound triggers handle interfacing with external systems. You can assign multiple outbound triggers to a
push scenario. Assigned outbound triggers are invoked at the end of push processing, based on the assigned
sequence.
To allow an on-demand subscription based push request from the mobile client, define the subscription setting
in the Subscription Settings tab. Subscriptions allow the mobile client to trigger a push process instead of a
traditional trigger by the back end SAP system update. OData based mobile applications do not support
subscription-based on-demand push configuration.
● Allow Subscription: Check to enable subscription-based push processing for the push scenario
● Subscription Agent ID: Displays the subscription agent assigned to handle the subscription request
Outbound triggers allow a mobile application to interface with external systems such as the SAP Cloud
Platform.
You can integrate outbound triggers into one of the following mobile application processes:
● Push processing
● OData mobile data object processing
An outbound trigger can support only one of the two available processes. The process is determined by the
outbound trigger handler. An outbound trigger handler can support any of the interface technologies, such as
HTTP triggers, file triggers, and web service triggers.
● General Data
You can define the following attributes in the General Data tab:
Basic Data
● Outbound Trigger ID: Required field. Unique ID of the outbound trigger in the Y or Z namespace, limited to
40 characters.
● Outbound Trigger Description: Short description of the outbound trigger
● Mobile Application: Select your mobile application. The outbound trigger configuration detail is defined
for the individual mobile application.
Retry Setting
Activation
If the Active Flag checkbox is not checked, the outbound trigger is not enabled.
Parameters Tab
An outbound trigger handler can declare special purpose parameters. If parameters are declared, they are
displayed in the Parameters tab. You can declare any number of parameters. A parameter can be a single field
parameter or a structured record.
● 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
○ 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 Asset 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
Asset 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 Asset 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 Asset 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.
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
● User Role
Rules based on predefined user roles
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.
By default, the SAP Asset Manager application maps the STARTED work order status on the client to the REL
status in SAP Mobile Add-On.
In many implementations, a status of MOBI is used in SAP Mobile Add-On to indicate that the work order is
started by a technician. The MOBI status cannot be modified on the back end.
You can map the mobile status to a different status within SAP Mobile Add-On by altering the mobile
application configuration for SAP Asset Manager and changing the system status technical code for the
STARTED mobile status. After you change the system status technical code, updates to SAP Mobile Add-On
made when a user starts a work order set the status in SAP Mobile Add-On to the MoBI status, matching the
entered technical code.
The only modification to make is in the ConfigPanel, in the Mobile Application Configuration page, Mobile Status
Setting tab. Change the mobile status for a started work order in the list of the mobile status options for SAP
Asset Manager, with the system status value of that same record altered to use the technical code of the
desired status.
Prerequisites
● Determine and note the technical code of the work order system status to which the mobile status
STARTED will be mapped, as it is used in the procedure.
● The system status to which you are mapping the mobile status of STARTED in this procedure is configured
as a work order status.
● The person performing this procedure has access to the ConfigPanel and permissions to change
configuration settings of the elements within it.
The following procedure describes the steps required to change a system status when a mobile STARTED
status is mapped to it.
Procedure
1. Starting from the ConfigPanel home page, click the Mobile Application Configuration link. Then click the
Mobile Status Setting tab.
2. Choose your desired mobile application from the list of Defined Mobile Applications in the left pane.
The application level status settings display in the tab to the right. Information includes the Mobile Status
List.
3. In the Mobile Status List table, find the Object Type of <WORKORDER> with a Mobile Status of <STARTED>
and click the Change button.
4. Change the System Status value to the technical code of the system status to which the STARTED mobile
status should be mapped. When done, click Save.
Results
After completion of the procedure, the STARTED mobile work order status is mapped to a different system
status than the default REL status.
Prerequisites
Context
Use the CatsMinuteInterval parameter when CATS is enabled and the LaborTimeMinutesInterval parameter
when PM confirmations are enabled. The following procedure is the same for either parameter, even though
this guide is using the CATSMinuteInterval parameter as an example.
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.
2. The CATSMinuteInterval parameter is found in the TIMESHEET group. You can scroll down to find the
parameter, or perform a search using the Search box. Highlight the CATSMinuteInterval parameter and
click the Change button.
Note
3. You can change either the CATS or the PM confirmation labor time interval to the following values:
○ 1
○ 5
○ 10
○ 15
If you accidentally set the parameter to an interval value that isn’t an allowed value, the parameter
automatically defaults to a value of 15 on the client device.
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
isn’t overridden at runtime through synchronization processing.
5. Save your changes.
The Clock In Clock Out (CICO) feature decouples time tracking from the mobile status of a work order or
operation, allowing multiple users to start and log time against the same work order or operation
simultaneously.
Overview
The CICO parameter in the ConfigPanel allows multiple users to work on the same work order or operation,
where all users receive the work orders and operations to their devices. CICO allows multiple work orders and
operations to be in the Started state that belong to different users. Mobile device users are able to see the
CICO state of all work orders or operations on their device. Users can also filter their work order or operations
lists based on clock in or clock out status.
● Multiple people can work on the same work order or operation even if the work order or operation is
already started by another user
● Users can clock in to any work order or operation on their device
● Users can only clock in to one work order or operation on their device at a time
● Users must clock out of the current work order or operation before clocking in to a different work order or
operation
● All time recording (CATS and Confirmation) uses the clock in clock out period as the default duration in
time entry screens
● When a user clocks in to a work order or operation:
○ The timestamp of the work order or operation is saved to a user-specific table that is persisted in the
back end
○ The mobile status of the work order or operation is set to Started if it isn’t already in a started state
● When a user clocks out of a work order or operation:
○ The work order or operation status is set to either Hold or Complete
○ If a work order or operation is set to Complete and Confirmations are used, the user can set it as the
final confirmation
● A user can start any work order or operation that is in a Hold, Received, or Local state
● A user can start only one work order or operation at a time
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.
2. The Enable parameter is found in the CICO group. You can scroll down to find the parameter, or perform a
search using the Search box. Highlight the Enable parameter and click the Change button.
3. If the Enable parameter is set to Y, clock in clock out is enabled. If it’s set to N, the parameter is disabled.
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
isn’t overridden at runtime through synchronization processing.
5. Save your changes.
Context
Use the SIGN_CAPTURE parameter group and the following parameters within the group to configure signature
control for SAP Asset Manager:
By default, the signature control feature is not enabled. To enable signature control:
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.
2. The signature control parameters are found in the SIGN_CAPTURE 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.
○ Y: Control is displayed on the client and is required before completing the object
○ N: Control is not displayed on the client (enabled by default)
○ O: Control is displayed on the client and is an optional step to complete the object
Note
If the parameters have no Parameter Value assigned, signature control does not display on the client.
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.
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:
Use the CATALOGTYPE parameter group and the following parameters within the group to configure your
catalog types for notifications in SAP Asset Manager:
● CatTypeActivities: Default is A
● CatTypeCauses: Default is 5
● CatTypeDefects: Default is C
● CatTypeObjectParts: Default is B
● CatTypeTasks: Default is 2
● CatalogProfileOrder: Default is Equipment, Functional Location, Notification Type
The CATALOGTYPE parameters correspond to the rules found in the OData mobile data object
SAM2010_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.
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.
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 SAM2010_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 92].
8. Save your changes.
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
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.
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
SAP ASSET MAN Create work order Work Orders IW31 Enable.WO.Create Includes opera
tions and suboper
AGER
ations
SAP ASSET MAN Edit work order Work Orders IW32 Enable.WO.Edit Includes opera
tions and suboper
AGER
ations (except lo
cal)
SAP ASSET MAN Create Notification Notifications IW26 Enable.NO.Create Includes items,
tasks, and activi
AGER
ties
SAP ASSET MAN Edit Notification Notifications IW22 Enable.NO.Edit Includes items,
tasks, and activi
AGER
ties (except local)
SAP ASSET MAN Edit FLOC Functional Loca IL02 Enable.FL.Edit Includes adding
tion characteristics
AGER
(except local)
SAP ASSET MAN Edit equip Equipment IE02 Enable.EQ.Edit Includes adding
AGER characteristics, in
stall, and disman
tle (except local)
SAP ASSET MAN Equip attachment Attachments N/A Enable.EQ.Attach See the Generic
upload Authorization
AGER
Check section in
this topic
SAP ASSET MAN FLOC attachment Attachments N/A Enable.FL.Attach See the Generic
upload Authorization
AGER
Check section in
this topic
SAP ASSET MAN Allow final confir- Confirmation N/A Enable.Conf.Cre See the Generic
mation ate.Final Authorization
AGER
Check section in
this topic
SAP ASSET MAN Issue and return MIGO N/A Enable.Parts.Issue See the Generic
parts Authorization
AGER
Check section in
this topic
ASSET CENTRAL Add checklist Checklist N/A Enable.CL.Create See the Generic
Authorization
Check section in
this topic
ASSET CENTRAL Fill checklist Checklist N/A Enable.CL.Edit See the Generic
Authorization
Check section in
this topic
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.
See the following screenshot for an example of a configured user role parameter:
Use the rule /SMFND/CL_CORE_AUTH_CHECK_RU - TCode Authorization Check to enable a more generic
authorization check. This rule is used for the following parameters:
● Enable.EQ.Attach
● Enable.FL.Attach
● Enable.Conf.Create.Final
● Enable.Parts.Issue
● Enable.CL.Create
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:
Procedure
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:
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.
Context
If you enable the EnableOnLocalBusinessObjects parameter, SAP Asset Manager allows mobile status update
changes for the following:
1. Navigate to Mobile Application Configuration Parameters tab using the ConfigPanel. Select your
application in the left column, Defined Mobile Applications.
The Parameter List populates with a list of all parameters available for the application.
2. Find the EnableOnLocalBusinessObjects parameter in the MOBILESTATUS group. 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. Enable or disable the parameter using the following strings: Y, Yes, T, or True are used to enable the
parameter. N, No, F, or False are used to disable the parameter.
4. Check the <Active> flag to ensure that the parameter is used by the mobile application. Check the <No
Runtime Change> box to ensure that the value of the parameter isn’t overridden at runtime through
synchronization processing if desired and if not already checked.
5. Save your changes.
Abstract document management provides the option to create and read DMS, GOS, or BDS documents
without configuration at the client application level.
Hover over the different types of abstract document in the flow chart to view the specific flow chart for the
document type.
Abstract document management provides the option to create and read DMS, GOS, or BDS documents
without configuration at the client application level.
Prerequisites
Address the following items before performing the procedure:
● Know the status or statuses that you’re filtering on for equipment synchronization, as they’re used in the
procedure
● Ability to access to the ConfigPanel and permissions to change configuration settings
With a standard activation of a DMS or GOS document management solution, each document type has its own
default content repository. Any application consuming document solutions like DMS or GOS follow the back-
end configuration settings.
Select SAM2010_DOCUMENT from the oData Mobile Data Object List and navigate to the following locations:
When you require SAP Asset Manager to create content in a custom repository that is different than your back-
end configuration, use the OTHER option. Implement the BADI /MERP/IF_CORE_OMDO_ABSDOC_BADI
Configuration Variations
Beginning with the SAP Asset Manager 2010 release, SAP Asset Manager supports working with third-party
repositories like Open Text or HTTP. Using third-party repositories leverages the back-end configuration for
GOS, BDS, or DMS for work orders, notifications, equipment, and functional locations. See 2945017 to
configure older application releases to work with third part repositories.
When using DMS, create custom storage category ZEXT to link to a third-party repository, such as an Open
Text content server. See 2945017 for more information. Through this additional configuration, attachments
uploaded from the application are stored in the third-party content server rather than the default content
server.
See the following release notes for addition information on configuring abstract documents:
Note
It isn't possible to integrate ABS documents with third-party repositories. Use this SAP note to deliver
additional parameters such as storage category at an object level.
See the following examples of back-end configuration with a third-party content server:
Example 1
Configure third-party repositories like Open Text to work with one of the available document solutions like BDS,
DMS, or GOS using the ConfigPanel. Then apply SAP Note 2945017 and configure the desired document
solution for work orders, equipment, and functional location objects.
Example 2
Integrate a third-party repository in more than one way with your back-end SAP system. If your implementation
doesn’t fit with DMS, BDS, or GOS, use the OTHER option in the ConfigPanel. Implement BADI /MERP/
CORE_OMDO_ABSDOC_BADI to align with the implementation.
Geospatial Services provide the technology to create, analyze, maintain, and distribute geospatial data and
information.
You can use either GIS (Geographic Information System) or GEF (Geographical Enablement Framework) with
SAP Asset Manager. Note that you can use either service, but you can't use both Services at the same time in
the application.
A geographic information system (GIS) integrates hardware, software, and data for capturing, managing,
analyzing, and displaying all forms of geographically referenced information.
The SAP Asset Manager application has custom map controls with GIS functionality implemented using Mobile
Development Kit and Open UI extensions. The SAP Asset Manager application is delivered with predefined
globals that are Esri-specific, however, you can point to any GIS vendor you choose.
For information about configuring GEF, see the subtopics located Geographical Enablement Framework (GEF)
[page 88] topic.
Some GIS settings are standard with the initial SAP Asset Manager application.
You can change any of the settings described in this topic to configure the application for your site.
Note
You can also change the map setting metadata through the Mobile Development Kit. Note that if there are
metadata differences, Mobile Development Kit changes override ConfigPanel changes.
In the ConfigPanel, the GISMapParameter entity type contains the following properties:
● ParameterGroup
● ParameterName
● ParentParameterGroup
● ParameterValue
Use the fields in the following section to properly categorize these parameters.
From the ConfigPanel Home page, navigate to OData Mobile Data Object Configuration Data Filter Tab
<APP_VERSION>_GIS_MAP_CONTROL Operation - READ Data Distribution . Click the Change button.
See the following for an example screenshot of the parameters in the ConfigPanel in the Data Filter tab, and a
table representing how to configure the parameters in the tab.
CONFIG EsriClientID
Use
You can view token-based authenticated basemaps and feature layers on the mobile client. Use the
ConfigPanel to configure the client ID and client secret strings.
The mobile client retrieves the tokens. The client ID and client secret are supplied to the client so each client
can generate their tokens for accessing authenticated services.
If your organization wishes to access Esri application-level authenticated GIS services, configure the SAP Asset
Manager application as shown in the following procedure.
You can also configure a proxy through Esri. Authenticated basemaps and feature layers are requested through
a local proxy. The proxy manages the generation and use of tokens based on the client ID and client secret. For
more information on configuring a proxy, see the Esri documentation, Working with Proxy Services .
To turn on GIS authenticated services in the ConfigPanel, add the following rule:
1. From the ConfigPanel Home page, navigate to OData Mobile Data Configuration OData Mobile Data
Object List Data Filter Tab SAP_ASSET_MANAGER_<XX> SAM2010_GIS_MAP_CONTROL
Operation - READ Data Distribution INI_PARAMETER .
2. Click the Change button. In the Rule List section, click the Add button to add a new rule. The rule gives you
the freedom to retrieve your client credentials in a manner appropriate for your organization:
○ Parameter Group: AUTHENTICATION
○ Parameter Name: ConfigRule
○ Parameter Value: /SAPAssetManager/Rules/Path/To/A/Rule.js
The specified rule must return a json object in the form of the following example. Be sure to replace the
text in the sample code with your actual client ID and client secret ("YourClientId" and
"YourClientSecret"):
Sample Code
{
"ClientId": "YourClientId",
"ClientSecret": "YourClientSecret"
}
Establish an oAuth connection using a secure TokenID to request offline maps information from the ArcGIS
server.
Context
The oAuth 2.0 client ID and secret for your connection are stored in the RFC destination. Maintain the RFC
destination in the app parameters in the ConfigPanel.
The OauthTokens entity is provided out of the box to use for the RFC destination set in the Parameters tab. Use
the following procedure to create the ARCGIS_CONNECTION_TOKEN_URL RFC destination in your backend
system:
Procedure
1. Using the SAP GUI enter transaction SM59 and enter ARCGIS_CONNECTION_TOKEN_URL, the new RFC
destination.
2. From the Technical Settings tab of your new RFC connection, set the Target Host to match the ArcGIS
server URL. Set the Path Prefix to /sharing/rest/oauth2/token?.
Note
If necessary, configure the proxy that you’re using to allow your backend systems to connect to the
internet.
Create a new rule in the SAP Asset Manager metadata to retrieve a valid authentication token for authenticated
resources within the map control.
Context
To create a new rule for offline GIS, see the existing rule found in the metadata file of SAP Asset Manager at /
SAPAssetManager/Rules/Extensions/TokenRequest.js. The rule found there uses an online oData
request to get the token from the back-end server. This rule is the recommended way to retrieve a token from
the Esri oAuth service.
1. Navigate to the metadata of your SAP Asset Manager project using your preferred text editor or the SAP
Web IDE and create a new rule.
2. Save the rule you created.
3. Open the .page file that contains your map control using your preferred text editor.
4. Navigate to the Controls section and locate the control for the map. The map control has the following
specific properties:
○ Type of Control.Type.Extension
○ Module of Extension-MapFramework
5. Add a TokenAuthentication object within the ExtensionProperties object of the control. Add an Action
property of a rule to retrieve a valid authentication token as shown in the following example:
Sample Code
{
"_Type":"Control.Type.Extension",
"Module": "extension-MapFramework",
"Control":"MapExtensionWithContext",
"Class":"MapExtensionWithContext",
"_Name":"MapExtensionControl",
"ExtensionProperties": {
…
"TokenAuthentication": {
"Action": "/path/to/rule/that/returns/a/
token"
},
…
}
}
6. Save the page and update your application with the new metadata.
Results
The new metadata allows token authentication on your ArcGIS map when required.
Geographical Enablement Framework (GEF) works as the foundation to extend business data with geometric
attributes for SAP S/4HANA.
As a framework leveraging the spatial capabilities inherent on the SAP S/4HANA platform, it enables
organizations to develop geospatially enriched business data, and make them accessible from within SAP
Asset Manager.
SAP Asset Manager uses the geometries (points, lines, and polygons) from the GEF geotables in SAP S/4HANA
for the geo-enabled objects in the application. SAP Asset Manager also uses the business layers, including the
For information about configuring GIS, see the subtopics located in the Geographic Information System (GIS)
[page 83] topic.
Some GEF settings are standard with the initial SAP Asset Manager application.
You can change any of the settings described in this topic to configure the application for your site.
Note
You can also change the map setting metadata through the Mobile Development Kit. Note that if there are
metadata differences, Mobile Development Kit changes override ConfigPanel changes.
In the ConfigPanel, the GISMapParameter entity type contains the following properties:
● ParameterGroup
● ParameterName
● ParentParameterGroup
● ParameterValue
Use the fields in the following section to properly categorize these parameters.
From the ConfigPanel Home page, navigate to OData Mobile Data Object Configuration Data Filter Tab
<SAMXX>_GIS_MAP_CONTROL Operation - READ Data Distribution . Click the Change button.
See the following for an example screenshot of the parameters in the ConfigPanel in the Data Filter tab, and a
table representing how to configure the parameters in the tab.
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.
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.
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.
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.
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 Asset Manager,
you may need to adjust the rules for one or more of the oMDO filters.
Many of the filters in SAP Asset 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.
Many of the common configuration changes made for an SAP Asset 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
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
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.
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. For a detailed
description of all oData mobile data object fields, see and the related subtopics.
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.
In the default configuration of SAP Asset Manager, work orders are distributed to technicians based on basic
parameters. Your site may wish to distribute work orders to users based on the order type.
By default, all Plant Maintenance specific order types are included in the synchronization logic for the SAP
Asset Manager application.
In many environments, one or more order types are added to SAP Mobile Add-On specifically for work orders
that are distributed to technicians. The added order types indicate that SAP Asset Manager will only download
certain specified work orders. To support this distribution method, change the data filter rules of the OMDOs
involved in work order synchronization. The OMDOs include:
● SAM2010_ORDER_TYPE
● SAM2010_WORK_ORDER_GENERIC
Creating rules based on work order types affects synchronization processing and work order downloads to the
mobile devices of your users.
Prerequisites
● The order types for work orders that are downloaded to technicians using the SAP Asset Manager
application are already determined.
● The person performing the procedure has access to the Config Panel and permissions to change settings.
Context
The following procedure modifies the synchronizing behavior of the SAP Asset Manager application so only
work orders with a given order type or types are downloaded to the client. In the procedure, you’ll change the
ORDER_TYPE filter in the OMDOs involved in work order synchronization. Specifically, you add rules to the
filter in each OMDO to include only the desired work order types. You add a rule for each order type to include.
If you don’t create a rule for a work order type, then those work order types are excluded from the work order
download synchronization processing. If the work orders are excluded from the synchronization processing,
then the work orders aren’t present on the mobile clients of your users.
Procedure
1. From the Config Panel home page, click the OData Mobile Data Object Configuration link, then click the
Data Filter tab. Be sure to have your desired mobile application chosen in the Mobile Application Filter field
at the top of the page.
2. Expand the OData Mobile Data Object by Mobile App list on the left and click SAM2010_ORDER_TYPE.
3. Expand the Standard Filter in the Defined Filters pane, and click the ORDER_TYPE filter.
4. View the rule list for the filter, which is empty in the default configuration of SAP Asset Manager. Click the
Change button.
5. Create a rule for each order type included in the work order distribution to the SAP Asset Manager
technicians. The settings for the rule are as follows:
○ DOF Rule Type: Static Value in Range Format
○ Sign: Inclusive
○ Option: =
○ Low Value: The desired order type
For more details on adding or editing filter rules, see Changing oData MDO Filter Rules [page 92].
8. Expand the Operation - READ Data Distribution in the Defined Filters pane, and click the
ORDER_TYPE filter.
9. View the rule list for the filter, which is empty in the default configuration of SAP Asset Manager. Click the
Change button.
10. Create a rule for each order type included in the work order distribution to the SAP Asset Manager
technicians, as you did with the previous OMDO filter. The settings for the rule are as follows:
○ DOF Rule Type: Static Value in Range Format
○ Sign: Inclusive
○ Option: =
○ Low Value: The desired order type
11. Save the changes.
Results
After you finish the procedure, work orders are downloaded by the SAP Asset Manager application only if their
work order type is set to a type for which a filter rule was created. Other work order types aren’t retrieved by
the application.
Business object distribution defines the data that needs to be downloaded to the mobile device based on the
resource planning of technicians for different business objects, such as work order and notification. You can
use this configuration to define which technicians has to complete which activities on the mobile device.
Implementation environments in different business industries or business types may use a different business
object model from the default to determine the proper technician assignment for a business object such work
order and notification.
By default, the SAP Asset Manager application determines the assignment of a work order using the personnel
number of the work order header. However, you can make minor configuration changes to support several work
assignment models.
For some customers using Assignment Type 3 for work orders,viewing a list of suboperations is more important
than viewing a list of operations. Work order headers are still visible. You can configure your preference using
the ConfigPanel for SAP Asset Manager.
Implementation environments in different business industries or business types may use a different business
model from the default to determine the proper technician assignment for a work order.
The following assignment types are supported with minor configuration changes:
Note
● Assignment Type 1: Header-level person responsible for the work order (default, no change required)
● Assignment Type 2: Operation-level personnel number of the work order
● Assignment Type 3: Sub-operation-level personnel number of the work order
● Assignment Type 4: Capacity requirement personnel assignment
● Assignment Type 5: Header-level planner group*
Prerequisite: Mobile user has to have the user parameter IHG set up in the user profile parameter.
● Assignment Type 6: Operation- or task-level work center*
Prerequisite: Mobile user has to have the user parameter AGR set up in the user profile parameter.
● Assignment Type 7: Header-level business partner*
● Assignment Type 8: Header-level of the work center*
Prerequisite: Mobile user has to have the user parameter VAP set up in the user profile parameter.
● Assignment Type A: Multi resource scheduling (MRS)
● Assignment Type Z: Other (custom BAdI option)*
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 SAM2010_WORK_ORDER_GENERIC, and then the Data Filter
tab.
3. Expand the Defined Filters list as follows; Operation - READ Data Distribution and click
WO_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.
Note
If you’re configuring an operation level assignment type, you must update the OPER_EXCL_SYST_STAT
filter with the I0009 - CNF:Confirmed value. However, remove the value if you’re configuring a header
level assignment type.
By default, the SAP Asset 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:
Note
The SAP HR module is required for Assignment Type 1 and Assignment Type 2.
● Assignment Type 1: Header-level person responsible for the work order (default, no change required)
● Assignment Type 2: Task-level personnel number of the work order
● Assignment Type 3: Header-level planner group*
Prerequisite: Mobile user has to have the user parameter IHG set up in the user profile parameter.
● Assignment Type 4: Header-level business partner*
● Assignment Type 5: Header-level of the work center*
Prerequisite: Mobile user has to have the user parameter VAP set up in the user profile parameter.
● Assignment Type D: Dependent Queue
By default, this assignment is based on the technician’s work order dependent collection*.
● Assignment Type Z: Other (custom BAdI option)*
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 SAM2010_NOTIFICATION_GENERIC, 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.
A large set of records could affect performance on the SAP Asset Manager client. Therefore, you can employ
more filtering based on the status of equipment.
By default, SAP Asset 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 Asset Manager client,
modify the SAM2010_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.
For your given SAP Asset 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 SAM2010_EQUIPMENT OMDO.
Prerequisites
● 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, SAM2010_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 Asset Manager client.
Procedure
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
Results
When you finish the procedure, the equipment records downloaded by the SAP Asset Manager application are
filtered to only include records with the status or statuses configured in the filter rules.
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.
The default implementation of SAP Asset 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.
Prerequisites
● 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 SAP Mobile Add-On
● 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.
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.
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
SAM2010_CATS_TIMESHEET. 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
CatsTimesheet. See Setting up an OData Mobile Data Object [page 131] for more information.
Prerequisites
Be sure that you have installed the Customer Service component. See the instructions in the Asset Manager
Component Installation Guide for IOS for more information.
Note
Configuring Customer Service order types is optional and is required only if the Customer Service
component is enabled.
Procedure
6. Select SAM2010_WORK_ORDER_GENERIC from the list. Then select Data Filter tab Operation - READ
Data Distribution ORDER_TYPE
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.
7. To activate the Customer Service order type, click Change.
Results
Prerequisites
Be sure that you have installed the Customer Service component. See the instructions in the Asset Manager
Component Installation Guide for IOS for more information.
Note
Configuring Customer Service notification types is optional and is required only if the Customer Service
component is enabled.
Procedure
6. Select SAM2010_NOTIFICATION_GENERIC from the list. Then select Data Filter tab Operation - READ
Data Distribution NOTIF_TYPE
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.
7. To activate the Customer Service order type, click Change.
Results
Context
Note
Push configuration is available for SAP Asset Manager for Android starting with the 4.0 release.
Event-based push is supported for assignment types 1 (header-level person responsible for the work order) and
2 (operation-level personnel number of the work order). You can only configure push for one work order
assignment type at a time.
By default, work order push is enabled for whichever assignment type your work order OMDO is set to. You can
manually assign the WO_ASSIGNMENT_TYPE filter for your data distribution model to 1 or 2 to set a push
assignment type different to the assignment type of the work order data distribution.
Procedure
1. In the ConfigPanel, navigate to the OData Mobile Data Object Configuration section and find OMDO
SAM2010_WORK_ORDER_GENERIC. Ensure the filter WO_ASSIGNMENT_TYPE is set to 1 on the Data
Filter tab.
2. Return to the Home page of the ConfigPanel. Click the Push Scenario Definition link. Ensure that your
mobileapplication is selected in the Mobile Application Filter.
3. Ensure the Active flag for the SAM2010_EMERGENCY_WORKORDER_PUSH scenario on the General Data
tab is checked. Note that you can have both work order and notification pushes marked as Active because
they are separate objects.
4. Make sure the configuration in the Source Setting and Distribution Setting sections are correct. By default,
the <Source Object> for the work order operation push is the exchange object
SAM2010_WORK_ORDER_PUSH with the <Distribution Object> SAM2010_WORKORDER_PUSH.
5. Return to the ConfigPanel Home page, then navigate to the EFI Assignment section. In the Enhancement
Implementation Includes list, select /MERP/EFI_PM /MERP/CL_PM_AUFNR_EFI_EVT .
6. Click the Assignment tab. Ensure the Active checkbox is checked for the exchange object
SAM2010_WORK_ORDER_PUSH.
Context
Note
Push configuration is available for SAP Asset Manager for Android starting with the 4.0 release.
Event-based push is supported for assignment types 1 (header-level person responsible for the work order) and
2 (operation-level personnel number of the work order). You can only configure push for one work order
assignment type at a time.
By default, work order push is enabled for whichever assignment type your work order OMDO is set to. You can
manually assign the WO_ASSIGNMENT_TYPE filter for your data distribution model to 1 or 2 to set a push
assignment type different to the assignment type of the work order data distribution.
Procedure
1. In the ConfigPanel, navigate to the OData Mobile Data Object Configuration section and find OMDO
SAM2010_WORK_ORDER_GENERIC. Ensure the filter WO_ASSIGNMENT_TYPE is set to 2 on the Data
Filter tab.
2. Return to the Home page of the ConfigPanel. Click the Push Scenario Definition link. Ensure that your
mobileapplication is selected in the Mobile Application Filter.
Context
Event-based push is supported for notification assignment types 1 through 5. You can only configure push for
one notification assignment type at a time.
By default, notification push is enabled for whichever assignment type your notification OMDO is set to. You
can manually assign the NOTIF_ASSIGNMENT_TYPE filter for your data distribution model to 1, 2, 3, 4 or 5 to
set a push assignment type different to the assignment type of the notification data distribution.
1. In the ConfigPanel, navigate to the OData Mobile Data Object Configuration section and find OMDO
SAM2010_NOTIFICATION_GENERIC. Ensure the filter NOTIF_ASSIGNMENT_TYPE is set to the
assignment type of your choice (1 - 5) on the Data Filter tab.
2. Return to the Home page of the ConfigPanel. Click the Push Scenario Definition link. Ensure that your
mobile application is selected in the Mobile Application Filter.
3. Ensure the Active flag for the SAM2010_EMERGENCY_NOTIFICATION_PUSH scenario on the General
Data tab is checked. Note that you can have both work order and notification pushes marked as Active
because they are separate objects.
4. Make sure the configuration in the Source Setting and Distribution Setting sections are correct. By default,
the <Source Object> for the notification push is the exchange object SAM2010_NOTIFICATION_PUSH
with the <Distribution Object> SAM2010_NOTIFICATION_PUSH.
5. Return to the ConfigPanel Home page, then navigate to the EFI Assignment section. In the Enhancement
Implementation Includes list, select /MERP/EFI_PM /MERP/CL_PM_QMNUM_EFI_EVT .
6. Click the Assignment tab. Ensure the Active checkbox is checked for the exchange object
SAM2010_NOTIFICATION_PUSH.
Context
Note
Push configuration is available for SAP Asset Manager for Android starting with the 4.0 release.
1. From the ConfigPanel Home page, navigate to the Outbound Trigger Configuration section and select your
desired mobile application from the Mobile Application Filter dropdown menu at the top of the page.
2. From the Outbound Triggers by Mobile App list, select the outbound trigger
SAM2010_WORKORDER_TRIGGER_SCPMS. Make sure that the <Cloud Platform Mobile App ID>
matches your mobile services application ID from SAP Cloud Platform Mobile Services. By default, the
application ID is set to com.sap.<appXX>.oauth.prod.
3. Set up the RFC destination SAM2010_SCPMS_PUSH_NOTIFICATION pointing to the mobile services host
name using the SAP GUI:
a. In the SAP GUI, using transaction SM59, add the following new RFC destination:
SAM2010_SCPMS_PUSH_NOTIFICATION of type G (HTTP Connection to External Serv)
b. On the Technical Settings tab of the new connection, set the Target Host to match the push API of the
SAP Cloud Platform Mobile Services. Use service number 443, which is the port number of the HTTPS
connections.
Note
If necessary, configure the proxy that you are using to allow your back-end systems to connect to
the Internet.
Note
On the first delta sync, the SAP Asset Manager client automatically performs substeps a-d for you. If
desired, you can still perform these substeps to verify that the push registration process has
completed successfully.
a. Using the SAP GUI, launch the Admin portal with transaction code /n/SYCLO/ADMIN. On the Admin
portal home page, select Administration User Management . Make sure to select your desired
mobile application in the Mobile Application Filter field at the top of the page. Choose Search to list all
users for that application.
b. Select User ID under Search Result, and click the Client Registration Info tab under the Mobile User
Detail section. Choose Change from the menu bar.
c. Enter the matching CPms User Id (using upper case) for the back end user name listed under this tab.
d. Save your changes.
7. Return to the Home page of the ConfigPanel. Select the Push Scenario Definition page. Under Push
Scenarios by Mobile App list, select the desired push scenario definition. Click the Outbound Trigger tab
and ensure that the proper outbound trigger is assigned and active for the push scenario.
Prerequisites
Note
The SAP Asset Manager Installation Guide is a guide to setting up the basic framework necessary for push
services using the default settings. For more details regarding configuration of push services, see the Push
Scenario Definition [page 48] topic.
● SAP Asset Manager application on the device is running on Mobile Development Kit 2.2.001
● You have installed SAP Asset Manager 2010
● You have installed either SAP Mobile Add-On ECC or SAP Mobile Add-On for SAP S/4HANA. See the
following installation guides on the following portal pages for version information:
○ SAP S/4HANA Mobile Add-On
○ SAP Mobile Add-On ECC
Context
To configure and activate push for the Android platform, see the Configuring Push for Android [page 126]
procedure.
Procedure
c. If you are using a custom deployment of SAP Asset Manager, upload the corresponding APNs
certificates here. If you are using the default application provided by the Apple App or the Google Play
store, select Predefined for SAP Asset Manager in the Predefined Global Push Configuration section.
b. In the Technical Settings and tab of the new connection, set the Target Host to match the push API of
the SAP Cloud Platform Mobile Services, using 443 (the port number for HTTPS connections).
If necessary, configure the proxy you are using to allow your back end to connect to the outside
internet.
c. Click the Logon & Security tab. Under the Logon Procedure, select Basic Authentication. Enter the user
name and password of a service user.
d. In SAP Cloud Platform, ensure your service user has the role of Notification User assigned to them to
ensure that the user is allowed to utilize the SAP Cloud Platform Mobile Services API. The service user
must be a member of the SAP Cloud Platform account.
e. In the Security Options section of the Logon & Security tab, ensure that the <SSL Secure Protocol>
is set to Active.
f. Remaining in the Security Options section, ensure that the SSL Certificate List used contains the SAP
Cloud Platform certificate chain and is active.
g. Save the connection and perform a connection test. If the configuration is completed properly, a 200
HTTP response is returned.
b. Click the Parameters tab. If your user store on the back end and user store on the SAP Cloud Platform
are identical, set the SCPMS_WITH_SAP_USER_ID parameter value to True. If the user stores are not
identical, set the parameter to False.
c. Return to the ConfigPanel home screen and click the Push Scenario Definition link. Navigate to the
Outbound Trigger tab. Find and highlight the push on the list of Push Scenarios by Mobile App and
ensure that the outbound trigger is active.
Results
Push services are activated for SAP Asset Manager. Thoroughly test the push functionality before deploying to
the client devices.
Prerequisites
Note
The SAP Asset Manager Installation Guide is a guide to setting up the basic framework necessary for push
services using the default settings. For more details regarding configuration of push services, see the Push
Scenario Definition [page 48] topic.
● SAP Asset Manager application on the device is running on Mobile Development Kit 2.2.001
● You have installed SAP Asset Manager 2010
● You have installed either SAP Mobile Add-On ECC or SAP Mobile Add-On for SAP S/4HANA. See the
following installation guides on the following portal pages for version information:
○ SAP S/4HANA Mobile Add-On
○ SAP Mobile Add-On ECC
Context
To configure and activate push for the Android platform, see the Configuring Push for Android [page 126]
procedure.
Procedure
c. If you are using a custom deployment of SAP Asset Manager, upload the corresponding APNs
certificates here. If you are using the default application provided by the Apple App or the Google Play
store, select Predefined for SAP Asset Manager in the Predefined Global Push Configuration section.
Note
In a Cloud Foundry environment, you must use email instead of an I-number to utilize push
notifications in the Administration portal.
If necessary, configure the proxy you are using to allow your back end to connect to the outside
internet.
c. Click the Logon & Security tab. Under the Logon Procedure, select Basic Authentication. Enter the
Mobile Push Notification Alias as the user name and the Mobile Push Notification API Key as the
password.
d. In Mobile Services, ensure your service user has the API Key assigned to them to ensure that the user
is allowed to utilize the SAP Cloud Platform Mobile Services API. This API key is the same value used as
the password in the RFC Destination.
Basic authentication for this service user allows for free communication flow.
e. In the Security Options section of the Logon & Security tab, ensure that the <SSL Secure Protocol>
is set to Active.
f. Remaining in the Security Options section, ensure that the SSL Certificate List used contains the SAP
Cloud Platform certificate chain and is active.
g. Save the connection and perform a connection test. If the configuration is completed properly, a 405
code is returned.
j. On the additional properties tab, create a new property with the following attributes:
○ Property Group: PUSH
○ Property Name: X-API-Key
○ Property Value: Mobile push API key from SAP Cloud Platform Mobile Services
b. Click the Parameters tab. If your user store on the back end and user store on the SAP Cloud Platform
are identical, set the SCPMS_WITH_SAP_USER_ID parameter value to True. If the user stores are not
identical, set the parameter to False.
Results
Push services are activated for SAP Asset Manager. Thoroughly test the push functionality before deploying to
the client devices.
Firebase Cloud Messaging (FCM) is a cross-platform cloud solution for messages and notifications for Android,
iOS, and web applications.
Context
To enable push notification for the SAP Asset Manager application using the Android platform, use the
following procedure:
Procedure
1. Create a free Firebase account. See the main Firebase page to set up a new account, or connect an
existing account.
Note
4. Copy and paste the information in the Server Key field to use in a later step.
Your app is registered and you’re moved to Step 2 - Download config file.
For instructions on how to enable Android push notifications in SAP Cloud Platform Mobile Services, see
the Android Push Notifications procedure.
For detailed information on configuring push for the SAP Asset Manager application, see the procedure
Activating Default Push Services for SAP Asset Manager, specifically the screenshot in Step 1d.
Next Steps
Continue to the procedure Setting up the Outbound Trigger for your Push Configuration [page 106].
https://help.sap.com/viewer/DRAFT/f15c174c3c3647088d38fb220e42c006/latest/en-US/
5629175b49304549b724bc838c9a72ec.html
For OData troubleshooting information, see OData API in the SAP Cloud Platform documentation.
The following table lists the OData features that SAP Mobile Add-On supports.
$inlinecount Supported
$skiptoken Supported
$format Supported
Navigation Supported
Tombstone Supported
$batch Supported
Deep insert Supported via single post operation and through $batch re
quest using content ID referencing
$filter Details
● 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)
Note
For related constraints, see SAP Note 1830712 .
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 Asset 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
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.
Next Steps
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 133]
Procedure
1. Navigate to and click the Mobile Application Integration Framework Configuration Home OData Mobile
Data Object Configuration link.
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
Next Steps
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
● Setting the OData Mobile Data Object Service Assignment [page 133]
● Setting the OData Mobile Data Object Configuration [page 135]
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.
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
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.
Procedure
1. Navigate to and click the Mobile Application Integration Framework Configuration OData Model
Configuration link.
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
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.
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 Asset 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.
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.
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.
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 Asset 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.
Use parameters to enable the checklist feature and configure other checklist options available.
Context
To configure the checklist feature for SAP Asset Manager, use the CHECKLISTS parameter group and the
following parameters within the group:
The CHECKLISTS parameters correspond to the rules found in the OData mobile data object
SAM2010_ASPM_CHECKLIST. You can add a 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.
2. You can scroll down to find the CHECKLISTS group parameters, listed in the Context section, or perform a
search using the Search box. Highlight the parameter you want to configure and click the Change button.
Results
Next Steps
Continue to the following procedures to finish configuring the checklist feature for ASPM:
● Setting Up an ASPM Connection to the ASPM System to Use Checklists [page 145]
●
The RFC destination is already created and connected to the ASPM out of box. However, an oAuth connection
from the ASPM Cloud Foundry system to SAP Asset Manager is required.
Prerequisites
Use the Integration of Asset Central Foundation with SAP EAM guide to establish an oAuth connection. Pay
attention to the Server Management Properties topic.
Context
Use the following procedure to create and configure an oAuth connection from the ASPM Cloud Foundry
system to SAP Asset Manager.
Procedure
The ASPM readiness check program on the SAP GUI checks the readiness of the ASPM checklist feature.
Note
Before following the instructions in this topic, ensure that you’ve performed the Setting Up an ASPM
Connection to the ASPM System to Use Checklists [page 145] procedure.
Using the SAP GUI, execute the program /MERP/CORE_READINESS_CHK_PROG to run the readiness check.
The readiness check program gives three options to check or complete the ASPM checklist for SAP Asset
Manager:
This checkbox disables the rest of the inputs on the screen if checked. Choosing this option runs the program
in check-only mode. No RFC destination or configuration is made.
Output
Use this checkbox to reuse the ACI app if it exists. Selecting this option uses the same RFC destination and
authentication properties to create a new server configuration.
Create the RFC destination or middleware server configuration: Using the RFC Destination section, give an
RFC Destination, select an oAuth Method and oAuth Value. An RFC destination and/or middleware server
configuration is created if they don't already exist.
If the RFC destination and middleware configuration don't exist; the program redirects to the RFC Destination
Creation screen. Once the RFC destination is ready, it creates a middleware server management entry in the
configuration tables for SAP Asset Manager.
Note
For SAP_BASIS release 752 and above, use the radio button oAuth Profile and property
AUTH_OAUTH_PROFILE. For earlier versions, use the radio button oAuth RFC and property
AUTH_OAUTH_RFC.
Output
Troubleshooting
If the readiness check program output shows the RFC connection test failed, perform a manual test. Make sure
to add a proxy and/or certificate to STRUST if needed.
You can manually change the middleware server configuration via /SYCLO/ADMIN.
Next Steps
If you’re using SAP Asset Manager with authenticated GIS, continue to the Readiness Check for Authenticated
GIS Maps [page 153] topic.
Context
Note
Before performing this procedure, follow the appropriate ASPM readiness check. See the Checking the
Readiness of the ASPM System [page 148] topic for details.
Procedure
2. Create the RFC Destination: Creating the RFC destination stores the GIS server login credentials and adds
them to the mobile application parameter.
The /SYCLO/ADMIN ConfigPanel entry the Authenticated GIS readiness check program checks or creates
is shown in the following example:
SAP Asset Manager for Field Operations Worker uses the digital core with SAP S/4HANA for task driven
activities and rounds. It supports workers who perform asset inspections and checks with focus on
measurement points and on smaller services and repairs.
Field Operations Worker, or FOW, is an add-on component to SAP Asset Manager. If you don’t see FOW
features while using the SAP Asset Manager application, or in the ConfigPanel, your site hasn’t installed the
component.
Field Operations Worker adds the following functionality to the core SAP Asset Manager application:
● View routes data: A route is comparable to a work order in the base SAP Asset Manager application.
● View stops data: A stop in Field Operations Worker is comparable to an operation in the base SAP Asset
Manager application. A route is composed of one or more stops.
● View asset information: An asset in Field Operations Worker is comparable to a piece of equipment in the
base SAP Asset Manager application. Assets are located at an FOW stop.
● Use field data capture to take readings on measurement points. Measurement points are located on assets
or a set of assets at a route stop.
Creating rules based on order types affects synchronization processing and order downloads to the mobile
devices of your users who use the Field Operations Worker component.
Prerequisites
● The order types for work orders that are downloaded to technicians using the Field Operations Worker
component are already determined.
● The person performing the procedure has access to the Config Panel and permissions to change settings.
Context
Note
Field Operations Worker orders are a subset of the base SAP Asset Manager application work orders.
If you don’t create a rule for the PM02 order type, then that order type is excluded from work order download
synchronization processing. If the FOW orders are excluded from synchronization processing, then the orders
aren’t present on the mobile clients of your users.
Procedure
1. Click the OData Mobile Data Object Configuration link, then click the Data Filter tab from the main
ConfigPanel page. Be sure to have your desired mobile application chosen in the Mobile Application Filter
field at the top of the page.
Selecting an application filters the OData Mobile Data Object by Mobile App choices in the left panel with
only OMDOs available in your application.
2. Expand the OData Mobile Data Object by Mobile App list on the left and click SAM2010_ROUTE.
3. Select the Data Filter tab.
4. Click the Operation - READ Data Distribution ORDER_TYPE node in the Defined Filters list.
5. Create a rule using the following parameters if the rule doesn’t already exist:
○ DOF Rule Type: Static Value in Range Format
○ Sign: Inclusive
○ Option: =
○ Low Value: PM02 - Maintenance order
○ Ensure the Active Flag box is checked
Results
After you finish the procedure, both Field Operations Worker orders and base SAP Asset Manager work orders
are downloaded by the SAP Asset Manager application.
Linear assets are technical systems with a linear infrastructure whose condition and properties can vary from
section to section (dynamic segmentation). You can see linear asset data associated with various objects such
as work orders, operations, technical objects, and notifications.
In addition to the basic SAP Asset Manager configuration, there are a few considerations when configuring SAP
Asset Manager with Linear Asset Management (LAM).
Note
Before configuring LAM on your system, see 2900476 so that the LAM exchange works properly.
Linear Asset Management (LAM) is especially designed to meet the requirements of linear asset maintenance.
A linear asset is a special type of asset that has an associated length dimension. This dimension is represented
through starting and ending points or by specifying the asset length. For the mobile device, the linear asset
management functionality enables the field technician to work on orders and notifications that have linear
equipment and functional locations. Field personnel can create work orders, notifications, time confirmations,
and material confirmations for the linear assets.
From the mobile device, you can view linear data for the following:
● Work orders
● Operations
● Notifications
● Items
● Equipment
● Functional locations
● Confirmations
● Measuring points
● Measurement documents
Ensure that the Active Flag flag for the LAMparameter is checked. In addition, define several MDOs and objects
for the complex table and data table.
● LAM_OBJECT_DATA
● LAM_OFFSET_TYPE
● LINEAR_REFERENCE_PATTERN
For general information on configuring OMDOS, see the OData Channel Integration Settings Procedures topics
found in the Mobile Add-On Configuration Configuration Panel Common Procedures chapter of this guide.
The functionality of adding or editing linear data for characteristics defines segments of a linear asset where a
specific attribute, or characteristic value, is valid. A segment is defined by start point, end point, length, and
unit of measurement (linear data).
Note
● Linear data for characteristics works only for characteristics that are marked as relevant for linear
asset management.
● To use linear data for characteristics, create a special Organizational Area and assign it to the relevant
classes and characteristics.
The Meter Management component is delivered out of the box with predefined settings, which you can change
according to your back-end system setup. The following settings, however, have to be set:
● Binding Industry Solutions & Utilities (ISU) process type to work order type
● Setting the optimal meter reading history
● Binding meter reading reason relevant for technical installation
● Binding meter reading notes based on the ISU process type
Binding the ISU process type to the work order type provides the SAP Asset Manager application the correct
representation of what process type is being conducted with the different work order types. This binding is
located in the SAM2010_ORDER_ISULINK OMDO, under the Read filter. You can update these filters according
to your business process.
Assignment types 1, 2, and 3 are supported for the Meter Management component.
The following filters represent binding criteria for different process types. By default, the ISU process types are
bound to order types as follows:
Mandatory
Mandatory
Mandatory
1. On the ConfigPanel home page, choose OData Mobile Data Object Configuration.
Make sure that 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 desired OMDO object, such as SAM2010_ORDER_ISULINK,
and then click the Data Filter tab.
3. Expand the Defined Filters list under the READ operation with the standard filter. Select the filter that you
want to update from the list of available filters as listed in the table in this topic. Choose the Change button
from the menu.
4. Set the order type for the desired process type you have selected.
5. Save your changes.
The back end ISU system configuration specifies which meter reading notes are relevant for the major ISU
process types. This configuration has to be replicated in the OData Mobile Data Object
SAM2010_METER_READING_NOTE under the READ operation with the standard filters, so that the SAP Asset
Manager application reflects the proper meter reading notes for a specific process type. The default
configuration lists the meter reading notes relevant for the ISU process. However, you can change it if you have
different requirements in your back end configuration.
05
METERREAD_NOTE _IN Standard Filter, Mandatory 01 Used for the meter reading
STALL notes for the installation
04
process
METERREAD_NOTE _RE Standard Filter, Mandatory 04 Used for the meter reading
MOVE notes for the remove process
05
To change the default binding for a particular process, complete the following steps:
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 desired OMDO object, such as
SAM2010_METER_READING_NOTE, and then click on the Data Filter tab.
3. Expand the Defined Filters list under the READ operation with the standard filter. Select the filter that you
want to update from the list of available filters as listed above. Choose the Change button from the menu.
The default setting for meter reading history is to include all meter readings from the past 30 days till the
current day. If you have a different requirement, you can change it from the OData Mobile Data Object
SAM2010_METER_READING under the READ operation with the standard filter METERREAD_SCHEDDATE as
shown in the following example.
The back end ISU system configuration specifies explicitly which meter reading reasons are relevant for
technical installation. These are the only reasons displayed on the SAP Asset Manager application when
completing a meter reading during the technical installation process. Set this binding in the OData Mobile Data
Object SAM2010_METER_READING_REASON under the READ operation with the standard filter
MR_REASON_TECHINST.
The default configuration contains meter reading reasons 08 and 09 as required for technical installation. If
you have different requirements for your back end configuration, you can change these defaults.
The Quality Management application component supports tasks associated with quality planning, quality
inspection, and quality control. In addition, it controls the creation of quality certificates and manages
problems with the help of quality notifications.
Quality Management (QM) notifications are integrated with SAP Asset Manager as follows:
Note
Before configuring QM, you must install the QM component. See the Quality Management chapter in the
SAP Asset Manager Component Installation Guide for the installation procedure.
Quality Management is disabled on an out-of-the-box new SAP Asset Manager installation. Use the following
topics and procedures found in this chapter to enable Quality Management.
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:
Use the following parameter groups and associated parameters to configure Quality Management in SAP Asset
Manager:
● QMFORMULA: Inspection lots can contain points or characteristics. You can use the following formula
parameters to determine the characteristic value:
○ C0: Arithmetic mean of measured values for characteristic. Standard parameter.
○ C5: Upper limit of tolerance range
○ C6: Lower limit of tolerance range
○ C7: Target value of characteristic
● CATALOGTYPE: Sets a usage decision on inspection lots on the client. Standard is 3
● DOCUMENT: Standard is QMQMEL
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.
2. Type your desired parameter group into the Search box, or scroll to find your parameter. Highlight the
parameter you want to configure and click the Change button. The following example uses the parameter
group QMFORMULA.
Results
Complete all other topics and procedures in the Quality Management Configuration [page 165] to fully
configure and enable the Quality Management feature.
For general information and a procedure on changing OMDO data filters, see the following topics:
To fully enable Quality Management, ensure that the following data filters and data filter rules are configured
properly and active:
SAM2010_CATALOG_CODES
Select SAM2010_CATALOG_CODES from the oData Mobile Data Object List and navigate to Operation -
READ Standard Filter CATALOG_TYPE . Ensure the following rules in the <Rule Value> field are set to
Active:
● 8 - Activities (QM)
● 9 - Defect Types
● D - Coding
SAM2010_DOCUMENT
When you enable QM on the SAM2010_DOCUMENT data filter, you enable the ability to attach documents to
an inspection. When mobile client users take a reading on the SAP Asset Manager application, they can attach
documents that relate to the inspection on work orders, equipment, functional locations, or notifications.
Select SAM2010_DOCUMENT from the oData Mobile Data Object List and navigate to the following locations:
● QMQEL: QM notification
● QMTBLOC: Inspection method
SAM2010_INSPECTION_LOT
Set the dependency to get inspection lots based on work orders related to the inspection assigned to the
mobile client user as follows:
Select SAM2010_INSPECTION_LOT from the oData Mobile Data Object List and navigate to Operation -
READ Data Distribution OBJECT_DISTRIBUTION_MODE . Ensure that <Range Value> 2 - Dependency
Queue is set to Active.
Navigate to the Dependent Object tab. Ensure that <Source Tech Entity Type> INSPECTIONLOT is
connected to <Dependent oMDO ID> SAM2010_NOTIFICATION_GENERIC and is set to Active. When a
mobile client user fetches the inspection lots, the related defects, created as QM notifications, are fetched as
well.
Ensure that <Source Tech Entity Type> INSPECTIONCHAR is connected to <Dependent oMDO ID>
SAM2010_INSPECTION_HISTORY and is set to Active. The fetched inspection history is based on the
inspection characteristics available.
SAM2010_NOTIFICATION_GENERIC
Select SAM2010_NOTIFICATION_GENERIC from the oData Mobile Data Object List and navigate to
Operation - READ Data Distribution NOTIF_ASSIGNMENT_TYPE . Ensure that <Range Value> D is
active.
Navigate to Operation - READ Data Distribution NOTIF_TYPE . Ensure that <Input Parameter> QM is
active.
SAM2010_NOTIF_PARTNER_DET_PROC
Select SAM2010_NOTIF_PARTNER_DET_PROC from the oData Mobile Data Object List and navigate to
Operation - READ Standard Filter NOTIF_TYPE . Ensure that <Input Parameter> QM is active.
Select SAM2010_NOTIF_TYPE from the oData Mobile Data Object List and navigate to Operation - READ
Standard Filter . Ensure that Quality Management is enabled in the following locations:
SAM2010_PRIORITY
Select SAM2010_PRIORITY from the oData Mobile Data Object List and navigate to Operation - READ
Standard Filter PRIORITY_TYPE . Ensure that <Rule Value> QM is active.
SAM2010_WORK_ORDER_GENERIC
Enable the dependency between a work order and a related inspection lot on the mobile device:
Navigate to the Dependent Object tab. Find the WOHEADER objects in the <Source Tech. Entity Type>
column. Scroll to find the SAM2010_INSPECTION_LOT object. Ensure it is marked as Active.
SAP Web IDE is a browser-based IDE consisting of integrated parts that interact with each other and with an
SAP system.
SAP Web IDE Full-Stack streamlines the end-to-end application lifecycle – easily develop, test, build, deploy,
and extend role-based, consumer-grade apps for business users. Create applications rapidly and deliver an
outstanding user experience. Developers can extend or build SAP Fiori apps, create SaaS solutions, extend
SAP S/4HANA cloud services, develop hybrid mobile applications, and build IoT apps for SAP Leonardo, using
the UI development toolkit for HTML5 (SAPUI5) for desktop and mobile devices, SAP HANA toolset, and Java
programming language and technologies. Since SAP Web IDE Full-Stack runs on SAP Cloud Platform, it needs
no installation and allows you to integrate with other services that run on the platform – such as SAP Fiori
Cloud apps, Git integration, mobile services, IoT services, and more.
Architecture
The following diagram provides high-level typical architecture for SAP Web IDE Full-Stack.
Component Description
SAP Cloud Platform SAP Cloud Platform enables customers and partners to rap
idly build, deploy, and manage cloud-based enterprise appli
cations that complement and extend your SAP or non-SAP
solutions, either on-premise or on-demand.
SAP Cloud Platform cockpit Central point for managing all activities associated with your
SAP Cloud Platform account and for accessing key informa
tion about your applications.
SAP Web IDE application Integrated development environment used to create or ex
tend SAP UI5 or SAP Fiori applications.
SAPUI5 User interface technology that is used to build and adapt cli
ent applications.
SAP Cloud Platform connector Allows SAP Web IDE and SAP Cloud Platform to connect to
an on-premise system securely and with minimal configura-
tion effort.
SAP Gateway Provides a simple way to connect SAP Web IDE to an exter
nal SAP system with access to OData functionality.
Note
When working in SAP Web IDE, the following operations may be processed by our partner Infrastructure-
as-a-Service (IaaS) providers:
● Code completion
● Code validation
These operations may involve transfer and process of data in different regions.
Who is it for?
SAP Web IDE is a flexible tool for developers who want to dive right into the code editor without having to spend
time configuring and administering the development environment.
The tool is aimed at developers who need a modern and secure environment to create new or extend existing
SAP Fiori, SAPUI5, or hybrid applications. Developers are provided with a comprehensive set of tools, including
strong code editors with templates, wizards, beautifier capabilities, code completion, code snippets, code
validation, code checking, WYSIWYG, and many more features.
Note
The Mobile Development Kit for SAP Cloud Platform Mobile Services is a metadata-based application
development platform.
The Mobile Development Kit (MDK) lets you customize, deploy, and manage your customized iOS and Android
apps in the cloud. The Mobile Development Kit editor lets you edit various aspects of your application using the
Mobile Development Kit editor. It also provides native client support and consumes mobile services such as
onboarding, offline OData, life-cycle management, and supportability through the using the Mobile
Development Kit client.
The Mobile Development Kit allows business process experts to customize the app in a cloud-based editor
using the SAP Web IDE, and developers to edit code directly in the metadata files.
The end-to-end use case for Mobile Development Kit includes tasks involving the following roles:
● Administrator
● Business process expert
● Developer
● User
One of the main purposes of the Mobile Development Kit is to easily customize and redeploy metadata for your
SAP Asset Manager application.
Restriction
Develop any customization on the app as a separate component in a Mobile Development Kit project.
Developing customizations as a component makes it easier to maintain customizations during upgrades,
as it isolates custom code. Isolating your custom code eliminates the chance of overwriting when you
implement a new release.
A typical metadata customization procedure is as follows. This example assumes that metadata definitions
already exist in the Mobile Development Kit and that you’re customizing them, or changing them:
1. Locate the object you want to modify. You can modify pages, actions, or rules. See the following topics and
subtopics for more information on how to create and modify the following metadata objects using the
Mobile Development Kit:
○ Create Pages
○ Create Actions
○ Create Rules
2. Deploy the metadata. See Deploying App Metadata from Editor to Mobile Services for more information.
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:
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 Asset 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.
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 SAM2010_EQUIPMENT,
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.
By default, the SAP Asset Manager application determines the assignment of work orders and notifications
using the personnel number assignment at header level. However, implementation environments in different
industries or business types may use a different assignment model from the default to determine the proper
technician assignment for work orders and notifications. The SAP Asset Manager application supports several
assignment models; you only need to change the assignment type configuration for the specific model.
See Business Object Distribution by Assignment Model [page 95] for more details about assignment model
distribution, and how to change assignment type for both work order and notification.
The filters listed in the following table are common to all SAP Asset Manager distribution rules. See the specific
rules for details on filter requirements for those rules.
WO_ASSIGNMENT_TYPE Data Distribution, Mandatory See specific rule Defines which distribution model is
for value used
ORDER_CATG Data Distribution, Optional See specific rule Restricts work order distribution
for value based on work order category. For
maintenance orders, it should be
value 30.
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.
The standard SAP Asset Manager application work order distribution is controlled by the OMDO (OData mobile
data object) SAM2010_WORK_ORDER_GENERIC READ operation. It supports several data distribution
models for the work order.
You can choose the appropriate distribution model based on your specific business processes and
requirements.
Requirements
The following are requirements before configuring the distribution model for Distribution by Work Order
Header Person Responsible:
Requirements
The following are requirements before configuring the distribution model for Distribution by Work Order
Header Person Responsible:
● Mobile user (i.e., the technician) must have an employee number (personnel number) assigned in SAP
● Employee number is assigned to the work order operation as the person responsible
● Work order is released
● Work order is not marked for deletion
Requirements
The following are requirements before configuring the distribution model for Distribution by Work Order
Suboperation Person Responsible:
● Mobile user (i.e., the technician) must have an employee number (personnel number) assigned in SAP
● Employee number is assigned to the work order suboperation as the person responsible
● Work order is released
● Work order is not marked for deletion
Requirements
The following are requirements before configuring the distribution model for Distribution by Capacity
Requirement Person Responsible:
● Mobile user (i.e., the technician) must have an employee number (personnel number) assigned in SAP
● Employee number is assigned to the work order capacity requirement split records as the person
responsible
● Work order is released
● Work order is not marked for deletion
Requirements
The following are requirements before configuring the distribution model for Distribution by Work Order
Header Planner Group:
● Mobile user (i.e., the technician) has been assigned to the planner group based on the business
● Employee number is not required
● Planner group associated with the mobile user is assigned to the work order header
● Work order is released
● Work order is not marked for deletion
Requirements
The following are requirements before configuring the distribution model for Distribution by Work Order
Operation Work Center:
● Mobile user (i.e., the technician) has been associated with a work center in business
● Employee number is not required
● Work center associated with the mobile user is assigned to work order operation
● Work order has been released
● Work order has not been marked for deletion
Requirements
The following are requirements before configuring the distribution model for Distribution by Work Order
Header Business Partner:
Requirements
The following are requirements before configuring the distribution model for Distribution by Work Order
Header Work Center:
● Mobile user (i.e., technician) has been associated with a work center based on the business
● Employee number is not required
● Work center associated with the mobile user is assigned to the work order header
● Work order is released
● Work order is not marked for deletion
Requirements
The following are requirements before configuring the distribution model for Distribution through MRS
Scheduling Engine:
● MRS has been implemented in the SAP system, and is responsible to schedule and update work order
capacity records with the assigned technician
● Employee number is required for the mobile user
● Work order is released
● Work order is not marked for deletion
Requirements
The following are requirements before configuring the distribution model for Distribution by Free Search:
● Free search criteria for the work order. Used for an OnDemand work order look-up scenario.
● Employee number is not required
● Work order is released
● Work order is not marked for deletion
The OMDO (OData mobile data object) SAM2010_NOTIF_ASSIGNMENT_TYPE READ operation controls the
standard SAP Asset Manager application notification distribution. It supports several data distribution models
for the notification.
You can choose the appropriate distribution model based on your specific business processes and
requirements.
Notification requests are assigned to the technician directly or assigned through the work center, planner
group, or related business partner of the technician. The SAP Asset Manager application supports these
different assignment types while downloading notifications associated with the technician.
● 1 - Header Level Person Responsible: Assign this notification to the HR personnel number of the
technician through the notification header Partner section.
● 2 - Notification Task Level Personnel Number: Assign this notification to the HR personnel number of the
technician through individual Task Personnel Number field.
● 3 - Header Level Planner Group: Assign this notification to the planner group associated with the
technician through the header level Planner Group field.
● 4 - Header Level Business Partner: Assign this notification to the business partner associated with the
technician through header level Partner Function Maintenance. The business partner can be anyone related
to the notification partner function and associated with the technician, such as user responsible, sold-to-
party, or other party. If there is no MAM configuration set up for the user, the default configuration uses
VU-User Responsible as the default partner function and the technician SAP User ID as the partner
number.
● 5 - Header Level Work Center: Assign this notification to the work center associated with the technician
through the header level Work Center field.
● D - Dependency Queue: Enables the dependency queue from the work order. When active, all notifications
associated with a work order are downloaded, as well as qualifying data based on additional distribution
rules that are set.
Customers can choose the appropriate distribution model based on their specific business processes and
requirements.
Requirements
The following are requirements before configuring the distribution model for Distribution by Notification header
Person Responsible:
Requirements
The following are requirements before configuring the distribution model for Distribution by Notification task
level Personal Responsible:
Requirements
The following are requirements before configuring the distribution model for Distribution by Notification header
level Planner Group:
Requirements
The following are requirements before configuring the distribution model for Distribution by Notification header
level Business Partner:
Requirements
The following are requirements before configuring the distribution model for Distribution by Notification header
level Work Center:
Requirements
The following are requirements before configuring the distribution model for Distribution by Free Search:
● Free search for notification used for an on-demand notification look-up scenario
● Employee number is not required
● Notification is not marked for deletion
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.
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 Asset 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.
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:
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.
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.
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.
For information about how to configure and activate the payload trace tool, see Tracing Tools: Configuration in
the SAP Gateway Technical Operations Guide.
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.
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 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.