How to do Data Staging for Agentry based Mobile ... · SAP Mobile Platform Applicable Releases: SAP Mobile Platform 3.0 Prerequisite: Any Agentry based apps running on SMP 3.0 with

SAP How-to GuideMobility

SAP Mobile Platform

Applicable Releases:

SAP Mobile Platform 3.0

Prerequisite:

Any Agentry based apps running on SMP 3.0 with Add-on SMFND 610_700with Support Package 04.

Provided by: RIG Technology Team, SAP

How to do Data Staging for Agentry based Mobileapplication (SAP Backend)

SAP How-to GuideMobility

SAP Mobile Platform

Version 1.0

March 2015

© Copyright 2015 SAP AG. All rights reserved.No part of this publication may be reproduced or tran smitt ed in any form or for any purpose wi thout the express p ermission of SAP AG. Th e information cont ained herein may b e changed wi thout prior notice.Some softw are products market ed by SAP AG and its dist ributors contain propri et ary softw are component s of other software vendors.Microsoft, Windows, Excel, Outlook, and PowerPoint are registered tr ademarks of Microsoft Corporation.IBM , DB2, D B2 Universal Datab ase, Syst em i, System i5, System p, Syst em p5, Syst em x, Syst em z, System z 10, Syst em z9, z 10, z 9, iSeries, pSeri es, xSeri es, z Series , eServer, z/VM, z /O S, i5/O S, S/390, OS/390, O S/4 00, AS/400, S/390 Parall el Enterp rise Server, Po werVM, Pow er Archit ecture, POWE R6+, PO WER6 , PO WER5 +, PO WE R5, PO WER, OpenPow er, PowerPC, Bat chPipes, Bl adeC enter, System Stor age, G PFS, H ACMP, RET AIN, D B2 Connect, RACF, Redbooks, O S/2 , Parall el Sysplex, MVS/E SA, AIX,

Intelligent Miner, WebSph ere, N etfinity, Tivoli and Informix are trademarks or regist ered trad emarks of IBM Corporation.Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.Adobe, the Adobe logo, Acrobat, PostScript, and Reader are eith er trademarks or regist ered t rad emarks of Adobe Systems In corporated in the United Stat es and /or other countries.Oracl e is a regist ered trad emark of Oracle Corporation.UNIX, X/Op en, OSF /1, and Motif are regist ered trademarks of the Open Group.Citrix, ICA, Program N eighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trad emarks or regist ered trad emarks of Citrix Systems, Inc.HTML, XML, XH TML and W3C are t rad emarks or registered trademarks of W3C®, World Wid e Web Consortium, M ass achus etts Institut e of Technology.Jav a is a registered trademark of Sun Micro syst ems, Inc.Jav aScript is a registered trademark of Sun Microsyst ems, Inc., used under licen se for technology invented and i mplement ed by N etscape.SAP, R/3, SAP N etWeaver, Duet, Partn erEdge, ByDesign, SAP BusinessObjects Explorer, StreamWork, and other SAP product s and services mentioned herein as w ell as thei r respective logos are trademarks or regist ered trad emarks of SAP AG in Germany and other co untries.

Business Objects and the Business Objects logo, BusinessObjects,

Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other

Business Objects products and services mentioned herein as well as their

respective logos are trademarks or registered trademarks of Business

Objects Software Ltd. Business Objects is an SAP company.Sybase and Adapti ve Serv er, iAnywh ere, Sybas e 365, SQL Anywhere, and other Sybas e products and services mentioned herein as well as thei r respective logos are trademarks or regist ered t rad emarks of Sybase, Inc. Sybase is an SAP comp any.

