This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Test Automation

Test Automation

RIA Test Automation is an enterprise testing solution developed by RIA Advisory to streamline regression and end-to-end testing. It supports Oracle products like ORMB, C2M, CCS, and MDM, while also integrating with various enterprise applications. The platform enables efficient API, batch, and UI testing to improve software quality and reduce testing effort and costs.
Schedule a Demo
Test Automation

1 - Getting Started

1.1 - Upgrade to TA v3

When upgrading the Test Automation from version 2.8 to 3.0, take note of the following configuration changes.

Removed modules

  • External Systems module
  • Services module has been replaced by Step module
  • Scenario-Level linking/chaining
  • Scenario-Level datasets
  • Test Suite templates have been replaced by Test Flows
  • Assertion mapping at the services level

Renamed modules

  • Features module has been renamed to Collections
  • Validations module has been renamed to Assertions

1.2 - Quickstart Guide

Overview

When using Test Automation, it is advisable to utilize Starter Packs for streamlined configurations and efficient implementations. However, should you opt for creating all modules from the ground up, see General configuration.

Prerequisites

Kubernetes and Helm requirements

  • Kubernetes version 1.28 or higher
    • ingress-nginx
    • cert-manager
    • PostgreSQL database with TA DB Pack
    • Ocular Framework (if ocular will be used as auth)
  • Helm version 3.0 or higher

System requirements

The following are the minimum requirements for machines running Test Automation:

SpecificationMinimum requirement
CPU2 vCPU
Memory8 GB
Storage50 GB

Prerequisite packages

Test Automation offers two prerequisite packages — Bundles and Configuration Migration Assistant (CMA). These packages serve as the foundation for Test Automation to operate. Before installation, you are required to deploy only one of the two packages to ensure the functionality of Test Automation. For more information, see Prerequisite packages.

Selenium IDE plugin

Selenium IDE plugin is a third-party browser plugin that needs to be installed in your browsers. This plugin is the primary tool used for scenarios involving UI recordings.

To install a Selenium IDE plugin, see Getting Started in the Selenium IDE documentation.

Starter Packs

Starter packs are sets of pre-defined scenarios that you can employ for your testing projects. These scenarios cover a wide range of diverse testing situations, enabling you to begin your testing project effortlessly and efficiently. This ensures comprehensive coverage of crucial testing scenarios right from the start.

Test Automation offers the following starter packs for the following industries:

  • Banking — To see the list of pre-defined scenarios for the banking industry, see Banking starter pack.
  • Healthcare — To see the list of pre-defined scenarios for the healthcare industry, see Healthcare starter pack.
  • Utilities — To see the list of pre-defined scenarios for the utilities industry, see Utilities starter pack.

Use a starter pack

To use a starter pack, follow these steps:

  1. Install Test Automation.
  2. Ensure that all the Prerequisites are met.
  3. Ensure that all the Required Test Automation actions have been completed.
  4. Modify your test data. For more information, see Dataset.
  5. Optional: If you are using a custom API, ensure that you have modified the Payload Details in the Services module.
  6. Navigate to Flow. To run a test flow, see Run a test flow.
  7. View your test results in Results. For more information, see Results.

Required Test Automation actions

Environment configuration and authentication details

Before running the test, ensure that the testing environment is properly set up and configured. This includes specifying the necessary credentials and database details for accessing the configured environment. For more information, see Environments.

General configuration

If you decide to customize all modules, follow these steps:

  1. Verify that all the Prerequisites are met.
  2. Install Test Automation.
  3. Create a project.
  4. Create a step for the created project.
  5. Create an assertion for the created project.
  6. Create a dataset.
  7. Run a test flow.
  8. View the results.

1.2.1 - Prerequisite Packages

Overview

Test Automation offers two prerequisite packages — Bundles and Configuration Migration Assistant (CMA). These packages serve as the foundation for the operation of Test Automation.

Services

The following are the services included in a pre-requisite package:

ServiceService TypeDescription
TA-IWSRestCatalogInbound web serviceReturns the catalog of REST-based web services with details based on the REST web service catalog.
TA-GetOpenAPISpecInbound web serviceGenerates the OpenAPI Specification for a given REST Inbound Web Service and version of OpenAPI Specification.
TA-GetBatcCtInbound web serviceRetrieve batch controls configured on the extendable lookup TA-AutomationBatchControls and their corresponding value TA-ValidAutomationBatchControls.
TA-RestBatchSubmissionInbound web serviceProvides functionalities to manage and monitor batch jobs through RESTful APIs.
TA-BatchStatsInbound web serviceReturns the statistics of a batch job, including the number of records processed, the threadpool used, start time, and end time.
TA-BatchJobSubmissionBusiness serviceSubmits a batch job instance for a given batch control.
TA-CheckBatchJobStatusBusiness serviceReturns the status of a batch job run, such as Started, Pending, or Ended.
TA-GetBatchControlBusiness serviceReturns the details of a given batch control.
TA-GetBatchRunStatusBusiness serviceRetrieves the status and run number of a batch run for a given batch control.
TA-BatchErrorBusiness serviceReturns an error message when a batch run encounters any error.

Bundles

Test Automation integrates with ORMB through the use of REST APIs. Components that may not be readily available in the base or framework version of ORMB can be added by importing bundles. This simplifies the integration process by removing the need to create new APIs.

Download

You can download the bundles here.

Apply a bundle on your ORMB web application

  1. Log in to your ORMB web application.
  2. On the Admin Menu, click B > Bundle Import > Add.
  3. On the Bundle Import popup window, input a value for the External Reference and Detailed Description fields.
  4. Open a downloaded bundle XML file and copy the contents. Then, paste the contents to the Bundle Details field on the Bundle Import popup window.
  5. Click Save. The Bundle Import popup window will be closed upon clicking Save.
  6. On Main > Bundle Import > Record Actions, click Apply.

Configuration Migration Assistant (CMA)

CMA is a set of pre-defined configurations and SQL queries, such as Inbound web services, that help trigger batch executions and check the status of these executions.

Download

If you are using a TA Banking starter pack or an ORMB environment, download the files here.

If you are using a C2M environment, download the files here.

Import CMA files to your OUAF environment

  1. Run the downloaded streamlineCMAProcess_script.sql in both the source and target environments.
  2. Copy the created migration data export file, TA-EXPFINAL.cma, and paste it into the target environment:
    • If you are using ORMB 5.0, /u01/app/sploutput/ORMB5000/F1_CMA_FILES/export.
    • If you are using ORMB 6.0, /u01/app/sploutput/ORMB6000/F1_CMA_FILES/export.
  3. Import the C2M_TA_C2M_Pre_Requisite.cma dataset to your target environment.

1.2.1.1 - TA Downloads

Overview

The downloads were generated using the following environment versions:

ORMB 6.0.0.0

  • Customer Release V4.5.0.1.1 000 000
  • Oracle Revenue Management and Billing for Financial Services V6.0.0.0.0 205149 000
  • Oracle Utilities Application Framework V4.5.0.1.1 008 000

C2M 2.7.0.3

  • Customer Release V4.3.0.4.0 000 000
  • Oracle Utilities Customer To Meter V2.7.0.3.0 024 000
  • Oracle Utilities Customer Care and Billing V2.7.0.3.0 078 000
  • Oracle Utilities Meter Data Management V2.3.0.2.0 082 000
  • Oracle Utilities Work and Asset Management V2.2.0.6.0 096 000
  • Oracle Utilities Application Framework V4.4.0.2.0 008 000

C2M 2.9.0.1

  • Customer Release V4.3.0.4.0 000 000
  • Oracle Utilities Customer To Meter V2.9.0.1.1 110 000
  • Oracle Utilities Customer Care and Billing V2.9.0.1.1 101 000
  • Oracle Utilities Meter Data Management V2.5.0.1.1 102 000
  • Oracle Utilities Work and Asset Management V2.4.0.1.1 103 000
  • Oracle Utilities Application Framework V4.5.0.1.1 008 000

The following are the items for which the packages are created:

  • Field: TA_FIELD_CONFIG_LBL
  • Zone: TA-SERBATCTL
  • Business Object: TA-AutomationBatchControls
  • Extendable Lookup: TA-AutomationBatchControls, TA-ValidAutomationBatchControls
  • Service Script: TA-GetBatcCt
  • IWS: TA-GetBatcCt
  • IWS: TA-IWSRestCatalog
  • IWS: TA-GetOpenAPISpec
  • Zone: TA-GETBTRNST
  • Business Service: TA-BatchJobSubmission
  • Business Service: TA-CheckBatchJobStatus
  • Business Service: TA-GetBatchControl
  • Business Service: TA-GetBatchRunStatus
  • IWS: TA-RestBatchSubmission
  • Zone: TA-BATCHSTAT
  • Zone: TA-BATCHERR
  • BS: TA-BatchStatus
  • BS: TA-BatchError
  • IWS: TA-BatchStats

C2M downloads

VersionCMAPrerequisite bundle
2.9.0.1TA_C2M_Pre_Requisite.cmaTA-IWS_Service_Prereq_Bundle_C2M_2.9.0.1.xml
2.7.0.3TA_C2M_Pre_Requisite.cmaTA-IWS_Service_Prereq_Bundle_C2M_2.7.0.3.xml

ORMB downloads

VersionJSONPrerequisite bundle
6.0.0.0TA - ORMB IWS Services.postman_collection.jsonTA-IWS_Service_Prereq_Bundle_ORMB_6.0.0.0.xml
4.0.0.0TA - ORMB IWS Services.postman_collection.jsonTA-IWS_Service_Prereq_Bundle_ORMB_4.0.0.0.xml
2.9.0.0TA - ORMB IWS Services.postman_collection.jsonTA-IWS_Service_Prereq_Bundle_ORMB_4.0.0.0.xml

1.2.1.2 - Batch prerequisites

Add batches

To ensure batches are loaded in Test Automation (TA) tool and configured for execution, you need to ensure following steps are followed for every configured OUAF environment in TA.

  1. Navigate to Admin > E > Extendable lookup.
    You can also enter /Extendable lookup in the search bar.
  2. Enter TA-AutomationBatchControls in the Business Object field. Click Search.
  3. Click the link in the Description column of the TA-AutomationBatchControls object.
  4. Click the edit icon for the TA-AutomationBatchControls in the Extendable Lookup Value List.
  5. Click + in the Field Configurations section of the Extendable Lookup window.
  6. Enter the batch name under the Batch Control column.
  7. Copy the automatically generated description to the Description column. If the batch name is incorrect, the description will not be generated. Click Save.
  8. Repeat Steps 7-8 for all other batches that will be configured in TA.

Troubleshooting

Batches are still not loading

  • Ensure the required OUAF environment from which the batches need to load is set up as default.
  • Ensure if the Authentication type is correct.
  • Ensure the OUAF environment is whitelisted.

1.2.1.3 - IWS prerequisites

Add services

To ensure configured IWS are loaded in Test Automation (TA) tool and configured for execution, you need to ensure that the following steps are followed for every configured OUAF environment in TA.

  1. Navigate to Admin > W > Extendable lookup page.
    You can either click or enter `/Web Service Catalog` in the search bar.
  2. Click the broadcast button beside the REST Web Service Class.
  3. Select all the required services in the Candidate Services section, then click Add to Catalog.

Troubleshooting

REST Catalogs are not loading

  • Ensure the required OUAF environment from which the IWS services need to load is set up as default.
  • Ensure if the Authentication type is correct.
  • Ensure that the OUAF environment is whitelisted.

1.2.2 - Banking Starter Pack

Overview

This documentation lists all scenarios defined in the Banking starter pack. To use a starter pack, ensure that you have already completed the steps in Use a starter pack.

Customer onboarding test scenarios

Test scenariosService typeDescription and Query
Create a customer
  • API
  • UI

Creates a user with the following details using API:

  • Customer ID number — ID number registered in the banking database.
  • Address — Home or work address of the user registered in the banking database.
  • Division — Specifies the division where the user is registered.
