Skip to Content

Implement Create Entity and Linking Entities in an MDK App

test
0 %
Implement Create Entity and Linking Entities in an MDK App
Details
// Explore More Tutorials

Implement Create Entity and Linking Entities in an MDK App

Create relationship between two OData entities.

You will learn

  • How to create relationship between parent and child entities
  • How to create a local child entity to an existing parent entity
  • How to create a local parent entity first and then a local child entity
  • How to implement dynamic data subscription


For this tutorial, you will use Mobile Services sample backend which has parent-child relationship setup among entities. For example, A customer can have n (>=0) number of sales orders.

To implement deep insert between parent and child OData entities, you need to carry out the following tasks:

  • Create a new page for creating an order
  • Add an action bar item to the new page for cancelling the current activity
  • Create a new CreateEntity OData action to create a new sales order
  • Create a new message action for displaying failure message if order creation fails
  • Create a navigation action to show order creation page from Customer detail page
  • Implement data subscription to update count value when a new sales order is created
MDK
Step 1: Create new page for new Sales order record

In this step, you will create the Create Order page as a Form Cell Page. This type of page allows for form input style changes. The page will provide only a subset of items available on the Customer Detail page. You will add the fields that will be editable by the end-user.

Right click on the Pages folder | New MDK Page | Form Cell Page | Next.

MDK

A Form Cell Page is suitable for pages that generate new objects or modify existing objects. It includes a form cell container by default. You can add form sections, multiple containers or action controls to this page. Under each container section, you can add various container items.

You can find more details about Form Cell page.

Enter the Page Name SalesOrderHeaders_Create and click Next and the Finish on the Confirmation step.

MDK

In the Properties pane, set the Caption to Create Order.

MDK

Now, you will add the fields (like Currency Code, Net Amount, Tax Amount, Gross Amount, Life cycle status, Life cycle status name and order creation date) for creating a new sales order record by the end-user.

In the Layout Editor, expand the Control | Container Item section.

You can find more details about available controls in Form Cell page.

Drag and drop a Simple Property onto the Page area.

MDK

Drag and drop five additional Simple Property controls and one Date Picker control onto the page so you have seven total controls.

MDK

Select the first Simple Property control and provide the below information:

Property Value
Name FCCreateCurrencyCode
Caption CurrencyCode
isEditable true
Value EUR
MDK

Under Value property, you can set some default values.

Select the second Simple Property control and provide the below information:

Property Value
Name FCCreateNetAmount
Caption NetAmount
isEditable true
Value 18.010
MDK

Select the third Simple Property control and provide the below information:

Property Value
Name FCCreateTaxAmount
Caption TaxAmount
isEditable true
Value 108.010
MDK

Select the forth Simple Property control and provide the below information:

Property Value
Name FCCreateGrossAmount
Caption GrossAmount
isEditable true
Value 126.02
MDK

Select the fifth Simple Property control and provide the below information:

Property Value
Name FCCreateLifeCycleStatus
Caption LifeCycleStatus
isEditable true
Value N
MDK

Select the sixth Simple Property control and provide the below information:

Property Value
Name FCCreateLifeCycleStatusName
Caption LifeCycleStatusName
isEditable true
Value New
MDK

Select the last control Date Picker and provide the below information:

Property Value
Name FCCreatedate
Caption Creation Date
isEditable true
Mode datetime
Value Enter Date
MDK

At the end, page should look like below:

MDK

Save the changes to the SalesOrderHeaders_Create.page.

Log on to answer question
Step 2: Add cancel button on create customer page

Now, you will add a button on the Create Order page and set its onPress to CloseModalPage_Cancel.action.

Drag and drop an Action Bar Item to the upper left corner of the action bar.

Action Bar Item is a button that users can use to fire actions when pressed. You can add an Action Bar Item only to the Action Bar (at the top of the page).

MDK

In the Properties pane, click the link icon to open the object browser for the System Item property.

