# Autotests Screen
The Autotests screen is designed to make the managing of functional testing projects easier.
To access the screen, click «Autotests» in the main system menu.
# Project Management
# Creation
To create a new project on the Autotests screen, click «Create Project» in the upper right corner. In the window that opens specify the Workgroup-Owner, enter the Name, and optionally specify a brief Description of the project. Click «Add» and a new project will be created in the Paused state, and you will be redirected to the project page.
# Settings
To change general project settings (Name, Owner, Description), go to the «Settings» tab, enter the new value in the required fields, and press «Save«.
You can add tags to the project for better navigation – to do this, click «Add Tags» next to the project name and enter the tag name. If the tag you are looking for already exists, it will be attached to the project; if not, choose the color of the new tag, and it will be created automatically.
To set up Workgroups access to the project, go to the «Access» tab.
To give workgroups permissions to view or edit the project, select one or more groups in the «Select workgroups» field, select view or edit in the field beside, and click «Grant access».
To change the granted permission, change the type of access in the selector next to the corresponding group's name.
To revoke access, click on the «🗑« icon next to the group name.
To start the reception of functional testing builds, configure the project:
- In the *Settings tab, generate and copy the API key – click *Update, then *Copy.
- Select a build parser – select an appropriate parser in the «Build parser» selector for processing assemblies coming into the project.
- Go to the automated test execution system and provide the API key you have copied earlier.
For Jenkins: go to the project settings and enter the command
export X_TESTFORGE_PROJECT_KEY=<API key>
into the «Execute Shell command» field, where<API key>
is the key you copied in step 1.
To change the project's state, use the options in the upper right corner of the page:
Click Start to let the project start receiving autotest build reports.
Click Stop to make the project stop receiving reports.
Optionally – add tags or change the description to indicate the project suspension reason and enable «Delayed start» to automatically Run the project at the selected time.
Click «Archive» to make the project stop receiving reports and stop the project from being displayed on the project screen by default.
Optionally – add labels or change the description to indicate the reason for archiving the project.
WARNING
You can start only the configured projects for which a build report parser is specified.
To bind the project to a CI, use the selector on the «Bound CIs» tab.
To unbind a project from a CI, click «🗑« next to the CI's name.
# Project Navigation
To navigate among the synthetic monitoring projects, return to the Testforge screen.
The central filtering and navigation tool on the screen is the rubricator, a set of quick filters for the main project parameters. It is located on the left side of the screen.
To use the rubricator, expand any of the parameters in the table on the left: Tags, Owner, Project State, Last Build Status and select the value you want to filter projects by.
The values of all selected parameters will be displayed to the right of the search bar.
To make more complex filtering conditions, select multiple values for one or more parameters.
TIP
Filter conditions with different values of the same parameter are combined using the OR
operator, and values of the different parameters are joined using the AND
operator.
To exclude a condition, click on the cross symbol to the right of the parameter-value pair in the rubricator or to the right of the search bar.
To reset all filtering conditions, select «All projects» at the top of the rubricator. Select «Favorite Projects» to display only the favorite projects.
After configuring the required filter, you can save it for easy access – click «Save as» in the upper area of the page and enter a name. Once saved, the filter will be available for selection in the drop-down list to the left of the «Save» button. Click it, and the projects will filter by the corresponding conditions.
Open the drop-down list and mark the filter with «⭐️«(Favorites)** – the filter will be displayed in the quick access bar at the top of the screen.
You can edit and delete the selected filter – open the supplementary menu to the right of the «Save» button and select the required action: Save as – save the filter with a new name, Rename – change the name of the selected filter, Reset changes – reset filtering conditions to the last saved ones, Delete query – delete the filter.
# Quick Actions
You can interact with projects in the Autotests screen without having to open the project page.
To manage project tags, click on the «Add Tags» field on the right from the project name – in the drop-down list select an available tag to add to the project. If the required tag doesn't exist, it will be created automatically. To remove a tag from the project click the cross button on the right side of the tag.
To quickly copy the project API key open the context menu to the right of the project tags and click «Copy API Key».
To quickly change the project state, open the context menu to the right of the project tags and select the required one: «Start Project» «Pause Project» «Archive Project».
For quick access to the required project page tab, open the context menu to the right of the project tags and select the required one: «Open Access Settings» «Open Bound CIs»
Click «⭐️« on the right from the context menu to add the project to Favorites or to remove it from.
Favorite projects are always displayed at the top of the project list.