Add Validation to a Tutorial (v2 parser)

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.

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.

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):

###Rule
exact-match

###Match
OrderButtonText=Order
OrderDialogTitle=Order Product
OrderDialogMsg=Do you want to order this product now?
OrderDialogSuccessMsg=The product has been ordered

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.

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.

###Rule
single-choice

###Question
True or False - Pipes are required on the outside of table content.

###Match
[ ] True
[x] False

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 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.

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
single-choice

###Question
Select the correct file which contains the routing instructions:

###Match
[ ] Detail.view.xml
[ ] Component.js
[ ] formatter.js
[x] manifest.json

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
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

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
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

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

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
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

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

In this example, the user is asked to enter text that begins with the validation text. The validation is case sensitive.

The rule code:

###Rule
regex-begins-with

###Question
Enter code.

###Match
document.GetElementById('test');

In the text area below, enter text that begins document.GetElementById('test'); and click Submit Answer.

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:

###Rule
regex-substring

###Question
Enter code.

###Match
<footer>
   <Bar>
    <contentRight>
      <Button text="{i18n>OrderButtonText}"
                   type="Accept"
                 icon="sap-icon://accept"
                 press="handleOrder" />
    </contentRight>
  </Bar>

In the text area below, enter the following text, and click Submit Answer.

<footer>
   <Bar>
    <contentRight>
      <Button text="{i18n>OrderButtonText}"
                   type="Accept"
                 icon="sap-icon://accept"
                 press="handleOrder" />
    </contentRight>
  </Bar>
</footer>

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
regex-with-id-exact-match

###Question
Enter code.

###Match
https://codejam[id]trial.hanatrial.ondemand.com/codejam/mylibrary.xsjs

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.

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:

###Rule
http-status-check

###Question
Enter URL.

###Match
200

Enter a valid URL, one that returns a status code of 200.

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 https://regexr.com/.

We use the Java implementation of regular expressions. See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.

The rule code:

###Rule
regex

###Question
Enter code.

###Match
^https:\/\/account.hanatrial.ondemand.com\/cockpit\/.*\/\w\d+trial\/

In the text area below, enter the following text, and click Submit Answer.

https://account.hanatrial.ondemand.com/cockpit/#/acc/i347491trial/accountdashboard