All other product and service names mentioned are the trademarks of their resp ectiv e co mpani es. Dat a cont ained in this document serves information al purposes only. N ational product specifications may vary.The information in this document is proprietary to SAP. No part of this document may b e rep roduced, copied, or trans mitted in an y form or for any purpos e without the express prior writ ten permission of SAP AG.This document is a preli minary v ersion and not subject to your licens e agreement or any other agreement with SAP. This document contains only int ended strat egies, d evelop ments, and functionalities of the SAP® product and is not intended to be binding upon SAP to an y parti cular course of business , product strategy, and /or dev elopment. Pl eas e note that this docu ment is subject to ch ange and may be ch anged by SAP at any ti me without notice.SAP assu mes no responsibility for errors or omissions in this document. SAP does not w arrant the accuracy or compl et eness of the information, text, graphics, links , or other items contained within this mat erial . This document is provided without a warrant y of any kind, either express or i mplied, including but not limited to the i mplied w arranties of merchant ability, fitness for a particular purpose, or non-infringement.SAP sh all hav e no liability for damages of any kind including without limit ation direct , special, indirect , or consequ ential d amages that may result from the us e of these materi als. Thi s limit ation shall not apply in cases of intent or gross negligence.The statutory liability for p ersonal injur y and defectiv e products is not affected. SAP has no control over the information that you may access th rough the use of hot links contained in thes e materials and does not endors e your use of third-party Web pag es nor provide an y warranty whatso ever rel ating to third-part y Web pages .

SAP “How-to” Guides are intended to simplify the product implement-

tation. While specific product features and procedures typically are

explained in a practical business context, it is not implied that those

features and procedures are the only approach in solving a specific

business problem using SAP NetWeaver. Should you wish to receive

additional information, clarification or support, please refer to SAP

Consulting.

Any software coding and/or code lines / strings (“Code”) included in this

documentation are only examples and are not intended to be used in a

productive system environment. The Code is only intended better explain

and visualize the syntax and phrasing rules of certain coding. SAP does

not warrant the correctness and completeness of the Code given herein,

and SAP shall not be liable for errors or damages caused by the usage of

the Code, except if such damages were caused by SAP intentionally or

grossly negligent.

Disclaimer

Some components of this product are based on Java™. Any code change

in these components may cause unpredictable and severe malfunctions

and is therefore expressively prohibited, as is any decompilation of these

components.

Any Java™ Source Code delivered with this product is only to be used by

SAP’s Support Services and may not be modified or altered in any way.

Document HistoryDocument Version Description

1.00 First official release of this guide

Typographic ConventionsType Style Description

Example Text Words or characters quotedfrom the screen. Theseinclude field names, screentitles, pushbuttons labels,menu names, menu paths,and menu options.Cross-references to otherdocumentation

Example text Emphasized words orphrases in body text, graphictitles, and table titles

Example text File and directory names andtheir paths, messages,names of variables andparameters, source text, andnames of installation,upgrade and database tools.

Example text User entry texts. These arewords or characters that youenter in the system exactlyas they appear in thedocumentation.

<Exampletext>

Variable user entry. Anglebrackets indicate that youreplace these words andcharacters with appropriateentries to make entries in thesystem.

EXAMPLE TEXT Keys on the keyboard, forexample, F2 or ENTER.

IconsIcon Description

Caution

Note or Important

Example

Recommendation or Tip

Table of Contents

1. Business Scenario .................................................................................................................1

2. Background Information .......................................................................................................1

3. Prerequisites ..........................................................................................................................1

4. Configuration steps .............................................................................................................. 24.1 MDO Object for Data Store ............................................................................................. 24.2 Data Agent Definition ....................................................................................................... 34.3 Data Store Definition ........................................................................................................ 4

4.3.1 Data Store – General tab .................................................................................... 44.3.2 Data Store – Data Segment ............................................................................... 64.3.3 Data Store – Agent Assignment ........................................................................ 74.3.4 Data Store – Field Mappings .............................................................................. 84.3.5 Data Store – Schedule ........................................................................................ 9

4.4 Assign Data store MDO object to BAPI wrapper ......................................................... 104.5 Executing loading Program ............................................................................................ 11

5. Activate data staging step-by-step procedure .................................................................. 14

6. Appendix ..............................................................................................................................176.1 Runtime and Design time high level flow ...................................................................... 176.2 Data staging sequence diagram ................................................................................... 186.3 Some of the Pre-defined staging tables delivered ...................................................... 186.4 Some Troubleshooting Tips .......................................................................................... 196.5 FAQ’s ............................................................................................................................... 196.6 Additional reference ........................................................................................................21

