Documentation - aqua cloud
🇬🇧 English
🇬🇧 English
  • 💻Web client
    • Getting started
    • General
      • Home page
      • App language
      • User account
      • Change password
      • Shortcuts & Accessibility
    • How to Contact Our Support
  • 👩‍🔧Administration
  • User administration
    • Adding and editing user profile
    • Roles and permissions
    • Assign, unassign or change licenses
      • Comparison of Licenses
    • Assign/unassign projects and roles
    • Licenses statistics
    • Statistics
  • Project configuration
    • [NEW] Project template configuration (fields)
      • Shared value sets
    • [OLD] Project template configuration (fields)
      • Shared value sets
      • Creating field groups
    • Field rules
    • [NEW] Workflow configuration
      • Global rules
      • Status and transitions
    • [OLD] Workflow configuration
    • Additional project settings
    • Project integrations
    • System log
    • Email notifications
      • Project default notifications
      • My notifications
      • Configuration of the project notification templates
      • Troubleshooting
  • Projects and folders
    • Project wizard
    • Projects
      • Export project
      • Import project
        • Migration from Testrail
      • Archive project
    • Folders
      • Export project folder
      • Import project folder
  • 🧩Modules
  • Navigation page
    • Project tree
    • Items grid
    • Filtering and grouping
    • Views
    • Search
    • Preview item details
  • Items
    • Requirements management
      • Requirements
      • Subrequirements
      • Requirements coverage
    • Test cases management
      • Test cases
      • Nested test cases (shared test cases/steps)
      • Manual testing
      • Test data or Variables manager
      • Test environment tracking with labels (tags)
      • Test execution results
      • Test automation
      • Capture: Test recorder/bug reporter
      • Test it: easy way to start run
      • Quick run: test execution of multiple test cases at once
    • Test scenarios management
      • Test scenarios
      • Adding test cases to a test scenario
      • Executing test scenarios
    • Defects management
      • Defects
      • Creating a defect from a test execution
      • Review found or linked defects to the test execution
      • Creating a defect with Capture
    • General item capabilities
      • Creating and Editing Items
      • Copy item to a target project or duplicate within a project
      • Taking over field values between items
      • Item template (defaults)
      • Dependencies
      • Add links to a description
      • Take screenshots
      • Watch item and notify other users
      • Attachments (files)
      • History of changes
      • Discussions (comments)
      • Print item data
  • Reporting
    • Creating a new report template
    • Basic report elements
    • Element tree structure
    • Element properties
    • Diagrams
    • Pivot table
    • 'Sum' function
    • Creating custom report script
    • Parametrization of reports
    • Exclude empty items from a report
    • Adding table of contents to a report
    • How to filter executions based on custom added fields?
  • Dashboards
    • Creating a dashbord
    • Publishing the dashboard
    • Creating a chart
    • KPI alerts
    • Drilldown to details from a chart
    • Burndown chart template
  • Agile
    • Backlog
    • Sprint board
    • Preview
  • 🖥️Desktop client
    • Getting started
      • Important notice: Deprecation of the desktop client in June 2025 [updated]
      • FAQ: Transitioning from the desktop client to the web Client
      • Desktop installation
      • Home screen configuration
      • Views
      • Grid
    • Agile board
      • Burn Down Chart
    • Dashboard
    • User Administration
      • Adding and managing users
      • Roles and permissions
      • Assigning licenses projects and roles
      • Statistics
    • Project configuration
      • Configuration of Fields and Workflows
      • Email Notification
      • Change company logo in printout
      • Import Project Configuration
    • Import / Export Wizard
    • Project Planner
      • Creating and editing a new project plan
      • Adding and syncing items to project plan
      • Resource planning
      • Gates and Stages
    • Requirements Management
      • Dependency
      • Subrequirements
      • Mind map
      • Comments
      • Documents
    • Test Management
      • Step Designer
      • Test Execution
        • Autosave of a test execution
      • Variable Manager
      • Nested Testcases
      • Disable manual test execution time
    • Test Scenarios
      • Test Scenarios
      • Scheduled Executions of Test Scenarios
      • Run Dependency
    • Defect Management
    • Reporting
      • Creating a Report
      • Creating a new report template
      • The Report Wizard
      • Basic Report Elements
      • Element tree structure
      • Element Properties
      • Diagrams
      • Pivot Table
      • Sum Function
      • Script Development
      • Parametrization
      • Performance Improvements for Report Creation
      • Remove empty elements
      • Table of Contents
      • Invalid References
    • Agile Board
      • Configuring the Agile Component
      • Planning board
      • Scrum board
      • Burn Down Chart
    • Versioning
  • 💿Installation for on premise
    • System Requirements
      • Server
      • Desktop Client
      • Web Client
      • Agents
    • Server Installation
    • Server parameters
    • Web Client Installation
    • Getting Agents
    • Connection to MSSQL Database
    • Connection to Oracle Database 12.2c
    • Licenses
    • Monitoring
    • SSL-Configuration
    • Content Security Policy (CSP) Settings
  • 🪄AI Copilot
    • Transform your testing and project management with aqua's AI Copilot
    • Enable and manage AI Copilot options
    • Create documents with ease with AI Copilot
    • AI Copilot: generate a comprehensive description for the test cases in just one click
    • AI Copilot - create test cases out of requirements or based on context in seconds
      • Create test cases from the navigation page
      • Create test cases from a requirement
      • Create a test case from a test case page
    • Generate test data with AI Copilot
    • Generate test case based on a file
    • Generate test cases in BDD format
    • Generate test cases with AI Copilot using test design techniques
    • Create user stories, BDDs, or PRDs based on a file
    • Create multiple user stories or BDDs with AI Copilot
    • Split or convert requirements
    • AI Copilot chat
  • 🔗Integrations
    • Jira sync: synchronize items between aqua and Jira projects
      • Before you begin: key steps for synchronization
      • Sync configurator set up
        • Sync Configurator options
      • Log in to the Sync Configurator
      • Sync of the projects between aqua and Jira
      • Fields mapping
        • Supported default Jira fields
        • General aqua and Jira fields compatibility
        • Special compatibility for aqua and Jira fields
      • Additional settings
        • Allow mapping of only selected values and ignore other field values for the sync
        • Automatic creation and mapping of field values
      • Troubleshooting
      • Synchronisaton of subtasks with aqua
      • Formatting support
    • Azure Devops sync
    • Jira link: create and/or link Jira issues to aqua tickets
    • aqua4Jira plugin: Cover Jira issue with aqua test cases
      • Installation of the plugin
        • aqua4Jira Plugin - Now Compatible with Jira Data Center!
      • Configuration in Jira
      • Configuration in aqua
    • Automatic display of test cases or test scenarios in Jira tickets
    • Confluence integration
    • Capture: record tests or create comprehensive bug reports
    • Testlink: importer tool for migrating test cases to aqua
    • SSO
      • LDAP
      • SAML Configuration
        • Installation
        • Sample
  • 🌀Automation
    • Desktop Client
      • Creating an Automation Agent
      • Configure Automation
      • Ranorex
      • UFT
      • JMeter
      • SoapUI
      • Database
      • UnixShell
      • PowerShell
      • Automation Library
    • Web Client
      • Automation Agent
        • Creation & Configuration
        • Agent pools
        • Running task
      • Powershell
      • Unix Shell
      • Jenkins integration
      • Selenium
    • REST API
    • Automation: CI/CD tools and aqua REST API
      • Gitlab CI/CD: JAVA/Playwright
      • Gitlab CI/CD: TypeScript/Cypress
      • Gitlab CI/CD: TypeScript/Playwright
      • Gitlab CI/CD: TypeScript/Cypress/Cucumber
  • 🚀Product updates for on premise customers
    • Product updates
      • 25.47.0 - On Premise
      • 25.36.0 - On Premise
      • 25.31.0 - On Premise
      • 25.18.0 - On premise
      • 25.10.0 - On Premise
      • 24.135.0 - On Premise
      • 24.130.0 - On Premise
      • 24.126.0 - On Premise
      • 24.108.0 - On Premise
      • 24.101.0 - On Premise
      • 24.93.0 - On Premise
      • 24.83.0 - On Premise
      • 24.71.0 - On Premise
      • 24.53.0 - On Premise
      • 24.8.0 - On Premise
      • 23.140 - On Premise
      • 23.126.0 - On Premise
      • 23.102.0 - On Premise
      • 23.70.0 - On Premise
      • 23.22.0 - On Premise
      • 22.132.0 - On Premise
      • 22.123.0 - On Premise
    • Release Notes
      • 25.47.0 - On Premise
      • 25.36.0 - On Premise
      • 25.31.0 and 25.33.0 - On Premise
      • 25.26.0 - On Premise
      • 25.18.0 - On Premise
      • 25.10.0 - On Premise
      • 24.135.0 - On Premise
      • 24.130.0 - On Premise
      • 24.126.0 - On Premise
      • 24.114.0 - On Premise
      • 24.108.0 - On Premise
      • 24.101.0 - On Premise
      • 24.93.0 - On Premise
      • 24.83.0 - On Premise
      • 24.71.0 - On Premise
      • 24.53.0 - On Premise
      • 24.8.0 - On Premise
      • 23.140.0 - On Premise
      • 23.126.0 - On Premise
      • 23.102.0 - On Premise
      • 23.70.0 - On Premise
      • 23.22.0 - On Premise
      • 22.132.0 - On Premise
      • 22.123.0 - On Premise
  • 🚀Product updates for public and private clouds customers
    • Product updates
      • 25.47.0 - public and private cloud
      • 25.36.0 - public and private cloud
      • 25.33.0 - public and private cloud
      • 25.18.0 - public and private cloud
      • 25.10.0 - public and private cloud
      • 24.135 - public and private clouds
      • 24.130 - public and private clouds
      • 24.126.0 - public and private clouds
      • 24.108.0 - public and private clouds
      • 24.101.0 - public and private clouds
      • 24.93.0 - public and private clouds
      • 24.88.0 - public and private clouds
      • 24.83.0 - public and private clouds
      • 24.71.0 - public and private clouds
      • 24.63.0 - public and private clouds
      • 24.50.0 - public and private clouds
      • 24.33.0 - public and private clouds
      • 24.8.0 - public and private clouds
      • 23.140 - public and private clouds
      • 23.126.0 - public and private clouds
      • 23.107.0 - public and private clouds
      • 23.92.0 - public and private clouds
      • 23.70.0 - public and private clouds
      • 23.46.0 - public and private clouds 1/3
      • 23.46.0 - public and private clouds 2/3
      • 23.46.0 - public and private clouds 3/3
      • 23.22.0 - public and private clouds
      • 22.132.0 - public and private clouds
    • Release notes
      • 25.47.0 - public and private cloud
      • 25.36.0 - public and private cloud
      • 25.33.0 - public and private cloud
      • 25.31.0 - public and private cloud
      • 25.24.0 - public and private cloud
      • 25.18.0 - public and private cloud
      • 25.10.0 - public and private cloud
      • 24.135.0 - public and private clouds
      • 24.130 - public and private clouds
      • 24.126.0 - public and private clouds
      • 24.114.0 - public and private clouds
      • 24.108.0 - public and private clouds
      • 24.101.0 - public and private clouds
      • 24.93.0 - public and private clouds
      • 24.88.0 - public and private clouds
      • 24.83.0 - public and private clouds
      • 24.71.0 - public and private clouds
      • 24.63.0 - public and private clouds
      • 24.50.0 - public and private clouds
      • 24.33.0 - public and private clouds
      • 24.8.0 - public and private clouds
      • 23.140.0 - public and private clouds
      • 23.126.0 - public and private clouds
      • 23.107.0 - public and private clouds
      • 23.92.0 - public and private clouds
      • 23.70.0 - public and private clouds
      • 23.46.0 - public and private clouds
      • 23.22.0 - public and private clouds
      • 22.132.0 - public and private clouds
      • 22.123.0 - public and private clouds
    • 📢AQUA NEWS
      • 🔒 Rate Limits for Public Cloud Users
      • Preview of aqua's public API
      • aqua is now ISO 27001 certified and DORA Compliant
      • Upcoming changes to aqua API
      • AI Copilot launching for All public clouds users on January 27th!
  • 📹Capture
    • What is Capture?
    • Chrome extension installation
    • Capturing in Incognito mode
    • Using Capture with Edge
    • Capturing with video
      • Option to enable mic when capturing a screen and adding voice notes
      • Option to pause/resume while capturing the video
        • Masking sensitive information while capturing
    • Capturing with screenshot
    • Running a test execution
    • Last minute session replay
    • Masked inputs while creating captures
