Sage X3 Automated Test Platform - Jenkins installation and setup

This implementation guide covers the installation and setup required to take advantage of Jenkins. Jenkins is an open source automation server which can be used to automate the testing of Sage X3. This guide explains how to install and setup Jenkins and how to use the Sage X3 Automated Test Platform library with Jenkins.

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

Audience

This document is for customers and partners that wish to use the Sage X3 Automated Test Platform library with Jenkins.

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

  • A Jenkins pipeline for executing your automated tests.

  • Sage X3 Automated Test 2.2.0: Deliver ATP-TemplateRunAutomatedTests Jenkins pipeline template to execute your automated tests.

  • Sage X3 Automated Test 2.3.0: ATP-TemplateRunAutomatedTests Jenkins pipeline template updated with the new loginUserRootName, loginUserRootPassword, and downloadFolder parameters.

  • Sage X3 Automated Test 2.4.0: ATP-TemplateRunAutomatedTests Jenkins pipeline template updated with the new userStoredValuesFile parameter.

  • Sage X3 Automated Test 2.7.0: ATP-TemplateRunAutomatedTests Jenkins pipeline template updated with the new JENKINS_NODE and UpdateATPX3 parameters. It is mandatory to update your Jenkins pipeline.

Follow this procedure to update your ATP-RunAutomatedTests pipeline.

Sage X3 Automated Test Platform 3.0.0:

ATP-TemplateRunAutomatedTests Jenkins pipeline template updated to control version of Nodejs according to version of Sage X3 Automated Test Platform.

  • 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, refer to the prerequisites_atp documentation.

  • Sage X3 Automated Test 3.0.0: ATP-TemplateRunAutomatedTests Jenkins pipeline template updated with new timeout, timeoutLocks, timeoutPrints, timeoutWaitfor, and timeoutCucumber parameters to setup specific timeout, and allurePDFPrint, allurePDFName, and allurePDFPath parameters to generate allure report in pdf.

From 2025 R1 this version can't be installed anymore. You have to use a more recent version of Sage X3 Automated Test Platform compliant with your Sage X3/Sage Warehousing product.

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

  • Prior to update

    • make sure you have executed sagex3atp-reset-credentials.bat delivered in the atp-3.1.0.x-win zip file (03-NexusCredentials folder).

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

From 2025 R1 this version can't be installed anymore. You have to use a more recent version of Sage X3 Automated Test Platform compliant with your Sage X3/Sage Warehousing product.

Sage X3 Automated Test Platform 3.2.2:

  • From version 2025 R1, this version replaces previous version of Sage X3 Automated Test Platform3.2.0 / 3.2.1

    • A new atp Jenkins installer is delivered, allowing to Install or update ATP Library on your Jenkins pipeline without requiring a connection to Nexus repository.

    • Nodejs binary is delivered with ATP Library and doesn’t need to be installed anymore as a windows program on your Jenkins server.

    • This new installer allows you to install the required version of Sage X3 Automated Test Platform, offering flexibility if you need to execute different ATP pipelines using different versions of ATP for different versions of Sage X3 / Warehousing environments.

    • To know which version of Nodejs is delivered with Sage X3 Automated Test platform, refer to the prerequisites_atp documentation

  • ATP-TemplateRunAutomatedTests Jenkins pipeline template has been updated with new browserLanguage and ATPInstallerPath parameters.

  • ATP-TemplateRunAutomatedTests Jenkins pipeline template has been refactored to use Password Parameter type in order to conceal both loginPassword and loginUserRootPassword parameters.

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

  • From version 2025 R1, this version replaces previous version of Sage X3 Automated Test Platform 3.3.0

    • A new Jenkins installer is delivered, allowing to Install or update ATP Library on your Jenkins pipeline without requiring a connection to Nexus repository.

    • Nodejs binary is delivered wtih ATP Library and doesn’t need to be installed anymore as a windows program on your Jenkins server.

    • This new installer allows you to install the required version of Sage X3 Automated Test Platform, offering flexibility if you need to execute different ATP pipelines using different versions of ATP for different versions of Sage X3 / Warehousing environments.

    • To know which version of Nodejs is delivered with Sage X3 Automated Test Platform, refer to the prerequisites_atp documentation.

  • The ATP-TemplateRunAutomatedTests Jenkins pipeline template has been updated with the new logTechnicalDetails and ATPInstallerPath parameters.

Sage X3 Automated Test Platform 4.0.0:

  • A new Jenkins installer is delivered, allowing to Install / update ATP Library on your Jenkins pipeline without requiring a connection to Nexus repository.

    • Nodejs binary is delivered with ATP Library and doesn’t need to be installed anymore as a windows program on your Jenkins server.

    • This new installer allows you to install the required version of Sage X3 Automated Test Platform, offering flexibility if you need to execute different ATP pipelines using different versions of ATP on different versions of Sage X3 / Warehousing environments.

  • To know which version of Nodejs is delivered with Sage X3 Automated Test platform, refer to the prerequisites_atp documentation.

  • The ATP-TemplateRunAutomatedTests Jenkins pipeline template has been updated with the new ATPInstallerPath parameter.

Minimum version 17 of Java runtime environment (JRE) is required from Jenkins version 2.463 or later.

Refer to the prerequisites_atp documentation for more information about Java runtime Environment (JRE) compatibility.

Follow this procedure to update your ATP-RunAutomatedTests pipeline.

Find out more

Refer to the following guides:

Sage X3 Automated Test Platform - User guide

Sage X3 Automated Test Platform - Client installer guide

Sage X3 Automated Test Platform - Step definitions guide