--- author_name: Joshua Margo author_profile: https://github.com/jmmargo keywords: tutorial auto_validation: true time: 10 tags: [ tutorial>beginner, type>tutorial ] primary_tag: type>tutorial parser: v2 slug: docs-tutorial-3-adding-validationv2 canonical_url: https://developers.sap.com/tutorials/docs-tutorial-3-adding-validationv2 --- # Add Validation to a Tutorial (v2 parser) Add validation to your tutorial so developers can show that they've completed it successfully. ## You will learn - How to create a rules files with validation steps - How to add a validation step to the end of a tutorial step - How to turn on validation for a tutorial ## Intro Validation allows developers to show that they finished a tutorial successfully, for example, by answering questions or copy-and-pasting the correct code into validation text areas. After passing the validation for all steps, the developer is listed as completing the tutorial. ![Validation example](https://raw.githubusercontent.com/sap-tutorials/meta-tutorials/main/tutorials/docs-tutorial-3-adding-validationv2/ExampleValidationCongrats.png) For examples of validation, see the tutorials in the missions in the [AppSpace](https://developers.sap.com/app-space.html). > To complete validation, the developer must be logged in. > **IMPORTANT:** Please use at least one fill-in-the-blank type question, and one multiple-answer question for each mission you create. The rules are created in a file called `rules.vr`, which you add to your tutorial folder (just like images). The file always is called `rules.vr`, so be careful that you don't confuse rules files for different tutorials. >**IMPORTANT**: Never commit the `rules.vr` file to the production repository. When checking a user's answer, the 1DX system references the `rules.vr` file in the QA repository. We have added the `rules.vr` file to the `.gitignore` file, Git will ignore it. Developers can check all the tutorials they've completed by going to the Developer Center [home page](https://developers.sap.com). ### Add validation tag Validation metadata should be added to the tutorial metadata, so when using a tutorial template, there is nothing to do here. If you are writing the tutorial from an empty markdown file, be sure to insert the value in the tutorial metadata. ![Tag](https://raw.githubusercontent.com/sap-tutorials/meta-tutorials/main/tutorials/docs-tutorial-3-adding-validationv2/Tag.png) This metadata indicates that you have added validation to your tutorial. If temporarily you need to publish your tutorial to QA without validation -- and without errors being thrown -- you can remove the tag ... temporarily. > **IMPORTANT:** The value should always be **`true`**. ### Create the rules file Add a file called `rules.vr` to your tutorial folder (the new tutorial wizard will add one for you). The file is a set of rules, each one separated by a start and end `[VALIDATE_X]` tag (where X is an integer that represents the step number): ``` [VALIDATE_1] ###Rule exact-match ###Match OrderButtonText=Order OrderDialogTitle=Order Product OrderDialogMsg=Do you want to order this product now? OrderDialogSuccessMsg=The product has been ordered [VALIDATE_1] ``` Place the name of the rule element (e.g., `###Rule` and `###Match`) on its own line and the text that corresponds to that element on the following line. How to write each rule type is described in the `RULE` steps below. >**IMPORTANT**: The `rules.vr` file is never committed to the production repository. When validating a tutorial, the 1DX system references the `rules.vr` file in the QA repository. When moving your tutorial to production, make sure the `rules.vr` file is not included. ### Add validation to tutorial steps To add a validation to a step, just indicate the step number before and after the validation text. In the example code block below the validation will be appended to step three. ``` [VALIDATE_3] ###Rule single-choice ###Question True or False - Pipes are required on the outside of table content. ###Match [ ] True [x] False [VALIDATE_3] ``` ### Test tutorial With your tutorial in the `tutorials` folder, commit your validation changes, and then check that the validation works as you expected. >Once you successfully validate a step, you cannot do the validation again (e.g., to check other input) unless you clear all of your progress. >  >To clear your progress, go to **[My Progress](https://www.sap.com/developer/progress.html)** and click **Forget Me**. at the bottom of the page. If something doesn't work properly, update your rules **AND** tutorial file (add an extra space to the Markdown file if you otherwise don't need to make changes), commit and push the changes, and retest. ### RULE Question, single answer >**IMPORTANT:** Please make sure that at least one question per mission is NOT this type of question and is fill-in-the-blank type question. Currently, there is no way to avoid "cheating" and quickly discovering the correct answer. Use multiple-answer (even with only 1 correct answer). **In this example, the user is asked to select the correct answer to a question.** The rule code: ```RULE [VALIDATE_1] ###Rule single-choice ###Question Select the correct file which contains the routing instructions: ###Match [ ] Detail.view.xml [ ] Component.js [ ] formatter.js [x] manifest.json [VALIDATE_1] ``` ### RULE Question, multiple answer **In this example, the user is asked to select the correct answers (more than one) to a question. You can set any number of correct answers.** The rule code: ```RULE [VALIDATE_2] ###Rule multiple-choice ###Question Which of the following file(s) must be modified to insert an `i18n` string in an app view? ###Match [x] Detail.view.xml [ ] Component.js [x] i18n.properties [ ] manifest.json [VALIDATE_2] ``` ### RULE Text matches **In this example, the user is asked to enter text that exactly matches the validation text. The validation is case sensitive.** >**IMPORTANT:** This validation ignores white spaces and casing. The rule code: ```RULE [VALIDATE_3] ###Rule exact-match ###Question Enter code. ###Match OrderButtonText=Order OrderDialogTitle=Order Product OrderDialogMsg=Do you want to order this product now? OrderDialogSuccessMsg=The product has been ordered [VALIDATE_3] ``` In the text area below, enter the following text, and click **Submit Answer**. ``` OrderButtonText=Order OrderDialogTitle=Order Product OrderDialogMsg=Do you want to order this product now? OrderDialogSuccessMsg=The product has been ordered ``` ### RULE Text exactly matches **In this example, the user is asked to enter text that exactly matches the validation text. The validation is case sensitive.** >**IMPORTANT:** This validation requires the user to enter the text EXACTLY as it appears in the rules file. The rule code: ```RULE [VALIDATE_4] ###Rule exact-match-precise ###Question Enter code. ###Match OrderButtonText=Order OrderDialogTitle=Order Product OrderDialogMsg=Do you want to order this product now? OrderDialogSuccessMsg=The product has been ordered [VALIDATE_4] ``` In the text area below, enter the following text, and click **Submit Answer**. ``` OrderButtonText=Order OrderDialogTitle=Order Product OrderDialogMsg=Do you want to order this product now? OrderDialogSuccessMsg=The product has been ordered ``` ### RULE Text starts with **In this example, the user is asked to enter text that begins with the validation text. The validation is case sensitive.** The rule code: ```rules [VALIDATE_5] ###Rule regex-begins-with ###Question Enter code. ###Match document.GetElementById('test'); [VALIDATE_5] ``` In the text area below, enter text that begins `document.GetElementById('test');` and click **Submit Answer**. ### RULE Text contains **In this example, the user is asked to enter text that exactly matches the validation text, but can include text before or after. The validation is case sensitive.** The rule code: ``` [VALIDATE_6] ###Rule regex-substring ###Question Enter code. ###Match ``` ### RULE Text exactly matches with ID **In this example, the user is asked to enter text that exactly matches the validation text, but with their ID instead of `[id]`. This validation is NOT case sensitive.** The rule code: ```RULE [VALIDATE_7] ###Rule regex-with-id-exact-match ###Question Enter code. ###Match https://codejam[id]trial.hanatrial.ondemand.com/codejam/mylibrary.xsjs [VALIDATE_7] ``` In the validation box below, copy the following URL, but replace the '[id]' with your ID: `https://codejam[id]trial.hanatrial.ondemand.com/codejam/mylibrary.xsjs` You need to be logged in. ### RULE HTTP status code **In this example, the user is asked to enter a URL that returns the status code specified in the rule (such as `200`).** The rule code: ``` [VALIDATE_8] ###Rule http-status-check ###Question Enter URL. ###Match 200 [VALIDATE_8] ``` Enter a valid URL, one that returns a status code of 200. ### RULE Custom Regex **In this example, the user is asked to enter text that exactly matches a regular expression.** To construct the regular expression, you may wish to use online parsers, such as . >We use the Java implementation of regular expressions. See . The rule code: ```RULE [VALIDATE_9] ###Rule regex ###Question Enter code. ###Match ^https:\/\/account.hanatrial.ondemand.com\/cockpit\/.*\/\w\d+trial\/ [VALIDATE_9] ``` In the text area below, enter the following text, and click **Submit Answer**. ``` https://account.hanatrial.ondemand.com/cockpit/#/acc/i347491trial/accountdashboard ```