Skip to main content


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

Filter management

Updated on March 3, 2022

Use the Filter Management tab in your Pega Cloud applications to create and manage Tomcat Java-based filters. Use this feature to securely filter traffic from your application URL without creating service requests to manage filter configurations.

Use of this feature requires that users have the pxSecurityAdmin privilege to see the Filter tab. From this tab, you can create, edit, or delete Java-based filters in your system.

Incoming URL requests for Pega Platform go through a Java-class filter, which examines each URL request and processes it based on any configured filter logic. The filter applies only to requests that match the specified pattern.

After you modify the filter configuration, restart your entire environment from My Pega Cloud for the changes to take effect. For more information, see .

The following images display the Filter Management tab during various phases of creating, editing, and deleting filter configurations.

The following image shows the Filter Management tab with filters:

Filter Management tab with filters
The Filter Management tab showing filters.

The following image shows the Filter Management tab with filters pending system restart:

Filter management tab with filters pending system restart
The Filter management tab showing filters pending a system restart.

The following image shows the Editing a Filter dialog box.

A sample editing a filter dialog
The Editing a Filter dialog box showing the example of a CORS Filter.

The following image shows the More icon options in each filter configuration.

More options in each filter configuration
The More options in each filter configuration.

Supported Java-based filters

As you create filters to securely filter traffic from your application URL, use this reference to identify the Tomcat Java-based filters supported by the Pega Platform.

Filter management supports the following Apache Tomcat Java-based filters that map to Initialization and URL Pattern parameters:

  • Cors Filter
  • CSRF Prevention Filter
  • Remote Address Filter
  • Remote CIDR Filter
  • Remote IP Filter
  • Request Dumper Filter
  • Session Initializer Filter

For more information, see the Apache Tomcat Configuration Reference available at https://www.apache.org/.

Creating a filter

Use filter management to create filter configurations. Pega Platform supports creating, editing, or deleting Apache Tomcat filters within your application for use with web and mobile applications without creating service requests to manage filter configurations.

For more information about Apache Tomcat Java-based filters, see Supported Java-based filters.
  1. In the header of Dev Studio, click ConfigureSystemSettingsServlet & Filter ManagementFilter.
  2. Click Add new Filter.
  3. In the Filter Name field, enter a filter name.
  4. In the Class name field, enter a class name.
  5. Select Is async supported to enable asynchronous processing support for filters, which allows the filter to store incoming requests for later response.
  6. In the Initialization parameters section, complete the following steps:
    1. In the Name field, enter the attribute of the parameter.
      This section contains a description of the filter's behavior when the system applies it.
      The Name defines the format and purpose of the filter.
    2. In the Value field, enter the format of the parameter.
      The Value defines the format of the parameters and functionality of the filter.
  7. In the URL patterns section, enter the URL pattern the filter uses.

    The system applies the filter when the URL Pattern is used during authentication.

  8. Click Add.
  9. Restart your entire environment from My Pega Cloud. For more information, see .

Editing a filter

Use filter management to edit filter configurations. Pega Platform supports editing Apache Tomcat filters within your application for use with web and mobile applications without creating service requests to manage filter configurations.

For more information about Apache Tomcat Java-based filters, see Supported Java-based filters.
  1. In the header of Dev Studio, click ConfigureSystemSettingsServlet & Filter ManagementFilter.
  2. Identify the filter that you want to edit, then click the More icon on the right side of the row, and then select Configure.
  3. Modify the filter.
  4. Click Update.
  5. Restart your entire environment from My Pega Cloud. For more information, see .
  • Servlet management

    Use the Servlet Management tab in your Pega Cloud applications to securely add, modify, and disable servlet configurations without editing the web.xml file.

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.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us