Documentation Index

Fetch the complete documentation index at: https://docs.unqork.io/llms.txt

Use this file to discover all available pages before exploring further.

Testing Tool Dashboards

Prev Next

The Testing Tool organizes test data across three sequential dashboards. Each level drills into the next:

  1. Workspace Dashboard: A high-level view of test health across all applications in a workspace.
  2. App Dashboard: Test metrics and module details for a specific application.
  3. Module Dashboard: Individual API and component test results for a specific module.

Test Metrics

Each dashboard displays the following metrics, scoped to the current level (workspace, application, or module). Metrics update in real-time as tests are added, edited, or removed.

Metric Description
API Coverage The percentage of API modules that have tests at this level.
API Success Rate The percentage of successful API tests at this level.
Component Coverage The percentage of module components that have tests at this level.
Component Success Rate The percentage of successful component tests at this level.

Workspace Dashboard

The Workspace Dashboard is the entry point for the Testing Tool. Use this dashboard to monitor high-level testing health and identify applications that require attention.

Selecting a Workspace

Use the Workspace drop-down to select a workspace in the environment. After selecting one, the dashboard populates with API module test coverage and success rates, component test coverage and success rates, and available filters.

Workspace drop-down menu showing available workspaces and the dashboard populating with test coverage and success rate data after selection. Workspace test metrics showing API Coverage, API Success Rate, Component Coverage, and Component Success Rate percentages.

Workspace Dashboard Filters

The Workspace Dashboard lists all applications in the workspace. Use the available filters to identify applications missing test configurations, sort by test success rate, and filter by coverage percentages.

Workspace Dashboard filters panel showing options for Application, Result (Pass, Fail, N/A), and Sort By fields.
Setting Description
Application Use this drop-down to select a specific application in the workspace. Multiple applications can be selected.
Result Finds all applications with passed, failed, or no tests.
Pass When checked, displays all applications with a 100% API Success Rate.
Fail When checked, displays all applications with an API Success Rate less than 100%.
N/A When checked, displays all applications without tests.
Sort By Sorts the Applications table by App Name, API Coverage, API Success Rate, Component Coverage, Component Success Rate, or Result.
App Name Organizes the Applications table alphabetically in ascending (A-Z) order.
API Coverage Organizes by API test coverage. Applications with the highest percentage of API modules tested appear at the top.
API Success Rate Organizes by API Success Rate. From top to bottom: applications with successful tests (100%), applications with failed tests (less than 100%), and applications without tests.
Component Coverage Organizes by Component Coverage. Applications with the highest percentage of components tested appear at the top.
Component Success Rate Organizes by Component Success Rate. From top to bottom: applications with successful tests (100%), applications with failed tests (less than 100%), and applications without tests.
Result Organizes by App Status. From top to bottom: applications with a green Result icon, a red Result icon, and no Result icon. Results are in ascending (A-Z) order by default.
Apply Click to apply the filters.
Reset Filters Click to reset the filters and return the Applications table to its default view.

Applications Table

Below the test metrics, a table displays all workspace applications.

Attribute Description
App Name The application name.
API Coverage The percentage of all application API modules that have tests. The calculation is the number of tested modules compared to the total number of modules.
API Success Rate The percentage of successful API tests. The calculation is the number of successful tests compared to the total number of tests.
Component Coverage The percentage of all module components that have tests. The calculation is the number of tested components compared to the total number of testable components in the module.
Component Success Rate The percentage of successful component tests. The calculation is the number of successful tests compared to the total number of tests.
Result A green icon displays when the API Success Rate is 100%. A red icon displays for rates below 100%.
View App Tests Click to open that application in the App Dashboard.

Hover over any percentage to see how it calculates.

From top to bottom, the table has the following organization:

  • Applications with successful tests (100% Success Rate).
  • Applications with failed tests (Success Rate less than 100%).
  • Applications with no tests.

By default, the table displays ten entries. Click the pagination buttons below the table to see more entries.

App Dashboard

Click View App Tests from the Workspace Dashboard to open the App Dashboard for a specific application.

To view the application in the Unqork Designer Platform, click View App in Workspace in the top-right corner.

Animated demonstration of selecting a workspace, finding an application, and clicking View App Tests to open the Testing App Dashboard. Testing App Dashboard test metrics section showing API Coverage, API Success Rate, Component Coverage, and Component Success Rate percentages.

App Dashboard Filters

Use these filters to find specific modules in the application.

