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 18, 2020


This content applies to On-premises, Client-managed cloud and Pega Cloud environments

Attention: Client assumes all responsibility for files imported into Pega Cloud®. Pegasystems Inc. is not responsible for clients importing files that may contain malicious code. Clients can refer to the Pega Cloud Acceptable Use Policy to understand the client responsibilities model. 

To incorporate third-party Java functionality into Pega Platform™, you need to import 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:

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

Each task is described below.

To set up a custom codeset version:

  1. In the navigation pane of Dev Studio, click Records > SysAdmin > Dynamic System Settings.
  2. Find the code engine dynamic system setting with the following Setting Purpose:


  1. Open the dynamic system setting.
  2. In the top navigation pane, click Save > Save As.
  3. In the Setting Purpose field, edit Customer to the name of your codeset.
  4. Click Create and Open.
  5. In the Value field, enter 01-01-01 as a codeset version.
  6. Click Save.

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

To import a custom Java archive or class:

  1. In the header of Dev Studio, click Configure > Application > Distribution > Import.
  2. In the Application Import Wizard, select whether you want to import the JAR or class file from the following directory types:
    • Local File
    • From Repository
    • File on Server
  3. Navigate to the location of the JAR or class file.
  4. Click Next.
    Pega Platform displays a page of the JAR file details.
  5. Confirm the details of the JAR file, then click Next.
  6. In the Code Archive page, enter the Codeset name and the Codeset version as defined in the dynamic system setting.
  7. Click Next to finish the import.
  8. Restart your environment to import the JAR file into the version of the codeset.

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