//Input - Customer Identifier

SELECT a.PER_ID_NBR CUST_IDENTIFIER ,b.ADDRESS1 ADDR_LINE1 ,b.ADDRESS2 ADDR_LINE2 ,b.ADDRESS3 ADDR_LINE3 ,b.ADDRESS4 ADDR_LINE4 ,b.CITY CITY ,b.POSTAL POSTAL_ID ,b.cis_division DIVISION FROM CI_PER_ID a ,CI_PER b ,c1_address_entity c ,CI_CIS_DIVISION d WHERE a.PER_ID_NBR = :F1 –Customer Identifier AND a.PER_ID = b.per_id AND c.ENTITY_ID = b.per_id AND b.cis_division = d.CIS_DIVISION

Create an account and contract

  • API
  • UI

Creates a bank account with the following details using API:

  • Account number — Account number of the user as stored in the banking database
  • Account type — Specifies the account type of the account number.
  • Account start date — Specifies when the account became active.
  • Contract type — Type of the contract associated with the account number.
  • Contract status — Describes the current status of the contract.
  • Contract start date — Specifies when the contract became active.
//Input - Account Identifier

SELECT a.ACCT_NBR ACCT_IDENTIFIER ,a.ACCT_NBR_TYPE_CD ACCT_TYPE ,b.SETUP_DT ACCT_STRT_DT ,c.SA_TYPE_CD CONTRACT_TYPE FROM CI_ACCT_NBR a ,CI_ACCT b ,CI_SA c WHERE a.acct_id = b.acct_id AND a.ACCT_NBR = :F1 – Account Identifier AND b.acct_id = c.acct_id

Create parent-child relationship
  • API
  • UI

Links a child’s account to their parent’s account.

//Input - Parent Customer Identifier

SELECT PARENT_PER_NBR ,CHILD_PER_NBR ,A.PER_REL_TYPE_CD ,TO_CHAR(A.START_DT, ‘DD-MON-YYYY’) START_DATE FROM CI_PER_PER A ,( SELECT PER_ID PARENT_PER_ID ,PER_ID_NBR PARENT_PER_NBR FROM CI_PER_ID ) ,( SELECT PER_ID CHILD_PER_ID ,PER_ID_NBR CHILD_PER_NBR FROM CI_PER_ID ) WHERE A.PER_ID1 = PARENT_PER_ID AND PER_ID2 = CHILD_PER_ID AND CHILD_PER_NBR = :F1 – Child Customer

Update customer details

  • API

Updates the details of a customer. The Person ID number value cannot be updated, but the following can be:

  • Customer identifier
  • Email ID
  • Phone number
  • Address line 1
  • Address lne 2
  • Address line 3
  • Address line 4x
  • City
  • Postal ID
  • Division
//Input - Person Identifier

SELECT a.PER_ID_NBR CUST_IDENTIFIER ,b.per_id CUST_ID ,b.ADDRESS1 ADDR_LINE1 ,b.ADDRESS2 ADDR_LINE2 ,b.ADDRESS3 ADDR_LINE3 ,b.ADDRESS4 ADDR_LINE4 ,b.CITY CITY ,b.POSTAL POSTAL_ID ,b.cis_division DIVISION FROM CI_PER_ID a ,CI_PER b ,c1_address_entity c ,CI_CIS_DIVISION d WHERE a.PER_ID_NBR = :F1 – Person Identifier AND a.PER_ID = b.per_id AND c.ENTITY_ID = b.per_id AND b.cis_division = d.CIS_DIVISION

//Input - Parent Customer Identifier

SELECT a.PER_ID1 PARENT_ID ,a.PER_ID2 CHILD_ID ,( SELECT per_id_nbr FROM ci_per_id WHERE a.per_id2 = per_id ) Child_Identifier FROM ci_per_per a ,ci_per_id b WHERE b.PER_ID_NBR = ‘ABCD01’ – Parent Customer Identifier AND a.per_id1 = b.per_id; //Input - Person Identifier

select B.PER_ID_NBR, c.DESCR Char_Type , PER_ID_NBR Char_Value from CI_PER_ID b , CI_ID_TYPE_l c where B.PER_ID IN( select Per_id from CI_PER_ID where PER_ID_NBR = ‘87009953’) – Person Identifier and b.ID_TYPE_CD = c.ID_TYPE_CD;

Update account details
  • API

Updates the details of an account. The Account number and Zone values cannot be updated, but the following can be:

  • Effective date
  • Char type
  • Char value
  • Bill cycle
  • Currency
//Input - Account Identifier

SELECT a.ACCT_ID
,a.EFFDT
,b.DESCR CHAR_TYPE
,decode(trim(a.CHAR_VAL), NULL, a.ADHOC_CHAR_VAL, a.CHAR_VAL) Char_Value
,d.BILL_CYC_CD
,d.CURRENCY_CD
FROM ci_acct_char a
,ci_char_type_l b
,CI_ACCT_NBR c
,CI_ACCT d
WHERE a.acct_id = c.ACCT_ID
AND c.acct_nbr = :F1 – Account Identifier
AND a.CHAR_TYPE_CD = b.CHAR_TYPE_CD
AND c.ACCT_ID = d.ACCT_ID

Pricing set-up test scenarios

Test scenariosService typeDescription and Query
Assign price list at a customer level
  • API
  • UI

Assigns a list of standard prices for items to a customer, including the following details:

  • Price List ID — Identification number of the price list where prices of items are defined.
  • Start date — Effective date for the price list for the customer.
  • End date — Specifies when the price list is no longer for the customer.
//Input - Person Identifier

SELECT e.PER_ID ,a.PRICELIST_ID ,TO_CHAR(c.START_DT, ‘DD-MON-YYYY’) START_DT ,c.PRICE_STATUS_FLAG ,c.PRICEITEM_CD ,f.Value_amt ,l.descr ,g.TIERED_FLAG FROM ci_pricelist a ,ci_priceLIST_asgn b ,ci_priceasgn C ,ci_party d ,CI_PER_ID e ,CI_PRICECOMP f ,CI_RC_MAP g ,CI_RC_MAP_L l WHERE a.PRICELIST_ID = b.PRICELIST_ID AND b.PRICELIST_ID = C.OWNER_ID AND d.PARTY_UID = B.PARTY_UID AND d.PARTY_TYPE_FLG = ‘PERS’ AND d.PARTY_ID = e.PER_ID AND e.PER_ID_NBR = :F1 – Person Identifier AND f.price_asgn_id = c.price_asgn_id AND f.RC_MAP_ID = g.RC_MAP_ID AND f.pricecomp_seqno = g.RC_SEQ AND l.RC_MAP_ID = G.RC_MAP_ID AND l.language_cd = ‘ENG’ ORDER BY f.PRICE_ASGN_ID ,f.PRICECOMP_SEQNO

Assign price list at an account level
  • API
  • UI

Assigns a list of standard prices for items to an account, including the following details:

  • Price List ID — Identification number of the price list where prices of items are defined.
  • Start date — Effective date for the price list for the customer.
  • End date — Specifies when the price list is no longer for the customer.
//Input - Account Identifier

SELECT e.ACCT_ID ,a.PRICELIST_ID ,TO_CHAR(c.START_DT, ‘DD-MON-YYYY’) START_DT ,c.PRICE_STATUS_FLAG ,c.PRICEITEM_CD ,f.Value_amt ,l.descr ,g.TIERED_FLAG FROM ci_pricelist a ,ci_priceLIST_asgn b ,ci_priceasgn C ,ci_party d ,CI_ACCT_NBR e ,CI_PRICECOMP f ,CI_RC_MAP g ,CI_RC_MAP_L l WHERE a.PRICELIST_ID = b.PRICELIST_ID AND b.PRICELIST_ID = C.OWNER_ID AND d.PARTY_UID = B.PARTY_UID AND d.PARTY_TYPE_FLG = ‘ACCT’ AND d.PARTY_ID = e.ACCT_ID AND e.ACCT_NBR = :F1 – Account Identifier AND f.price_asgn_id = c.price_asgn_id AND f.RC_MAP_ID = g.RC_MAP_ID AND f.pricecomp_seqno = g.RC_SEQ AND l.RC_MAP_ID = G.RC_MAP_ID AND l.language_cd = ‘ENG’ ORDER BY f.PRICE_ASGN_ID ,f.PRICECOMP_SEQNO

Assign override pricing at a customer level
  • API
  • UI

Assigns a price list that overrides any existing price list assigned to the customer.

//Input - Customer Identifier

SELECT d.PER_ID_NBR
,b.START_DT
,b.END_DT
,b.PRICE_STATUS_FLAG
,c.DESCR
FROM ci_party a
,ci_priceasgn b
,ci_priceitem_l c
,ci_per_id d
WHERE a.party_uid = b.OWNER_ID
AND a.PARTY_TYPE_FLG = ‘PERS’
AND D.PER_ID_NBR = ‘55445566’ – Customer Identifier
AND D.PER_ID = a.PARTY_ID
AND b.PRICEITEM_CD = c.PRICEITEM_CD;

Assign override pricing at an account level
  • API
  • UI

Assigns a price list that overrides any existing price list assigned to an account.

//Input - Account Identifier

SELECT d.ACCT_NBR ,b.START_DT ,b.END_DT ,b.PRICE_STATUS_FLAG ,c.DESCR FROM ci_party a ,ci_priceasgn b ,ci_priceitem_l c ,CI_ACCT_NBR d WHERE a.party_uid = b.OWNER_ID AND a.PARTY_TYPE_FLG = ‘ACCT’ AND D.ACCT_NBR = ‘RIAINDIA_MS01’ – Customer Identifier AND D.ACCT_ID = a.PARTY_ID AND b.PRICEITEM_CD = c.PRICEITEM_CD;

Billing test scenarios

Test scenariosService typeDescription
Generate bill from billing batches
  • Batch

Generates a bill using the account name. For batch testing, it runs the following batches in order:

  • BILLOPEN (Pending Bill Generation) — Generates blank bill in pending status for accounts in a given division and bill cycle for a given cut-off date.
  • BSGENREG (Bill Segment Generation) — Generates bill segments, including all billable charges, of accounts that have blank bills in an open bill cycle, input bill cycle, or division for a given cutoff date.
  • POSTPROC (Bill Completion) — Creates post processing bill segment that has been generated by the previous batches.
//Input - Account Identifier ,Account Num Type