Powered by GitBook
On this page
  • Configuration of Custom Fields
  • Configuration of a Workflow

Was this helpful?

  1. Desktop client
  2. Project configuration

Configuration of Fields and Workflows

PreviousProject configurationNextEmail Notification

Last updated 1 year ago

Was this helpful?

In this chapter you will learn more about the configuration of data fields for your aqua projects. You will receive information how to set the position of fields in the layout designer, how to configure workflows, and how to configure restrictions.

Every aqua project implements a template which defines the configuration of the project. By editing the template, you can customize the layout and the dialogue fields for the following items:

  • defects,

  • requirements,

  • test cases,

  • test scenarios

  • scripts.

There are two types of fields - predefined fields and custom fields. Predefined fields are configured by default and cannot be changed by aqua users. Custom fields can be added when additional fields are required for an individual specification.

Configuration of Custom Fields

Select your project in the project browser. Using the right mouse button, choose the entry Project Configuration and then Template. A new dialog will open as like in the following screen.

Note: The Names of the predefined fields and the available values for these fields depend on the selected language in aqua and project-specific configurations.

Therefore, it is possible that names and values may differ from those in the screenshot. Choose the tab Requirement and click on Custom fields.

To add a new custom field, click on the New button in the fields panel in the ribbon bar. A new field of type Text with the preliminary name New Field will be created in the Custom fields area. Click on the name of the new field and change it to Description.

  1. Click on the Requirement tab

  2. Click on Custom fields

  3. Click on New button in the fields panel in the ribbon bar

  4. Change name to Description