How-to-do Data staging for Agentry Mobile applications with SAP backend

April 2015 1

1. Business ScenarioDuring initial synch time of any Agentry apps bulk of the time is spending in download complextable required for respective Agentry apps which could be significantly high depending on datavolume. By enabling data staging the synchronization time for very large data set can be reduced.Let’s say if you’re using Agentry application for SAP backend and during go-live or user acceptancetesting phase you’re expecting 100’s of users to concurrently connect to SMP 3.0 server and synchdata for the first time. In normal scenarios without data staging you could see long wait time forusers trying to download complex table data and additionally it puts lot of load on SAP backendsystem. So with data staging enabled sync times can be reduced significantly by pre-populatingcomplex table data ahead of time. Agentry mobile frame supports data staging from Add-onSMFND 610_700 with Support Package 04 onwards.Data staging is only recommended for initial synch and provided data volumes are justified. Eventhough there is no technical limitation of using it during later stages but data staging poses differentset of challenges to maintain data staging tables up-to-date, so carefully review use of data stagingby keeping data staging tables up to date. It is also overhead to maintain data staging up to date, soeither you can deactivate data staging after initial go-live or use it.Note: - Data staging frame work is only supported for complex tables in standard product. Bydefault data staging is not activated for complex tables.

2. Background InformationThe goal of this document is to show how to enable data staging for ctparts complex table in IM 4.1application as an example. During initial synchronization all mobile users will try to downloadapplication definitions and data set relevant for their mobile application. For example, you candefine a data store and load it with a pre-calculated data set for a complex table with a very largedata set for initial download, by doing so you improve the runtime performance of your mobileclient during initial synchronization.By default, data staging is turned off. The use of data staging is only recommended for initial synch,since we are dealing with static data to reduce time during initial synch and any errors due to datastaging table out of synch. It is recommended to take advantage of exchange mechanism framework for master and transactional data delta synch subsequently.

3. PrerequisitesThis exercise has the following prerequisites:

Agentry Apps. (for SAP backend)SAP Add-on installed and BC set activatedRequired authorization to do Syclo config. panel changesTo get the most out of this document, experience with ABAP programming is recommended.


April 2015 2

4. Configuration stepsThe following sections provide a detailed step-by-step procedure on how to enable data staging forctparts complex table in Inventory Manager 4.1 application as an example.There are few areas that are required to enable configure data staging:

Data store MDO Object – Create a separate MDO object for data store. Idea is to haveseparate MDO object for loading data store object and separate MDO object forpulling/consuming data to the Agentry client. We can still use same default class handlerand BAPI wrapper used for ctparts complex table or create new ones as required. In ourexample default MDO object for ctparts complex table is SIM41_MATERIAL_PLANT_VIEW.

Data Store Definition - Defines staging data store settings, data storage, data agentassignment, schedule, and mapping information

Data Agent Definition - Defines the data store supplying agent settingsConsuming MDO Object - Enable data staging

4.1 MDO Object for Data StoreYou can either create new MDO object from scratch or by copying standard existing MDO objectSIM41_MATERIAL_PLANT_VIEW and by changing namespace and description.

Data filters:Separate set of filters can be defined for data store MDO object. In this example I havehardcoded plants values for which material data need to be loaded. When loadingprogram is executed, it looks at these filters and load material data only for these plantsvalues into staging table.


April 2015 3

Data StagingThere is no need to enable any parameters in this tab for the data store MDO.

4.2 Data Agent DefinitionUsing data agent tab your specifying agent type, data objects like BAPI wrapper and MDO objectto be used by data loading program which is read during the runtime.


April 2015 4

In this tab you define the data store supplying agent settings. Within this IMG activity, you define adata staging framework data agent. A data agent defines the technical routine that populates a datastore. The technical routine definitions include class handler and function module.BASIC DATAData Agent ID: Data agent object idData Store Desc.: Specify description for data agentMobile Application: Mobile application for which data agent is applicable.