SELECT c.acct_nbr ACCT_IDENTIFIER ,c.acct_nbr_type_cd ,b.BILLABLE_CHG_ID ,TRIM(b.PRICEITEM_CD) PRICE_ITEM_CD ,CALC_AMT BSEG_AMT ,a.SVC_QTY TXN_AMT ,DECODE(( SELECT value_amt FROM ci_pricecomp e WHERE e.PRICE_ASGN_ID = b.PRICE_ASGN_ID AND PRICECOMP_SEQNO = 10 ), NULL, ‘NA’, ( SELECT ‘0’ || value_amt FROM ci_pricecomp e WHERE e.PRICE_ASGN_ID = b.PRICE_ASGN_ID AND PRICECOMP_SEQNO = 10 )) Rate1 ,DECODE(( SELECT LOWER_LIMIT FROM ci_pricecomp_tier pt ,ci_pricecomp e WHERE pt.PRICECOMP_ID = e.PRICECOMP_ID AND e.PRICE_ASGN_ID = b.PRICE_ASGN_ID AND PRICECOMP_SEQNO = 10 ), NULL, ‘NA’, ( SELECT LOWER_LIMIT FROM ci_pricecomp_tier pt ,ci_pricecomp e WHERE pt.PRICECOMP_ID = e.PRICECOMP_ID AND e.PRICE_ASGN_ID = b.PRICE_ASGN_ID AND PRICECOMP_SEQNO = 10 )) TIER1_LOWER_LIMIT ,DECODE(( SELECT UPPER_LIMIT FROM ci_pricecomp_tier pt ,ci_pricecomp e WHERE pt.PRICECOMP_ID = e.PRICECOMP_ID AND e.PRICE_ASGN_ID = b.PRICE_ASGN_ID AND PRICECOMP_SEQNO = 10 ), NULL, ‘NA’, ( SELECT UPPER_LIMIT FROM ci_pricecomp_tier pt ,ci_pricecomp e WHERE pt.PRICECOMP_ID = e.PRICECOMP_ID AND e.PRICE_ASGN_ID = b.PRICE_ASGN_ID AND PRICECOMP_SEQNO = 10 )) TIER1_UPPER_LIMIT ,DECODE(( SELECT value_amt FROM ci_pricecomp e WHERE e.PRICE_ASGN_ID = b.PRICE_ASGN_ID AND PRICECOMP_SEQNO = 20 ), NULL, ‘NA’, ( SELECT ‘0’ || value_amt FROM ci_pricecomp e WHERE e.PRICE_ASGN_ID = b.PRICE_ASGN_ID AND PRICECOMP_SEQNO = 20 )) Rate2 ,DECODE(( SELECT LOWER_LIMIT FROM ci_pricecomp_tier pt ,ci_pricecomp e WHERE pt.PRICECOMP_ID = e.PRICECOMP_ID AND e.PRICE_ASGN_ID = b.PRICE_ASGN_ID AND PRICECOMP_SEQNO = 20 ), NULL, ‘NA’, ( SELECT LOWER_LIMIT FROM ci_pricecomp_tier pt ,ci_pricecomp e WHERE pt.PRICECOMP_ID = e.PRICECOMP_ID AND e.PRICE_ASGN_ID = b.PRICE_ASGN_ID AND PRICECOMP_SEQNO = 20 )) TIER2_LOWER_LIMIT ,DECODE(( SELECT UPPER_LIMIT FROM ci_pricecomp_tier pt ,ci_pricecomp e WHERE pt.PRICECOMP_ID = e.PRICECOMP_ID AND e.PRICE_ASGN_ID = b.PRICE_ASGN_ID AND PRICECOMP_SEQNO = 20 ), NULL, ‘NA’, ( SELECT UPPER_LIMIT FROM ci_pricecomp_tier pt ,ci_pricecomp e WHERE pt.PRICECOMP_ID = e.PRICECOMP_ID AND e.PRICE_ASGN_ID = b.PRICE_ASGN_ID AND PRICECOMP_SEQNO = 20 )) TIER2_UPPER_LIMIT FROM ci_bchg_sq a ,ci_bill_chg b ,ci_acct_nbr c ,ci_sa d ,ci_bseg_calc f WHERE a.BILLABLE_CHG_ID = b.BILLABLE_CHG_ID AND c.acct_nbr = :F1 – Account Identifier AND c.acct_nbr_type_cd = :F2 – Account Num Type AND c.acct_id = d.acct_id AND d.sa_id = b.sa_id AND f.BILLABLE_CHG_ID = b.BILLABLE_CHG_ID;

Generate bill from application

  • UI

Runs the following batches in order:

  • C1-GLASGN — Assigns the GL account to a financial transaction
  • GLS — Stages the GL download
  • GLDL — Extracts the GL download
SELECT BSEG_ID
,EXP_MSG
,MESSAGE_PARM1
,MESSAGE_PARM2
,MESSAGE_PARM3
,MESSAGE_PARM4
,MESSAGE_PARM5
,CRE_DTTM
FROM CI_BSEG_EXCP;

Payment test scenarios

Test scenariosService typeDescription and Query
Create payment
  • UI
  • API

Creates a payment for the already generated bill.

For UI:

SELECT ACCT_ID
	,DECODE(PAY_STATUS_FLG, '50', 'COMPLETED', 'NOT COMPLETED')
	,PAY_AMT
	,MATCH_VAL BILL_iD
	,ILM_DT
FROM ci_pay;

SELECT PAY_ID ,EXP_MSG ,MESSAGE_PARM1 ,MESSAGE_PARM2 ,MESSAGE_PARM3 ,MESSAGE_PARM4 ,MESSAGE_PARM5 ,CRE_DTTM FROM CI_PAY_EXCP;

For API:

//Input - Account Identifier, Bill ID
SELECT D.ACCT_NBR ACCT_IDENTIFIER
,A.ORIG_BILL_AMT BILL_AMOUNT
,SUM(C.PAY_AMT) TOTAL_PAID_AMOUNT
,B.DESCR PAYMENT_STATUS
FROM C1_BILL_DTLS_VW A
,CI_LOOKUP_VAL_L B
,CI_PAY C
,CI_ACCT_NBR D
WHERE A.ACCT_ID = C.ACCT_ID
AND C.ACCT_ID = D.ACCT_ID
AND D.ACCT_NBR = :F1 – Account Identifier
AND A.BILL_ID = :F2 – Bill ID
AND B.FIELD_NAME = ‘PAY_STATUS_FLG’
AND B.FIELD_VALUE = C.PAY_STATUS_FLG
GROUP BY A.ORIG_BILL_AMT
,D.ACCT_NBR
,B.DESCR

//Input - Account Identifier, Payment Event ID SELECT C.PAY_AMT PAYMENT_AMT ,B.DESCR PAYMENT_STATUS FROM CI_ACCT_NBR A ,CI_LOOKUP_VAL_L B ,CI_PAY C WHERE A.ACCT_ID = C.ACCT_ID AND B.FIELD_NAME = ‘PAY_STATUS_FLG’ AND B.FIELD_VALUE = C.PAY_STATUS_FLG AND A.ACCT_NBR = :F1 – Account Identifier AND C.PAY_EVENT_ID = :F2 – Payment Event ID

General ledger test scenarios

Test scenariosService typeDescription
Link general ledger (GL) to account
  • Batch

Runs the following batches in order:

  • C1-GLASGN — Assigns the GL account to a financial transaction
  • GLS — Stages the GL download
  • GLDL — Extracts the GL download
Input - Account Identifier

SELECT COUNT(1) RECORDSCOUNT FROM CI_FT A ,CI_BILL B ,CI_FT_GL C ,CI_ACCT_NBR D WHERE A.FT_TYPE_FLG = ‘BS’ AND A.PARENT_ID = B.BILL_ID AND C.FT_ID = A.FT_ID AND C.GL_ACCT = ’ ' AND B.ACCT_ID = D.ACCT_ID AND D.ACCT_NBR = :F1 – Account Identifier

SFTP test scenarios

The following scenarios support file uploads for SFTP and Batch service types:

  • Create price list
  • Define price list-price item
  • Assign price list
  • Onboard a customer
  • Create person hierarchy
  • Create account
  • Create invoice
  • Upload feed management
//Input - Account Identifier, Bill ID

SELECT TP.ACCT_NBR
	,TP.BILL_ID
	,TO_CHAR(MAX(TP.CRE_DTTM), 'MM-DD-YYYY') AS BILL_DATE
	,TP.BILL_AMOUNT
	,TO_CHAR(TP.LATEST_PAYMENT_DATE, 'MM-DD-YYYY') AS LATEST_PAYMENT_DATE
	,TP.LATEST_PAYMENT_AMOUNT
	,TP.TOTAL_PAYMENT_STATUS
	,TP.TOTAL_PAID_AMOUNT
	,(TP.BILL_AMOUNT - TP.TOTAL_PAID_AMOUNT) AS OUTSTANDING_PAYMENT
FROM (
	SELECT B.ACCT_NBR
		,A.BILL_ID
		,A.ORIG_BILL_AMT AS BILL_AMOUNT
		,SUM(D.PAY_AMT) OVER (PARTITION BY A.BILL_ID) AS TOTAL_PAID_AMOUNT
		,C.DESCR AS TOTAL_PAYMENT_STATUS
		,A.CRE_DTTM
		,D.PAY_AMT AS LATEST_PAYMENT_AMOUNT
		,E.CRE_DTTM LATEST_PAYMENT_DATE
		,ROW_NUMBER() OVER (
			PARTITION BY A.BILL_ID ORDER BY E.CRE_DTTM DESC
			) AS RN
	FROM C1_BILL_DTLS_VW A
	INNER JOIN CI_ACCT_NBR B ON A.ACCT_ID = B.ACCT_ID
	INNER JOIN CI_PAY D ON D.ACCT_ID = A.ACCT_ID
	INNER JOIN CI_LOOKUP_VAL_L C ON C.FIELD_NAME = 'PAY_STATUS_FLG'
		AND C.FIELD_VALUE = D.PAY_STATUS_FLG
	INNER JOIN CI_PAY_EVENT E ON E.PAY_EVENT_ID = D.PAY_EVENT_ID
	WHERE TRIM(B.ACCT_NBR) = TRIM(:F1 --Account Identifier)
			AND A.BILL_ID = ${ :F2 -- Bill ID}
		) TP
	WHERE TP.RN = 1
	GROUP BY TP.ACCT_NBR
		,TP.BILL_ID
		,TP.BILL_AMOUNT
		,TP.LATEST_PAYMENT_DATE
		,TP.LATEST_PAYMENT_AMOUNT
		,TP.TOTAL_PAYMENT_STATUS
		,TP.TOTAL_PAID_AMOUNT
	ORDER BY BILL_DATE DESC FETCH FIRST 1 ROW ONLY

Report generation

Available reportsAvailable service typeDescription
Aging Detail Report
  • API download
  • SFTP download
Generates a Form of Payment (FOP) report based on aging details.
Payment Detail Report
  • API download
  • SFTP download
Generates a Form of Payment (FOP) report based on payment details.
Payment Summary Report
  • API download
  • SFTP download
Generates a Form of Payment (FOP) summary report.
Adjustment Detail Report
  • API download
  • SFTP download
Generates a Form of Payment (FOP) report with adjustment details.

1.2.3 - Healthcare Starter Pack

Overview

This documentation lists all scenarios defined in the Healthcare starter pack. To use a starter pack, ensure that you have already completed the steps in Use a starter pack.

Test scenarios

Test scenariosAvailable service typeDescription
Upload health product and health plan
  • API
  • Batch

Creates a health product and plan using API and processes it with batch execution.

  • Product code — code of the health product that will be used when creating a customer.
  • Plan code — code of the health plan that will be used when creating a customer.
  • Batch-C1-HCPHP — batch that processes the inbound messages for the creation of health products or plans.
Rate upload

  • API
  • Batch

Creates rates that define customer's charges and billable charges.

  • Batch-C1-HCPHP — batch that processes the inbound messages for the creation of rates.
Custmomer upload by referring rate plans
  • API
  • Batch

Updates a customer account based on product code, plan code, and rate. For example, if a rate is specified with Tobacco is Y and a customer has a Y Tobacco switch, then the rate will be mapped to the customer.

Runs the Batch - C1-HCEXS to process the inbound bound message for the creation of the customer, account, and contract.

Billable charge creation

  • Batch

Runs the following batches in order:

  • C1-REPC1 (Identify Entities for Repricing) — Identifies the entities that are eligible for repricing.
  • C1-REPC2 (Process Repricing Request) — Processes the entities captured by the C1-REPC1 batch.
  • C1-FIBCR (Fully Insured Billable Charge Creation) — Creates the billable charge for the processed entities.
Customer billing
  • Batch
  • UI

Generates a bill using the billable charges and account. For batch testing, it runs the following batches in order:

  • BILLOPEN (Pending Bill Generation) — Generates a blank bill in pending status for accounts in the specified division and bill cycle based on the given cut-off date.
  • BSGENREG (Bill Segment Generation) —Generates bill segments, including all billable charges, of accounts that have blank bills in an open bill cycle, input bill cycle, or division for a given cutoff date.
  • POSTPROC (Bill Completion) — Creates a post-processing bill segment generated by previous batches and finalizes the bill.
General ledger scenario
  • Batch

