Sage X3 Automated Test Platform - Step definitions guide

Overview

This document describes the step definitions in the Sage X3 Automated Test Platform library and gives samples for each of them. Examples of code are also provided.

Audience

Customers and partners can use this document as guidance on how to write automated tests with the Sage X3 Automated Test Platform. This document provides a list of the existing step definitions for each graphical component as well as code samples for each.

New step definitions

Sage X3 Automated Test Platform version 2.2.0

• Interact with data table actions (Delete all/CSV/Excel export).

• Interact with the Select all check box in the data table header.

• Control the log that contains a message, a confirmation message, or an error message using both text and a stored value.

• Select a log panel line that contains the required text for the required occurrence.

• Check that a modal dialog is displayed whose title contains both text and a stored value.

• Call a row action that contains both text and a stored value.

Sage X3 Automated Test Platform version 2.3.0

• Generate a dynamic sequence and save it into a stored value.

• Capability to combine both text and stored value in both write and verification modes.

• Change the site depositor (Sage X3 Warehousing).

• Verify the text or background color of a cell.

Sage X3 Automated Test Platform version 2.4.0

• Interact with user stored values.

• Interact with the export function of the right panel.

• Drop-down list enhancement to select an option from the list with an exact match.

Sage X3 Automated Test Platform version 2.5.0

• Capability to check if a field (text field, date field, checkbox) is displayed or hidden.

• Capability to check if a data table column header is displayed or hidden.

• Capability to check if a tab is displayed or hidden.

• Capability to check if a function or entity of the site map is displayed or hidden.

• Capability to check if a left list or left picking list is empty.

Sage X3 Automated Test Platform version 2.7.0

• Capability to verify if a drop-down list value is displayed or hidden.

• Capability to verify if a drop-down list value in a cell is displayed or hidden.

• Capability to interact with the buttons or actions located on the top bar of a data table, left list, hierarchical left list, and picking list such as:

  • Expand and Collapse buttons located on the top left bar of a hierarchical left list, picking list, or hierarchical data table.

  • The Clear filter button located on the top left bar of a left list.

  • Previous, Next, Maximize and Minimize buttons located in the top right bar of a left list, hierarchical left list, and picking list.

  • First, Last, Previous, Next, Page number, Maximize and Minimize buttons located in the top right bar of the data table.

  • Actions located in the top left bar of the data table, such as Excel export.

• Capability to use the First, Last, Previous, and Next icons arrow in the page header.

• Capability to count the number of rows in a data table or a log.

• Refactoring of the step definitions to interact with text field actions in different languages, such as quick selection, Jump to, and other text field actions.

• Refactoring of the step definitions to interact with data table cell action in different languages, such as quick selection and other cell actions.

• Refactoring of the step definitions to expand and collapse hierarchical left lists in different languages.

• Refactoring of the step definitions to expand and collapse picking lists in different languages.

Sage X3 Automated Test Platform version 2.8.0

• Capability to take screenshots on demand.

Sage X3 Automated Test Platform version 2.9.0

• Text editor step definitions are compliant with the rich text editor using CKEditor 5.

Sage X3 Automated Test Platform version 3.0.0

• Capability to run tests in parallel and to lock tests to avoid tests to conflict with each other.

• Capability to select element in hierarchical picking list, using string pattern and combination of multiple (user) stored values and text.

• Capability to navigate to the first or last browser tab opened.

• Refactor step definitions to use the print / export tool in the right panel.

Sage X3 Automated Test Platform version 3.1.1

• Capability to dismiss an alert box.

Sage X3 Automated Test Platform version 3.2.2

• Allows for testing the state visibility of standalone fields such as text or date fields that are displayed or hidden programmatically.

  • Existing step definitions can now be used to test the visibility of fields displayed or hidden programmatically.

• Adds capability to test Sage X3 Extensibility and

  • To execute GraphQL queries and mutations.

  • To verify GraphQL response results partially or entirely.

  • To attach GraphQL actual responses from the queries or mutations returned by Sage X3

  • To generate Allure report PDFs and display GraphQL attachments, such as executed queries and responses returned by Sage X3.

    • Refer to Executing GraphQL queries & mutations (Extensibility)

• Landing page step definitions and language changing step definitions using the More languages panel were refactored to ensure HTML DOM agnosticism in case of later UX changes.

  • The step definition syntax remains the same.

  • Because date -s tags were added to the HTML DOM, the step definitions refactored with Sage X3 Automated Test Platform 3.2.0 are compliant with the Syracuse version delivered with Sage X3 2024 R1 and higher versions.

Sage X3 Automated Test Platform version 3.3.1

• Add capability to control XML files content

• Add capability to test E-invoice / E-Credit-note conformance

• Interact with quick filter in header dropdown section of X3 in order to filter Syracuse data table

• Step definition using stored values and static parameters have been enhanced so the code and the value evaluated during the test execution can be displayed in allure report as attachment.

Sage X3 Automated Test Platform version 4.0.0

• Add capability to read pdf file and control the text content.

• Add capability to choose the operator type when filtering table column header.

• Add capability to control locale / none locale date within a table.

• Add the same capabilities of date calculation as regular date field for date within data table cell.

• Add capability to store XML information from a clob and store it into a stored value. Then capability to parse the XML from the stored value.

• Add capability to use stored values on dropdown list field.

• Add capability to test the state visibility to the table row action.

• Add capability to test if an image is defined or undefined into a data table cell.

• Add capability to set time

Sage X3 Automated Test Platform version 4.1.0

• Delivers new step definitions:

  • Add capability to execute and verify Classic SOAP Web Services.

  • • Add capability to interact with Sage Copilot chatbot and insights (Beta⁽¹⁾).

    • ⁽¹⁾This functionality is delivered in beta version and subjected to change according to the modifications done on Sage X3 or Sage Warehousing side.

  • Add capability to use (user) stored value while executing or controlling GraphQL queries or mutations.

  • Add new interactions for the upload component to control the type of file uploaded.

  • Add new interactions to set a date field using the date calendar component.

• Enhances existing step definitions:

  • Add capability to use (user) stored value or static parameter on alert box.

  • Add capability to use (user) stored value or static parameter on confirmation dialog.

  • Add capability to control screen displayed with (user) stored value.

  • Add capability to use (user) static parameter on password field.

  • Add capability to use (user) stored value for landing page.

Sage X3 Automated Test Platform version 5.0.0

• Delivers new step definitions:

  • Add step definitions to read and control CSV/TXT files content.

  • Add step definitions to load GraphQL variables and headers.

  • Add step definitions to automate SQL Designer component (Graphical Query tool).

  • Extends step definitions to calculate the first last, previous next day of the (month, year, quarter, week) from the current day or from a specific day.

Find out more

Refer the following how to guides for complete information:

Sage X3 Automated Test Platform - User guide

Sage X3 Automated Test Platform - Client installer guide

Sage X3 Automated Test Platform - Jenkins installation and setup

Sage X3 Automated Test Platform - Third-party components