1 Setup Mobile Application for OData Delta Services

Transcription

1 1 SetupMobileApplicationforODataDeltaServices To use any services provided by SAP Mobile Application Integration Framework, including the CRM Application AddOn (software component SMCRM), a mobile application must be setup using the ConfigPanel tool provided by the integration framework in SAP. In order to make use of the standard xchange Tables provided by the CRM Application AddOn (component SMCRM), we will define a new mobile application 'Z_ODATA_DELTA_SERVICES' to be used for OData delta query services. A BC Set containing the customizing settings of mobile application 'Z_ODATA_DELTA_SERVICES' is provided by note CheckSystemRequirement To follow the steps described in this guide, you need to make sure the required software components are installed in the SAP CRM system. You can check the system information from any SAPGUI screen, menu -> System -> Status... Page 1 of 16

2 Minimum required software components: SMCRM 600_700 SP00 - Agentry SAP Framework CRM AddOn IW_BEP 200 SP06 - Netweaver Gateway Backend Event Provider It is highly recommended that SMCRM 600_700 Support Package 01 is applied in your SAP CRM system. If not, you need to implement SAP Note Helper class for accessing exchange tables. 1.2 UploadBCSet'Z_ODATA_DELTA_SERVICES' From note , download the zip file 'Z_ODATA_DELTA_SERVICES.zip' and unzip the file to your local PC. You will have the file 'Z_ODATA_DELTA_SERVICES.bcs'. Log into SAP CRM system, run tcode SCPR3 to upload the BC Set. Select file 'Z_ODATA_DELTA_SERVICES.bcs' to upload. Page 2 of 16

3 When prompted for Object Directory Entry, choose 'Local Object'. Save the BC Set 'Z_ODATA_DELTA_SERVICES' by choose 'Save'. Page 3 of 16

4 1.3 ActivateBCSet'Z_ODATA_DELTA_SERVICES' After BC Set 'Z_ODATA_DELTA_SERVICES' is created, we now need to activate the BC Set to extract the customizing settings into the target SAP CRM client. Log into the SAP CRM system and client in which OData delta query services will be provided. Run tcode SCPR20, and specify 'Z_ODATA_DELTA_SERVICES' as BC Set. Choose option 'Activate BC Set' to continue with BC Set activation. Provide a valid customizing request. Page 4 of 16

5 Page 5 of 16

6 Accept default activation options, and choose Continue Activation to activate the BC Set. 1.4 ReviewandVerifyMobileApplicationSettings After activation of BC Set, we want to review the mobile application settings being automatically generated by the BC Set. Run tcode SPRO to start IMG, and follow the path IMG -> Agentry SAP Framework Configuration -> System Settings. Choose activity 'Define Mobile Applications', this will launch the ConfigPanel tool of the Mobile Application Integration Framework. Page 6 of 16

7 Verify that in ConfigPanel -> Mobile Application Configuration, mobile application 'Z_ODATA_DELTA_SERVICES' exists. 1.5 ReviewListofExistingxChangeObjects We also want to verify xchange Objects have been defined. From ConfigPanel page, use link 'ConfigPanel Home' to navigate to ConfigPanel home page. Page 7 of 16

8 From ConfigPanel home page, select link 'Exchange Object Configuration' to go to xchange Object configuration area. In xchange Object Configuration, set the Mobile Application Filter to app 'Z_ODATA_DELTA_SERVICES'. This will filter out xchange Objects not belong to mobile app 'Z_ODATA_DELTA_SERVICES'. You should see 16 xchange Objects listed. There are total of 16 xchange Objects provided: ZODATA_ACCOUNT - Change detection for master data Account ZODATA_ACTIVITY - Change detection for 1Order transactions business activities ZODATA_CONTACT - Change detection for master data Contact Person ZODATA_EMPLOYEE - Change detection for master data Employee ZODATA_LEAD - Change detection for 1Order transactions Lead ZODATA_MARKETING_ATTRIBUTE - Change detection for master data Marketing Attribute Page 8 of 16