Runs the following batches in order:

  • C1-GLASGN — Assigns the General Ledger account to a financial transaction.
  • GLS — Stages the downloaded General Ledger.
  • GLDL — Extracts the downloaded General Ledger.
Create payment
  • API
Creates a payment for the generated bill.

1.2.4 - Utilities starter pack

Overview

This documentation lists all scenarios defined in the Utilities starter pack. To use a starter pack, ensure that you have already completed the steps in Use a starter pack.

Manage customer data

Test scenariosC2M/CCS prerequisiteService type
Create a person and accountNone
  • API
Add person characteristicsAdded person in the previous scenario

  • API
Add a person of relationship type of roommate to an accountExisting person or account
  • API
Remove person characteristicsExisting person

  • API
Maintain customer information - life support/phone/email/mailing addressExisting person
  • API
Maintain customer info- remove life support alertExisting person
  • API
Change mailing address to personExisting account

  • API
Change mailing address to account overrideExisting account

  • API
Change mailing address to mailing premise on accountExisting account

  • API
Maintain customer account information - financial responsibilityExisting account

  • API
Add copy of bill & bill routeExisting account

  • API
Maintain customer information - add autopayExisting account

  • API
Maintain customer information - remove autopayExisting account

  • API
Add Premises - residential or commercial

  • API
Delete premiseExisting premise

  • API
Update premiseExisting premise

  • API
Update premise characteristicsExisting premise

  • API
Change a premise type on an existing premiseExisting premise
  • API

Establish service

Test scenariosC2M/CCS prerequisiteService type
Add a Service Point - Electric/Water/ Gas/RefuseExisting premise
  • API
Delete a service pointExisting premise

  • API
Update service point - device locationExisting service point
  • API
Update service point - SP instructionExisting service point

  • API
Manual change of service point, service route, and sequenceExisting service point
  • API
Disconnect service pointExisting service point
  • API
Deactivate service pointExisting service point

  • API
Start SA on a premise not linked to any account, with current date Start SA on a premise not linked to any account, with future dateExisting person, account, service point

  • API

Device Management

Test scenariosC2M/CCS prerequisiteService type
Manually Add a Device to SP - Water Residential/Water CommercialExisting service point and device configuration
  • API
Install a Device - Manual Water Meter/Manual Waste Water Meter/Sensus Water Meter /Sensus Waste Water Meter [CCS]Existing install event

  • API
Remove install event [CCS]Existing install event
  • API
Turn off or remove a device - Manual Water Meter/Manual Waste Water Meter/Sensus Water Meter /Sensus Waste Water Meter [CCS]Existing install event

  • API
Configure a device - Manual Water Meter/Manual Waste Water Meter/Sensus Water Meter /Sensus Waste Water Meter [CCS]Existing device and configuration
  • API
Install a device - Water Analog Meter/Water Smart Meter/Water AMR Meter [C2M]Existing install event
  • API
Update install event - Remove deviceExisting install event

  • API
Update install event - Turn off deviceExisting install event

  • API

Financial management

Test scenariosC2M/CCS prerequisiteService type
Add bill cycle to an accountExisting account
  • API
Add bill message to an accountExisting account

  • API
Add bill intercept to accountExisting account
  • API
Remove bill intercept to accountExisting account

  • API
Add copy of bill and bill routeExisting account
  • API
Enter a bill after date on an account that is scheduled to billExisting account
  • API
Change budget bill amount manuallyExisting service agreement

  • API
Create account alert - protected bill cycleExisting account
  • API
Generate a first bill
Generate a bill - Final Bill (with Balance Owed)
Generate and complete a manual bill - Deposit
Generate and complete a manual bill - First Bill for Account greater or equal to X days
Generate and complete a manual bill - First Bill for Account less than X days
Existing bill
  • API
Add bill message - to a billExisting bill

  • API
Delete a pending bill - Bill Segments in Freezable status
Delete a pending bill - Bill Segments in Error status
Existing bill

  • API
Cancel a billExisting bill

  • API
Reopen a completed online billExisting bill

  • API
Reopen a bill and add an adjustmentExisting bill

  • API
Rebill bill segmentExisting bill segment

  • API
Delete bill segment
Delete bill segment in freezable status
Existing bill segment

  • API
Process payments - Process Customer PaymentsExisting account and payment tender

  • API
Distribute payment
Payment distribution
Existing payment
  • API
Cancel a paymentExisting payment
  • API
Misapplied payment - Transfer paymentExisting payment
  • API
Apply adjustment
Add an adjustment
Existing service agreement
  • API
Cancel an adjustment
Cancel a transfer adjustment
Existing adjustment
  • API

Credit and collections

Test scenariosC2M/CCS prerequisiteService type
Start collection processExisting account with debt and service agreement
  • API
Cancel a collection processExisting account with debt and service agreement

  • API
Change or update a collection event informationExisting account with debt and service agreement
  • API
Add a collection eventExisting account with debt and service agreement

  • API
Delete a collection eventExisting account with debt and service agreement
  • API
Start severance processExisting account with debt and service agreement
  • API
Cancel a severance processExisting account with debt and service agreement

  • API
Change a severance eventExisting account with debt and service agreement

  • API
Add a severance eventExisting account with debt and service agreement
  • API
Start the write-off processExisting account with debt and service agreement
  • API
Cancel a write-off processExisting account with debt and service agreement
  • API
Add, change, or delete write-off processExisting account with debt and service agreement
  • API

1.3 - Key Features

Modernized UI

V3 boasts a completely redesigned user interface focused on usability. The clean, uncluttered, and logically organized interface enables users to navigate effortlessly, locate information quickly, and perform tasks efficiently.

Intuitive Graphical Test Flow

V3 revolutionizes test scenario creation with a user-friendly, visual, top-down workflow. Testers can effortlessly design end-to-end test scenarios using a drag-and-drop interface, providing a clear visual representation of complex test flows. This eliminates the need for complex navigation, making the process intuitive and efficient.

Streamlined Setup

V3 simplifies configuration with a centralized approach. Users can configure assertions, and integrations directly within the test flow screen, eliminating the need to navigate multiple menus and reducing setup time.

Version Control

V3 enables flexible management of different service configurations within projects through its integrated version control system. This feature allows users to easily maintain and switch between multiple versions, ensuring adaptability to changing requirements and testing environments.

Enhanced Issue Tracking

V3 seamlessly integrates with popular issues and project tracking software like Jira and Azure DevOps. This integration allows automatic defect reporting, ensuring no issue is overlooked. It streamlines collaboration between development and QA teams, accelerates issue resolution, and keeps everyone synchronized.

Robust Testing Environment

V3 provides a robust testing environment with advanced features:

  • Soft Assertions: Allow test executions to continue even when validation fails, logging warnings for these non-critical failures.
  • Hard Assertions: Stop test execution immediately upon encountering a validation failure, ensuring critical issues are addressed promptly.
  • Custom Assertions: Allow users to write custom logic using code or expressions for specific validation needs, offering unparalleled flexibility.

Centralized Project-Level Global Variables

Manage global variables centrally at the project level, reducing redundancy and ensuring consistency across all test cases. This centralized control simplifies maintenance while allowing seamless customization. Project-level variables can also be overridden at the environment level, enabling different values for variables across environments and providing enhanced flexibility to tailor the test environment to specific needs throughout the entire project.

Test Step Validation: Ensure Setup Accuracy

Validate individual test step configurations before executing the full test suite, catching errors early and saving valuable time and resources. This proactive approach enhances the accuracy of results and ensures that each step is set up correctly, improving the overall reliability of your test cases.

Results Comparison

V3 enables easy comparison of results from different test runs or iterations of the same run. This feature provides insights into changes over time, highlights potential regressions, and facilitates trend analysis for continuous improvement.

Modernized UI

V3 boasts a completely redesigned user interface focused on usability. The clean, uncluttered, and logically organized interface enables users to navigate effortlessly, locate information quickly, and perform tasks efficiently.

Intuitive Graphical Test Flow

V3 revolutionizes test scenario creation with a user-friendly, visual, top-down workflow. Testers can effortlessly design end-to-end test scenarios using a drag-and-drop interface, providing a clear visual representation of complex test flows. This eliminates the need for complex navigation, making the process intuitive and efficient.

Streamlined Setup

V3 simplifies configuration with a centralized approach. Users can configure assertions, and integrations directly within the test flow screen, eliminating the need to navigate multiple menus and reducing setup time.

Version Control

V3 enables flexible management of different service configurations within projects through its integrated version control system. This feature allows users to easily maintain and switch between multiple versions, ensuring adaptability to changing requirements and testing environments.

Enhanced Issue Tracking

V3 seamlessly integrates with popular issues and project tracking software like Jira and Azure DevOps. This integration allows automatic defect reporting, ensuring no issue is overlooked. It streamlines collaboration between development and QA teams, accelerates issue resolution, and keeps everyone synchronized.

Robust Testing Environment

V3 provides a robust testing environment with advanced features:

  • Soft Assertions: Allow test executions to continue even when validation fails, logging warnings for these non-critical failures.
  • Hard Assertions: Stop test execution immediately upon encountering a validation failure, ensuring critical issues are addressed promptly.
  • Custom Assertions: Allow users to write custom logic using code or expressions for specific validation needs, offering unparalleled flexibility.

Centralized Project-Level Global Variables

Manage global variables centrally at the project level, reducing redundancy and ensuring consistency across all test cases. This centralized control simplifies maintenance while allowing seamless customization. Project-level variables can also be overridden at the environment level, enabling different values for variables across environments and providing enhanced flexibility to tailor the test environment to specific needs throughout the entire project.

Test Step Validation: Ensure Setup Accuracy

Validate individual test step configurations before executing the full test suite, catching errors early and saving valuable time and resources. This proactive approach enhances the accuracy of results and ensures that each step is set up correctly, improving the overall reliability of your test cases.

Results Comparison

V3 enables easy comparison of results from different test runs or iterations of the same run. This feature provides insights into changes over time, highlights potential regressions, and facilitates trend analysis for continuous improvement.

1.4 - New Features

Sync Test Run to TestRail

To sync TestRail during execution, follow these steps:

  1. Go to the Test Flow page.

  2. Click Run.

  3. In the Run Setup Form click the Sync Run To TestRail toggle.

Summary

To synchronize and manage test artifacts within the TA tool, you must first configure the TestRail integration in the settings. Then, enable the TestRail integration. Next, you must also configure TestRail in the project-level settings. Now that you have configured TestRail in the TA tool and project-level, make sure to sync test flows and test runs during execution.

1.5 - Architecture

Overview

This document provides a high-level infrastructure diagram and an overview of the various components, processes, and protocols relevant to the Test Automation tool.

Core Components

Client

This refers to the user interface of a web application, which is the point of interaction between users and the software. It includes elements such as buttons, menus, forms, and graphics that allow users to navigate and utilize the functionalities of the application.

Auth Server

This handles user authentication and authorization processes, ensuring that only authorized individuals have secure access. This includes verifying user identities through login credentials and granting access to specific resources based on predefined roles and permissions.

Core Service

The core service is responsible for orchestrating various processes, implementing business logic, and providing API access. This microservice efficiently manages requests related to configuration management, which includes creating and managing projects, defining steps within those projects, establishing assertions for testing purposes, designing test flows, and generating datasets necessary for testing and analysis. By centralizing these functions, this service ensures a streamlined and cohesive approach to handling user requests and enhancing the overall application performance.

Execution Dispatcher

The Execution Dispatcher is responsible for managing the submitted executions. It uses Kafka to queue the executions when multiple tasks are in progress. Additionally, it handles the logic for distributing the execution to different types of steps. During this process, Hazelcast’s cache is utilized to store the state of each execution.

SQL Executor, Batch Executor, API Executor, UI Executor

These microservice components are responsible for establishing a connection to a target system and executing various testing operations. Each component is designed to handle specific aspects of the testing process. By integrating with the target system, these components facilitate data exchange and verification.

Kafka Streams

