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
  • Parameterize
  • Configuring the Agent
  • Working with Ranorex
  • Troubleshooting
  • Troubleshooting with Administrator Rights
  • Troubleshooting with Environment
  • Referencing External Assemblies (.dll-Files)
  • Migrating a project

Was this helpful?

  1. Automation
  2. Desktop Client

Ranorex

PreviousConfigure AutomationNextUFT

Last updated 11 months ago

Was this helpful?

A functional test is applied in the context of a test case in aqua. Therefore, the user has to create a new test case first. By selecting the Automation tab, the Step Designer switches to test automation. Now, create the necessary test steps in the Step Designer. An automated test may consist of multiple test steps and may contain multiple automation scripts, which are executed in the order of the test step index. Test scripts that were previously created, may be reused by using the Script Library. Initially, a single test step is sufficient.

Select your single test step by clicking into the white area in the column Automation. To create a Ranorex-Test script, click on New Script and then select Ranorex.

A test script template is now created and can be edited using the External Editor - Ranorex Studio. Ranorex Studio, for example, allows you to create a new automation by recording user interactions.

If you have not already worked with the automation tool, aqua will point out that the path to Ranorex needs to be configured. The corresponding menu is offered to you by the system. In this case click on "Open Configuration". Then select the path to the Ranorex application.

Test cases must be saved before they can be transferred. If you have saved the test case, you can open Ranorex with the "Continue" button.

By clicking on External Editor, a blank project will be opened in Ranorex. Test cases can be recorded and edited here. aqua is on hold, until the external editor is closed. If the automation is completed and the editor is closed, aqua offers the option of saving the new test case.

By saving the new test case, it will be automatically added to the database. If you don’t want to accept the changes, do not save the test case. To run an automated test, the test case must be executed in the same way as the manual tests. Open the test case and click on the Run button. If this is an automated test, and if agents are available in the network, then a selection of possible test systems will be displayed.

The results will be automatically transferred to aqua and then displayed to the user.

Parameterize

You can parameterize your Ranorex test cases by using aqua parameters. To do so, open the Variable Manager and insert some variables.

Go into Ranorex and add a new Action as shown below:

Your test case is now parameterized. The result is displayed below.

You can also use the "Variables" button to add new variables in Ranorex and use them within the actions. To replace the variables with the aqua variables, the naming must always be the same in both tools.You can also use variables in the Ranorex repository in the same way (e.g. to open certain windows or to control buttons on an application depending on the variables). These variables can be replaced by aqua variables as well, if the naming is the same.

Below is an example for the use of variables at different places:

Configuring the Agent

Extract the RanorexAgent-*.zip and open aquaAgentRanorexGui.exe.config.

Here you have to set the Agent Code and the aquaServiceUrl. In the following, you will find an example:

<?xml version="1.0"?>
<configuration>
     <appSettings>
          <add key="agentCode" value="pvq6wrb70huknv47ji39"/>
          <add key="aquaServiceUrl" value="http://youraquaserver/aquaAPI/aquaagentwebservice.asmx"/>
          <add key="keepAliveSendingFrequencyMs" value="30000"/>
          <add key="compilerTimeoutMs" value="60000"/>
          <add key="tempDirectory" value="temp"/>
          <add key="ranorexVersion" value="7"/>
          <add key="proxyHost" value=""/>
          <add key="proxyPort" value=""/>
          <add key="proxyUsername" value=""/>
          <add key="proxyPassword" value=""/>
          <add key="maxGUILogEntries" value="30"/>
     </appSettings>
     <startup>
     <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/></startup>
</configuration>

Working with Ranorex

Here are some best practice tips for working with Ranorex and aqua. This page will show how to use one repository in several test cases. First, create a new test case in aqua and add a test step with a Ranorex script. This script will contain the repository.

Create a namespace to identify the repository.

Open Ranorex as external editor and create a new repository in Ranorex.

Save the repository in the module folder.

Take note of the folder where the repository is saved. The path should look like this:<some path>\aqua_Automation\TCxxxxxx\_001_CommonRepository\CommonRepository.rxrepHover over the repository to see the path (see screenshot below).

This repository can be used in another test step as follows: first add a new test step in aqua. Now open Ranorex with the External Editor button.

In Ranorex choose Open from Disk to select the repository created earlier.

Browse to the path where the repository file was saved.

Now we want to also use our repository in another test case. To do so, we add the script containing the repository to the aqua script library.

Now, we create a new test case and open the script library (Show Library button). Then, just drag the script to the white area in the test step.

Add another step with a Ranorex script to the new test case and open this step in Ranorex. Use the repository by selecting Open from Disk and browsing to the folder where the repository is stored (note: This is the folder of the first test case).

Ranorex will ask you to choose a reference for the repository. Choose Link repository to project. The repository is now shared between the two test cases. Any changes you make to the repository within this test case will be reflected in the other test case.

In this way, one repository can be used in all your test cases being tested in the same system under test.

