Skip to main content

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

About Connect Java rules

Updated on August 16, 2022

Use a Connect Java rule to define a connector interface between your application and an external Java application or a Java class.

Note: Connect Java rules are no longer being actively developed, and are being considered for deprecation in upcoming releases. Using Connect Java rules does not follow Pega development best practices. Consider other implementation options instead.

The following tabs are available on this form:

  • Service
  • Constructor
  • Method

Pega Platform offers various ways to interact with existing Java code, but using a Java connector is a best practice in most situations. See Using existing Java code — A comparison of design alternatives for information about design options on the Pega Community.


To list the Connect Java rules in your application, use the Application Explorer or click ConfigureIntegrationConnector Definitions & Simulations.

To list all Connect Java rules that are available to you, use the Records Explorer.


Ensure that the external Java class or .jar file are on the Pega Platform class paths. For instructions, see the Pega Community article About the Process Commander Class Paths.

Typically, use Connector and Metadata wizard when building a Java connector. The wizard uses the Java Reflection API to introspect the class or JavaBean's public constructors and public methods and generates the appropriate connectors, connector activities, classes, and properties.

To use the wizard, select ConfigureIntegrationConnectors Connector and Metadata wizard.

If you create a Java connector rule manually, complete the Service tab first.


To debug your application, you can simulate a Java connector when the external class is unavailable or lacks a test environment.

Where referenced

Connect Java rules can be referenced in an Integrator shape of a flow rule, or on the Definition tab of a Data Page rule, as the source of data for the contents of the data page.


A Connect Java rule is an instance of the Rule-Connect-Java class. Connect Java rules belong to the Integration-Connectors category.

  • Previous topic Connect HBase rules - Completing the Create, Save As, or Specialization form
  • Next topic Connect Java rules - Completing the Create, Save As, or Specialization form

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