Legacy checks
Before live checks were available, the custom and template checks were available. You can still use these in your projects but we recommend using live checks instead.
Custom checks
Custom checks are a type of task validation check. They locate potential mistakes in the annotation task and run whenever a team member clicks "validate" in one of this project's tasks.
Custom checks differ from template checks in their flexibility. Kognic broadly defines template checks, while you fully define custom checks.
You find all currently created custom checks and add new ones inside Project Settings and the tab Programmatic Checks.
How do I add and activate a new custom check?
To add and activate a new check you go through the following steps:
- Click the "Add custom check"-button in either the top right corner of the custom checks list or, if no custom checks exist, in the center of the empty custom checks list.
- Select from the available parameters and operators to define the check's conditions. You can select parameters of the type Property or Geometry.
- (Optional) Add additional AND or OR conditions if needed.
- Give your check a name and a description. This will help you and others recognize and understand its function.
- Select what should happen if the check conditions are met during task validation. The check can either trigger a warning or an error. A warning doesn't block task submission, while errors do.
- Write a validation message that should be displayed to the team member performing the task. Make sure it is informative and instructive.
- Click "Add check" and the check is added to the project but in an inactive state.
- Locate your new check in the "Custom check" list and click activate.
- Save your updated project settings.
- You have created and activated a new check! π
How do I ensure my custom checks work as intended?
You can preview custom checks while creating or editing them.
- Locate and click the button called "Test check in task view" (see GIF below). This opens a view link in which the check is activated.
- Create a situation that meets the check's conditions.
- Validate the task by clicking "Test custom check."
- If the check was correctly configured and you successfully created a situation that meets its conditions, a warning or error message should be displayed.
How do I turn off an already existing custom check?
There are two ways to ensure a custom check isn't used in the project's tasks: deactivating or deleting it. If you deactivate the check, it remains available but is currently not used for task validation. If you delete the check, it is removed from the project permanently.
Template checks
Template checks are a type of task validation check. They locate potential mistakes in the annotation task and run whenever a team member clicks "validate" in one of this project's tasks.
Kognic creates and maintains the template checks, but you decide which to use in your project and how to configure them.
You find all available template checks inside Project Settings and the tab Programmatic Checks.
How do I activate and configure a template check?
If you find a template check which seems suitable for the error you want to prevent you can customize and activate it by completing the following steps:
- When you have located a template check you want to use, click "Activate and configure".
- A dialog opens in which you can configure the check to your needs. You do this by editing the check configuration JSON.
- When you feel happy with your configuration, click "Activate check."
- Save your updated project settings.
- You have created and activated a new check! π
How do I turn off an already existing template check?
You can turn off the template check by deactivating it. This means it is no longer used for task validation in the project.