AGENT INFOAgent Type: BAPI wrapper or any custom data handler - In this example we are using BAPI forcomplex table. In the future release we could expect more agent types or you could implementyour agent type.Data Supply BAPI Wrapper: BAPI wrapper used loading staging table.Data Supply Mobile Data Object: Specify data store MDO that was created in section 4.1.

4.3 Data Store Definition...

Use the data store definition settings to define data store settings, data storage, data agentassignment, schedules and mapping information. In this IMG activity, you define the data stagingframework data stores. A data store is a data storage that can provide data to a mobile data object.A data store can consist of multiple data segments, which are related data sets. A data store ispopulated by assigned data agents and schedules. For example, you can define a data store andload it with a pre-calculated data set for a complex table with a very large data set for initialdownload. This can improve the runtime performance of your mobile client during initialsynchronization.

4.3.1 Data Store – General tabIn data store section of IMG you specify all the settings related to data store object, data storage,data agent assignment, schedule, mapping information etc. which is read by data loading programduring the runtime.


April 2015 5

BASIC DATAData Store ID : Specify data store object nameData Store Desc.: provide description for the data store objectStore Type : Standard data store ( In further releases it could be enhanced to add moretypes)Mobile Application : Specify mobile application name

STORAGE INFORMATIONData Retention Period (Day) : Specify number of days that you want to retain data in stagingtable.Reserved for Mobile data object (Optional); check the box and specify consuming MDOobject for which you want to restrict this data store object. (This is for consuming MDOobject).Activation Check the activation flag to data store.


April 2015 6

4.3.2 Data Store – Data Segment

Data Segment Detail

Click on to add new data segment.Note: - Data segment section is intended for using with multiple data segment where youhave more than one data segment. May be one example could be a) composite complextable where you have multiple output structures b) same output table could be populated fordifferent structures.Data Segment ID : Output structure BAPI structure for the complex table


April 2015 7

Table Name: Specify staging table name for your scenario. In our example we are using/SMERP/STG_MM001 table which is relevant for ctparts complex table.

Segment Alias: segment alias that you want to specify. Can be different from data segment.

4.3.3 Data Store – Agent Assignment

Data Agent id: Specify your data agent.Data Segment id: Data segment from Data Segment tabAgent Parameter Name: Out structure specified in the Data Agent.

Note: You have more than one agent defined depending on number of data segments you havedefined.


April 2015 8

4.3.4 Data Store – Field Mappings

Field Mapping DetailTable Mapping Assignment: Agent assignment (drop down)Data Agent ID: Data segment id (drop down)Source Field Name: Source field nameParameter Name: Data segment idTarget Field Name: Target field name of the staging table.Example for mapping: Showing example of functional location complex table from Work Manager6.2 apps, if field name in staging table is different from field name in target structure (Data stagingtable) and source structure (ET_COMPLEX_TABLE –in this example) . Use field mapping tab tomap your source and target fields.Source structure fields:

Target structure snapshot:


April 2015 9

Your field mapping between source and target fields should look like this

Note: Use this section for mapping if your source and target fields are different.

4.3.5 Data Store – ScheduleUsing this tab to define the scheduling details, including the Schedule ID, Data Agent ID, Start andEnd dates and times. You can also define a Frequency for this schedule as well as an ECATT VariantName and ECATT Variant Container. These scheduling parameters are read by the loading utilityprogram ‘/SMFND/DSF_DRIVER_PROG’ for the data store at the runtime.

Click on to create schedule


April 2015 10

Scheduling Detail:-Schedule ID : Specify name for schedule idData Agent ID : Specify Data Agent idStart Dates and Start time: Specify schedule start date and timeEnd Dates and End time: Specify schedule end date and timeFrequency: In hoursTotal Execution: Total program execution countECC Variant Container: variant of loader programECATT Variant Name: ECATT variant if used for loader programActive Flag: Active schedule details.

4.4 Assign Data store MDO object to BAPI wrapper

Note: Make sure that still standard/consuming MDO is set as default assignment.


April 2015 11

