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.
Watch a video overview of the process:
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. Open the Apty Studio application and select the hosting application you plan to work with. The Apty 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:
Multiple regular expression Validators can be applied to the same field.
Multiple regular custom validators can be applied to the same field.
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:
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.
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:
Go to Admin Console > on the left side panel select an application you've worked at in the Editor > in the Application Menu go to Publish > Frames.
Green dots next to the frame indicate the frame is Published,
Yellow dots indicate the frame is in Draft mode, and blue dots indicate the status of Ready.