Importing custom Java archives and classes
Version:
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.
-
Setting up a custom codeset version.
-
In the navigation pane of Dev Studio, click
-
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
. -
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.
-
-
Importing a custom Java archive or class.
-
In the header of Dev Studio, click
. -
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
-
Click Next.
-
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.
-
- Importing custom XML files for input streams
Use custom XML files for use as an input stream by importing the XML files as a Java archive (JAR) and extracting the files using an activity.
- Pre-import and post-import collections
Add steps to the pre-import and post-import collections to take specific actions based on archive metadata. Pre-import steps run before every archive import attempt. Post-import steps run after every successful archive import.
Published August 5, 2020 - Updated January 25, 2021