4.5 Executing loading Program1) To execute the loading for the data store, you need to schedule the data store loading utilityprogram ‘/SMFND/DSF_DRIVER_PROG’ as an optional background job or standalone. Thisprogram can be used for both loading and purging staging table data.Note: Before executing loading program make sure that the required configurations are in place.

2) Execute program /SMFND/DSF_DRIVER_PROG in SE38

3) Specify inputs for loading program

This single program can be used to perform both data loading and data purging.

Note: - Please be sure to apply OSS note 2152313 before using qRFC option - Data loading orpurging using qRFC does not work consistently in data staging loading program/SMFND/DSF_DRIVER_PROG.


April 2015 12

Data staging loading program can be executed wide open for a given mobile application, datastore id or data agent id.Perform Data loading: Check this option if you want program to execute for data loading.Mobile Application: Name of the mobile application.Data store ID: specify data store id (optional)Data Agent ID: specify data agent id (optional)Schedule ID: specify schedule id (optional)Ignore validity (scheduling): Check this option if you want loading program to ignore anyschedule settings defined under schedule section of data store.Load using qRFC tasks: use this option to load data staging table for multiple data store id’s ordata agent id’s. By default program executes in sequential fashion by checking qRFC optionprogram triggers parallel processing in case executing program for multiple data store id ordata agents.Perform Data Purging: Check this option if you want program to purge data.Mobile Application: Name of the mobile application to purge data.Data store ID: specify data store id to purge dataSchedule ID: specify schedule id (optional)Ignore validity (Retention): Check this option if you want loading program to ignore anyretention settings defined under general tab of data store.Load using qRFC tasks: use this option to load data staging table for multiple data store id’s ordata agent id’s. By default program executes in sequential fashion by checking qRFC optionprogram triggers parallel processing in case executing program for multiple data store id ordata agents.

Note: Loading program can be used for data loading and data purging independently.

4) Material staging table before executing loading program


April 2015 13

5) Loading program logAt end of program execution program, it prints out log outlining processing status.

6) Material staging table entries after executing loading program.


April 2015 14

5. Activate data staging step-by-step procedure1) On /Syclo/configpanel initial screen click on – Data store definition hyperlink

2) Create new Data store definition

3) Create Data Store Agent definition

Note: Refer section 4.0 for detailed configuration steps.


April 2015 15

4) Create separate MDO object for data store.

5) Add assignment for Data store MDO object at BAPI wrapper level.

Note: Same BAPI can be used for both populating staging data and download data to Mobile client.


April 2015 16

6) Activate data staging at consuming MDO object level.

7) Populate data staging table by executing program /SMFND/DSF_DRIVER_PROG.

8) Test data staging on SAP side by executing BAPI wrapper associated with complex table.


April 2015 17

6. Appendix

6.1 Runtime and Design time high level flow


April 2015 18

6.2 Data staging sequence diagram

6.3 Some of the Pre-defined staging tables delivered


April 2015 19

6.4 Some Troubleshooting Tips 1) If data staging table is populated but records are not retrieved by consuming BAPI forcomplex table?

Make sure that DSF_RECORD_ID field has sequential numeric value in therespective complex table.If you’re not seeing sequential numeric value for field DSF_RECORD_ID then mostlikely number range for “/SMFND/DS1 “ object is not maintained.

2) Number range for object “/SMFND/DS1” is maintained but still records are notretrieved by consuming BAPI for complex table?

Make sure that number range interval is defined as “01’.

3) Number range is maintained correctly but still records are not retrieved byconsuming BAPI for complex table?

Check configuration related to consuming MDO object to make sure that datastaging is activated.Check configuration related to data agent and data store.Make sure that load program was executed and records are populated in datastaging table.Make sure that you’re on with support package 04 with Add-on SMFND610_700.

4) Tried loading data using qRFC option but don’t see any records loaded into stagingtable?

Check qRFC queue using SMQ2 tcode for errors.5) Data is populated in staging table but latest data that is changed is not coming down to Agentryclient?Please note staging table are static in nature, it only contains snapshot at the point when the

