--- parser: v2 auto_validation: true primary_tag: software-product>mobile-development-kit-client tags: [ software-product>mobile-development-kit-client, tutorial>beginner, operating-system>ios, operating-system>android, topic>mobile, software-product>sap-business-technology-platform, software-product>sap-mobile-services, software-product>sap-build-code, software-product>sap-build, software-product>sap-business-application-studio ] time: 25 author_name: Jitendra Kansal author_profile: https://github.com/jitendrakansal slug: cp-mobile-dev-kit-annotations canonical_url: https://developers.sap.com/tutorials/cp-mobile-dev-kit-annotations --- # Use OData Annotations to Add CRUD Functionality to an MDK App Generate a fully functional CRUD cross-platform application based on OData annotations. ## Prerequisites - **Tutorial group:** [Set Up for the Mobile Development Kit (MDK)](https://developers.sap.com/group.mobile-dev-kit-setup.html) - **Install SAP Mobile Services Client** on your [Android](https://play.google.com/store/apps/details?id=com.sap.mobileservices.client) device or [iOS](https://apps.apple.com/us/app/sap-mobile-services-client/id1413653544)
![Play Store QR Code](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-0.1.png)
Android		![App Store QR Code](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-0.2.png)
iOS
(If you are connecting to `AliCloud` accounts, you will need to brand your [custom MDK client](https://developers.sap.com/tutorials/cp-mobile-dev-kit-build-client.html) by allowing custom domains.) ## You will learn - How MDK editor parses OData Annotations for a given OData service - How to create a fully functional cross-platform application ## Intro You may clone an existing metadata project from the [MDK Tutorial GitHub repository](https://github.com/SAP-samples/cloud-mdk-tutorial-samples/tree/main/4-Level-Up-with-the-mobile-development-kit/4-Use-OData-Annotations-to-Add-CRUD-Functionality-to-an-MDK-App) and start directly with step 5 in this tutorial but make sure you complete step 2. --- Mobile development kit brings OData annotations capabilities to your cross-platform applications. MDK editor supports generating List-Detail pages based on annotations. List-Detail pages are similar to a Master-Detail page, but it is two pages instead of one. The MDK editor parses existing annotations to give you a huge leap forward in your cross-platform applications. ![OData Annotations List-Detail Pages Overview](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-0.1.gif) ### Understand the SAP Fiori Elements SAP Fiori Elements is a framework comprising of templates for commonly used application patterns, for example List Report, Worklist, Object Page, Overview Page and Analytical list page. Predefined templates combined with OData service and annotations generates SAP Fiori application at startup. ### Add annotation information in the backend destination Sample backend in SAP Mobile Services provides annotation functionality for **Products**. 1. In SAP MDK Demo App configuration, click `Sample OData ESPM`. ![SAP MDK Demo App Sample OData ESPM](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-0.3.png) 2. Select **Include Predefined Annotations** option and click **Save**. This will add Product annotation to the sample backend destination. ![Include Predefined Annotations Option Selected](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-0.4.png) ### Create a New Project Using SAP Build This step includes creating a mobile project in SAP Build Lobby. 1. In the SAP Build Lobby, click **Create** > **Create** to start the creation process. ![SAP Build Lobby Create Button](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-1.1.png) 2. Click the **Application** tile and choose **Next**. ![Application Tile Selection](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-1.2.png) 3. Select the **Mobile** category and choose **Next**. ![Mobile Category Options](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-1.3.png) 4. Select the **Mobile Application** to develop your mobile project in SAP Business Application Studio and choose **Next**. ![Mobile Application Option Selection](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-1.4.png) 5. Enter the project name `mdk_annotations` (used for this tutorial) , add a description (optional), and click **Review**. ![Project Name Entry Review Screen](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-1.5.png) >SAP Build recommends the dev space it deems most suitable, and it will automatically create a new one for you if you don't already have one. If you have other dev spaces of the Mobile Application type, you can select between them. If you want to create a different dev space, go to the Dev Space Manager. See [Working in the Dev Space Manager](https://help.sap.com/docs/build_code/d0d8f5bfc3d640478854e6f4e7c7584a/ad40d52d0bea4d79baaf9626509caf33.html). 6. Review the inputs under the Summary tab. If everything looks correct, click **Create** to proceed with creating your project. ![Project Summary Review Screen](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-1.5.1.png) 7. Your project is being created in the Project table of the lobby. The creation of the project may take a few moments. ![Project Creation In Progress Lobby](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-1.6.png) 8. After you see a message stating that the project has been created successfully, click the project to open it. The project opens in SAP Business Application Studio. ![Project Created Successfully Open](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-1.7.png) >When you open the SAP Business Application Studio for the first time, a consent window may appear asking for permission to track your usage. Please review and provide your consent accordingly before proceeding. >![SAP BAS Usage Consent Window](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-1.8.png) ### Configure the Project Using Storyboard The Storyboard provides a graphical view of the application's runtime resources, external resources, UI of the application, and the connections between them. This allows for a quick understanding of the application's structure and components. - **Runtime Resources**: In the Runtime Resources section, you can see the mobile services application and mobile destination used in the project, with a dotted-line connected to the External Resources. - **External Resources**: In the External Resources section, you can see the external services used in the project, with a dotted-line connection to the Runtime Resource or the UI app. - **UI Application**: In the UI Applications section, you can see the mobile applications. 1. Click on **+** button in the **Runtime Resources** column to add a mobile services app to your project. ![Runtime Resources Column Add Button](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-2.1.png) >This screen will only show up when your CF login session has expired. Use either `Credentials` OR `SSO Passcode` option for authentication. After successful signed in to Cloud Foundry, select your Cloud Foundry Organization and Space where you have set up the initial configuration for your MDK app and click Apply. >![CF Login Credentials Dialog](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-2.2.png) 2. Choose `myapp.mdk.demo` from the applications list in the **Mobile Application Services** editor. ![Mobile Application Services App Selection](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-2.3.png) 3. Select `com.sap.edm.sampleservice.v4` from the destinations list and click **Add App to Project**. ![Destination Selection Add App To Project](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-2.4.png) >You can access the mobile services admin UI by clicking on the Mobile Services option on the right hand side. In the storyboard window, the app and mobile destination will be added under the Runtime Resources column. The mobile destination will also be added under the External Resources with a dotted-line connection to the Runtime Resource. The External Resource will be used to create the UI application. ![Storyboard With Runtime Resources Added](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-2.5.png) 4. Click the **+** button in the UI application column header to add mobile UI for your project. ![UI Application Column Add Button](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-2.6.png) 5. In the **Basic Information** step, provide the below information and click **Next**. You will modify the generated project in next step and will deploy it later. | Field | Value | |----|----| | `MDK Template Type` | `Base` | | `Enable Auto-Deployment to Mobile Services After Project Creation` | Select `No` | ![Basic Information Step MDK Template](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-2.7.png) >The `Base` template creates the offline or online actions, rules, messages and an empty page (`Main.page`). After using this template, you can focus on creating your pages, other actions, and rules needed for your application. More details on _MDK template_ is available in [help documentation](https://help.sap.com/doc/f53c64b93e5140918d676b927a3cd65b/Cloud/en-US/docs-en/guides/getting-started/mdk/bas.html#creating-a-new-project-cloud-foundry). 6. In the **Data Collections** step, provide the below information and click **Finish**. Data Collections step retrieves the entity sets information for the selected destination. | Field | Value | |----|----| | `Enter a path to service (e.g. /sap/opu/odata/sap/SERVICE_NAME)` | Leave it as it is | | `Select the Service Type` | Leave the default value as `OData` | | `Enable Offline` | Select `No` | ![Data Collections Step Configuration](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-2.8.png) Regardless of whether you are creating an online or offline application, this step is needed for app to connect to an OData service. When building an MDK Mobile application, it assumes the OData service created and the destination that points to this service is set up in Mobile Services. >Data Collections step retrieves the entity sets information for the selected destination. 7. After clicking **Finish**, the storyboard is updated displaying the UI component. The MDK project is generated in the project explorer based on your selections. ![Storyboard Updated With UI Component](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-2.9.png) ### Add MDK Annotation component to MDK project 1. Right-click `Application.app` and select **MDK:New Annotation Component**. ![Application.app New Annotation Component Menu](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-4.1.png) 2. In the **Annotation Selection** step, MDK editor fetches annotation details. Select **Product** Annotation and click **Next**. ![Annotation Selection Product Step](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-4.2.png) 3. In **Template Customization** step, select **CRUD** Template and click **Finish**. ![Template Customization CRUD Selection](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-4.3.png) In MDK project, you will see new pages, actions, and rules have been generated for **Products**. ![Generated Products Pages Actions Rules](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-4.4.png) You will also notice a button control has been generated on the `Main.page` to navigate to `Product_List.page`. Pages, actions and rules created are a starting point. You can edit those pages and make it your own. At this point the MDK editor is no longer reading the annotations from OData. >If the OData designer updates the backend services data schema (annotations), the MDK pages will stay as originally created. It will not automatically update the pages or overwrite your changes. You are *disconnected* from the annotations at this point. ### Deploy the Project So far, you have learned how to build an MDK application in the SAP Business Application Studio editor. Now, you will Deploy the Project definitions to Mobile Services to run it in the Mobile client. 1. Open the `Application.app` file, click the **Deploy** option in the editor's header area, and then choose the deployment target as **Mobile Services**. ![Application.app Deploy Option Header](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-5.1.png) 2. Select deploy target as **Mobile Services**. ![Mobile Services Deploy Target Selection](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-5.2.png) If you want to enable source for debugging the deployed bundle, then choose **Yes**. ![Enable Source For Debugging Prompt](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-5.3.png) You should see **Deploy to Mobile Services successfully!** message. ![Deploy To Mobile Services Success Message](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-5.4.png) ### Display the QR code for onboarding the Mobile app SAP Business Application Studio includes a feature that displays a QR code for onboarding in the mobile client. To view the onboarding QR code, click the **Application QR Code** icon in the editor's header area. ![Application QR Code Icon Header](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-6.1.png) The On-boarding QR code is now displayed. ![Onboarding QR Code Displayed](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-6.2.png) >Leave the Onboarding dialog box open for the next step. ### Run the Project [OPTION BEGIN [Android]] >Ensure that you choose the correct device platform tab above. Once you have scanned and onboarded using the onboarding URL, it will be remembered. If you log out and onboard again, you will be prompted to either continue using the current application or scan a new QR code. 1. Follow [these steps](https://github.com/SAP-samples/cloud-mdk-tutorial-samples/blob/main/Onboarding-Android-client/Onboarding-Android-client.md) to successfully on-board the MDK client on your Android device. After you accept app update, tap on the **Products** to navigate to the Products List page. ![Products Navigation List Page Android](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-6.3.png) 2. In following pages, you can create a new record, modify an existing record, open the product image, add a purchase order item, add a sales order item and even delete the record. ![Product Detail Page Android Step 1](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-6.4.png) ![Product Detail Page Android Step 2](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-6.5.png) [OPTION END] [OPTION BEGIN [iOS]] >Ensure that you choose the correct device platform tab above. Once you have scanned and onboarded using the onboarding URL, it will be remembered. If you log out and onboard again, you will be prompted to either continue using the current application or scan a new QR code. 1. Follow [these steps](https://github.com/SAP-samples/cloud-mdk-tutorial-samples/blob/main/Onboarding-iOS-client/Onboarding-iOS-client.md) to successfully on-board the MDK client on your iOS device. After you accept app update, tap on the **Products** to navigate to the Products List page. ![Products Navigation List Page iOS](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-6.6.png) 2. In following pages, you can create a new record, modify an existing record, open the product image, add a purchase order item, add a sales order item and even delete the record. ![Product Detail Page iOS Step 1](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-6.7.png) ![Product Detail Page iOS Step 2](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-annotations/img-6.8.png) [OPTION END] ---