A stream processing platform used for real-time data processing, enabling users to analyze and act on streaming data as it flows in. This platform facilitates the immediate collection, processing, and analysis of data from various sources, ensuring that insights are generated in the moment. Furthermore, it provides timely feedback to end users while the execution is ongoing, allowing for quick adjustments and responses to changing conditions.

Hazelcast

An in-memory data grid that is used for caching information and managing distributed data storage. It allows for quick access to data by storing it directly in the system’s memory.

PostgreSQL

A relational database that is used for the storage and management of persistent data. It organizes data into structured formats, typically utilizing tables, which allow for efficient retrieval and management.

MinIO Object Storage

An object storage solution designed for efficiently storing large files and media assets that are produced during user interface (UI) execution or report generation processes.

2 - Web Application

2.1 - Dashboard

Overview

The Dashboard is the main screen where the user interacts with the TA and provides a high-level overview of the testing activities.

The date filter located in the top-right corner of the application enables you to customize the timeframe for the data displayed on the dashboard. By selecting a specific date range, you can focus on relevant execution data within that period. This filter applies to all dashboard sections, ensuring that metrics, graphs, and reports reflect only the data from the selected timeframe.

Tests Executed

This section provides a high-level overview of the executed test flows, categorized by their outcomes. It includes counts of test flows that successfully passed, those that failed, those that passed but with warnings, and those that were terminated or canceled.

Execution Average Time

This section provides an overview of the average execution time for test runs, categorized by step types.

Issues Reported

This section displays a count summary of all the reported issues encountered during execution, categorized by their current status.

Recent Runs

The Recent Runs section of the dashboard features a dynamic graph displaying all test executions within the configured timeframe. Each bar represents a single execution, showcasing the count of scenarios run and their statuses: Success, Fail, Warning, or In Progress.

The graph provides an at-a-glance view of execution results, with a navigation bar above the legend that allows users to zoom in for a more focused analysis by adjusting the displayed timeframe.

The Trends Over Time section presents a line graph that tracks execution results over the configured timeframe. The graph includes two lines: a green line representing the number of successful executions and a red line representing the number of failed executions for each day.

The graph provides an at-a-glance view of execution trends, with a navigation bar above the legend that allows users to zoom in for a more focused analysis by adjusting the displayed timeframe.

2.2 - Project

Overview

The Project module enables you to create a personalized testing workspace to avoid overlap in your activities. Depending on your testing requirements, you can customize your workspace by adding items.

Create a project

To create a project, click on the button on the top left pane.

Field Description
Logo

Logo of the project. The supported file types are png, jpg, and jpeg.


Mandatory: No

Project Name Name of the project.

Mandatory: Yes
Project Code Unique identifier assigned to a project.

Mandatory: Yes
Project Description Description of the project.

Mandatory: Yes
Releases Shows configured releases. Only 1 release can be active at a time.
Environments Configured environments for the project. For more information, see Environments.
Variables Configured global variables for the project. For more information, see Variables.
Integrations Configured integrations for the project. For more information, see Integrations.

Update a project

Select a project to view and edit its details. You can update all details except the Project Code. After you make the modifications, click the Update button.

The search feature allows you to filter the list of steps by providing a keyword or the full name of the step. Only the steps that match the provided keyword or name will be displayed in the view.

Filter

Click the icon to display additional sorting options.

Delete a project

To delete a project, hover over the project you want to remove. An icon will appear. Click on this icon and select Delete.

Deleting a project will also remove all associated versions and the data contained within each version. Before you confirm the deletion, a list indicating the number of data items that will be deleted is displayed.

Versions

Versions allow you to create new versions of an existing project, where all parameters and their values are automatically copied. This enables you to change parameters while keeping the original version.

To create a new version, click the plus icon in the Version section and enter a valid name that has a maximum of 20 characters.

2.2.1 - Environments

Overview

The Environments section is where your testing environments are defined. A testing environment can be a development, staging, production, or any other project-specific environment. This section allows you to add, modify, or delete environments according to your needs.

Create an Environment

To create an environment, click Create Environment and enter valid values in the following fields:

Field Description
Environment Name Name of the environment. Should be minimum 4 characters long.

Mandatory: Yes
API Base URL URL of the environment for API or Batch testing.

Mandatory: Yes
Application URL URL of the environment for UI testing.

You can also specify the target URL in the Service > Uploaded File > url field . In case, different target URLs are specified in the Application URL and Uploaded File > url fields, the system will use the URL specified in the Application URL.

Mandatory: No
Default Sets the selected environment as default for test runs and templates of an external system. Selecting will override the existing default environment, if any.

Mandatory: No
Authentication

Specifies the authentication details for the test environment. The following are the possible values:

  • BASIC
  • ORMB
  • API_KEY
  • TOKEN
  • SIGNATURE
  • NO_AUTH
  • OCULAR
  • OAUTH

For more information, see Authentication Details.

Mandatory: Yes

Database Details Parameters used to connect to a database. For more information, see Database Details.

Mandatory: Yes
Proxy

Enables the proxy server for the environment. For more information, see Proxy Details.

Mandatory: No

SFTP

Enables the Secure File Transfer Protocol(SFTP) to download and upload files from any server. For more information, see SFTP Details.

Mandatory: No

Authentication Details

The following are the supported authentications for your environment and the additional mandatory settings that you need to provide.

Authentication Description
BASIC

If you select BASIC authentication, you need to supply the following:

  • Username — Username to use when connecting to the target test environment.
  • Password — Password to use when connecting to the target test environment.
ORMB

If you select ORMB authentication, you need to supply the following:

  • Username — Username to use when connecting to your ORMB environment.
  • Password — Username to use when connecting to your ORMB environment.
API_KEY

If you select API_KEY authentication, you need to supply the following:

  • Key — API key to access the API service.
  • Value — Actual value of the specified API Key.
  • Add To — Defines how and where the API Key should be added to the API service.
TOKEN

If you select TOKEN authentication, you need to supply the following:

  • Token — Value of the token to access an application or an API service.
SIGNATURE

If you select SIGNATURE authentication, you need to supply the following:

  • Access Key — Authorization key to access your account or application.
  • Secret Key — Password of the Access Key.
NO_AUTH No authentication type is required.
OCULAR

If you select OCULAR authentication, you need to supply the following:

  • Username — Username to use when connecting to your EPM.
  • Password — Password to use when connecting to your EPM.
OAUTH

If you select OAUTH authentication, you need to supply the following:

  • Grant Type — Specifies how the client requests an access token. Possible values include Password Credentials, where the user’s username and password are used, and Client Credentials, where only the application’s own credentials are used and no user is involved.
  • Token URL — Specifies the URL where the client sends a request to get an access token.
  • Client ID — Public identified or the application.
  • Client Secret — Private credential to authenticate the client.
  • Scope — Defines the permissions the client is requesting.
  • Username — Identifier of the user to get a token.
  • Password — Password of the user to get a token.

Database Details

To configure a database, click and enter valid values in the following fields. After adding the details, click Test Connection to ensure that the connection details you configured are correct and working properly. The status will change from Pending to Success or Failed depending on the result of the test connection.

Field Description
Name Name of the database to connect to.

Mandatory: Yes
Database Type

Type of the database. The possible values are the following:

  • POSTGRES
  • ORACLE

Mandatory: Yes

DB Connection Specifies the status of the database connection.
Default? Indicated whether the database is set as default.
Actions Displays a delete icon that when clicked deletes the selected database.

SFTP Details

The Secure File Transfer Protocol (SFTP) allows you to download and upload files from the configured server. To configure your SFTP server, enter valid values to the following fields:

Field Description
Server Address Address of the SFTP server.

Mandatory: Yes
Port Port of the SFTP server.

Mandatory: Yes
Username Username used to log in to the SFTP server.

Mandatory: Yes
Password Password used to log in to the SFTP server.

Mandatory: Yes, if authentication is being done without the .pem file.
Add .pem File A .pem file is a base64-encoded file used to store and share cryptographic keys and certificates securely. There are two methods of authentication of the SFTP:
  • With .pem file
  • Without .pem file
If you need to change the attached .pem file, click the Upload File button.
Passphrase Password to decrypt an encrypted .pem file.
Test Connection Tests the network connection and validates if the SFTP details are correct.

Proxy Details

If you want to enable the proxy server for the environment, enter valid values to the following fields:

Field Description
Proxy Address Address of the proxy server.

Mandatory: Yes
Proxy Port Port of the proxy server.

Mandatory: Yes

Variables

If you want to specify a value that is unique to a specific environment, please enter valid values in the following fields. Make sure that the variable you want to define at the environment level is already defined at the project level.

Field Description
Name Name of the variable.
Default Value Specifies the default value of the variable.
Value Specifies other possible values for the variable.
Action Displays the delete button that allows you to delete the added variable.

2.2.2 - Variables

Overview

The variables in the Variables section can be reused across all steps and flows within your project. For example, if you need to automate a login process, you can store sensitive login credentials like username and password as project variables. Instead of manually entering these credentials in every API or UI step, you can reference them using {{username}} and {{password}}, ensuring consistency and simplifying maintenance.

By using project variables, you can easily update values in one place. If you need environment-specific values, for example, different credentials for development or production, you can configure Variables in Environments to manage these settings for each environment, making it easy to switch between them without modifying individual steps.

Create a variable

To create a variable, follow these steps:

  1. Navigate to the Project > Variables.
  2. Click . A new row will be added to the Variables table.
  3. Optional. Click Is Secret if you want the value to be hidden.
  4. Enter valid values for the Name, Type, and Value columns.
  5. Click Save. If you wish to cancel the creation of a new variable, click X.

Edit a variable

The name of the variable is not editable. You can only modify the type or value of a variable. Once modified, click Save.

Delete a variable

To delete a variable, click the delete icon on the row of the variable you wish to delete.

Search a variable

To search for a variable, you can enter a keyword of the full name or value of the parameter on the Search box beside . Only the variable names that match the provided keyword or name will be displayed in the view.

2.2.3 - Integrations

Overview

The Integrations section in the Project module enables you to configure integrations at the project level.

Before confguring your integrations, ensure that you have enabled your test case management and issue tracking applications in the Settings module.

Configure project integrations

  1. Go to the Integrations tab of the selected project.
  1. Click Configure Project Integrations.

  2. Click the Test Case Management toggle.

  1. Select TestRail from the dropdown across App To Use.
  1. Select a project from the TestRail Project dropdown list.

  2. Click the Issue Tracking toggle.

  1. Select the issue tracking app from the App To Use dropdown list.
  1. Select a project from the TestRail Project dropdown list.
  1. Click Save.

Modify an integration configuration

You can modify any configuration for the test case management and issue tracking integrations by selecting a new value from the dropdown list, then clicking the Save button.

Disable an integration

Click the toggle button of the integration you wish to disable. Any configured value for that integration will remain.

2.3 - Step

Overview

Steps are individual actions or instructions that make up a Scenario, and multiple steps can be associated with a single scenario. A step can also be reused across different scenarios within the same Project. There are no limitations on the type of steps you can add in a scenario as long as they are part of the same project. Any changes made to a step in a flow will be reflected across all flows where that step is reused.

If you want to prevent any changes to a step from affecting other Flows, you can use the Clone Step or Clone Scenario option at the test flow level. By assigning a unique name to the cloned steps or scenarios, you ensure that any future changes to the original will not impact the cloned entities.

View

In the upper left corner, select your project from the Select Project dropdown list and the version from the Version dropdown list. Only the steps associated with the selected project and version are displayed on the left pane.

Edit a step

To view or modify the details of a step, select the step from the left pane that lists all steps associated with the selected project and version. You can change any detail by directly editing the corresponding field. Ensure to click Update after making your modifications.

The search feature allows you to find a specific step by entering a keyword or the full name of the step on the textbox. Only the steps that match the provided keyword or name will be displayed in the view.

Filter

Click the icon to display additional filtering and sorting options. For filtering, a dropdown list of available filter parameters will show all associated values for the selected project and version.