Note: If more than one test case referencing the repository is opened in aqua, it will be write-protected.

Troubleshooting

Troubleshooting with Administrator Rights

Ranorex starts with elevated rights per default. If you do not use aqua with elevated rights, this might lead to unexpected behaviour. To avoid this, open the settings of your ranorex studio and deactivate the following option.

Troubleshooting with Environment

Build started 12.04.2016 09:27:08.

Project "C:\Users\*\Desktop\aquaRanorexAgent-16.1.2.0\aquaRanorexAgent\temp\PEE42\aquaProject.csproj" on node 1 (Clean;Build target(s)).C:\windows\Microsoft.NET\Framework\v4.0.30319\Microsoft.Common.targets(609,5): error : The OutputPath property is not set for project 'aquaProject.csproj'.

Please check to make sure that you have specified a valid combination of Configuration and Platform for this project. Configuration='Debug' Platform='BPC'. You may be seeing this message because you are trying to build a project without a solution file, and have specified a non-default Configuration or Platform that doesn't exist for this project.

[C:\Users\*\Desktop\aquaRanorexAgent-16.1.2.0\aquaRanorexAgent\temp\PEE42\aquaProject.csproj]Done Building Project "C:\Users\*\Desktop\aquaRanorexAgent-16.1.2.0\aquaRanorexAgent\temp\PEE42\aquaProject.csproj" (Clean;Build target(s)) -- FAILED.

Build FAILED.

"C:\Users\*\Desktop\aquaRanorexAgent-16.1.2.0\aquaRanorexAgent\temp\PEE42\aquaProject.csproj" (Clean;Build target) (1) ->(_CheckForInvalidConfigurationAndPlatform target) -> C:\windows\Microsoft.NET\Framework\v4.0.30319\Microsoft.Common.targets(609,5): error :

The OutputPath property is not set for project 'aquaProject.csproj'. Please check to make sure that you have specified a valid combination of Configuration and Platform for this project. Configuration='Debug' Platform='BPC'. You may be seeing this message because you are trying to build a project without a solution file, and have specified a non-default Configuration or Platform that doesn't exist for this project. [C:\Users\*\Desktop\aquaRanorexAgent-16.1.2.0\aquaRanorexAgent\temp\PEE42\aquaProject.csproj]

Solution

Referencing External Assemblies (.dll-Files)

The csproj-file for editing and execution of test steps is built new every time according to the given test steps, to ensure the re-usability (keyword: script library) of test steps by aqua. Since several test steps are edited at once, it is hard to identify which reference belongs to which test step.

To solve that problem, please proceed as follows:

  1. Localize the assembly in your file system, path will be like:

C:\Program Files (x86)\Microsoft Visual Studio 12.0\Visual Studio Tools for Office\PIA\Office15\Microsoft.Office.Interop.Word.dll)

  1. Open the affected Ranorex test case in aqua

  2. Copy the .dll-files into the test step

  1. Add the reference to the local .dll-file in the test step, using the 'Browse...' button

  1. Save and close the Ranorex project

  2. Save the test case in aqua

When saving the test case in aqua the reference to the local assembly is automatically recognized and the assembly is saved in aqua.

To simplify such references, you can use so-called utility scripts in script items. These are additional script items which can be added to scripts via the 'Usage' button. Alternatively, place the reference script in the first test step.

The helper script for the references can contain more than one reference. Thus, you can build a whole library of references which are referenced multiple times. You do not need to create or link multiple scripts for each reference.

Migrating a project

This manual describes how to migrate test cases which are automated with Ranorex from one aqua Server to another.

  1. Create the same scripts (Same Name and Namespace!) on your target system, like on your source system.

  2. Create dependencies between the scripts. This makes sense, especially to reuse the repository and the user code module.

  1. Create a test case which contains all scripts on both aqua environments.

  1. Export the variables of the original test cases via the variable manager on the source system

  2. Open the external editor (Ranorex) on your source system and open the folder, which contains the solution (Right-click on solution --> Open folder).

  3. Copy this folder and delete the Main.cs file in all sub folders which contain scripts.

  4. Open the test case you created in step 3 on your target system.

  5. Open the folder which contains the solution and copy the folder you copied in step 6 to this destination (without Main.cs files!).

  6. If the correct recordings are not found, show them via the button Show all files and add them to the project (Right click --> Include in Project).

  1. Edit the following to lines in the Main.cs files, so that the correct Recordings are called (yellow marked)

  1. Compile the project in Ranorex. Close Ranorex and save the test case in aqua.

  2. Create all test cases with the scripts in your target system and import the variables you exported in step 4 via variable manager.

NOTE:

Now, you can add your variable to URL by clicking on in the URL and selecting As new variable. A window will open where you can enter the name of the variable. This must correspond to the spelling of the variable name in aqua (in our case "URL").

Delete platform environment variable BPC on the windows os, where agent is running.

🌀
http://stackoverflow.com/questions/2507856/why-is-my-platform-environment-variable-defined-as-bnb