Our documentation site has been updated to AIO Tests Knowledge Base
Custom Fields
Sometimes users need additional fields to track their organization’s testing process. AIO Tests allows users to define custom fields allowing them to personalize AIO Tests to their needs and track details at a more granular level.
Custom Fields in AIO Tests is project specific and is currently available for Cases, Sets, Cycles and Runs. Once created, data for custom fields can also be imported while importing cases and cases with custom fields can also be exported. Custom fields can also be marked as required fields.
Only Jira Admins, Project Admins and designated AIO Admins can add/edit/delete custom fields in the project
- 1 Creating a Custom Field
- 2 Custom Fields for Sprint and Jira Custom Fields
- 3 Custom Fields for Runs
- 4 Accessing Case, Set and Cycle Custom Fields
- 5 Accessing Run Custom Fields
- 6 Editing a Custom Field
- 7 Deleting a Custom Field
- 8 Custom Fields Available for Viewing and Sorting in Lists (grids)
- 9 Custom Fields Available for Filtering
- 10 Reserved Names
Creating a Custom Field
Listed below are the types of custom fields that can be created in AIO Tests.
Boolean: Allows users to define a yes/no type of field
Date: Allows users to define a date field
Number: Allows users to define a number field
Single line text: Users can enter a single line of text in this field
Single select list: Users can choose a single value from a list of options
Multi select list: Users can choose multiple values from the provided list
Single user selector: Users can pick one user from the list and also select if the user should be notified via email
Multi user selector: Users can pick multiple users from the list and also select if the users should be notified via email
URL: Users can enter URLs that can point to confluence requirements, google drive documents, etc.
Multi-line text (RTF): Text can be entered on multiple lines using RTF for this type of field
Jira Field: Users can bring in their single-select Jira fields in AIO Tests along with Sprint information
To create a custom field, follow the steps below:
Click on gear icon and select Project Settings. Select Custom Fields from the left panel
Click on the ‘+' sign to open the custom field entry screen. Name is a mandatory field. By default, in the Type drop-down, Boolean will be selected. Users can change the type of custom field using the highlighted down arrow. Users can click on the highlighted 'Save’ button to save the newly created custom field
Name - Name of the field to be created
Description - Description of the field to be created
Type - Type can be anyone of the above described types
Applies To - Select the entity for which the field is being created
Required - Check the box if the field is required for any entity
Allowed List Values - This is applicable for Single select list and Multi select list. Define the values from which the users can choose
Default Values - Enter values in the space so that when the entity is being created the default value will be entered automatically. Users will have the option to change it upon entity creation
Notify User - This is applicable only for ‘Single user selector’ and ‘Multi-user selector’ options. Users can choose if the person should be notified via emails about them being added to this field
Users cannot create two custom fields with same name.
Custom Fields for Sprint and Jira Custom Fields
AIO Tests supports creating custom fields mapped to single select custom fields and Sprint fields in Jira.
Users can create a new custom field and select Jira Field from the Type dropdown. This would fetch all Jira fields applicable to the Issue Screens in Jira along with Sprint (if applicable in project).
Select the Jira field to map to. Set a name and select the entities the custom field applies to. Values are populated from Jira. In case of Jira custom field, applicable values to current project are displayed. In case of Sprint, sprints applicable to boards of current project will be shown.
Select default values if required and mark them as mandatory, based on need.
Save the custom field. Once created, the Jira based custom fields would continue to work as other custom fields and should be available in filters, columns, export, import, copy of cases etc.
Custom Fields for Runs
Users can also define custom fields at the Run level to capture details while execution e.g. Browser, Environment, Build Numbers, etc.
If the field is marked as mandatory, users will get the option to specify on which status the validation should be triggered. Read here on how to access them.
Please note, “Not Run” type of statuses cannot be used for triggering validations.
Accessing Case, Set and Cycle Custom Fields
Once fields are created, they will be available as a separate section in each of the entities. The image below shows how the newly added fields appear on ‘Create Case’ screen. It will similarly appear on Create Set, Create Cycle and corresponding Edit screens.
Right panels
The Custom fields also appear on the right panels of all entities as shown below (shown for Cycle).
Accessing Run Custom Fields
The custom fields defined for Runs are only available on the Execution tab within the Cycle Details page. They can be edited using the pencil icon next to the heading.
If the fields have been marked as mandatory, validations will be triggered on the corresponding status change (as well as bulk status change).
The custom fields can be updated for multiple runs together using the ‘Bulk edit latest runs’ option from Manage Cases ellipsis. Validations will be triggered based on the status selected and setup.
Editing a Custom Field
To edit a custom field, go to Project Settings → Custom Fields and click on the edit icon next to the field. The field values will become editable. Users can change the name, applicable entity, default values and allowed list values.
Deleting a Custom Field
A custom field can be deleted from the system if it doesn’t have any associated values in any of the entities using the delete icon.
Custom Fields Available for Viewing and Sorting in Lists (grids)
Most of the custom fields will be available to be added in the lists view on all entities via the Column Selector.
Once the field is added to the grid view, users can sort on the custom fields by clicking on the header.
Custom Fields Available for Filtering
Once the fields have been added, they are available in the list of filters. Users can filter on these fields even if they are not added to the grid view.
Reserved Names
To avoid confusion with AIO Tests default fields, certain names have been reserved and thus users cannot create custom fields with names same as the reserved names. Below is the list.
assignee | component | folder | s.no. |