Filter Description
Module Use this drop-down to select a specific module in the application. Multiple modules can be selected.
Module Type Finds specific types of modules. Options include API and Other.
API When checked, displays only API modules in the application.
Other When checked, displays all non-API modules in the application.
Result Finds all modules with passed, failed, or no tests.
Pass When checked, displays all modules with a 100% API Success Rate.
Fail When checked, displays all modules with an API Success Rate less than 100%.
N/A When checked, displays all modules without tests.
Sort By Sorts the Modules table by Module Name, Result, Success Rate, Test Coverage, or Total Tests.
Module Organizes the Modules table in ascending (A-Z) order by module name.
API Coverage Organizes by API test coverage. API modules with tests display at the top. With API modules, API Coverage is either 100% or 0%.
API Success Rate Organizes by API Success Rate. From top to bottom: API modules with successful tests (100%), API modules with failed tests (less than 100%), and modules that are not API modules.
Component Coverage Organizes by Component Coverage. Modules with the highest percentage of components tested appear at the top.
Component Success Rate Organizes by Component Success Rate. From top to bottom: modules with successful tests (100%), modules with failed tests (less than 100%), and modules without tests.
Result Organizes by Result. From top to bottom: modules with a green Result icon, a red Result icon, and no Result icon. Results are in ascending (A-Z) order by module name.
Apply Click to apply the filters.
Reset Filters Click to reset the filters and return the Modules table to its default view.
Testing App Dashboard filters panel showing Module, Module Type, Result, and Sort By filter options above the Modules table.

Modules Table

Below the test metrics, a table displays all application modules. If API displays next to the module name, it is an API module.

Attribute Description
Module The module name. API indicates it is an API module.
API Coverage The percentage of all application API modules that have tests. The calculation is the number of tested modules compared to the total number of modules.
API Success Rate The percentage of successful API tests. The calculation is the number of successful tests compared to the total number of tests.
Component Coverage The percentage of all module components that have tests. The calculation is the number of tested components compared to the total number of testable components in the module.
Component Success Rate The percentage of successful component tests. The calculation is the number of successful tests compared to the total number of tests.
Result A green icon displays when the API Success Rate is 100%. A red icon displays for rates below 100%.
View Module Tests Click to open that module in the Module Dashboard.

Hover over any percentage to see how it calculates.

From top to bottom, the table has the following organization:

  • Modules with successful tests (100% API Success Rate).
  • Modules with failed tests (API Success Rate less than 100%).
  • Modules with no tests.

By default, the table displays 10 entries. Click the pagination buttons below the table to see more entries.

Module Dashboard

Click View Module Tests from the App Dashboard to open the Module Dashboard for a specific module.

To view the module in the Module Builder, click View Module in Designer at the top-right of the dashboard.

From the Module Dashboard, the following actions are available:

  • View the module in the Module Builder.
  • Manually execute all API tests in the module.
  • Create an API test.

As long as the Testing workflow in the environment is running, tests execute automatically on module save. To learn more about enabling the Testing workflow, see Testing Tool Overview.

The Tests table displays all API and component tests for the module. If the module contains both test types, use the API Tests and Components tabs to filter.

API Tests and Components tabs on the Testing Module Dashboard.

For API tests, the following attributes display:

Attribute Description
Created The date and time the test was created.
Test Name The test's name at creation.
Test Type The test type. Options include Execution Sequence (checks whether all components trigger in the correct order), Match Response (compares the expected API response against the actual API response), and Validate Fields (validates a data field against specific criteria).
Result A green icon displays when the Test Success Rate is 100%. A red icon displays for rates below 100%.
View API Test Click to view the test's details.

For component tests, the following attributes display:

Attribute Description
Component key The Property ID of the component with the test.
Type The logic component type: for example, Calculator, Decisions, or Data Workflow.
Total Tests The total number of tests for that component.
Success Rate Successful tests have a 100% success rate. Failed tests have a Success Rate less than 100%. Components with no tests display no Success Rate.
View Component Tests Click to view the component test's details.

By default, the table displays ten entries. Click the pagination buttons below the table to view more.

Module Dashboard Filters

Different filter options are available depending on the type of test. If the module only has one type of test, tabs do not display.

API Test Filters

Click the API Tests tab to display only API tests.

