Apty pursues multiple goals: it navigates end users through the complex processes in the hosting application via Workflows, reminds them about important events through Announcements, provides valuable tips and tricks via Tooltips, and verifies that the data that users provide is clear and useful via Validations. The latter is achieved by adding sufficient instructions and rules on what can and cannot be accepted as input to the page of a hosting application. Validations are advanced Tooltips that provide prompts whether the data entered is correct or not.
|Reference: What is a Validation?|
This instructions set explains the procedure of creating Validations and includes 3 steps:
- Accessing Validations option in the Apty Studio,
- Creating a Validation,
- Publishing a Frame with a Validation.
To access Validations option in the Apty Studio:
1. Login to the the Apty Studio and select the hosting application you plan to work with. The Studio menu opens.
2. Click on the Validations icon.
3. The system will prompt you to create a Frame, unless it was created earlier. If the required Frame for this page was created earlier, select it from the list.
To learn how to create a Frame, refer to this article.
To create a Validation:
1. On the Validations page click Create New Validation or the + (Plus) button at the top right corner of the screen.
2. Click Select Spotlight. The control is now passed to the application page in the browser. Select the input field, check box, radio button, or another interactive element that is supposed to validate user action.
3. Provide the unique descriptive name for your Validation settings in the Name field.
4. Add Validators. Four categories of the validations can be added to an input field:
- Required field: checks whether the field is empty and if so, the form with the input will not be submitted.
- Length constraint: checks whether the input fits within the range of the specified length.
- Regular expression: Powerful way to check the format / accuracy of the input provided by the end user. For example, to check whether the user has entered a valid email address, the following regular expression is used:
5. Define position the position of an icon and error / success message upon validation:
- Apty offers 12 predefined positions to locate the balloon around the element it belongs to. Click on the circles in the Editor to preview how the ballon is going to look on the hosting web application in the live mode.
- Icon offset: Allows setting up the proximity of a balloon to an element.
Show Icon when field has not been touched yet: For validations, Apty has the ability to show or hide the validation icon beside the Spotlight field. When the Show icon.. box is checked, the Validation icon is visible beside the element it belongs to; otherwise, it is hidden until the user tries to interact with the element.
6. Click Save to start using a new Validation rule. It is now available as a part of a Frame in the Admin Console, but to make it active, it should be published.
To publish a Frame with Validation:
When all the Validations are added to the required Spotlights in a Frame and are ready to be used, system still preserves them in the Draft status, unless stated otherwise.
To change the Frame status to Ready or Publish:
PATH: Admin Console > on the left side panel select an application you've worked at in the Apty Studio > Publish > Frames
- Draft: This state specifies that the content is in the development state and is not ready for testing or being available for end users.
- Ready: This state defines that the instructional content is ready for testing in the development or test environment. In this state the content can be seen in the Apty Player only in the development environment but is not available in the production environment.
- Publish: This state specifies that the content has been tested and is ready to be available for the hosting application end users. The content in this state will be visible in the Apty Player to the production environment.
Once the Frame is published, Validations cannot be modified. In order to modify the Validations, change the status of the Frame to the Draft state.
For more instructions on Managing Validations refer to: