To use the OpenEdge DevOps Framework (OEDF) Gradle plugin, ensure that you have the following:
  • Certified Progress OpenEdge® 12.2 or later.
  • OpenEdge ABL installed (version 12.2 or later).
  • Gradle 9.3.1.
  • JDK 17 or later.
    Note: Running OEDF 2.4 with Gradle 9.3.1 on JDK 11 is not supported because Gradle 9.x.y requires JDK 17 or later.
  • OEDF is supported on AIX, Linux, and Windows, which is consistent with the platforms supported by OpenEdge 12.2.x and later versions. Oracle ended Java support for Solaris with JDK 15. Since OEDF 2.4 requires JDK 17 or later, it does not run on Solaris. For Solaris environments, you can continue using OEDF 2.3.
  • PCT (Progress Compile Tool):

    • By default, the plugin uses the PCT version available in your OpenEdge installation (for example, the DLC directory), or the default PCT available in your environment.

    • Optionally, you can use a different PCT version by setting the PCT_VERSION property using:

      • A system property
      • A Gradle property
      • An environment variable
  • An ABL project
  • A basic understanding of Gradle

Set up the environment

OpenEdge provides the progradle.bat script to simplify the OpenEdge DevOps Framework (OEDF) setup on your machine. This script prepares the environment required to run the Gradle builds that use the OEDF plugins.

When you execute the progradle.bat script, the following actions are performed in the background:
  • The specified Gradle version is automatically installed when you run the script for the first time.

    To determine the supported Gradle version for your OpenEdge and OEDF versions, use the following OpenEdge + OEDF → Gradle compatibility matrix, and then update the distributionUrl property in the $DLC\gradle\wrapper-scripts\gradle\wrapper\gradle-wrapper.properties file.

    OpenEdge + OEDF → Gradle compatibility
    OpenEdge version OEDF 1.x OEDF 2.0-2.2 OEDF 2.3.0 OEDF 2.4.x
    OpenEdge 12.2 Gradle 5.6.x Gradle 7.3.3 Gradle 7.6.x or 8.2.x Gradle 9.3.x (requires JDK 17 for Gradle run-time)
    OpenEdge 12.8 Gradle 5.6.x Gradle 7.3.3 Gradle 7.6.x or 8.2.x Gradle 9.3.x
    OpenEdge 13.0 Gradle 5.6.x Gradle 7.3.3 Gradle 7.6.x or 8.2.x Gradle 9.3.x
  • The OpenEdge JDK is automatically configured for running the Gradle build scripts.

As an alternative, you can install and configure the supported versions of Gradle and Java separately. For more information, see the OpenEdge Platform and Product Availability Guide for each OpenEdge release.

OEDF 2.4 uses Gradle 9.3.1. However, ProGradle continues to use the Gradle Wrapper configuration located at:
%DLC%\gradle\wrapper-scripts\gradle\wrapper\gradle-wrapper.properties
By default, this Gradle Wrapper configuration file references Gradle 8.2.1:
distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip

Why this update is required

OEDF 2.4 uses Gradle 9.3.1, and ProGradle must align with the same Gradle version. ProGradle reads the Gradle version directly from the gradle-wrapper.properties file. If this file continues to reference 8.2.1, ProGradle will use that version, causing a Gradle version mismatch during builds.

To update the Gradle Wrapper configuration manually, perform the following steps:
Note: Gradle 9.3.1 requires JDK 17 or later to run the Gradle Daemon. When running Gradle 9.3.1 with OpenEdge 12.2.x, ensure that JDK 17 or later is used as the Gradle run-time. This upgrade prevents the build from failing to start due to an unsupported Java run-time.
  1. In a text editor, open the wrapper configuration file from %DLC%\gradle\wrapper-scripts\gradle\wrapper\gradle-wrapper.properties.
  2. Locate the current distributionUrl value and replace it with the updated value.
    Current value:
    distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip
    Updated value:
    distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.1-bin.zip

    This change ensures that ProGradle downloads and uses Gradle 9.3.1.

  3. Verify the Gradle version used by ProGradle by running the following command from proenv:
    "C:\Progress\OpenEdge128\bin\progradle.bat" -v
  4. Run a sample task with logging enabled:
    "C:\Progress\OpenEdge128\bin\progradle.bat" --info helloProGradle

Configure a property

OpenEdge DevOps Framework (OEDF) provides options to configure project builds by setting properties. It supports numerous properties depending on the project requirements. For example, when you set the PCT_VERSION property, it instructs OEDF to use PCT from Apache Maven instead of using it from the OpenEdge installation path.

You can configure a property in any of the following ways:
  1. Set as a system property by running the following CLI command:
    -DPCT_VERSION=<PCT-version>
  2. Set as a Gradle property.

    For example, set PCT_VERSION=<PCT-version> in the gradle.properties file.

  3. Set as an environment variable.

The preferred order of precedence for this property (from highest to lowest) is 1 > 2 > 3.