diff --git a/tutorials/mob-app-mao-erp-app-create/mob-app-mao-erp-app-create.md b/tutorials/mob-app-mao-erp-app-create/mob-app-mao-erp-app-create.md index 37009150c..3c746c0b8 100644 --- a/tutorials/mob-app-mao-erp-app-create/mob-app-mao-erp-app-create.md +++ b/tutorials/mob-app-mao-erp-app-create/mob-app-mao-erp-app-create.md @@ -8,20 +8,20 @@ author_profile: https://github.com/I545182 parser: v2 --- -# Create an SAP Mobile Services App for the SAP Service and Asset Manager Mobile App -Create and update an SAP Mobile Services app for the SAP Service and Asset Manager mobile app using the Mobile Services App Create transaction /MERP/CPMS_APPCREATE from the SAP GUI. +# Create a SAP Service and Asset Manager Mobile Services App with Metrics +Create and update a SAP Service and Asset Manager Mobile Services App with Metrics using transaction /MERP/CPMS_APPCREATE from the SAP GUI. ## Prerequisites - Access to your SAP BTP Subaccount and Space. - Access to the SAP Mobile Services service in your SAP BTP subaccount. -- Latest App Create and Metrics Updates. Please review SAP Note 3703174 for the latest updates. +- Latest App Create and Metrics Updates. Please review [SAP Note 3703174](https://me.sap.com/notes/3703174) for the latest updates. ## You will learn -- How to create and update an SAP Mobile Services app for the SAP Service and Asset Manager mobile app using the MS App Create transaction `/MERP/CPMS_APPCREATE`. -- How to review the created MS app. +- How to create and update a SAP Service and Asset Manager Mobile Services App with Metrics using transaction `/MERP/CPMS_APPCREATE`. +- How to review the SAP Service and Asset Manager Mobile Services App with Metrics - Optional Features: - 1. Use an RFC Destination (Middleware Server) to create the App. - 2. Use an RFC Destination to send Metrics to Cloud Reporting. + 1. Use a RFC Destination (Middleware Server) to create the Mobile Services App. + 2. Use a RFC Destination to send Metrics to Cloud Reporting. 3. Set up Satellite Systems. 4. Enable Multiple Threads in Offline Configuration. - Troubleshoot: @@ -30,7 +30,7 @@ parser: v2 3. Usage Metering Background Job Missing. ## Intro -In this mission you will learn how to create and update an SAP Mobile Services app for the SAP Service and Asset Manager mobile app using the SAP Service and Asset Manager Mobile Services App Create transaction **`/MERP/CPMS_APPCREATE`** from the SAP GUI. The Mobile Services app created by the transaction may be used to onboard your SAP Service and Asset Manager mobile app. +In this mission you will learn to create and update a SAP Service and Asset Manager Mobile Services App with Metrics using transaction **`/MERP/CPMS_APPCREATE`** from the SAP GUI. The Mobile Services App created by the transaction may be used to onboard your SAP Service and Asset Manager mobile app. ### Gather the Required Information @@ -42,11 +42,11 @@ In this mission you will learn how to create and update an SAP Mobile Services a ![CCInfo](ccinfo.png) -### Create the Mobile Services App via the MS App Create Transaction +### Create a SAP Service and Asset Manager Mobile Services App with Metrics 1. Execute the transaction **`/MERP/CPMS_APPCREATE`** from the SAP GUI, then select your required variant (i.e., `SAP&SAM_`). -2. Fill in the **Admin API**, **SCC Location Id** and **Virtual Host**. Please ensure the **Background Job User** will maintain authorization to run the Usage Metering background job (parameter info below). To use an RFC Destination to create the app instead of the **Admin API** please see Step 4 (optional). The app is created as the Metrics Host by default, to set up the app as the Metrics Satellite please see Step 6. Then execute the transaction. +2. Fill in the **Admin API**, **SCC Location Id** and **Virtual Host**. Please ensure the **Background Job User** will maintain authorization to run the Usage Metering background job (parameter info below). To use a RFC Destination to create the app instead of the **Admin API** please see Step 4 (optional). The app is created as the Metrics Host by default, to set up the app as the Metrics Satellite please see Step 6. Then execute the transaction. ![SelScreen](selscreen.png) @@ -56,10 +56,10 @@ In this mission you will learn how to create and update an SAP Mobile Services a | **OData Service Mobile App** | Used to generate the mobile app's offline configuration sent to the SAP Mobile Services **Mobile Offline Access** feature. | | **OData Service Technical Name** | Used to generate the mobile app's offline configuration sent to the SAP Mobile Services **Mobile Offline Access** feature. | | **OData Service Group Version** | Used to generate the mobile app's offline configuration sent to the SAP Mobile Services **Mobile Offline Access** feature. | - | **MS Application ID** | The unique application identifier given to the SAP Mobile Services app. | - | **MS Application Name** | The application name given to the SAP Mobile Services app. | - | **MS Application Description** | The application description given to the SAP Mobile Services app. | - | **MS Vendor Name** | The vendor name given to the SAP Mobile Services app. | + | **MS Application ID** | The unique application identifier given to the SAP Mobile Services App. | + | **MS Application Name** | The application name given to the SAP Mobile Services App. | + | **MS Application Description** | The application description given to the SAP Mobile Services App. | + | **MS Vendor Name** | The vendor name given to the SAP Mobile Services App. | | **MS Application Timeout** | The maximum time in milliseconds before a client connection times out in your environment. After that timeout period, the connection is closed. | | **MS App License Type** | The Service Plan used by Mobile Services. The plan `basic-plus-app` is recommended for SAP mobile applications. | | **SCC X.509 Virtual Host** | Used to generate the URL for the Mobile Services Mobile Destinations. | @@ -71,7 +71,7 @@ In this mission you will learn how to create and update an SAP Mobile Services a >**WARNING:** Any change that may affect the offline configuration (e.g., a new entity type is added to your mobile app configuration, or the **Defer Batch Response** setting is changed for the **OData Service Technical Name** provided when generating the offline configuration) will require you to update the offline configuration in Mobile Services and reset your mobile app. See Step 2.5 to update. -3. If you are not using a Middleware Server with an RFC Destination with Basic Authentication enabled, then you should receive a sign-in prompt after executing the transaction. Please use your SAP BTP username and password to sign in. +3. If you are not using a Middleware Server with a RFC Destination with Basic Authentication enabled, then you should receive a sign-in prompt after executing the transaction. Please use your SAP BTP username and password to sign in. >Please allow ~5 minutes to complete processing. @@ -79,13 +79,13 @@ In this mission you will learn how to create and update an SAP Mobile Services a ![Output](output.png) -5. The Mobile Services app can be updated by re-executing the transaction and selecting the features to update when prompted. See additional info for each option below. +5. The Mobile Services App can be updated by re-executing the transaction and selecting the features to update when prompted. See additional info for each option below. | Feature | What is Updated? | | :------ | :--------------- | | **Update Mobile Offline Access** | Updates the offline configuration of your app. | | **Update Usage Metering** | Creates Usage Metering Middleware Server and Background Job. Existing Middleware Server and Background Job are deleted. Updates Client Role in Product Table. Updates MS_UNIFIED_SERVER system component. | - | **Compare Offline Configuration** | Compare offline configuration properties, request groups and request download phases between the backend and the mobile services app. | + | **Compare Offline Configuration** | Compare offline configuration properties, request groups and request download phases between the backend and the Mobile Services App. | | **Update Mobile Connectivity** | Updates the offline and online destination settings of your app. | | **Add Mobile App Update** | Assigns the feature to your app if not already assigned. | | **Update Mobile Push Notification** | Updates the Predefined Global Push Configuration to **SAP ASSET MANAGER**. | @@ -93,7 +93,7 @@ In this mission you will learn how to create and update an SAP Mobile Services a | **Add Mobile Cloud Build** | Assigns the feature to your app if not already assigned. | | **Add Mobile Client Log Upload** | Assigns the feature to your app if not already assigned. | -### Review the Created Mobile Services App +### Review a SAP Service and Asset Manager Mobile Services App with Metrics 1. In the **Native/MDK** section of the SAP Mobile Services service in your SAP BTP subaccount you should see your app in a **Started State** with the **MS Application ID** you provided in Step 2.2. @@ -109,7 +109,7 @@ In this mission you will learn how to create and update an SAP Mobile Services a - **Offline Access** - **Push Notification** -3. From your app's overview screen, select the **Connectivity** feature. You should see two Mobile Destinations created with the properties below. Under the **Actions** column, selecting the **Launch in Browser** icon should return the metadata. +3. From your app's overview screen, select the **Connectivity** feature. You should see two Mobile Destinations created with the properties below. The `sap-client` header should be automatically added to the destinations **Custom Headers** section. Under the **Actions** column, selecting the **Launch in Browser** icon should return the metadata. ![Destinations](destinations.png) @@ -118,15 +118,13 @@ In this mission you will learn how to create and update an SAP Mobile Services a | `DEST_SAM_PPROP` | **`http://:/sap/opu/odata/MERP/SAP_SRV_ASSET_MANAGER_`** | | `DEST_SAM_ONLINE_PPROP` | **`http://:/sap/opu/odata/MERP/SAP_ONLINE_LOOKUP_EXT_`** | -4. The `sap-client` header should be automatically added to the destinations. The client can be edited in the **Custom Headers** section. - - ![EditDest](editdest.png) + **Custom Headers** | Header Name | Header Value | | :-----------| :----------- | | `sap-client` | Your client (i.e., **`800`**) | -5. From your app's **Mobile Connectivity** feature, select the **Service Keys** tab. You should see a Service Key with the properties below. The Key should be automatically maintained as the `X-API-Key` property in the Additional Properties of the Usage Metering Middleware Server which we will review in Step 3.9. +4. From your app's **Mobile Connectivity** feature, select the **Service Keys** tab. You should see a Service Key with the properties below. The Key should be automatically maintained as the `X-API-Key` property in the Additional Properties of the Usage Metering Middleware Server which we will review in Step 3.8. | Field Name | Value | | :--------- | :---- | @@ -134,15 +132,15 @@ In this mission you will learn how to create and update an SAP Mobile Services a | Roles | **`sap_application_metering`** | | Type | **`API Key`** | -6. From your app's overview screen, if you select the **Offline Access** feature you should be able to display and edit the offline configuration. If the offline configuration is missing, then please see Step 8. +5. From your app's overview screen, if you select the **Offline Access** feature you should be able to display and edit the offline configuration. If the offline configuration is missing, then please see Step 8. -7. From your app's overview screen, select the **APIs** tab to view the onboarding QR code which you can scan from the SAP Service and Asset Manager mobile app. +6. From your app's overview screen, select the **APIs** tab to view the onboarding QR code which you can scan from the SAP Service and Asset Manager mobile app. -8. We will now check the Usage Metering Middleware Server. Execute transaction **/SYCLO/ADMIN** from the SAP GUI to open up the MAIF Admin Panel. Navigate to **Administration** > **Server Management**. Select the Middleware Server with the name noted in Step 2.4. If the Usage Metering Middleware Server is missing then please see Step 8. +7. We will now check the Usage Metering Middleware Server. Execute transaction **/SYCLO/ADMIN** from the SAP GUI to open up the MAIF Admin Panel. Navigate to **Administration** > **Server Management**. Select the Middleware Server with the name noted in Step 2.4. If the Usage Metering Middleware Server is missing then please see Step 8. ![MDW](mdw.png) -9. Verify that the Middleware Server has the following **Basic Info** and **Additional Properties**. If the Middleware Server's **Basic Info** or **Additional Properties** are not as expected then please see Step 9. +8. Verify that the Middleware Server has the following **Basic Info** and **Additional Properties**. If the Middleware Server's **Basic Info** or **Additional Properties** are not as expected then please see Step 9. **Basic Info** @@ -167,11 +165,11 @@ In this mission you will learn how to create and update an SAP Mobile Services a | **`METERING`** | **`X-API-Key`** | **``** | | **`METERING`** | **`service_path`** | **`/mobileservices/service-key/metering`** | -10. To verify that the Usage Metering Background Job is scheduled, please execute transaction **SM37** from the SAP GUI and search for the job name noted in Step 2.4. If the background job is missing, then please see Step 10. +9. To verify that the Usage Metering Background Job is scheduled, please execute transaction **SM37** from the SAP GUI and search for the job name noted in Step 2.4. If the background job is missing, then please see Step 10. ![SM37](sm37.png) -11. Execute transaction **/SYCLO/CONFIGPANEL** from the SAP GUI to open up the MAIF Configuraiton Panel. Navigate to **Mobile Application Configuration** > **System Components**. You should see a system component with the properties below. +10. Execute transaction **/SYCLO/CONFIGPANEL** from the SAP GUI to open up the MAIF Configuration Panel. Navigate to **Mobile Application Configuration** > **System Components**. You should see a system component with the properties below. ![SystemComponent](syscomp.png) @@ -181,7 +179,7 @@ In this mission you will learn how to create and update an SAP Mobile Services a | System Role | **`Host`** | | Active Flag | Selected | -12. To ensure the Metrics Requests are sent successfully execute transaction **SE38** and execute program **`/MFND/CORE_CLOUD_METRICS_PROG`**. Provide `SAP_SERVICE_ASSET_MANAGER` in `Product Technical Name` and execute. +11. To ensure the Metrics Requests are sent successfully execute transaction **SE38** and execute program **`/MFND/CORE_CLOUD_METRICS_PROG`**. Provide `SAP_SERVICE_ASSET_MANAGER` in `Product Technical Name` and execute. **Selection Screen** ![MetricsSelScreen](metricsselscreen.png) @@ -200,9 +198,9 @@ In this mission you will learn how to create and update an SAP Mobile Services a | **Persona** | Users having authorization for the Persona. | | **Mobile Application** | Sync Info for the previous day. | - >Persona Authorization configuration can be found in the MAIF Configuration Panel. Execute transaction **/SYCLO/CONFIGPANEL** from the SAP GUI to open up the MAIF Configuraiton Panel and navigate to **Mobile Application Configuration** > **Application Persona**. + >Persona Authorization configuration can be found in the MAIF Configuration Panel. Execute transaction **/SYCLO/CONFIGPANEL** from the SAP GUI to open up the MAIF Configuration Panel and navigate to **Mobile Application Configuration** > **Application Persona**. -### Optional Feature 1 - Use an RFC Destination (Middleware Server) to Create the App +### Optional Feature 1 - Use a RFC Destination (Middleware Server) to Create the Mobile Services App 1. Execute transaction **SM59** from the SAP GUI. Then click the create icon. @@ -251,21 +249,21 @@ In this mission you will learn how to create and update an SAP Mobile Services a | `Middleware Svr SerNo` | **`SCP`** | | RFC Destination | **`Z_MS_ADMIN_API`** | -10. You may now use the generated **Server GUID** instead of the **Admin API** in Step 2.2 . You may use F4 Help on the **Admin API or Middleware Server GUID** field of the MS App Create transaction to search for the created Middleware Server. +10. You may now use the generated **Server GUID** instead of the **Admin API** in Step 2.2 . You may use F4 Help on the **Admin API or Middleware Server GUID** field to search for the created Middleware Server. ![ServerGUID](serverguid.png) -### Optional Feature 2 - Use an RFC Destination to send Metrics to Cloud Reporting +### Optional Feature 2 - Use a RFC Destination to send Metrics to Cloud Reporting -1. Copy the **URL** of the **Server API**. from the APIs tab of your Mobile Services app. +1. Copy the **URL** of the **Server API**. from the APIs tab of your Mobile Services App. ![UIHost](uihost.png) 2. Execute transaction **SM59** from the SAP GUI. Then click the create icon. -2. Provide the destination name **`Z_SAM_METERING`** and set **Connection Type** to **`G HTTP Connection to External Server`** (substituting `` with your app version). +3. Provide the destination name **`Z_SAM_METERING`** and set **Connection Type** to **`G HTTP Connection to External Server`** (substituting `` with your app version). -3. Provide the copied URL without `https://` in **Host** field of the Target System Settings. Use the **Port** and **Path Prefix** as in the example below. +4. Provide the copied URL without `https://` in **Host** field of the Target System Settings. Use the **Port** and **Path Prefix** as in the example below. ![RFCTechSetMeter](rfctechsetmeter.png) @@ -275,19 +273,19 @@ In this mission you will learn how to create and update an SAP Mobile Services a | Service No.(Port) | **`443`** | | Path Prefix | **`/mobileservices/service-key/metering`** | -4. In the **Logon & Security** tab, within the **Security Options** > **Status of Secure Protocol** section, of your RFC destination please set the **SSL** radio button to **Active**. +5. In the **Logon & Security** tab, within the **Security Options** > **Status of Secure Protocol** section, of your RFC destination please set the **SSL** radio button to **Active**. ![RFCSecSetMetering](rfcsecsetmetering.png) -5. Save the RFC Destination. +6. Save the RFC Destination. -6. We will now update the Usage Metering Middleware Server with the RFC Destination created. To update the Middleware Server, execute transaction **/SYCLO/ADMIN** from the SAP GUI to open up the MAIF Admin Panel. +7. We will now update the Usage Metering Middleware Server with the RFC Destination created. To update the Middleware Server, execute transaction **/SYCLO/ADMIN** from the SAP GUI to open up the MAIF Admin Panel. -7. Navigate to the **Administration** > **Server Management** section. +8. Navigate to the **Administration** > **Server Management** section. -8. Select the Middleware Server with the name noted in Step 2.4. If the Usage Metering Middleware Server is missing then please see Step 9. +9. Select the Middleware Server with the name noted in Step 2.4. If the Usage Metering Middleware Server is missing then please see Step 9. -9. Update the **RFC Destination** and click **Save**. +10. Update the **RFC Destination** and click **Save**. ![MDWMetering](mdwmetering.png) @@ -295,17 +293,17 @@ In this mission you will learn how to create and update an SAP Mobile Services a 1. Please ensure app has been created and reviewed (Steps 2 and 3) in the Host System. -2. Follow Steps 1 and 2 and Check `Satellite System` before executing. The `Host RFC Destination` may be provided to create Middleware Server in the Host System used to retrieve the Metrics from the Satellite System. If you do not provide the `Host RFC Destination` please ensure you manually create the Middleware Server in the Host System. +2. Follow Steps 1 to 2.2 then return to this Step before executing. Check the `Satellite System` checkbox. Provide the `Host RFC Destination` (recommended) to create the Satellite Middleware Server in the Host System that will be used to retrieve the Metrics from the Satellite System. If you do not provide the `Host RFC Destination` please ensure you manually create the Satellite Middleware Server in the Host System (see Step 6.5). Execute the transaction. If you are updating an existing app please select **Update Usage Metering** feature when prompted. ![SatelliteSettings](satsettings.png) -3. Please take note of the **Middleware Server** created on the Host System with RFC. +3. Please take note of the **Middleware Server** created on the Host System via RFC. ![SatelliteOutput](satoutput.png) 4. In the Host System execute transaction **/SYCLO/ADMIN** from the SAP GUI to open up the MAIF Admin Panel. Navigate to the **Administration** > **Server Management** section. -5. Select Middleware Server noted above. Create Satellite Middleware Server if not created automatically via RFC in the previous step. Edit the Middleware Server and provide an RFC Destination to the Satellite System. Ensure the RFC authentication is automatic. +5. Select Middleware Server noted above. Create Satellite Middleware Server if not created automatically via RFC in the previous step. Edit the Middleware Server and provide a RFC Destination to the Satellite System. Ensure the RFC authentication is automatic. **Basic Info** @@ -315,28 +313,31 @@ In this mission you will learn how to create and update an SAP Mobile Services a | :--------- | ----- | | Mobile Application | **``** | | Server Name | **`_MS_UNIFIED_SERVER_CLNT`** | + | System Component | **`MS_UNIFIED_SERVER`** | | `Middleware Svr SerNo` | **`SCP`** | | Server GUID | **``** | | Port | **`00443`** | - | UI Host Name | **`https://example.cfapps.sap.hana.ondemand.com`** | - | RFC Destination | Provide RFC Destination to Satellite System | + | UI Host Name | No Value Required | + | RFC Destination | Provide a RFC Destination to the Satellite System | **Additional Properties** (case sensitive) ![SatServerProps](satserverprops.png) - + | Property Group | Property Name | Property Value | | :------------- | :------------ | :------------- | - | **`METERING`** | **`Host`** | **` `** | - | **`METERING`** | **`X-API-Key`** | **``** | - | **`METERING`** | **`service_path`** | **`/mobileservices/service-key/metering`** | + | **`METERING`** | **`Host`** | No Value | + | **`METERING`** | **`X-API-Key`** | No Value Required | + | **`METERING`** | **`service_path`** | No Value Required | + + >Ensure all properties exist even with no values. -12. To ensure the Satellite Metrics are retrieved successfully execute transaction **SE38** and execute program **`/MFND/CORE_CLOUD_METRICS_PROG`** in the Host System. Provide `SAP_SERVICE_ASSET_MANAGER` in `Product Technical Name` and execute. +6. To ensure the Satellite Metrics are retrieved successfully execute transaction **SE38** and execute program **`/MFND/CORE_CLOUD_METRICS_PROG`** in the Host System. Provide `SAP_SERVICE_ASSET_MANAGER` in `Product Technical Name` and execute. **Successful Output** ![SatMetricOutput](satmetricoutput.png) -### Optional Feature 3 - Enable Multiple Threads in Offline Configuration +### Optional Feature 4 - Enable Multiple Threads in Offline Configuration 1. Follow Step 2.1 and 2.2 then return to this Step before executing. Then click **Advanced Mode**. @@ -376,7 +377,7 @@ In this mission you will learn how to create and update an SAP Mobile Services a ### Troubleshoot 2 - Usage Metering Middleware Server Missing and/or Properties Missing -1. Follow Step 2.5 and select **Usage Metering** feature when prompted. +1. Follow Step 2.5 and select **Update Usage Metering** feature when prompted. 2. Alternately, you may create the Usage Metering Middleware Server manually. Execute transaction **/SYCLO/ADMIN** from the SAP GUI to open up the MAIF Admin Panel. @@ -399,21 +400,21 @@ In this mission you will learn how to create and update an SAP Mobile Services a | Port | **`00443`** | | UI Host Name | **`https://example.cfapps.sap.hana.ondemand.com`** | - >The **UI Host Name** can be found in the **APIs** tab of your Mobile Services app. Copy the **URL** of the **Server API**. + >The **UI Host Name** can be found in the **APIs** tab of your Mobile Services App. Copy the **URL** of the **Server API**. > >![UIHost](uihost.png)
 
