Verifying the User Input

Objective

After completing this lesson, you will be able to Help users see if their input is incorrect.

User Input Validation

As a user creates a new business object item or changes an existing one by selecting the Edit button on the object page, the system creates a draft which is automatically saved in the background. The message Draft updated is displayed in the footer after each update of the draft. It is allowed to update draft while it is still incomplete and inconsistent. In order to activate the draft (that is to save the draft as an active document), the input should be consistent. For that, there are different validation checks which can be done.

For more information about draft handling, see Draft Handling.

Client Side Validations

Client side validations, as the name suggests, are executed on the front end and are done and visualized immediately after the focus leaves the input field. For example, a user can enter the wrong date format or more characters than the field length allows. The field is marked red and a message button appears in the footer of the object page ( bottom left). It displays the number of errors and, when choosing it, a message popover opens and displays the messages. They are displayed as long as the errors are not corrected.

Client Side Validation Message

You can also navigate to the corresponding field and see the same error message there.

The Error Message displayed in the Field

Back-end validations

Other input consistency checks may require some validations in the back end. Usually such validations are triggered as a user chooses the Save button on the object page (correspondingly the Apply button on the subobject page).

The app is responsible for preparing such consistency checks in the back end.

For example, CAP runtimes automatically validate user input in the fields which correspond to the properties annotated with @assert.integrity, @assert.target, and some others. Check the CAP documentation for the complete list of supported input validation annotations Input Validation.

SAP Fiori elements automatically displays messages that are sent from the back end as part of the request-response cycle. The messages for subitems are also displayed.

Messages referring to the state of an instance, for example input consistency checks, are called state messages. They are displayed in the Edit mode on the object page and the subobject page in the same popover as the client side validation messages. The messages are displayed on the UI as long as the inconsistencies are not corrected. The state messages can be persisted in the back end.

For the sake of completeness we have to mention the transition messages which can also be sent from the back end.

They are 'transient' in nature and do not affect the state of the object. They refer only to the last action that was executed. These messages are not relevant for the user input validation. These messages can be displayed in the list report or on the object page in the display mode. For more information, see Using Messages.

For more annotations for User Input validation with CAP, see Common Annotations.

Add the Validation for the Field Agency on the Object Page

Usage Scenario

In the Manage Travels app, you want to prevent users from adding an incorrect agency name. To achieve this, you want to add a validation so that an error is displayed each time when the user tries to save a travel entry with an agency name that doesn't exist in the database.

Task Flow

In this exercise, you will add an annotation that validates the user input for the field Agency.

In the CAP CDS data model, to_Agency is a managed to-one association in the Travel entity to the TravelAgency entity. So, a CAP validation will be triggered for to_Agency during Create and Edit events. In UI terms, this is when the user selects Save to save the travel entry on the object page.

Prerequisites

You have completed the exercise Hide the Starting Date and End Date for Travels with the Canceled Travel Status in the unit Applying Dynamic Field Control and Validating User Input on the Object Page (lesson: Dynamically Affecting the Visibility and Editability of UI Elements). Alternatively, you can check out its solution branch: solution/hide-starting-and-end-dates-for-canceled-travels.

Watch the Simulation and/or Perform the Steps

This exercise provides a simulation that guides you through the list of steps below. Performing these steps allows you to follow the simulation in your trial account.

Steps

  1. Open your CAP project in SAP Business Application Studio.

  2. In the Explorer view, under Projects, select db/data/schema.cds.

  3. Open the schema.cds file.

  4. In the Travel entity, add the @assert.target annotation for to_Agency.

    It is a managed to-one association to the TravelAgency entity. The annotation checks if the user input for the Agency field has a corresponding entry in the associated or referenced target table for the TravelAgency entity.

  5. Perform the following steps to check.

    1. Open the Manage Travels app.

    2. Click Edit.

    3. Enter a value in the Agency field. This value must not exist in the reference table.

    4. Click Save.

Result

You cannot save the document as the value entered in the Agency field is incorrect.

Note

Log in to track your progress & complete quizzes