The new custom field Description is now created. In order to be used the field needs to be placed inside the dialog.

To do this, open the Layout Designer by clicking on the Layout button in the View panel in the ribbon bar. Click on the Requirement tab to place the new custom field Description into the Requirement dialog. The displayed toolbox contains all fields, that can be added to the dialog. Move the entry of the field Description via drag & drop from the toolbox into the layout. Hold down the left mouse button until the entry is at the desired final position. Further adjustments to the layout can also be made via drag & drop.

  1. Click on the Layout button in the View panel of the ribbon bar.

  2. Click on the Requirement tab.

  3. Move the Description field via drag & drop from the list into the desired position into dialog.

  4. Click on the Save & Close button in Project panel in the ribbon bar to save the changes and to close the project configuration.

The new custom field is now added to the layout and can be used by all project members. Every custom field specifies a particular type of value it can contain. The available types are: Date time, Decimal, String, Drop down, Drop down (multiple choice), Text, User and User (multiple choice).

Type

Description

Example

Date time:

Used for calendar dates and time.

Date the requirement was created

Decimal:

Used for number values.

Points, euros, business values

String:

Used for short text values.

Name

Drop down:

Allows choosing one value from a list with predefined values.

Version, priority, significance

Drop down (multiple choice):

Allows choosing multiple values from a list with predefined values.