**Additional Properties** (case sensitive) ![MDWMeterAddProp](mdwmeteraddprop.png) - + | Property Group | Property Name | Property Value | | :------------- | :------------ | :------------- | - | **`METERING`** | **`Host`** | **`X` or ` `** | + | **`METERING`** | **`Host`** | **`X`** | | **`METERING`** | **`X-API-Key`** | **``** | | **`METERING`** | **`service_path`** | **`/mobileservices/service-key/metering`** | - >To generate **X-API-Key** go to the **Mobile Connectivity** feature of your Mobile Services app and select the **Service Keys** tab. Click the add icon "**+**" to add a Service Key with the following values and copy the generated key. + >To generate **X-API-Key** go to the **Mobile Connectivity** feature of your Mobile Services App and select the **Service Keys** tab. Click the add icon "**+**" to add a Service Key with the following values and copy the generated key. > >![AddServiceKey](addservicekey.png) > @@ -429,7 +430,7 @@ In this mission you will learn how to create and update an SAP Mobile Services a ### Troubleshoot 3 - Usage Metering Background Job Missing. -1. Follow Step 2.5 and select **Usage Metering** feature when prompted. If the background job is still missing, you may try the next steps. +1. Follow Step 2.5 and select **Update Usage Metering** feature when prompted. If the background job is still missing, you may try the next steps. 2. Execute the program **`/MFND/CORE_CLOUD_METRICS_PROG`** in transaction **SE38** from the SAP GUI.