9 ZODATA_MARKETING_ATTRIBUTE_SET - Change detection for master data Marketing Attribute Set. ZODATA_MARKETING_ATTRIBUTE_VALUE - Change detection for master data Marketing Attribute Value. ZODATA_OPPORTUNITY - Change detection for 1Order transaction Opportunity. ZODATA_PRODUCT - Change detection for master data Product. ZODATA_QUOTATION - Change detection for 1Order transaction Sales Quotation. ZODATA_SALES_ORDER - Change detection for 1Order transaction Sales Order. ZODATA_SERVICE_CONFIRMATION - Change detection for 1Order transaction Service Confirmation. ZODATA_SERVICE_ORDER - Change detection for 1Order transaction Service Order. ZODATA_SURVEY - Change detection for master data survey definition. ZODATA_TASK - Change detection for 1Order transaction Task. If you don't find the xchange Objects in the ConfigPanel, please repeat step 1.2 and xchangeobjectexplanationtechnicalsettings Technical settings for an xchange Object defines the most essential technical information about the xchange Object. Exchange Object - Unique Identifier for xchange Object. xchange Object Id is always unique in the SAP system. No duplicate is allowed. For best practice, when name an xchange Object, use a naming convention for each mobile application. xchange Object Id is also namespace protected. Customer defined xchange Object should use Y* and Z* namespace. Partner defined xchange Object should use partner namespace /XXX/. Mobile Application - Each xchange Object must be assigned to one mobile application. Page 9 of 16

10 Exchange Table Name - Name of the transparent table in SAP system where change detection information is stored. You can use tcode SE16 data browser to exam the content of Exchange Table. Change detection information is captured for individual mobile application. Exchange Handler - ABAP OO class that handles change detection logic for the Exchange Object. Active Flag - Enable or disable an Exchange Object. 1.7 xchangeobjectexplanationchangedetectionfieldselection Change detection field selection defines the list of attributes change detection should be performed. If set, only when value of the specified the attributes changes should the xchange Object consider the business object is changed. Value change to attributes not specified in the field selection list is simply ignored. You can use this functionality to fine tune how change detection should be performed at the fieldby-field level. Page 10 of 16

11 1.8 xchangeobjectexplanationchangedetectionconditionfilter Change detection condition filter allows you to define filters to limit change detection to a subset of business object data. Only for qualified data set based on the condition filter rules, value changes will be considered. You also have the option to ignore changes due to data creation, or data deletion, or data update. You can fine tune the condition filter rules based on the business requirement of delta query services. In the example below, a change condition filter rule is defined for filter OBJECT_TYPE. Only 1Order transactions for object type 'BUS ' are qualified for change detection. Page 11 of 16

12 1.9 xchangeobjectexplanationlinkagesettings When supported technically by the xchange Object handler and configured in xchange Object settings, you can define xchange Object linkage. This is useful when a business object instance is changed, a trigger should also be raised so change detection is performed for related business objects. In the example below, if change has occurred to a business activity transaction, we also want to trigger change detection for any other 1Order transactions that are included in the business activity transaction document flow. Page 12 of 16

13 2 RetrieveDeltaObjectKeyListfromODataDeltaQueryServiceClass To support OData delta query service using change detection information captured by xchange Object, you must do the following: A custom Netweaver Gateway service is built using the standard Gateway OData channel procedure. Implement support for timestamp based DeltaToken in Netweaver Gateway Data Provider Class Implement call to xchange Framework to retrieve delta object key list using a timestamp based DeltaToken 2.1 ConstructTimestampBasedDeltaTokeninInitialQueryRequest In the GET_ENTITYSET method of your OData Runtime Data Provider class, implement the logic to construct the DeltaToken in the response to the initial delta query request. Code example below shows how to setup initial delta token: METHOD /iwbep/if_mgw_appl_srv_runtime~get_entityset.... * determine delta token. DATA: lv_date TYPE d, lv_time TYPE t, lv_timestamp TYPE timestampl, lv_guid_string TYPE string, lv_consumer_guid TYPE os_guid, lv_delta_token TYPE string. DATA: ls_header TYPE ihttpnvp. DATA: lo_delta_context TYPE REF TO /iwbep/if_mgw_req_entitystdlta. "Provide a GUID to the consumer CALL FUNCTION 'GUID_CREATE' IMPORTING ev_guid_16 = lv_consumer_guid. lv_guid_string = lv_consumer_guid. CALL METHOD me->update_client_state EXPORTING iv_guid = lv_consumer_guid ir_tech_request_context = io_tech_request_context CHANGING Page 13 of 16