Double click on the Cancel type and click OK.

MDK

System Item are predefined system-supplied icon or text. Overwrites Text and Icon if specified.

Now, you will set onPress to CloseModalPage_Cancel.action.

In Events tab, click the link icon for the OnPress property to open the object browser.

Double click on the CloseModalPage_Cancel.action and click OK to set it as the OnPress Action.

MDK

Save the changes to the SalesOrderHeaders_Create.page.

Log on to answer question
Step 3: Create navigation action

Now, create a navigation action that will open the SalesOrderHeaders_Create.page when executed.

Right-click on the Actions folder | New MDK Action | choose MDK UI Actions in Category | click Navigation Action | Next.

MDK

Provide the below information:

Property Value
Action Name NavToSalesOrderHeaders_Create
Page To Open select SalesOrderHeaders_Create.page
ModalPage check this option
MDK

Click Next and then Finish on the confirmation step.

Log on to answer question
Step 4: Add Create Order toolbar item to customer detail page

You will add a toolbar item to the Customers_Detail.page called Create Order. You will link this button to the navigation action you just created. This event will open the SalesOrderHeaders_Create.page when the Add button is pressed by the end-user.

In Customers_Detail.page, drag and drop a Toolbar Item to the lower left of the page.

MDK

In the Properties pane, set Caption to Create Order.

MDK

In the Properties pane, click the Events tab, click the link icon for the OnPress property to open the object browser.

Double Click on the NavToSalesOrderHeaders_Create.action and click OK to set it as the OnPress Action.

MDK

Save the changes to the Customers_Detail.page.

Log on to answer question
Step 5: Store the created data locally

The next step is to store newly created record locally for an offline application or send the new record directly back to the backed for online applications. You will now create an action to map the changes received from the Create Order page to the corresponding field in the OData service. You will also show a failure message if the create action fails to save the changes.

First, define a failure message.

Right-click on the Actions folder | New MDK Action | choose MDK Message Actions in Category | click Message Action | Next.

MDK

Provide the below information:

Property Value
Action Name CreateSalesOrderHeaderEntityFailureMessage
Type select Message
Message Failed to Create Sales Order record
Title Create Sales Order
OKCaption OK
OnOK --None--
CancelCaption leave it blank
OnCancel --None--
MDK

Click Next and then Finish on the Confirmation step.

Next, you will create the OData action to create a sales order entity.

You can find more details about Create Entity Action.

Right-click on the Actions folder | New MDK Action | choose MDK Data Actions in Category | click OData Action | Next.

MDK

Provide the below information:

Property Value
Action Name SalesOrderHeaders_CreateEntity
Type CreateEntity
Service SampleServiceV2
EntitySet SalesOrderHeaders
MDK

Click Next.

Since in SalesOrderHeaders_Create.page, we have defined seven properties (Currency Code, Net Amount, Tax Amount, Gross Amount, Life Cycle Status, Life Cycle Status Name and Creation Date) to be added, now in this step, we will bind them to respective UI Controls.

Check the CreatedAt property (if not already) and click the link icon to open the object browser.

Change the drop down in the object browser to Controls & ClientData, click the Current Page radio button.

In the search box start typing the control name FCCreatedate. The list will filter down to show the matching values. Double click on the Value (Value) entry under the FCCreatedate field and click OK to set binding.

MDK

Repeat the above step for remaining properties: CurrencyCode, NetAmount, TaxAmount, GrossAmount, LifeCycleStatus and LifeCycleStatusName.

MDK