API Tests tab selected in the Testing Module Dashboard filter panel.
Filter Description
Test Type Options include Execution Sequence, Match Response, and Validate Fields.
Result Finds all tests that passed, failed, or are inactive.
Pass When checked, displays all tests with a 100% Test Success Rate.
Fail When checked, displays all tests with a Test Success Rate less than 100%.
N/A When checked, displays all inactive tests.
Status Shows only active or inactive tests.
Active When checked, displays only active tests. Active tests are available to run.
Inactive When checked, displays only inactive tests. Inactive tests are disabled and cannot run.
Sort By Sorts the Tests table by Created, Result, Test Name, or Test Type.
Created Organizes by creation date and time. The most recent test displays at the top.
Result Organizes by Result. From top to bottom: tests with a green icon (passed), tests with a red icon (failed). Results are in ascending (A-Z) order by Test Name by default.
Test Name Organizes in ascending (A-Z) order by Test Name.
Test Type Organizes in ascending (A-Z) order by Test Type.
Apply Filter Click to apply the filters.
Reset Filter Click to reset the filters and return the Tests table to its defaults.

Component Test Filters

Click the Components tab to display only component tests.

Filter Description
Component Type Use this drop-down to select a logic component type. Options include Calculator, Decisions, and Data Workflow.
Sort By Sorts the Tests table by Component Key, Type, Total Tests, or Success Rate.
Component Key Organizes in ascending (A-Z) order by component Property ID.
Type Organizes in ascending (A-Z) order by component type.
Total Tests Organizes by total number of tests. Components with the most tests display at the top.
Success Rate Organizes by Success Rate. From top to bottom: successful tests (100%), failed tests (less than 100%), and components with no tests.
Apply Filter Click to apply the filters.
Reset Filter Click to reset the filters and return the Tests table to its defaults.

Viewing Test Details

API Test Details

After locating a test, click View API Test. The API Test Details page includes the following actions:

Action Description
Execute Test Click to execute the test manually. A dialog displays confirming whether the test passed or failed.
View Module in Designer Click to open the tested API module in the Module Builder.
Edit Test Click to edit the test. Options include changing the Test Name, changing the API request, adding or editing assertion tests, and setting the test to inactive.
Delete Test Click to delete the test.

Below these actions, three tabs display: Details, Result, and Service Logs.

Details tab

The Details tab includes the following information for all API request tests:

Attribute Description
Test Name The name of the test.
Test Type The API test type: Execution Sequence, Match Response, or Validate Fields.
Created The date and time the test was created.
Creator The Creator who created the test.
Active Whether the test is active or inactive: Active: Yes or Active: No.
Module ID The module ID of the module where the test exists.
Submission ID The submission ID of the submission tested.

Additional information displays based on the test type:

Test Type Additional Details
Execution Sequence Request: the tested API request. Event Log: the full sequence of the API call, including components, events, and steps at which events occur.
Match Response Request: the tested API request. Expected Response: the expected API response for the API module.
Validate Fields Request: the tested API request. Assertion Test: the tested data field and its criteria.
Details tab for an Execution Sequence test showing request and event log.

Result tab

The Result tab displays whether the test passed or failed, the executed API response, and the execution sequence of the API call. An Event Log displays the components and their events at each step. For Validate Fields tests, a table of assertion tests and their pass or fail results also displays.

Result tab for a failed Validate Fields test showing assertion results.

Service Logs tab

Every time an API call executes, the system creates a service log. The Service Logs tab displays the logs for the most recent test execution.

Attribute Description
URL The URL for the tested API call.
Service Log ID The generated identifier when the API request executes.
Response Code - Text The response code for the API call. For example, a successful call returns 200 - OK.
Duration (ms) The time the API call took to finish, measured in milliseconds.
Request Time The timestamp when the API call started.
Response Time The timestamp when the API call finished.
View Service Logs Dashboard Link Click to view this API module's service logs.

To learn more about the Service Logs Dashboard, see Service Logs Dashboard.

Service Logs tab for an Execution Sequence test showing URL, response code, and duration.

Component Test Details

After locating a component test, click View Component Tests. The Component Test Details page includes a link to open the module in the Module Builder.

Attribute Description
Row The row in the component's Testing Harness where the test exists. The first row is 0.
Inputs The component's test inputs.
Outputs The component's test outputs.
Result The test status: Pass (the test performed correctly) or Fail (the test performed incorrectly).
View Details Click to open a dialog displaying the expected and actual outputs. Useful for diagnosing failed tests.
View Details dialog showing expected and actual outputs for a failed component test.

Click Go to Module Builder to open that module. Click X to close the dialog and return to the Component Tests page.

Changelog

Date Change
2026-07-21 Sweep — fixed modal → dialog (3 occurrences including alt text).
2026-07-17 Combined Workspace Dashboard, App Dashboard, and Module Dashboard into a single reference article. Consolidated the shared test metrics table and navigation boilerplate.