Create a step

To create a step, click on the Create Step button and enter valid values to the following fields. To create a step, click on the Create Step button and enter valid values to the following fields.

Field Name Description
Step Name Name of the step. It should be a minimum of 5 characters long.

Mandatory: Yes
Step Type

Specifies the type of step. The following are the possible values:

Mandatory: Yes

Create an API step

To create an API step, enter valid values in the following fields:

Field Description
HTTP Method

Specifies the action to be performed by the external system on your server. The following values are supported:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

Mandatory: Yes

URL

Specifies the API URL used for validation. It consists of two parts:

  • Environment — Automatically displays the default environment configured in the selected project. To select a different environment, click the dropdown arrow beside Send to display all configured environments.
  • URL — Specifies the API service URL.

Mandatory: Yes

Params

Specifies the parameters used for query execution and data retrieval. Parameters can be configured in the following ways:

  • Query Params — Allows you to specify keys and their corresponding values for data retrieval. These can be updated either by modifying the URL or by adding queries in the table.
  • Path Params — Displays the parameter keys requested in the API URL. Only parameter values can be modified by updating the API URL.

Mandatory: No

Body

Specifies the payload details of the step. The following formats are supported:

  • Form Data — Allows you to define key-value pairs. For more information, see Form Data.
  • JSON — Allows you to define the structure of the request and response bodies.

Mandatory: No

Headers

Specifies the HTTP headers included in API requests or responses. Headers provide important metadata such as content type, authentication details, and instructions for processing data.

Template

Specifies the template for the request payload. For more information, see Template.

Response

Displays the data returned by the server in response to an API request. Responses contain the information or results of the request, such as user data, search results, or confirmation messages.

Template

A request payload template simplifies dataset configuration by defining the structure of the request body, including JSON nodes and parameters like path or query parameters.

The purpose of the template is to declare fixed values once and reuse them in datasets. Only the varying fields need to be populated when the template is reused.

The values in the template can be any of the following:

  • Default value: The same value is used every time the dataset is used.
  • Project variable: The value of the project variable assigned to the node is used.
  • User input: The user provides the value each time the dataset is configured.
  • Pattern value: A validation pattern is defined for the source input. Users must provide a value each time the dataset is configured, and the value must conform to the specified format or regular expression.
    To access valid and supported formats, click the </> icon to view all the available pattern value templates. You can scroll through the list or use the search field to find a specific format.

To test the entered expression, click the Test button. A popup window appears, displaying possible values for the entered expression in the left pane and the reference guide in the right pane.

Form data

Form Data allows you to define request parameters as key-value pairs. It is used to send a single request with a single or multiple parameters. Each parameter is represented as a separate key with a corresponding value.

Column Description
Select Checkbox used to select the form data row.
Key Name of the form data parameter sent in the request.
Type Data type of the parameter value, such as Text or File.
Value Value assigned to the parameter key.
Description Purpose of the parameter.
Action Delete icon to remove the selected parameter key.

Create a Batch step

To create a batch step, select a batch from the Batch Name dropdown field and enter valid values in the following fields:

Field Description
Batch Job ID

Unique identifier of the batch job.

Mandatory: Yes

Batch Code

Unique code associated with the batch job.

Mandatory: Yes

Description

Description of the batch.

Mandatory: Yes

Thread Number

Thread within the batch process.

Mandatory: Yes

Thread Count

Total number of threads used for parallel processing within the job.

Mandatory: Yes

Batch Rerun Number

Run number of the re-execution of a batch process in ORMB.

Mandatory: Yes

Batch Business Date

Specific date for ORMB transactions to be processed.

Mandatory: Yes

Override Nbr Records to Commit

Total number of records that can be manually overridden and committed to the database during a batch process in ORMB.

Mandatory: Yes

Override Max Timeout Minutes

Maximum time limit for a process to run before it times out.

Mandatory: Yes

User

User account used to log in to ORMB.

Mandatory: Yes

Language

Language or locale settings used to process and display data, messages, and invoices in ORMB.

Mandatory: Yes

Email Address

Email address of the user.

Mandatory: Yes

Trace Program Start

If enabled, detailed logs are captured at the beginning of a trace process.

Default: Disabled

Trace Program Exit

If enabled, end logs are captured to mark the completion of a trace process.

Default: Disabled

Trace SQL

If enabled, SQL queries executed during a trace process are captured and logged.

Default: Disabled

Trace Output

If enabled, all trace output, including logs and reports about the execution flow, SQL queries, and performance metrics, is generated.

Default: Disabled

Parameters

Field Description
Sequence

Unique values used to identify the parameter.

Parameter Name

Name of the parameter.

Description

Description of the parameter.

Parameter Value

Specifies the value of the parameter.

Required

Indicates whether the parameter is required for a batch job to run.

Create a Query step

Section Description
Schema

Specifies the schema of the database where the query will be executed. This is automatically populated from the configured database at the environment level and only needs to be selected at the assertion level.

Query

Defines the query being executed to get results for validation.

Parameters

Lists the input key-value pairs extracted from the provided query.

Result

Specifies the expected result after running the query.

Output Columns

List of database columns included in the expected result after running the query, along with their data types.

Create a File upload step

To create a new file upload step, follow these steps:

  1. Enter a valid value in the Step Name field.
  1. Select File Upload in the Step Type dropdown field.
  1. Click the Add New File button.
  1. Specify the Destination remote folder path.

  2. Drag or browse the files to upload. You have an option to overwrite an existing file.

  3. Click the Upload button.

  1. Click the Save button.

Create a File download step

To create a new file upload step, follow these steps:

  1. Enter a valid value in the Step Name field.
  1. Select File Download in the Step Type dropdown field.
  1. Click the Add Remote File button.
  1. Specify the Remote folder path and the Remote File Name.
  1. Click the Save button in the Download Files window.
  1. Click the Save button.

Create a UI step

To create a UI step, upload your .side file in the designated upload box.

Once uploaded, a table with the following columns is displayed:

Column Description
Command

Describes the command or action to be performed on the target.

Mandatory: Yes

Input

Indicates whether a value is necessary to be supplied to the target element for the command to be executed.

Mandatory: No

Target

Specifies the xpath of the target.


Mandatory: Yes

Value

Specifies the value to be supplied to the target element.


Mandatory: Only if the Input box is checked.

Description

Describes the command.


Mandatory: Yes

Screenshot

Indicates whether a screenshot will be captured during the execution of the command.

Mandatory: No

Run Details

After uploading a side file, you can click the Run button to preview the execution details of the commands defined in the uploaded file.

Input value

If the Input checkbox is ticked, you must supply a value to the target. A value could be one of the following:

  • Text — Enter any text manually.
  • File — Upload a file to use as the input value.
  • Project Variable - Select from the list of variables configured for the project.

Delete a step

To delete a step, hover over the step you want to remove. An icon will appear. Click on this icon and select Delete.

If a step is used in a flow or a dataset, a warning message will be displayed indicating that it cannot be deleted.

To delete the step, you must first remove it from any flows or datasets where it is being used.

2.4 - Assertion

Overview

Assertions serve as a quality control measure ensuring the completeness and correctness of the expected data as defined in a Step.

View

In the upper left corner, select your project from the Select Project dropdown list and the version from the Version dropdown list. Only the assertions associated with the selected project and version are displayed on the left pane.

Edit an assertion

To view or modify the details of an assertion, select the assertion from the left pane that lists all assertions associated with the selected project and version. You can change any detail by directly editing the corresponding field. Ensure to click Update after making your modifications.

The search feature allows you to filter the list of assertions by providing a keyword or the full name of an assertion. Only the assertions that match the provided keyword or name will be displayed in the view.

Filter

Click the icon to display additional filtering and sorting options. For filtering, a dropdown list of available filter parameters will show all associated values for the selected project and version.

Create an assertion

To create an assertion, click on the icon on the top left pane and enter valid values to the following fields.

Field Name Description
Assertion Service Name Name of the assertion. It must be at least 5 characters long.

Mandatory: Yes
Assertion Type

Specifies the type of step. The following are the possible values:

Mandatory: Yes

API assertion

To create an API assertion, enter valid values in the following fields:

Field Description
HTTP Method

Specifies the action to be performed by the external system to your server. The following are the possible values:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE

Mandatory: Yes

URL

Specifies the API URL used for validation. It consists of two parts:

  • Environment — Automatically displays the default environment set in the selected project. To select a different environment, click the dropdown arrow beside Send to view all configured environments within the selected project.
  • URL — Specify the URL of the API service.

Mandatory: Yes

Params

Specifies the type of parameters for query execution and data retrieval. You can specify parameters in the following ways:

  • Query Params — Allows you to specify keys and the respective values for data retrieval. This can be updated by modifying the URL or adding queries in the table.
  • Path Params — Displays the specified keys requested for retrieval in the API URL. Key values can only be changed by updating the API URL.

Mandatory: No

Body

Specifies the payload details of the assertion. You can choose between the following formats:

  • Form Data — Allows you to define key-value pairs.
  • JSON — Allows you to define the template of the request and response bodies.

Mandatory: No

Headers Specifies the API headers in HTTP requests or responses that provide important metadata, such as content type, authentication details, and instructions for processing the data.

Query assertion

Section Description
Schema Specifies the schema of the database where the query will be executed. This is automatically populated from the configured database at the environment level and only needs to be selected at the assertion level.
Query Defines the query being executed to retrieve results for validation.
Parameters Lists the input key-value pairs extracted from the provided query.
Results Specifies the expected result after running the query.
Output Columns Lists the database columns included in the expected result after running the query, along with their data types.

ORDS assertion

Section Description
Query Defines the query being executed to retrieve results for validation.
Parameters Lists the input key-value pairs extracted from the provided query.
Results Specifies the expected result after running the query.
Output Columns Lists the database columns included in the expected result after running the query, along with their data types.

File to File assertion

This assertion allows you to compare two specified files. To add files, follow these steps:

  1. Click the Add Remote File button.

  2. Enter valid values to the Remote Folder Path and Remote File Name fields.

  3. Click the Save button.

Change the attached file

To change the attached file, click the edit icon.

The Download Files form, similar to the one in Step 2 of the previous section, will be displayed. Make the necessary changes, then click Save.

Delete the attached file

To delete an attached file, follow these steps:

  1. Click the delete icon.

  2. Click Delete button on the confirmation prompt.

Run results

Once added to a flow and executed, the Assertions tab in the Run Result page displays the line differences between the files.

The files that were compared are also listed in the Details tab in the Run Result page.

Delete an assertion

To delete an assertion, hover over the assertion you want to remove. An icon will appear. Click on this icon and select Delete.

If an assertion is used in a flow or a dataset, a warning message will be displayed indicating that it cannot be deleted.

To delete the assertion, you must first remove it from any flows or datasets where it is being used.

2.5 - Flow

Overview

A test flow is a sequence of scenarios that verifies the functionality or correctness of your business system. The Flow module allows you to manage all your test flows in a project. This includes defining Scenarios, choosing or creating the steps and assertions for each scenario, and modifying or running test flows.

View

In the upper left corner, select your project from the Select Project dropdown list and version from the Version dropdown list. Only the flows associated with the selected project and version are displayed on the left pane.

Edit a test flow

To view or modify the details of a flow, select the flow from the left pane that lists all flows associated with the selected project. You can change any detail by directly editing the corresponding field. Ensure to click Update after making your modifications.

The filter feature allows you to filter the list of test flows by providing a keyword or the full name of the flow. Only the flows that match the provided keyword or name will be displayed in the view.

Filter

Click the icon to display additional filtering and sorting options. For filtering, a dropdown list of available filter parameters will show all associated values for the selected project and version.

Create a test flow

