Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Importing custom Java archives and classes

Updated on May 11, 2022

Incorporate third-party Java functionality into Pega Platform™ by importing a Java archive (JAR) file or class.

Standard JAR files typify as database drivers used for external database connections; third-party functions requiring import of a custom JAR file include incorporating IP filtering into your enterprise network, adding a functionality from Snowflake or its partners, or supporting IBM WebSphere Message Queue for inter-application communication in a Java environment.

To incorporate additional functions into your environment, you must perform the following tasks:

  • Set up a custom codeset version.
  • Import a custom JAR or class file.

Each task is described below.

  1. Setting up a custom codeset version.
    1. In the navigation pane of Dev Studio, click RecordsSysAdminDynamic System Settings.
    2. Find the code engine dynamic system setting with the following Setting Purpose:properties/com.pega.pegarules.bootstrap.codeset.version.Customer/default
    3. Open the dynamic system setting.
    4. In the top navigation pane, clickSave Save As.
    5. In the Setting Purpose field, edit Customer to the name of your codeset.
    6. Click Create and Open.
    7. In the Value field, enter 01-01-01 as a codeset version.
    8. Click Save.

      Pega Platform can now check against an existing codeset name and version when importing a customer Java archive or class.

  2. Importing a custom Java archive or class.
    1. In the header of Dev Studio, click ConfigureApplicationDistribution Import.
    2. In the Import Wizard, select a location from which to import the JAR file you created in step 1. Select from the following locations:
      • Local File
      • From Repository
      • File on Server
    3. Click Next.
    4. Confirm the details of the JAR file, then click Next.
    5. In the Code Archive page, enter the Codeset name and the Codeset version as defined in the dynamic system setting.
    6. Click Next to finish the import.
    7. Restart your environment to import the JAR file into the version of the codeset.
      • For Pega Cloud environments, file a service request to restart the application server of your Pega Cloud instance. For more information, see .
      • For on-premises environments, restart the application server.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us