SAP Service and Asset Manager Configuration Guide
SAP Service and Asset Manager Configuration Guide
1 Document History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3 Supported Features for SAP Service and Asset Manager for Windows. . . . . . . . . . . . . . . . . . . . 8
3.1 Supported SAP Transaction Codes for SAP Service and Asset Manager. . . . . . . . . . . . . . . . . . . . . . 10
10 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
10.1 SAP Gateway Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
10.2 SAP Gateway Error Logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
10.3 SAP Gateway Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
The following table provides an overview of the most important document changes.
Note
This guide only covers setting up and enabling the SAP Service and Asset Manager application on a
Windows platform.
The SAP Service and 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 setup of SAP.
Use the SAP Service and Asset Manager Configuration Guide along with appropriate SAP documentation.
SAP Service and 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 Service and Asset Manager allows remote employees to access, complete,
and manage their assigned work orders and notifications through their devices. With SAP Service and
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.
SAP Service and Asset Manager comes packaged with a mobile add-on for SAP ERP and a mobile add-on for
SAP S/4HANA. They offer tight integration and easier deployment without interference to or from your existing
SAP system customizations or standard SAP objects. They provide you with full configuration, administration,
and monitoring features that allow you to manage the SAP Service and Asset Manager application from within
your SAP system infrastructure.
SAP Service and Asset Manager supports the following back-end systems:
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
Service and 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 Service and Asset Manager for Windows allows a single user to be assigned the Maintenance Technician
Persona role. The table below shows the main functions of the persona.
Note
For more information concerning features supported when using SAP Service and Asset Manager for
Windows, refer to the note https://launchpad.support.sap.com/#/notes/3268538 .
CA_AT Attachment Y
TACH support for
MENT business ob
jects (DMS /
BDS / GOS)
CA_BUSI Business N
NESS_PAR partner
TNER
CA_CLAS Classifica- Y
SIFICA tion and
TION characteris
tics for tech
nical objects
CA_CRE Create Y
ATE_TECH equipment
_OBJECT and func
tional loca
tion
CA_NO_HI Notification Y
STORY history
CA_TECH_ Equipment Y
OBJECT and func
tional loca
tion master
data
PM_CLOC Clock In / N
K_IN_CLO Clock Out
CK_OUT
PM_CON PM confir- Y
FIRMA mations for
TION time record
ing
PM_MEAS Measure Y
UREMENT ment read
ings
PM_NOTI PM notifica- Y
FICATION tions
PM_PRT Production, Y
Resources,
and Tools
(PRT)
PM_SU Supervisor Y
PERVI mode
SOR_MOD
E
SAP Service and 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 Service and 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 Service and 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.
Note
If the Save and Cancel buttons are active, the Home link for the ConfigPanel is not available. Either save
your changes or cancel out of the changes to return to the main Configuration Panel page
Message List
Certain actions can generate system messages. These messages can be error messages or informational
messages. If you perform an action that prompts a system message, a message bar appears above the main
panel with a brief description of the message.
Click the Show List button to display the detailed view of the message list.
The following areas are used in configuring general information for the application:
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 Service and Asset Manager)
• System Components (not used in SAP Service and Asset Manager)
• Parameters
• Client Globals (not used in SAP Service and Asset Manager)
• User Attributes (not used in SAP Service and Asset Manager)
Application Persona
• Features
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 Service
and 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.
• Life-cycle management: When the <Application Blocked> box is checked, the mobile application is
disabled. The mobile user can no longer connect to the back-end system for the mobile application, and
the xChange process is also disabled. The <Effective Date> and <Time> fields flag when the change
takes effect.
• xChange Setting: When the <Disable Change Detection> box is checked, the change detection
process, or xchange process, for the application is completely disabled.
• Inbound Transaction Management: Not used in the SAP Service and Asset Manager application.
• Multi Backend Setting: When checked, enables a specific mobile application to connect to multiple SAP
systems, consisting of one host server and one or more satellite servers.
• System Role: Dropdown menu where you can select either Host or Satellite.
A Host system is the connection between SAP and the SAP Service and Asset Manager application in the
SAP Business Technology Platform. The host server provides the logic to the application and functions as
the bridge to the satellite server or servers. There can only be one host server per system.
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
• 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.
• Application Parameters: Use the <Add> and <Delete> buttons to create and delete parameters.
• Parameter Detail: The <Parameter Group> is the group to which the parameter belongs. Groups are
how you organize parameters. References to a parameter include both the group name and the parameter
name. The <Parameter Name> is the unique name of the parameter.
The <Parameter Value> is the currently configured value of the parameter. References to the
parameter return the configured value. Use the <Language Specific Value> checkbox to select which
parameters you wish to be language dependent. The checkbox and the corresponding Language Specific
Values tab are only active after you have clicked the Change button. Note that the language available in the
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.
The persona selected determines the data that is downloaded to the mobile client.
Application Personas
Features Tab
Switchable features allow you to configure various components into features. Feature assignment determines
the data that is downloaded to the mobile client.
Switchable Features
Check or uncheck a feature from the feature list to enable or disable it.
The Component Assignments page allows you to configure persona and feature assignments.
Use the Mobile Application Filter field to select your application. Then, click the application hyperlink in the
Search Results table.
Use the Apply Filters section to filter for a specific persona or specific features. In the following example, we've
filtered for all features that belong to the MAINTENANCE_TECHNICIAN persona.
The Feature Assignment section shows you the filtered results. Use the drop-down menu to further filter
your selections. For example, we've chosen to display only active, or selected features for the maintenance
technician persona.
The Switchable Features tab allows you to configure OMDOs required for each feature. During initial and delta
syncs, the mobile client only downloads data from the assigned OMDOs.
Use the Apply Filters section to filter for a specific OMDO or feature ID.
The Assignment List section shows you which OMDOs are assigned and active (or not active) with a feature.
Note
Don’t select OMDOs that belong to the online service (ex: /MERP/SAP_ONLINE_LOOKUP_EXT_<version>).
These online service entities might not exist in the base service (/MERP/
SAP_ASSET_MANAGER_<version>).
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 Service and 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
When you define an OData model to use with OData offline SDK client application, you also define referential
constraints for the association. Only key fields of the principle entity type can be used in referential constraints.
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
for the represented business object, including all aspects of related operations such as object creation, update,
deletion, or read and downloading. The OMDO also supports configuration such as data distribution rules for
data download.
OData requests for a business object are mapped to an OMDO object. The OMDO handler then processes
the requests for the OMDO object. For read requests, the OMDO handler considers and enforces the data
distribution rules and other configuration settings, and determines the proper output response. For create,
update, and delete requests, the OMDO handler creates or updates the SAP BusinessObjects in the back-end
system as requested in the OData requests, and provides the relevant response.
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.
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 Service and 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 Service
and Asset Manager, communicates with SAP and the object tables contained within SAP
• Exchange Object Configuration: Change detection rules for SAP data objects, such as leading 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.
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 Service and 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 Service and 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
Service and 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
As of the SAP Service and Asset Manager 2205 release, enable and disable parameters are no longer
available through the Parameters tab. You enable or disable all features through the Features tab. See the
Configuring Features [page 58] procedure for details.
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.
When a mobile user manually logs their time, or their time is automatically logged for them through the use of
the application, the time logged is rounded to the nearest interval configured. For example, you manually log an
additional 12 minutes of work on a work order on a mobile device. Your CATSMinuteInterval parameter is set to
15. Therefore, your additional time logged is automatically rounded up to 15 minutes. The time entry screens
also have their duration control values limited to minute values matching the configured interval.
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
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
Note
As of the SAP Service and Asset Manager 2205 release, enable and disable parameters are no longer
available through the Parameters tab. You enable or disable all features through the Features tab. See the
Configuring Features [page 58] procedure for details.
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
• 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
• The mobile status of a work order or operation is used to track time in either CATS or Confirmations
1. Using the ConfigPanel, navigate to Component Assignments. Select your application in the Mobile
Application Filter. Click the application link in the Search Result table.
The Application Assignment Definitions page displays.
2. Click the Change button. Find the PM_CLOCK_IN_CLOCK_OUT feature ID in the
MAINTENANCE_TECHNICIAN user persona part of the table. Enable or disable the feature using the Active
Flag checkbox.
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 Service and 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
SAM2210_CATALOG_CODES. You can add a new data filter rule to your customer namespace, or change the
existing parameter-rule association to a new parameter-rule association.
Procedure
1. Using the ConfigPanel, navigate to Mobile Application Configuration Parameters tab . In the left
column, Defined Mobile Applications, select your application.
The Parameter List populates with a list of all parameters available for the application.
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.
6. If you are creating a custom activity value type, navigate to OData Mobile Data Object Configuration
Data Filter Tab SAM2210_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 75].
8. Save your changes.
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:
3. Define how to consume the data in the OMDO through the ConfigPanel:
a. From the main page of the ConfigPanel, navigate to OData Mobile Data Configuration Data Filter
tab .
b. Select the OMDO filter to which you're adding the new user attribute from the user attributes defined
in the Mobile Application Configuration page in the ConfigPanel.
c. Choose your filter from the Defined Filters list. Click Change.
Context
If you enable the EnableOnLocalBusinessObjects parameter, SAP Service and Asset Manager allows mobile
status update changes for the following:
Procedure
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.
Context
A new feature created by a customer can only be created in the customer namespace.
Note
As of the SAP Service and Asset Manager 2205 release, enable and disable parameters are no longer
available through the Parameters tab. You enable or disable all features through the Features tab. See the
Configuring Features [page 58] procedure for details.
Procedure
The list of features delivered in SAP Service and Asset Manager is displayed in the Configuration Panel.
You may define new features in a customer namespace only.
Each feature has an Active check mark that you can toggle. This acts as the master switch across the
application.
You can also toggle features related to a persona. Each persona is configured with a list of features
supported in the standard delivery of SAP Service and Asset Manager.
You can view a list of features by persona in the Configuration Panel. Each feature has an In-Scope
checkbox, meaning that the feature is allowed for that persona. In-scope features are not editable in
customer or QA environments. Only In-Scope items can be enabled or disabled using the Active Flag
checkbox.
You can enable a feature for one persona, but disable the same feature for another persona. The list
can be filtered using the User Persona or Application Feature Id drop-down list to find entries directly.
Note that if the feature is disabled at the application-main switch level, the feature is still considered
disabled, regardless of the Active Flag status at the persona level.
2. Click the Change button. Enable or disable desired features.
3. Save your changes.
Results
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 SAM2210_DOCUMENT from the oData Mobile Data Object List and navigate to the following locations:
When you require SAP Service and 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 CREATE_OTHER_DOCUMENT . Your implementation must match with the
ABS data model to work with standard SAP Service and Asset Manager metadata. See the Other Method [page
67] flow chart for more information.
Beginning with the SAP Service and Asset Manager 2010 release, SAP Service and 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.
You can create Equipment and Functional Locations from the SAP Service and Asset Manager application in a
similar way to executing transactions IE01 and IL01 from the SAP Service and Asset Manager GUI.
Context
A template is required when you create equipment, but it's optional when you create a functional location. Any
existing equipment or functional location can be used as a template. It's possible to copy the classifications,
measuring points, business partners, documents, install location (equipment only), and notes from the
template. The description, maintenance plant, start date, manufacturer, date of manufacturer, model number,
Procedure
1. To access the ConfigPanel using a direct transaction code shortcut, enter /n/syclo/configpanel.
2. Activate CA_CREATE_TECH_OBJECT for MAINTENANCE_TECHNICIAN Persona in the Component
Assignments.
3. Add a rule to EQUIP_TEMPLATE filter in the SAM<version>_EQUIP_TEMPLATE oMDO in the oData Mobile
Data Object Configuration.
The PROPERTY_FLAG filter in the technical objects, either Equipment or Functional Location oMDO contains
the list of properties available to edit during the creation of a technical object. The properties, which are active
by default correspond to the default fields in the applications technical object create page, see the example.
EQUIPDESC corresponds to the Description field in the Equipment create page of the app.
When you modify either an oData mobile data object or an exchange object, first make a copy of the object and
place it in the customer namespace.
Context
The following procedure provides information on making a copy of an oData mobile data object (OMDO) or
exchange object within SAP Mobile Add-On. In any of the procedures provided in this guide where an OMDO
or an exchange object is copied, refer to this procedure for instructions. When you copy either an OMDO or an
exchange object, you can roll back any changes you make to the application if necessary without changing the
original objects.
Once you copy an OMDO and modify the object, you may adjust the oData model definition to reference the
new OMDO. Similarly, when you copy and modify an exchange object, you may need to change the EFI trigger
assignment to the new exchange object. These procedures are covered separately.
Procedure
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.
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 Service and
Asset Manager, you may need to adjust the rules for one or more of the oMDO filters.
Many of the filters in SAP Service and 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 Service and 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
plant. When business activities performed by a user are mobilized through the mobile application, the ability
to extend the same restrictions to the mobile application is necessary. Data filter rules provide the function to
restrict data access for mobile applications.
Use the following procedure to modify a data filter rule for an oMDO. The changes you make to the settings of a
given rule vary depending on your mobile application implementation requirements. Subsequent procedures in
the Configuration Guide refer to this procedure and provide detailed values and settings for filter rules involved
in the specific change.
Procedure
1. Access the ConfigPanel. See Accessing the SAP Mobile Add-On for SAP Configuration Panel [page 11] for
information.
2. From the ConfigPanel Home page, click the oData Mobile Data Object Configuration link.
3. At the top of the oData Mobile Data Object Configuration page display, in the Mobile Application Filter
field, choose your mobile application from the dropdown menu. Choosing your mobile application is not a
necessary step, but it eliminates objects that are not part of your mobile application from the object list.
4. Click the Data Filter tab.
5. Expand the oData Mobile Data Object List tree so you can see all of the oData mobile objects.
6. Select the oData mobile data object that requires filter modification from the list.
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 the OData Channel Integration Settings topic and and
the related subtopics in the Configuration Panel Overview [page 12] section.
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 Service and 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
Service and 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 Service and 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:
• SAM2210_ORDER_TYPE
• SAM2210_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 Service and Asset
Manager application are already determined.
• The person performing the procedure has access to the Config Panel and permissions to change settings.
The following procedure modifies the synchronizing behavior of the SAP Service and 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 SAM2210_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 Service and Asset
Manager. Click the Change button.
5. Create a rule for each order type included in the work order distribution to the SAP Service and 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 75].
6. Save your changes once you’re finished.
7. Find and click the SAM2210_WORK_ORDER_GENERIC OData mobile data object on the list on the left.
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 Service and Asset
Manager. Click the Change button.
10. Create a rule for each order type included in the work order distribution to the SAP Service and 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.
After you finish the procedure, work orders are downloaded by the SAP Service and 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 Service and 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 Service and Asset Manager.
For assignment types 2 and 6, some customers prefer the ability to view all operations rather than all work
orders. Work order headers are still visible. You can configure your preference using the ConfigPanel for SAP
Service and 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*
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 SAM2210_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 Service and 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 notification assignment (default, no change
required)
• Assignment Type 2: Task-level personnel number of the notification assignment
• 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 AGR set up in the user profile parameter.
• Assignment Type D: Dependent Queue
By default, this assignment is based on the technician’s notification assignment dependent collection*.
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 SAM2210_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 SAM2210_EQUIPMENT OMDO. Specifically, in the following procedure, you will configure the
EQUI_INCL_SYS_STAT filter with a rule that specifies which status or statuses to include. After you configure
the rule, only the equipment records with the specified statuses are retrieved by the application for download
to the clients.
A common equipment status is INST. However, the INST status is only one example of many options. You can
configure other filters, either with this example, or in place of it.
For your given SAP 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 SAM2210_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
Use the following procedure to create a filter rule for the OMDO, SAM2210_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
7. Repeat the previous step to include additional statuses in the filter.
8. Save your changes.
Results
When you finish the procedure, the equipment records downloaded by the SAP 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.
• 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.
Procedure
1. Navigate to ConfigPanel Home OData Mobile Data Object Configuration . Select the desired OMDO
from the list on the left of the current configuration page.
2. Click the Field Selection tab, then click the Change button.
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
SAM2210_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 96] for more information.
By default, follow-on work orders are enabled in a new installation. You can configure if a follow-on link exists or
doesn’t exist at the time of a new work order creation.
Note
Ensure that business function Enterprise Asset Management Part 7 (LOG_EAM_CI_7) is activated in the
back end. See Creating Follow-On Orders for more details.
Context
Procedure
Prerequisites
Be sure that you have turned on the Customer Service Notification feature.
Note
Configuring Customer Service order types is optional and is required only if the Customer Service
Notification feature is enabled.
Procedure
6. Select SAM2210_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 turned on the Customer Service Notification feature.
Note
Configuring Customer Service notification types is optional and is required only if the Customer Service
Notification feature is enabled.
Procedure
6. Select SAM2210_NOTIFICATION_GENERIC from the list. Then select Data Filter tab Operation - READ
Data Distribution NOTIF_TYPE
Results
You can use either the USE_USER_TIME_ZONE or the POSTING_DATE filter, found in the
SAM2210_PM_CONFIRMATION OMDO, to configure confirmation posting dates. Note that you can enable
only one filter at a time. If both filters are enabled, you'll get an error.
USE_USER_TIME_ZONE Filter
See the Configuring Confirmation Posting Date Using the USE_USER_TIME_ZONE Filter [page 87] procedure
for detailed instructions.
When the SAP system and mobile users are in different time zones, use the USE_USER_TIME_ZONE filter to
perform the time zone conversion. When the filter is active, the application uses the time zone of the mobile
user in the back end system to convert the actual start date / time. It also converts the finish date / time
received from the mobile client. The system time zone is the default setting. The User Time Zone filter is a back
end only configuration.
Note
To use the time zone handling functionality in confirmation, SAP system must be customised with time
zone. If SAP system time zone isn't maintained and the USE_USER_TIME_ZONE filter is active in the
SAM2210_PM_CONFIRMATION OMDO, posting of confirmation from SAP Service and Asset Manager
raises an error.
POSTING_DATE Filter
See the Configuring Confirmation Posting Date Using the POSTING_DATE Filter [page 88] procedure for
detailed instructions.
Context
Use the following procedure if you're configuring the confirmation posting date using the
USE_USER_TIME_ZONE filter.
Procedure
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. Click on oData Channel Integration Settings oData Mobile Data Object Configuration .
3. In the OData Mobile Data Object List select SAM2210_PM_CONFIRMATION, and then the Data Filter tab.
4. Expand the Defined Filters list as follows: Operation - CREATE Standard Filter
USE_USER_TIME_ZONE . Click the Change button.
5. Select the existing rule. Ensure the <Low Value> field is set to X - True and is enabled:
Context
Use the following procedure if you're configuring the confirmation posting date using the POSTING_DATE filter.
Procedure
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. Click on oData Channel Integration Settings oData Mobile Data Object Configuration .
3. In the OData Mobile Data Object List select SAM2210_PM_CONFIRMATION, and then the Data Filter tab.
4. Expand the Defined Filters list as follows: Operation - CREATE Standard Filter POSTING_DATE .
Click the Change button.
5. Select the existing rule. Ensure the <Low Value> field is set to 1 and is enabled:
• Default: 1 - Date from Mobile Device without conversion
• 2 - User Time Zone Date (at the time of BAPI execution)
• 3 - System Time Zone Date (at the time of BAPI execution)
The Parameter List populates with a list of all parameters available for the application.
8. Click the Change button.
9. Find and highlight the PostingDateFromUserOverride parameter, located in the PMCONFIRMATION
parameter group. Set the parameter to one of the following:
• N: (Default). If set to N, the confirmation posting date is automatically taken from the time zone set on
the mobile client.
• Y: If set to Y, the mobile client user can manually enter a date on the Confirmation screen in the app.
10. 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.
11. Save your changes.
Context
The following assignment types are supported when using the Supervisor module:
Configure the assignment types for the work order OData MDO as follows:
Note
One of the assignment types must be configured for the technician, while the other assignment type must
be configured for the supervisor based on the supported work assignment types. Only the same level of
assignment types is supported. In this, you can configure either header level assignments or operation level
assignments, and not both.
Procedure
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 SAM2210_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.
Configure the data filters to define the Supervisor role and Team Assignment types for the OMDO. Your specific
configuration is based on how the supervisor team is maintained in the back end.
For detailed instructions on how to work with data filters, see the Working with oData MDO Filter Rules [page
75] and Changing oData MDO Filter Rules [page 75] topics.
In addition to configuring the data filters found in the SAM2210_USER_ROLE OMDO, you must manually
maintain the team assignments for each user in the Mobile Administration and Monitoring Portal. Information
on configuring user parameters is found at the following locations:
The following team assignment types are supported for downloading the supervisor team:
• 1 - Work Center Assignment: Use when the team (technicians and supervisors) is maintained in the back
end through the Work Center Maintenance transaction (CR02/CR03)
• 2 - Organizational Structure Assignment: Use when the team is maintained in the back end through the
Org. Structure Assignment (PPOMA transaction).
• 3 - User Attribute Assignment: Use when the team isn't maintained in the back end through either the
Work Center Maintenance or the Org. Structure Assignment transactions. Additional configuration and
manual team assignments are needed.
• 4 - Custom Assignment: Use by the customer to define custom logic for downloading the
teams. Customer logic is implemented in the BADI method /MERP/CA_OMDO_USER_ROLE_BADI -
GET_ASSIGNMENT_OTHERS.
The position role type filter defines the Position Org ID for the supervisor, and is maintained as part of the team
configuration in the back end. The definition is needed to identify the mobile user with the Supervisor role. It's
also needed for Team Assignment types 1 and 2.
The work center role type filter is used for Team Assignment type 3. When using Team Assignment type 3,
create a new filter rule with the following properties:
Configure the data filters to define the Supervisor role and Team Assignment types for the OMDO. Your specific
configuration is based on how the supervisor team is maintained in the back end.
For detailed instructions on how to work with data filters, see the Working with oData MDO Filter Rules [page
75] and Changing oData MDO Filter Rules [page 75] topics.
You're configuring the ORDER_ACTIVITY_TYPE data filter found in the SAM2210_ORDACTTYPE OMDO.
If <Order Type> and <MaintActiv Type> fields are specified, the supervisor approval functionality is
enabled for the combination:
Context
Note
As of the SAP Service and Asset Manager 2205 release, enable and disable parameters are no longer
available through the Parameters tab. You enable or disable all features through the Features tab. See the
Configuring Features [page 58] procedure for details.
The Supervisor feature is called PM_SUPERVISOR_MODE. By default, the feature is not enabled.
To configure the supervisor options for SAP Service and Asset Manager, use the SUPERVISOR parameter
group and the following parameters within the group:
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 for the application.
Note
If the Parameter Value field and the Rule ID fields are blank, and if no data filter rule is created, the
authorization model is not used. The UserRoles entity set is then used to determine the authorization
role.
Note
By default status settings for the supervisor module aren't mapped to any back-end user or system status.
For an example of how to configure a mapping status, see the Changing the Mapping of a Mobile Status to
STARTED [page 47] procedure.
The following statuses to support the supervisor functionality are available at the work order and operation
levels, depending on your configuration of the work order assignment type:
• REVIEW: Set by the technician after they've completed their work. The supervisor is then required to
review the work.
• REJECTED: Set by the supervisor if they're rejecting the work done on the work order or operation.
When a supervisor approves a work order or an operation, the status moves to COMPLETED.
The supervisor can reject an order or operation as part of the review process. If an order or operation is
rejected, the supervisor must specify a rejection reason.
For information on how to work with data filters, see the Changing oData MDO Filter Rules [page 75] topic.
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 relevant OData services (/MERP/SAP_CREW_MANAGER_<XX> and /MERP/
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 98]
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 98]
• Setting the OData Mobile Data Object Configuration [page 100]
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.
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 Service and Asset Manager configuration, there are a few considerations when
configuring SAP Service and 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
Note
As of the SAP Service and Asset Manager 2205 release, enable and disable parameters are no longer
available through the Parameters tab. You enable or disable all features through the Features tab. See the
Configuring Features [page 58] procedure for details.
• 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.
• It’s possible to assign several characteristic values in different segments of a linear asset. Therefore,
set the value assignment to multiple values when the characteristics are created.
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 Business Technology
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 Business Technology Platform SAP Business Technology Platform enables customers and
partners to rapidly build, deploy, and manage cloud-based
enterprise applications that complement and extend your
SAP or non-SAP solutions, either on-premise or on-demand.
SAP Business Technology Platform cockpit Central point for managing all activities associated with your
SAP Business Technology Platform account and for access
ing key information about your applications.
SAP Web IDE application Integrated development environment used to create or ex
tend SAP UI5 or SAP Fiori applications.
SAP Business Technology Platform connector Allows SAP Web IDE and SAP Business Technology Platform
to connect to an on-premise system securely and with mini
mal configuration 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 Business Technology Platform Mobile Services is a metadata-based
application development platform.
The Mobile Development Kit (MDK) lets you customize, deploy, and manage your customized Windows 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 SAP Business Technology
Platform Mobile Services 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 Service and 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 Service and 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 SAM2210_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 Service and 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 Service and 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 78] 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 Service and 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 Service and Asset Manager application work order distribution is controlled by the OMDO
(OData mobile data object) SAM2210_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) SAM2210_NOTIF_ASSIGNMENT_TYPE READ operation controls
the standard SAP Service and 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 Service and 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 Service and 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 an 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.
Bias-Free Language
SAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities,
genders, and abilities.
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.