Under CreateLinks, select the checkbox for CustomerDetails and provide {{#Page:-Previous/#Property:@odata.readLink}} value under Options column.

MDK

CreateLinks allows you to link one or more entity objects to one of the target Entity’s navigation property.

Page:-Previous: A target path that when resolved will return the PageProxy object of the page before the currently displayed page.

In Mobile Services sample backend, click Metadata URL and you will find CustomerDetails navigation property for SalesOrderHeader entity.

MDK

Click Next and Finish on the confirmation screen. The action editor will open with the SalesOrderHeaders_CreateEntity.action loaded.

Next, define Success and Failure actions for SalesOrderHeaders_CreateEntity.action.

In the action editor for the new action, expand the Common Action Properties and provide the below information:

Property Value
Success Action CloseModalPage_Complete.action
Failure Action CreateSalesOrderHeaderEntityFailureMessage.action

When SalesOrderHeaders_CreateEntity.action gets executed successfully then CloseModalPage_Complete.action will be triggered or if SalesOrderHeaders_CreateEntity.action fails then CreateSalesOrderHeaderEntityFailureMessage.action will be triggered.

MDK

Save the changes to the SalesOrderHeaders_CreateEntity.action.

Now that the SalesOrderHeaders_CreateEntity.action has been created, you will need to call this action when the end-user presses the Save button. You will add a Save button on the SalesOrderHeaders_Create.page and link it to the SalesOrderHeaders_CreateEntity.action.

In SalesOrderHeaders_Create.page, drag and drop an Action Bar Item to the upper right corner of the action bar.

MDK

Click the link icon to open the object browser for the System Item property.

Double click on the Save type and click OK.

MDK

In the Properties pane | Events tab, click the link icon for the OnPress property to open the object browser, bind it to SalesOrderHeaders_CreateEntity.action.

MDK

Save the changes to the SalesOrderHeaders_Create.page.

What is the CustomerDetails property in CreateOrder action being referred to ?
×
Step 6: Add data subscription to Customer detail page

In Customers_Detail.page you added total number of order counts for a given customer. When a new SalesOrder is created, this count doesn’t get updated automatically unless you navigate back and forth to this page.

DataSubscriptions : it is a way to listen to data changes that when triggered should cause a UI element to redraw. If your control or section has a target, that target is automatically subscribed for data change events. Otherwise you can also explicitly subscribe to DataSubscriptions by specifying an entity set name or readLink in an array. You can find more details here.

In Customers_Detail.page, select Customer Orders Object Table control. In Properties section, click + icon under Misc and double click SalesOrderHeaders and click OK.

MDK

Save the changes to the Customers_Detail.page.

Log on to answer question
Step 7: Deploy and activate the application

Deploy the updated application to your MDK client.

Right-click on the DemoSampleApp MDK Application in the project explorer pane and select MDK Deploy and Activate.

MDK

Since we have deployed already both the destination and app id should be pre-selected based on the last time you deployed our application.  Confirm the Destination Name is mobileservices_cf and the Application Id is com.sap.mdk.demo and click Next.

MDK
Log on to answer question
Step 8: Test the application

Make sure you are choosing the right device platform tab above.

Re-launch the app on your device, you may asked to authenticate with passcode or Fingerprint. You will see a confirmation pop-up, tap OK.

Tap CUSTOMER LIST, tap one of the available customer record, you will then navigate to Customer detail page.

You will see the CREATE ORDER option in customer detail page. Tap on it to create a new sales order.

MDK

As we provided default values to the properties, you may change it if required. Tap on save icon*.

MDK

Now, you will notice that count value for SEE ALL is increased by one as you implemented in step 6.

MDK

On Main page, tap SYNC to send local changes to the backend, a successful message will be shown.

MDK

Re-launch the app on your device, you may asked to authenticate with passcode or Touch ID. When you see a confirmation pop-up, tap OK.

Tap Customer List, tap one of the available customer record, you will then navigate to Customer detail page.

You will see the Create Order option in customer detail page. Tap on it to create a new sales order.

MDK

As we provided default values to the properties, you may change it if required. Tap Save.

MDK

Now, you will notice that count value for See All is increased by one as you implemented in step 6.

MDK

On Main page, tap Sync to send local changes to the backend, a successful message will be shown.

MDK
Log on to answer question

Next Steps

Back to top