Sage X3 Automated Test Platform - Client installer

This implementation guide covers the installation and setup required to take advantage of the Sage X3 Automated Test Platform library.

Screenshots may be noticeably different depending on your product version and/or configuration.

Audience

This document is for customers and partners that wish to use the Sage X3 Automated Test Platform library on their local machine.

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.

What’s new

Sage X3 Automated Test Platform version 2.8.0: New installation and update process.

Sage X3 Automated Test Platform version 2.9.0:

Consult the Sage X3 Automated Test Platform - User guide for further information.

Sage X3 Automated Test Platform version 3.0.0:

  • Nodejs12 is required for installation or update of Sage X3 Automated Test Platform 2.X.X

  • Nodejs18. is required for installation or update of Sage X3 Automated Test Platform 3.X.X

    • To define the right version of Nodejs, refers to the following documentation: prerequisites_atp

Sage X3 Automated Test Platform 3.1.1:

  • Ensure compatibility with latest version of Nodejs 18 delivered to date.

    • Refer to the prerequisites_atp online documentation for more information. about Nodejs compatibility with Sage X3 Automated Test Platform 3.1.0

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

  • New steps have been added to allow changing nexus credentials during update process when they are not valid anymore.

    • Prior to update

    • for versions prior to 3.2.0, make sure you have executed sagex3atp-reset-credentials.bat delivered in the atp-3.1.0.x-win zip file (03-NexusCredentials folder). For versions 3.2.0 and above, the credentials updates are managed directly by the update process.

    • for security reason, password has changed and need to be updated prior to update.

    • for more information, see ATP_3.1.0.x_ENG.htm or ATP_3.1.0.x_FRA.htm file delivered with atp-3.1.0.x-win zip file.

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

  • Is compatible with version 17 of Java Runtime Environment (JRE). Refer to the prerequisites_atp documentation for more information about the Java Runtime Environment (JRE) compatibility.

Find out more

Refer to the following guides:

Sage X3 Automated Test Platform - User guide

Sage X3 Automated Test Platform - Jenkins installation and setup

Sage X3 Automated Test Platform - Step definitions guide

Before you start

Ensure that your configuration is compatible with the recommendations described below.

Prerequisites

System requirements

The minimal system specifications required to install the Sage X3 Automated Test Platform library are listed in the table below.

Category Minimum configuration recommendations
Operating system

Windows 10, 64 bit (version 1803 or higher),

Windows 11, 64 bit (version 22H2 or higher) compatible from Sage X3 Automated Test Platform version 3.0.0 or higher
Disk SSD (Solid State Drive)
Memory 8 GB (16 GB recommended)
Processor CPU (Intel® core 17, 2.4 GHZ or higher)

Required software

The following software is required for the Sage X3 Automated Test Platform library to be able to run:

  • Web browser: Chrome version 89 or higher

  • Azul Zulu or Oracle Java

    Download and install one of the following Java Runtime Environments (JRE):

    • Refer to the prerequisites_atp documentation for more information about the Java Runtime Environment (JRE)

Prior to installing Java and Google Chrome, please refer to the chapter Part 1: Verify the software prerequisites.

Sage X3 Automated Test Library version management

Sage X3 Automated Test Library version is managed with three M.m.P digits (sometimes with four M.m.P.b digits):
  • M = Major
  • m= minor
  • P= Patch
  • b = build

In some cases, the zip folder delivered to install or update Sage X3 Automated Test Library can have four digits. This happens when a fix is released for one of the files contained in the atp-M.m.P-win zip file. The content of the library delivered in the Nexus repository (repository used to install or update the library) remains the same.

For a zip named atp-M.m.P-win or atp-M.m.P.b-win, if you install Sage X3 Automated Test Platform, the corresponding version of the library installed will be M.m.P. You can find this version in the package.json file after installing SageX3 Automated Test Platform.

When do you need to update Sage X3 Automated Test Platform?

  • You can update Sage X3 Automated Test Platform when a new M.m.P version is released.

    If you want to update the Sage X3 Automated Test Platform library, refer to the Updating to a new version chapter.

  • When a new zip is released with an M.m.P.b version, it means that either the setup wizard installer file (file to install the Sage X3 Automated Test Platform library) or the ATP-TemplateRunAutomatedTests.xml file (file to install or update the Jenkins pipeline) has been fixed.

    If you want to update the Jenkins pipeline, refer to the Updating your ATP-RunAutomatedTests Pipeline documentation.

Additional requirements

An internet connection is required to be able to download and install the Sage X3 Automated Test Platform library.