Importing custom Java archives and classes
+
This content applies to On-premises, Client-managed cloud and Pega Cloud environments
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:
- Set up a custom codeset version.
- Import a custom JAR or class file.
Each task is described below.
To set up a custom codeset version:
- In the navigation pane of Dev Studio, click Records > SysAdmin > Dynamic System Settings.
- Find the code engine dynamic system setting with the following Setting Purpose:
properties/com.pega.pegarules.bootstrap.codeset.version.Customer/default
- Open the dynamic system setting.
- In the top navigation pane, click Save > Save As.
- In the Setting Purpose field, edit
Customer
to the name of your codeset. - Click Create and Open.
- In the Value field, enter 01-01-01 as a codeset version.
- 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:
- In the header of Dev Studio, click Configure > Application > Distribution > Import.
- 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
- Navigate to the location of the JAR or class file.
- Click Next.
Pega Platform displays a page of the JAR file details. - Confirm the details of the JAR file, then click Next.
- In the Code Archive page, enter the Codeset name and the Codeset version as defined in the dynamic system setting.
- Click Next to finish the import.
- Restart your environment to import the JAR file into the version of the codeset.
- For Pega Cloud environments, file a service request from My Support Portal to restart the application server of your Pega Cloud instance.
For more information, see Self-managing your Pega Cloud environments from My Support Portal. - For on-premises environments, restart the application server.
- For Pega Cloud environments, file a service request from My Support Portal to restart the application server of your Pega Cloud instance.