14 cr_entityset = er_entityset. lo_delta_context?= io_tech_request_context. lv_delta_token = lo_delta_context->get_deltatoken( ). IF lv_delta_token IS INITIAL. GET TIME STAMP FIELD lv_timestamp. CONVERT TIME STAMP lv_timestamp TIME ZONE 'UTC ' INTO DATE lv_date TIME lv_time. CONCATENATE lv_guid_string '_' lv_date lv_time INTO es_response_context-deltatoken. ENDIF.... * Put Deltatoken into http-header ls_header-name = 'deltatoken'. ls_header-value = es_response_context-deltatoken. CALL METHOD me->/iwbep/if_mgw_conv_srv_runtime~set_header EXPORTING is_header = ls_header. ENDMETHOD. "/iwbep/if_mgw_appl_srv_runtime~get_entityset 2.2 RetrieveDeltaObjectKeyListinSubsequentDeltaQueryRequest If delta token is provided by the delta query service consumer, we will make call to the utility method provided by the xchange Framework to retrieve the relevant delta object key list. With the delta object key list, we can then build the appropriate context for the delta query request. To make the call to xchange Framework utility class, we need to have the following information: Mobile application - Use the mobile application delivered by the BC Set as described in section 1, i.e, 'Z_ODATA_DELTA_SERVICES'. xchange Object Id - Based on the context for which OData service provider is needed, the appropriate xchange Object Id should be identified and used. Based on the xchange Object Id, the content of the relevant xchange Table are queried by the utility method, and the delta object key list is generated. Delta Token Timestamp in UTC - Delta token timestamp is used to calculate the delta object key list by the xchange Framework. Output EREF_OBJKEY_LIST_RANGE - Contains list of delta object keys returned by xchange Framework. Recommend to use structure '/IWBEP/T_COD_SELECT_OPTION'. Page 14 of 16

15 Code example below shows how to retrieve delta token from incoming request, making call to xchange Framework to determine delta object key list, and recalculate the new delta token value. In practical implementation, you could combine the logic in section 2.1 and 2.2 to support delta query. METHOD /iwbep/if_mgw_appl_srv_runtime~get_entityset.... * determine delta token. DATA: lv_ts TYPE timestamp, lv_timestamp TYPE timestampl, lv_date TYPE d, lv_time TYPE t, lv_guid_string TYPE string, lv_ts_string TYPE string, lv_delta_token TYPE string. DATA: ls_header TYPE ihttpnvp. DATA: lt_objkey_list TYPE /iwbep/t_cod_select_options. DATA: lo_delta_context TYPE REF TO /iwbep/if_mgw_req_entitystdlta. DATA: lref_objkey_list TYPE REF TO /iwbep/t_cod_select_options. Page 15 of 16 CONSTANTS: lc_odata_mobile_app TYPE /syclo/core_mobile_app_dte VALUE 'Z_ODATA_DELTA_SERVICES', lc_exobj_1o_activity TYPE /syclo/core_exchobj_dte VALUE 'ZODATA_ACTIVITY'. lo_delta_context?= io_tech_request_context. "Look for delta token in request lv_delta_token = lo_delta_context->get_deltatoken( ). "Delta token is found with value, this is delta query IF lv_deltatoken IS NOT INITIAL. "Decode delta token into timestamp value SPLIT lv_delta_token AT '_' INTO lv_guid_string lv_ts_string. lv_ts = lv_ts_string. "Make call to xchange Framework to retrieve delta object key list "based on the delta token timestamp "We need to provide the following to make the call: " Mobile application - default to Z_ODATA_DELTA_SERVICES " xchange Object - based on what is needed by specific OData " Service Provider. Here we use example ZODATA_ACTIVITY GET REFERENCE OF lt_objkey_list INTO lref_objkey_list. /smfnd/cl_core_exobj_tools=>determine_delta_objkeys( EXPORTING iv_mobile_app = lc_odata_mobile_app

16 ... iv_exchobj = lc_exobj_1o_activity iv_time_token = lv_ts IMPORTING eref_objkey_list_range = lref_objkey_list ). "Update delta token with the latest timestamp GET TIME STAMP FIELD lv_timestamp. CONVERT TIME STAMP lv_timestamp TIME ZONE 'UTC ' INTO DATE lv_date TIME lv_time. CONCATENATE lv_guid_string '_' lv_date lv_time INTO es_response_context-deltatoken. ENDIF.... * Put Deltatoken into http-header ls_header-name = 'deltatoken'. ls_header-value = es_response_context-deltatoken. CALL METHOD me->/iwbep/if_mgw_conv_srv_runtime~set_header EXPORTING is_header = ls_header. ENDMETHOD. "/iwbep/if_mgw_appl_srv_runtime~get_entityset Page 16 of 16