Sage X3 Automated Test Platform - User guide

Audience

This documentation is aimed for customers and partner who are interested in using the Sage X3 Automated Test Platform library on their local machine. The following document explains how to use the Sage X3 Automated Test Platform library as well as recommendations.

Sage X3 Automated Test Platform is compliant with Sage X3 2024 R1 (12.0.35) release and above.

To use Sage X3 Automated Test Platform library, you must have a Sage X3 license with the Test Robot activation parameter enabled.

Screenshots could be noticeably different depending on your product version and configuration.

What’s new

Sage X3 Automated Test Platform 2.3.0:

New loginUserRootName, loginUserRootPassword, and downloadFolder parameters
Sage X3 session management

Sage X3 Automated Test Platform 2.4.0:

New userStoredValuesFile static parameter to load a file containing user stored values (custom parameters)

Sage X3 Automated Test Platform 2.5.0:

New step definitions to test the visibility of UI components. Consult the Sage X3 Automated Test Platform - Step definitions guide for further information.

Sage X3 Automated Test Platform 2.6.0:

Fixed issues on radio buttons and text fields
Enhanced error messages when forms UI components are selected and could not be found

Sage X3 Automated Test Platform 2.7.0:

New step definitions delivered. Consult the Sage X3 Automated Test Platform - Step definitions guide for further information.
New parameters delivered for the ATP-TemplateRunAutomatedTests Jenkins pipeline. Consult the Sage X3 Automated Test Platform - Jenkins installation and setup documentation for further information.

Sage X3 Automated Test Platform 2.8.0:

New step definitions delivered to take screenshots on demand. Consult the Sage X3 Automated Test Platform - Step definitions guide for further information.
Removed support for Git Bash terminal and replaced it by default with PowerShell terminal.
New installation and update process for Sage X3 Automated Test Platform. Consult the Sage X3 Automated Test Platform - Client installer guide for further information.

Sage X3 Automated Test Platform 2.9.0:

Improved session management. When tests fail:
- Sage X3 or Sage X3 Warehousing sessions opened with Sage X3 Automated Test Platform are removed immediately.
- No record lock remains on Sage X3 or Sage X3 Warehousing.
Text editor step definitions are compliant with the rich text editor using CKEditor 5. Consult the Sage X3 Automated Test Platform - Step definitions guide for further information.

From release 2022 R4 (version 12.0.32), the number of ATP sessions contained in your license is considered the maximum number of concurrent ATP sessions.
The number of sessions is independent of the type of user ATP uses to connect to Sage X3. ATP can use any user available in your Sage X3 license to connect to Sage X3.

Active ATP sessions are deducted from the maximum number of available sessions in your license until they are closed.

Sage X3 Automated Test Platform 3.0.0:

Make Sage X3 Automated Test Platform compliant with Nodejs v18
- Consult to the Sage X3 Automated Test Platform – Client installer guide for further information.
- Consult to the Sage X3 Automated Test Platform – Jenkins guide for further information.
- Consult the prerequisites_atp documentation for more information about Nodejs compatibility.
Improve timeout management by delivering new parameters: timeout, timeoutLocks, timeoutPrints, timeoutWaitfor and timeoutCucumber.
- Those parameters have to be added to your parameters and parameters-cloud-chrome files. (you can copy them from the parameters_template and parameters-cloud-chrome_templates files after updating to version Sage X3 Automated Test Platform version 3.0.0.
- For more information refers to:
  - Setting up your parameters
  - Running simultaneous tests in VS Code chapter.
New step definitions delivered or refactored. Consult the Sage X3 Automated Test Platform - Step definitions guide for further information.

Parallel execution of tests: refer to Executing tests in parallel chapter for explanations & recommendations.
Print allure in pdf format: for more information refer to
- Setting up Allure pdf functionality
- Printing allure report in pdf format.

Fix security vulnerabilities.

Sage X3 Automated Test Platform 3.1.1:

Ensure compatibility with latest version of Nodejs 18 delivered to date.
- Refer to the prerequisites_atp documentation for more information about Nodejs compatibility with Sage X3 Automated Test Platform 3.1.0
Improvements have been made to ensure Sage X3 Automated Test session management is activated prior to enter Sage X3 function or entity.
Update of the Third-party components to beneficiate from the latest capabilities and fixes. Consult Sage X3 Automated Test Platform - Third-party components for more information.
Bugs fix for the following components (header dropdown, data table row action (toolbox))
Security vulnerabilities fix.
Fix issue when using Chrome version 127 to prevent search engine screen from being displayed when running tests.

Sage X3 Automated Test Platform 3.2.1:

Is compatible with Node.js 18. Refer to the prerequisites_atp documentation for more information about Node.js compatibility.
Uses WebdriverIO v8.
Allows for testing the state visibility of standalone fields such as text or date fields that are displayed or hidden programmatically.
Adds the capability to test the Extensibility framework and:
- To execute GraphQL queries and mutations.
- To verify GraphQL response results partially or entirely.
- To attach GraphQL 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) in the Extensibility framework documentation.
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 steps 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.
New parameters
- You need to copy the HEADLESS parameter in your parameters file and parameters-cloud-chrome file (if not yet existing) and set the value to false. Otherwise, tests executing in debug mode won’t display the browser.
- You need to copy the BrowserLanguage parameter in your parameters and parameters-cloud-chrome files and set it to your language ISO code if you don't want the browser's language to default to en-US.
Fix issue when using Chrome version 127 to prevent search engine screen from being displayed when running tests.

Sage X3 Automated Test Platform 3.3.0:

Is compatible with Node.js 18. Refer to the prerequisites_atp documentation for more information about Node.js compatibility.
Delivers step definitions to control XML files content and test E-Invoice / E-Credit-note conformance.
Delivers step definitions to interact with quick filter in Sage X3 header dropdown to filter Syracuse data table.
Display (user) stored value as attachments into allure report.
Display static parameters value as attachments into allure report.
Supports Java 17: Refer to the prerequisites_atp documentation for more information about Java runtime Environment compatibility
Delivers new parameter logTechnicalDetails to display or not technical information while executing the tests.
Improve usability by displaying the step definitions progress when executing the tests.