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

Return to the regular view of this page.

Quickstart Guide

Overview

When using Test Assistant, 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 Assistant:

SpecificationMinimum requirement
CPU2 vCPU
Memory8 GB
Storage50 GB

Prerequisite packages

Test Assistant offers two prerequisite packages — Bundles and Configuration Migration Assistant (CMA). These packages serve as the foundation for Test Assistant to operate. Before installation, you are required to deploy only one of the two packages to ensure the functionality of Test Assistant. 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 Assistant 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
  • Utilities

Use a starter pack

To use a starter pack, follow these steps:

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

Required Test Assistant actions

Batch configurations

You have to set up your batch configurations for batch executions. For more information, see Batch Configurations in Configurations.

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 Create an environment in Environment.

General configuration

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

  1. Verify that all the Prerequisites are met.
  2. Install Test Assistant.
  3. Create an external system.
  4. Create an environment for the created external system in the previous step.
  5. Create a project for the created external system in Step 3.
  6. Create a feature for the created project in the previous step.
  7. Create a service for the created external system in Step 3.
  8. Create a validation service for the created external system in Step 3.
  9. Create a step for the created service in Step 7. Link all applicable validation services.
  10. Create a scenario. Link all applicable steps and validation services.
  11. Create a dataset for the created scenario in the previous step.
  12. Execute a test.
  13. View the run results.

1 - Prerequisite Packages

Overview

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

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 Assistant 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.

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 scenariosAvailable service typeDescription
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.
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.
Create parent-child relationship
  • API
  • UI
Links a child's account to their parent's account.
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
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

Pricing set-up test scenarios

Test scenariosAvailable service typeDescription
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 of the price list for the customer.
  • End date — Specifies when the price list no longer for the customer.
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 of the price list for the customer.
  • End date — Specifies when the price list no longer for the customer.
Assign override pricing at a customer level
  • API
  • UI
Assigns a price list that overrides any existing price list assigned to the customer.
Assign override pricing at an account level
  • API
  • UI
Assigns a price list that overrides any existing price list assigned to an account.

Billing test scenarios

Test scenariosAvailable service typeDescription
Generate bill
  • Batch
  • UI

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 given division and bill cycle for 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.

Payment test scenarios

Test scenariosAvailable service typeDescription
Create payment
  • UI
  • API
Creates a payment for the already generated bill.

General ledger test scenarios

Test scenariosAvailable service 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

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

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.

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.