Affected system, requested customer

Text:

Used for rich text, such as comments, descriptions and pictures.

Comment, description

User:

Allows choosing one user from a list with the existing users of the project.

Mainly responsible user, project manager

User (multiple choice):

Allows choosing multiple users from a list with the existing users of the project.

Team members

Configuration of a Workflow

In aqua you can create a workflow for your specific project. Click on the Data button in Fields panel of the ribbon bar. Choose the Defect tab. Click on the Status field in the predefined fields area and the field values for Status will be displayed in the table on the right. Click inside the table on the first value and click on the Delete button. Repeat for all values.

  1. Click on the Data button in the View panel in the ribbon bar.

  2. Choose the Defect tab.

  3. Click on the Status field inside the Predefined fields area.

  4. Click in table with field values for Status.

Delete the values for the status. Click in the Field values for Status table and press the New button five times to add five new field values for the field Status. Click once in the value cell of each new value and rename them as: New, In Progress, Done, Test and Closed. Set checkmarks in Default at the value New, in 'Definition of Done at Closed' and for 'Hide in sprints' also at Closed.

The checkmark for Hide in sprints is set so that the status Closed does not appear on the Sprint board in Agile.

We have now created five values for the status of defects. To configure the workflow for the status, open the Workflow Designer button in the ribbon bar (5).

  1. Click in the Field values for Status table.

  2. Press New button in the Field Values panel of the ribbon bar.

  3. Click inside the value cell of each new value to rename it.

  4. Set checkmarks in Default, Definition of Done and Hide in sprints.

  5. Open the Workflow Designer by clicking on the Workflow button in the View panel in the ribbon bar.

The following table describes the transitions for workflow that we will be implementing as an example:

New

In Progress

Done

Test

Closed

<Create>

yes

New

yes

In Progress

yes

Done

yes

yes

Test

yes

yes

Closed

yes

yes

Note: The Table of transitions is red from the left to the right. As the Workflow Designer is now open, click on the Defects tab in order to specify the workflow for defects. Activate a workflow by clicking on Use Workflow button in Workflow panel in the ribbon bar.

When creating a new defect, we want it to have the initial status New. This is the transition between the nodes <Create> and New, which is automatically set as we previously defined that the default value should be New.

When, for example, a programmer starts fixing the cause of the defect, the only next possible status for the defect should be In Progress. In order to configure this dependency you need to create the transition between the nodes New and In Progress. To do this, slide the mouse over the edge of the New node, when the mouse cursor changes to a hand press and hold the left mouse button, drag the arrow to the In Progress node and release the mouse button.

  1. Activate a workflow by clicking on the Use Workflow button in Workflow panel in the ribbon bar.

  2. Initiate the transition between the nodes <Create> and New for the default status value.

  3. Create a transition between the two nodes. Configure all transitions between the status nodes as defined in the table. This is how the complete workflow for defects should look:

The following types of limitations are possible:

  • Global Limitations, which are defined for the whole workflow,

  • Action Limitations for the transitions between the status nodes,

  • Status Limitations for a particular status.

To create a Global Limitation, click on the Global button in the Limitations panel in the ribbon bar. This is how the Global Scope of the workflow is selected. Then, click on the Add button in group sort Limitations to add a limitation. The new limitation is added in the table of the area Global for the global scope. The table has the following five columns: Scope, Field, Condition, Attribute and Details.

Scope:

Describes the extent of the area for the limitation.

Field:

Specifies the field for which the limitation is applied.

Condition:

Defines a particular user role for which the limitation should apply.

Attribute:

Determines a property for the field for which the limitation should apply.· Hidden - the field cannot be seen.· Editable - the field can be edited.· Default Value - sets a default value for the field.· Highlight - highlights the field as outstanding and sets its background color to yellow.· Required - makes the field compulsory and sets its background color to red.· Value – differs depending on the type of the selected field in column Field.

Details:

Depends on the type of the selected field in the column Field and the selected value in the column Attribute.

Note: No limitations are possible for fields of type Text, as this is a type for rich texts.

Next, we want to configure the newly created Global Constraint for a specific use. For example, we want the Name field to be required when creating a defect. Click in the Field column and select Name from the list of existing fields. The Condition column should be set to For any role, because we want the constraint to be active for all roles. To make the Name field mandatory, click in the Attribute column and select Required. In this case, we do not want to negate the value of the Attribute, so the value of the Details column should remain at Is true.

  1. Click on the Global button in Limitations panel in the ribbon bar to set the global scope of the workflow.

  2. Then click on the Add button in Limitations panel to add a limitation.

  3. Click in the Field column and choose a field from the list of existing fields.

  4. Click in the Condition column and choose a role or a pool of roles from the list of existing roles.

  5. Click in the Attribute column and choose a value from the list.

  6. Click in the Details column and choose a value from the list.

To create an Action Limitation for a particular conjunction, click on the transition arrow and the Action table is displayed. We want that the field Assigned to, for example, to automatically resets its value to the user, which changes the Status of the defect to Tested.

In order to do so, click on the arrow between the nodes Done and Tested and press the Add button Limitations table to add a limitation. The new limitation is added in the Limitations table under Action: Done to Tested.Click in the Field column and choose Assigned to from the list of the existing fields. The Condition column should set the limitation For any role, because we want the limitation to be active for all roles. To set the value of the field, click on the Attribute column and choose Value. In this case we want to set-up the user who will changing the value of status, so click Details column and choose Current user.

  1. Click on a transition arrow.

  2. Press button Add in group sort Limitations to add a limitation.

  3. Click in the value of column Field and choose a field from list of the existing fields.

  4. Click in the value of column Condition and choose a role or a pool of roles from list of existing roles.

  5. Click in the value of column Attribute and choose a value from list.

  6. Click in the value of column Details and choose a value from list.

You can configure an Action Limitation in such a way that the Status can be changed only by the user of a particular role. We want the Status field can be set to Closed only by a user Project Administrator role for example.

To create this limitation, click on the transition arrow and the Action table is being displayed. Click on the Action tab inside the table. Choose Only for selected role(s) and go to the table of existing roles. Find the role Project Administrator and tick the box.

  1. Click on the transition arrow and the Action table is being displayed.

  2. Click on the tab Action inside the table.

  3. Choose Only for selected role(s) and go to the table of existing roles.

  4. Set a checkmark for the role required.

To create a Status Limitation for a particular status, click on the node of this Status. We want the field Priority to be highlighted only when the defect has the status New, for example. In order to do so, click on the New node and press the Add button in the Limitations panel to add a limitation. The new limitation is added in the Limitation table with the Status New. Click on the column Field and choose the field Priority from the list of existing fields. The value of the Condition column should set the limitation For any role, because we want the limitation is active for all roles. To highlight the field New, click on the Attribute column and choose Highlight. In this case, we do not want to negate the value the attribute, so the value of the Details column should remain Is true.

  1. Click on the node with the required status.

  2. Press Add button in the Limitations panel to add a limitation.

  3. Click on Field column and choose a field from the list of existing fields.

  4. Click on the Condition column and choose a role or a pool of roles from the list of existing roles.

  5. Click on the Attribute column and choose a value from the list.6. Click on the Details column and choose a value from the list

🖥️