loading program was executed. Any data that is changed after loading program was executed willnot be found in staging table. In other words staging doesn’t have exchange mechanism.

6.5 FAQ’sAfter initial synch is done does data staging framework uses exchange mechanism to loaddelta changes?Data will be read from staging table only during initial synch and subsequently data will beread from exchange table for delta changes.

Is there issue in disabling data staging after initial go-live?No – Once data staging is disabled, standard complex table logic flow will used duringregular sync’s subsequently. Any initial synch during this period may take time since datais read by executing query on SAP backend and not from staging table.

Can we use data staging even after go-live or after initial sync’s of Agentry clients?Even though it is not recommended to use after initial sync’s are done but technically thereis no restrictions from application side as long as staging table is update with the changes.


April 2015 20

Can we implement or enable data staging for Z complex tables?Yes – Absolutely SAP Add-on framework provides option to enable data staging even forcustom Z complex tables.

Can we implement data staging for other Agentry Objects like transactions?Standard product provides data staging support only for complex tables. Exchangemechanism is available for transaction objects so there is no need to enable data staging.But technically there is restriction from application side not to use data staging fortransaction objects which needs to carefully review before implementing any such logic.

Can we create our own data staging tables?Yes you can create your own staging tables. Just make sure that any Z staging tablescontain all these standard fields.

Is data staging specific to any Agentry product like WM 6.2?No – It is not specific to any standard product but data staging framework was introducesfrom Add-on SMFND 610_700 with support package 04 onwards. Data staging is onlyenabled for few complex tables at this point in each of the mobile application.

If we have roll out planned for Agentry applications in phase manner, Does activating datastaging in the middle will effect users who have already have gone live ?Once data staging is enabled – it is enabled at the application level. Staging table needs topopulate with data required for all the users. Reason being any initial synch or client resetfrom any application users will try to retrieve data from staging tables. So you mightencounter data quality issues if staging table is not up to date.

Can we create our Z loading program to load staging programs?It is not recommended to develop your loading program. But there is no restriction onapplication side to copy or create your own Z loading program as long it follows standarddata staging program‘s framework. Once Z program is created it becomes yourresponsibility to upgrade and maintain it.

Can we populate data staging table from multiple sources?Yes – Agentry data staging provides option to update single target staging table withmultiple sources.

In spite of enabling data staging initial Agentry client sync is taking time – What could bethe reasons?By enabling data staging your only speeding up only complex table download time. Youneed to analysis and identify where application is taking maximum time during initial synchtime.


April 2015 21

Executed data loading program but log indicates that zero records are loaded – What couldbe the issue?Carefully review your loading program options and other related data staging configurationto determine the cause.

Is there way to verify that data loading program populated staging table?During program execution program log indicates number of records loaded into stagingtable and contents of staging table can always be checked using SE16/SE11.

Can we load staging tables with data for multiple plants and users connects during initialsynch will they get data for their respective plant based on MDO object rules for complextable?Yes - It works. For MDO object of data store specify all the required plants for which dataneed to be loaded to complex table. When users connects and try to synch data stagingframework looks at consuming MDO object rules and loads the data accordingly.

Is there way to verify that data supplying BAPI is retrieving records from staging table?Yes – In SE37 you can use BAPI to retrieve complex table and do unit testing to make surethat data is pulled from data staging table or if you’re familiar with ABAP debugging you candebug class handler code to check data staging code is invoked.

How to disable Data staging after initial load or go-live?Go to consuming MDO object staging tab and disable data staging. Transport the changesacross system landscape.

6.6 Additional reference

OSS notes: 2116192 - FAQ - Mobile Add-On for SAP Performance RecommendationsRefer sizing guides for both SMP 3.0 and Agentry Mobile product.


April 2015 22

www.sap.com/contactsap

www.sdn.sap.com/irj/sdn/howtoguides

Documents

How to do Data Staging for Agentry based Mobile ... · SAP Mobile Platform Applicable Releases: SAP Mobile Platform 3.0 Prerequisite: Any Agentry based apps running on SMP 3.0 with