To create a new test flow, follow these steps:

  1. Select the Project and the Version on the upper left dropdown lists. If there are existing test flows in the selected project and version, they will be displayed on the left pane.

  2. Click the plus icon.

  3. Enter a valid test flow title, replacing Untitled Test Flow.

  4. Click on the Untitled Scenario, which is automatically added when creating a new flow.

  5. Add your first scenario by selecting an existing scenario within your project in the Create/Select Scenario field in the Scenario Details section. You can also Create a new scenario.

    Note that if you are using an existing scenario, the steps, sources, targets, and assertions configured in that scenario for other flows will be included.

  6. Click Apply Scenario on the popup window.

  1. Verify that all the associated steps for the selected and applied scenario are displayed. You can also Create a step in the flow module.

  2. Optional. Add a source and target parameters to the steps.

  1. Optional. Select the assertion type you wish to add to the selected step.
  1. Optional. Search for the assertion you wish to add to the selected step.
  1. Optional. Click Apply Assertion on the popup window.
  1. Optional. Verify that the added assertion is displayed in the step details section.

  2. Click Save.

Modify a test flow

You can also modify the configuration of test flows that have already been added to a test suite.

You can change the execution order of test flows by using the drag-and-drop functionality.

You can also modify the the dataset associated with a test flow or configure multiple datasets for it even after it has been added to the test suite. For more information, see Edit a dataset.

Similarly, if you need to run the test flow in a different environment you can also modify the environment. For more information, see Modify a step in the Flow module

Run a test flow

To run the test flow, click the Run button to view the Run Setup Form. Configure the necessary parameters in the following sections, then click the Run button.

Once the flow is executed, a new browser tab displaying the Run Details page will open. For more information, see Results.

Run config

The Run configuration allows you to enable the following options for flow execution:

  • Sync run to TestRail — Automatically syncs the run to the TestRail project associated with the flow.
  • Skip execution on failure — If enabled, the flow automatically stops execution when a scenario fails.

Datasets

Add the datasets to be used for execution by searching in the Search datasets field. All datasets associated with the flow are displayed. A counter in the header shows the number of selected datasets. Once selected, the datasets appear in the list.

Environment Setup

Before running a flow, you can also configure the environment for each scenario. All scenarios are listed in this section. The following settings can be configured for each scenario:

  • Environment
  • Database
  • Schema for each step in a scenario

Import a test flow

The Flow module enables you to import existing flows by clicking the down arrow in the left menu and select Import.

Drag or browse the file to be imported. The only supported file type is .ta_export.

Export a test flow

To export a flow, hover over the flow you want to export. An icon will appear. Click on this icon and select Export.

A list of all items to be exported is displayed.

After confirming the list, TA begins the export process.

Once complete, the file is automatically downloaded to your machine.

Delete a test flow

To delete a flow, hover over the flow you want to remove. An icon will appear. Click on this icon and select Delete.

The flow will be deleted from the version, but the scenarios, steps, and assertions used in it will not be deleted.

2.5.1 - Scenarios

Overview

A scenario is a high-level description of what you are testing. It consists of Steps that break down the scenario further, and Assertions that serve as validation criteria. A scenario can only be considered a success if it meets the validation criteria. Otherwise, it will be tagged as failed.

Create a new scenario

To create a new scenario, follow these steps:

  1. Add a new scenario node.

  2. Enter a valid name of the new scenario in the Create/Select Scenario field.

  3. Optional. Add a description for your scenario.

To add steps and assertions to your scenario, see Create a Test Flow.

Rename a scenario

To rename a scenario, follow these steps:

  1. Select the scenario node.
  2. Enter a new name.
  3. Select Rename to <new name>.
  4. Click Rename on the popup window.

The scenario with a new name is displayed.

Clone a scenario

To clone a scenario, follow these steps:

  1. Select the scenario node.
  2. Enter a new name.
  3. Select Clone to <new name>.
  4. Click the Clone button.

The cloned scenario replaces the older scenario.

Delete a scenario

To delete a scenario, click the more options icon in the upper-right corner of the scenario box, then select the Remove icon from the menu.

A prompt will ask whether to delete the scenario from this flow or from the entire version. Select your preferred option to continue.

Delete from test flow

If you select Remove from test flow, the scenario is deleted only from the current flow. Other flows using the scenario remain unaffected. There is no confirmation prompt, so verify you have selected the correct scenario before proceeding.

Delete scenario entirely

If you select Delete scenario entirely, the scenario is permanently removed from the version.

If the scenario is used in other flows, a pop-up will display all affected flows. You must delete the scenario from these flows before proceeding.

After deleting the scenario from all flows, you can now delete it entirely. A prompt specifying the version where it will be deleted is displayed.

Scenario usage

In the scenario usage tab, all the flows using the selected scenario node are displayed.

When the hyperlink is clicked, a new tab will open displaying the selected flow.

2.5.2 - Steps

Overview

The Flow modules allow you to use the steps defined in the Step module or add a new step to the project within the module.

Create a step in the Flow module

To create a new step in the Flow module, follow these steps:

  1. Click the scenario where you wish to create a step.

  2. Select the step type.

  1. Enter a valid values in the Create / Select Step, Step Description (optional), and Timeout fields.
  1. Add the necessary details by clicking the Details button. For more information, see:
  1. Optional. Enter valid values in the Source and Target fields. For more information, see Step sources and Step targets. You can also add new steps following the newly-created one.
  1. Click Save.

You can link steps to pass parameters to each other. However, you can only link steps that are part of the same scenario.

Step sources

The following are the possible sources for a step:

Source Description
Current step request payload Uses the value of a JSON node from the current request payload as a source for the selected step.
Current and previous step response payloads Uses the value of a JSON node from the previous and current response payload as a source for the selected step.
Previous variables Uses the value of a test flow variable defined in the step prior to the selected step.

Step targets

The following are the possible targets for a step:\

Target Description
Request body Uses the value of a JSON node from the current request payload as a target for the selected step.
Query params Assigns the value of the source to a query parameter defined within the selected step.
Path params Assigns the value of the source to a path parameter defined within the selected step.
New variable

Creates a new test flow variable as the target for the selected step.

The created variable can be used in succeeding steps or validations of the current step as a source.

Previous variables Uses a test flow variable defined prior to the selected step or scenario as a target.

Modify a step in the Flow module

To modify a step in the Flow module, follow these steps:

  1. Click the step type link on the upper-right corner of the step node.

  2. Click the edit icon.

  1. Make the necessary changes in the Edit Step window.

Rename a step

To rename a step, follow these steps:

  1. Select the step node.
  2. Enter a new name.
  3. Select Rename to <new name>.
  4. Click Rename on the popup window.

The step with a new name is displayed.

Clone a step

To clone a step, follow these steps:

  1. Select the step node.
  2. Enter a new name.
  3. Select Clone to <new name>.
  4. Click the Clone button.

The cloned step replaces the older step.

Delete a step

To delete a step, click the step type link on the upper right corner of the step box. More otions are displayed, click the Remove Step icon.

A confirmation popup window will be displayed. Click the Remove node button.

Steps usage

In the step usage tab, all the flows using the selected step node are displayed.

When the hyperlink is clicked, a new tab will open displaying the selected flow.

2.5.3 - Assertion

Overview

The Flow modules allow you to use the assertions defined in the Assertion module or add a new step to the project within the module.

Create an assertion in the Flow module

To create a new assertion in the Flow module, follow these steps:

  1. Select the assertion type you wish to add.
  1. Enter a valid name of the new assertion in the Create/Select Assertion field. You can also add a description to the Assertion Description (optional) field.
  1. Click the Details button.

  2. Add valid values to the necessary assertion parameters. For more information, see

- [Create a File assertion](../assertion.md#create-a-file-assertion)
- [Create a File to File assertion](../assertion.md#create-a-file-to-file-assertion)-->

<figure><img class="lightbox-trigger" src="








/ta/3.x.x

/images/flow_assertion-create-4.png" alt=""><figcaption></figcaption></figure>
  1. Click the Save button.

  2. Verify that the newly created assertion is listed under the associated step.

Disable an assertion in the Flow module

In the Flow module, you can disable an assertion for a specific scenario, preventing it from executing during flow execution.

To disable an assertion, follow these steps:

  1. Click the more options icon beside the assertion you wish to disable.
  1. Click Disable for this test flow.

The disabled assertion will also be automatically be disabled in the associated dataset.

To enable it back, follow these steps:

  1. Click the more options icon beside the assertion you wish to enable.
  1. Click Enable for this flow.

The enabled assertion will also be automatically enabled in the associated dataset.

2.5.4 - Sync to TestRail

Overview

This page provides the steps to sync test flows and test runs with TestRail. IF you want to learn how to configure your TestRail account for integration, see Settings. If you want to learn how to integrate your TestRail account with your project, see Integrations.

Sync test flows

Synchronize test flows to TestRail to link test cases and results across platforms.

  1. Select a test flow.

  2. Click the Sync to test flow button in the top-right corner of the page.


  1. Click Sync.

After a successful sync, a confirmation message will be displayed.

Sync test runs

Synchronize test runs to TestRail enables real-time tracking of test progress and outcomes.

  1. Click the Run button to view the Run Setup Form.
  1. Click the Sync Run To TestRail toggle.

You can also sync the run to TestRail in the following modules by repeating the steps above.

2.5.5 - Issue Tracking

Overview

Before linking an issue, ensure that you have enabled the JIRA integration in the Settings module and have configured JIRA in the Project Integrations.

You have the option to create a new issue or link a flow to an existing one.

Create a new issue

  1. Click the Issue Tracking icon.

  2. Click the Link Issue button.

  3. Enter valid values in the JIRA fields displayed. Some fields are automatically filled with a default value that can be modified.

  4. Click Create Issue. A confirmation message will be displayed.

A JIRA ticket summary with hyperlink to the JIRA project is now displayed when the Issue Tracking icon is clicked.

If you go the integrated JIRA project, a new JIRA ticket is created.

Synchronize test runs to TestRail enables real-time tracking of test progress and outcomes.

  1. Click the Issue Tracking icon.
  1. Click the Link Issue button.
  1. Click the toggle button to the Existing Issue.

  2. Select how you want to search for an existing issue.

  1. In the Search Issue field, enter a number if you selected By Issue Number and a keyword if you selected By Issue Title. A dropdown listing all tickets matching your search is displayed.
  1. Click the Link Issue button.

A JIRA ticket summary with hyperlink to the JIRA project is now displayed when the Issue Tracking icon is clicked.

2.6 - Dataset

Overview

A dataset is a collection of input data used for the parameters included in a test flow. First, you must define your test flow in the Flow module and ensure that the steps added to each scenario have a well-defined template. The templates for all the Steps in the flow will be used to create your dataset.

View

In the upper left corner, select your project from the Select Project dropdown list. Only the datasets associated with the selected project are displayed on the left pane.

Edit a dataset

To view or modify the details of a dataset, select the dataset from the left pane that lists all datasets associated with the selected project. You can change any detail by directly editing the corresponding field. Ensure to click Update after making your modifications.

The search feature allows you to filter the list of datasets by providing a keyword or the full name of a dataset. Only the datasets that match the provided keyword or name will be displayed in the view.

Filter

Click the icon to display additional filtering and sorting options. For filtering, a dropdown list of available filter parameters will show all associated values for the selected project and version.

Create a dataset

To create a dataset, click on the icon on the top left pane and enter valid values to the following:

After the filling out the following fields, it should look like this:

Field Name Description
Dataset Name Name of the dataset.

Mandatory: Yes
Test Flow Dropdown list displays all test flows defined in the Scenarios and Steps associated with it.

Mandatory: Yes
Step Dataset Template To view or modify a dataset template, first select a scenario and then choose the corresponding step. Next, select a template from all the templates defined for the chosen step.

After selecting a template, the Request payload will be displayed.

Mandatory: Yes
Source Type Specifies the type where the parameter will get its value. Possible values are the following:
  • Default Value — Value comes from the step dataset template or the user input variable submitted during the bulk dataset upload via the Excel template.
  • Project Variable — Value comes from a project variable.
Mandatory: Yes
Source Value Specifies the value to be used by the parameter.

To modify the pre-defined value of a project variable source, select a variable from the dropdown list.

To modify the pre-defined value of a static variable source, directly enter the new value in the textbox.

Mandatory: Yes

Enable or disable assertion

To disable an assertion and exclude it from the flow execution, untick the assertion.

To enable it again, just tick the assertion.

Sync dataset

When a step is deleted or added in the Flow module, the dataset will display a message indicating it is not synced. By clicking View Details, a list of the deleted or the added steps is displayed.

The dataset out-of-sync message is also triggered when assertions are added or deleted from a step in the Flow module. In addition, adding or deleting assertion input nodes will also trigger the dataset out-of-sync message on the Dataset page.

If you click Sync Dataset, the deleted steps, assertions, or assertion input nodes will be removed, and the added steps, assertions, or assertion input nodes will be included in the Dataset module.

Import a bulk dataset

The Dataset module enables you to import datasets by clicking the down arrow in the left menu and select Bulk Dataset import.

Enter a dataset name prefix, then upload the template file. If you need a template file, you can download one.

Download template file

You can download a predefined Excel template to format your data according to the specified guidelines. Once your data is formatted, you can upload it into the system. To download one, follow these steps:

  1. Select a test flow and version from the Test Flow and Version dropdown lists, respectively.
  2. All the scenarios used in the selected flow will be displayed. Make the necessary changes you need. To use different datasets with varying values, choose User Input from the dropdown, then specify a variable name.
  1. Click the Excel Download button.

A new Dataset Template.xlsx file will be downloaded.

  1. Optional. Enter one or more dataset names in the DatasetName tab, placing each in its own row.
  1. Fill in the fields that require user input as configured in the previous step, ensuring each value is entered in the same row as its corresponding dataset name.

Delete a dataset

To delete a dataset, hover over the dataset you want to remove. An icon will appear. Click on this icon and select Delete.

2.7 - Results

Overview

The Results module provides a centralized view of test execution results, allowing you to track real-time progress or review metrics for completed tests. It displays detailed information about the executed scenarios and steps, along with visual summaries like pie charts. There are two tabs in the Results module: Summary and Results.

The header section provides a quick and high-level overview of the test execution with the following details:

Field Description
Execution status Indicates the current state of the execution. The possible values are Completed, In Progress, Warning, and Failed.
Run Number Unique identifier of the test execution run.
Test Flow Name of the test flow being executed.
Run By User who initiated the test execution.
Started At Date and time when the test flow execution began.
Ended At

Date and time when the test flow execution was completed.

If the execution is still in progress, this field is empty.

Duration

Total time elapsed during the test flow execution.

If the execution is still in progress, this field is empty.

Test Datasets

Number of datasets used during the test execution.

If the execution is still in progress, this field is empty.

Scenarios

Total number of scenarios executed within the test flow.

If the execution is still in progress, this field is empty.

Steps

Total number of steps executed within the test flow.

If the execution is still in progress, this field is empty.

Passed Percentage

Percentage of scenarios that successfully passed.

If the execution is still in progress, this field is empty.

Download Summary Downloads the Results summary in pdf format.

Summary

The summary tab displays the Total Datasets, Error Categorization, Duration, Pass Rate Over Time, and Test Flow Average Execution per Test Run.

Total Datasets

The Total Datasets pie chart provides a quick visual representation of how many datasets passed, failed, are in warning status, or are still running.

Error Categorization

The Error Categorization pie chart provides a quick visual representation of how the errors are categorized.

Duration

The Duration chart provides a quick visual representation of how long the test was executed.

Pass Rate Over Time

The Pass Rate Over Time chart provides a quick visual representation of how the success rate of tests changes throughout the test runs.

Test Flow Average Execution Time per Test Run

The Test Flow Average Execution Time per Test Run chart provides a quick visual representation of how long the test runs and the average each test run takes to complete.

Results

The results tab displays information about the scenarios and steps. Its details, assertions, payloads, and attachments. It also highlights the Overall Scenario Summary, Scenario Step Types Distribution, and Scenario Step Status Distribution.

Scenarios and steps

The dashboard highlights the details of the executed test scenarios and their individual steps. The left pane provides a hierarchical view of the test flow, broken down into its constituent scenarios. Each scenario is further expanded to display the steps within it, allowing users to examine the execution status, duration, and other relevant metrics for each step.

Details

The Details tab displays the following information:

Field Description
Step Name Name of the selected step.
Step Type Type of the selected step.
Start time Date and time when the test step execution began.
End time Date and time when the test step execution was completed.
Duration Total time elapsed during the test step execution.
Assertion status distribution Pie chart that provides the status distribution of the assertions.
Step Started Displays the step status, date and time the step execution began, and the query if available.
Step Failed Displays the step status, date and time the step execution began, payloads, and the query if available.
Step Completed Displays the step status, date and time the step execution began, and the payloads.

Assertions

The Assertions tab displays a detailed list of all the field names specified for validation within the selected test step. For each field, the expected value, the actual value, and the operator are displayed in a tabular form.

When the expected and actual values are the same, meaning the validation passed, the row is highlighted in green. Otherwise, the row will be red.

Payloads

If the step type is API, the Payloads tab provides access to the request and response payloads associated with the selected step. This tab allows you to review the details of the data exchanged during the execution. Additionally, you can search for specific nodes by entering a keyword or the full parameter in the search text box.

Attachments

The Attachments tab displays all files utilized during the test step execution. This includes any relevant documents, logs, or additional files uploaded for reference during the test.

Overall Scenario Summary

The Overall Scenario Summary offers a high-level overview of the scenario to which the selected step belongs.

Field Description
Scenario name Name of the scenario to which the selected step belongs.
Environment Environment where the test scenario was executed.
Started at Date and time when the test scenario execution began.
Ended at Date and time when the test scenario execution was completed.
Passed steps Percentage of the passed steps within the scenario.

Scenario Step Types Distribution

The Scenario Step Types Distribution pie chart shows the proportion of different step types within the selected scenario, such as API, UI, or database steps.

Scenario Step Status Distribution

The Scenario Step Status Distribution pie chart provides a quick visual representation of how many steps passed, failed, or are still running.

2.8 - Settings

Overview

The Settings module enables you to configure integrations available in the tool. To configure an integration, click on any integration card and follow the displayed steps.

TestRail

TestRail is a web-based test management tool used to organize and manage test cases, plans, and test runs. Our TA Tool now supports seamless integration with TestRail, allowing users to synchronize and manage test artifacts efficiently. If you already have a TestRail account, proceed to Pre-configure TestRail. Otherwise, create a TestRail account in TestRail.

To configure integrations in projects, see Configure project integrations.

To synchronize integrations in test flows and test runs, see Sync to TestRail.

Prerequisites

You need to do the following to configure and integrate TestRail:

Pre-configure TestRail

To configure TestRail, follow these steps:

  1. After clicking the TestRail card, follow the instructions in the TestRail Pre-Configurations Steps.
  1. Click Next.

Generate an API Key

  1. Login to your TestRail account.

  2. Click on your profile icon.

  3. Click My Settings link.

  4. Navigate to the API tab.

  5. Click Add key.

  6. Enter a valid name for the key.

  7. Click Generate Key.

  8. Copy and paste the generated key to a secure file.

  9. Click Add Key.

  10. Click Save Configuration.

Get Base URL

To get the base URL, follow these steps:

  1. Open TestRail and log in.
  2. Copy the URL.
  3. Store the URL securely.

Enable TestRail integration

To integrate TestRail, follow these steps:

  1. Paste the base URL in the Base URL field.

  2. Paste the API key from the TestRail pre-configurations in the API Key field.

  3. Enter the email you use when logging into TestRail in the User Name field.


  1. Click Submit.

  2. Click the toggle to activate the integration.

JIRA

To configure integrations in projects, see Configure project integrations.

To link issues in test flows, see Issue Tracking.

Enable JIRA integration

To integrate JIRA, follow these steps:

  1. After clicking the JIRA card, follow the instructions in the Preconfigure your JIRA Instance.
  1. Click Next.

  2. Enter valid values in the madatory fields in the Configure Test Assistant.

  1. Click Submit.

  2. A popup window requesting access to your Atlassian account is displayed. Click Accept.

An Authorization Successful message is displayed.

2.9 - Test Suite

Overview

The Test Suite module enables you to organize, manage, and execute multiple test flows within a specific version. It also allows you to associate datasets, configure test environments and databases, and control how and when tests are run.

By grouping related flows into a single suite, you can streamline regression testing, ensure consistent execution settings, and automate scheduled runs.

Create a test suite

To create a test suite, follow these steps:

  1. Click the + button beside the Search textbox.
  2. Enter a valid value to the Test Suite Name textbox. The Test Suite Code field is automatically filled with a system-generated code based on the entered test suite name.
  1. Select the version from the Version dropdown.
  1. Click the Save button.

Add a flow

To add a flow to the test suite, follow these steps:

  1. Click the + button in the Test Flow Configurations section.
  1. Search the flow you wish to add from the Test Flow field. Note that only the flows associated with the selected version will be displayed.
  1. Select a dataset or multiple datasets from the Dataset field. Note that only the datasets associated with the selected version will be displayed.
  1. Configure the environments and databases of the listed scenarios.
  1. Click the Save button.

Schedule a run

To configure the schedule of the test suite run, follow these steps:

  1. Click the dropdown arrow beside the Run button.
  1. Select Schedule Run.

  2. Enter valid values in the following fields.

Field Description
Starts on > Date Date when the scheduled run will begin.
Starts on > Time Time when the run will start on the selected date.
Ends on > Date Date when the scheduled run will stop recurring. No runs will be triggered after this date.
Repeat Specifies the recurrence pattern for the schedule.
Repeat every Specifies the interval for the selected recurrence pattern.
  1. Click the Schedule button to save the configured schedule. To cancel, click the Cancel button.

Edit a test suite

To edit a test suite, select a test suite and make the necessary changes. Click the Save button once done.

Edit a run schedule

To edit a schedule, click the Edit link in the test suite view.

Then, make the necessary changes and click the Schedule button.

Edit flow order

The execution order of flows can be modified by dragging and dropping a flow to the desired position within the sequence.

Edit a test flow

To edit the dataset, you can untick the currently selected dataset in a flow and choose from other associated datasets by clicking the search field in the Dataset section.

You can also modify the environment and dataset by selecting your preferred options from the corresponding dropdown lists.

The search feature allows you to filter the list of datasets by providing a keyword or the full name of a dataset. Only the datasets that match the provided keyword or name will be displayed in the view.

Filter

Click the icon to display additional filtering and sorting options. For filtering, a dropdown list of available filter parameters will show all associated values for the selected project and version.

Delete a test suite

To delete a test suite, click the menu option and select Delete.

Then, in the confirmation popup window, click the Delete button.

3 -

What is RIA Test Automation?

RIA Test Automation is a versatile software testing solution developed by RIA Advisory to streamline and enhance the testing process for enterprise applications. Initially created to address the challenges of efficient regression testing in internal projects, it has now grown into a robust tool that can adapt to any enterprise system, providing complete end-to-end testing capabilities.

This tool especially supports various Oracle products, including Oracle Revenue Management and Billing (ORMB), Customer-to-Meter (C2M), Utilities Customer Cloud Service (CCS), and Meter Data Management (MDM). However, its flexible architecture allows for seamless integration across diverse business applications. Test Automation facilitates thorough testing across APIs, batch processes, and user interface interactions, enabling you to deliver quality software while minimizing the effort and costs involved in the testing process.

Learn more about the Test Automation

ArchitectureProvides an overview of the TA structure.architecture.md
DashboardMonitor your testing configuration and processes.dashboard.md
ProjectCreate your own testing workspace.project
StepDefine the steps within a project.step.md
AssertionDefine assertions within a project.assertion.md
FlowManage test flows within projects.flow
DatasetManage your test data.dataset.md
ResultsView the results of executed scenarios.results.md