Table of Contents

Article

Understanding the Pega Cloud Services patch process

This content applies only to Pega Cloud Services environments.

Pega Cloud Services applies patches to Pega Platform™ running on Pegasystems Inc. client environments as part of its standard maintenance policy as defined in Pega Cloud maintenance and types of system updates. The Pega Cloud Services patch process requires that Pega Infinity™ is running in the client Pega Cloud Services environment.

For information regarding planning and preparing for Pega Platform software upgrades, which is different than a Pega Platform patch, in your Pega Cloud Services environments, see Understanding the Pega Cloud Services software upgrade process.

Applying Pega Platform patches does not require a cloned environment for validation. The process applies software patches to a client’s environment with minimal interruption.

The information provided in this document is for planning purposes and is subject to change at the discretion of Pegasystems Inc.

Standard software patch process benefits

The Pega Cloud Services patch process in Pega Cloud Services environments running Pega Platform 8.x is applied to client environments with minimal interruption and without touching the environment infrastructure.

Each Pega Platform patch bundles the bug and security fixes over a given period into a cumulative release that improves the overall quality of the software running on Pega Cloud Services client environments. To review what is included in Pega Platform 8.x patches, see Pega Platform patches.

Software patch planning considerations

Pega Cloud Services clients should plan to have their system software patched by Pegasystems Inc. within standard maintenance windows that the client defined during the Pega Cloud Services onboarding process. Clients should note the following details:

  • For planning purposes, clients are notified 5 days in advance and then reminded with a second notification 4 hours prior to the initiation of the patch application process withing the standard maintenance window as defined by the client.
  • Updating rules is disabled while the patch is applied to the environment. This limitation will be removed in upcoming Pega Platform 8.x releases.

For any questions about a notification from Pegasystems Inc. about an upcoming software patch, clients can review the Pegasystems Inc. maintenance policies and procedures article Pega Cloud maintenance and types of system updates.

Pegasystems Inc. responsibilities

During the Pega Cloud Services software patch process, Pegasystems Inc. responsibilities include the following actions:

  • Manage communications with the client throughout the patch process, including notification before the patch is applied and when the patch application is complete.
  • Document any issue that was discovered during the patch process and, if necessary, work with the client to resolve any patch issues.
  • Remove any unnecessary rules in each patched environment within 7 days of the patch application.

Client responsibilities

During the Pega Cloud Services software patch process, client responsibilities include the following actions:

  • Stop all background processes before the patch is applied.
  • Restart the stopped processes after patch application is complete. To complete the pausing and subsequent resuming of these background processes, see the next section.

Managing background processes to prepare for a patch

To ensure that Pega Cloud Services applies a software patch successfully, the client must stop the following types of background processes before Pega Cloud Services initiates the patch application and restart applicable processes after patch application is complete:

  • Agents
  • Job schedulers
  • Queue processors
  • Listeners
  • DSM client only: Data flows

Information about stopping and then restarting background processes is included in the remainder of this section.

Stopping agents

To stop the agents that are currently running, complete the following steps:

  1. In the navigation panel of Admin Studio, click Resources > Agents.
  2. Select all agents by selecting the check box at the top of the Agents table.
  3. Click Stop.

Disabling jobs

To disable jobs that are currently running, complete the following steps:

  1. In the navigation panel of Admin Studio, click Resources > Jobs.
  2. For each job enabled, in the State column, click Override.

Stopping queue processor rules

To disable Queue processors that are currently running, complete the following steps:

  1. In the navigation panel of Admin Studio, click Resources > Queue processors.
  2. For each Queue processor running, in the State column, click Stop.

Stopping active listeners

To stop active listeners, complete the following steps:

  1. In the navigation panel of Admin Studio, click Resources > Listenersto display the Listeners table, which displays all of the configured listeners.
  2. In the top right corner of the Active listenerstable, click Stop all.

DSM clients only: Stopping data flows

To stop all of the active data flows complete the following steps:

  1. In the navigation panel of Dev Studio, click Configure > Decisioning > Decisions > Data Flows.
  2. To stop batch processing data flows, click the Batch processing tab. For all of the dataflows in this page, in the Action column, select Pause.
  3. To stop real-time processing data flows, click the Real-time processing tab. For all of the dataflows in this page, in the Action column, select Pause.

Restarting background processes after a patch

After the client receives confirmation from Pega that a patch has been applied to their environment and the services are up and running, the client must restart the background processes that they stopped to allow the patch to be applied.

To complete the restarting of these background processes, see the applicable section for each process you stopped.

Restarting agents

To restart the agents currently running in your Pega Platform application, complete the following steps:

  1. In the navigation panel of Admin Studio, click Resources > Agents.
  2. Select all agents by selecting the check box at the top of the Agents table.
  3. Click Restart.

The Status of each Agent changes from Stopped to Running.

Enabling jobs

To enable jobs that are currently disabled, complete the following steps:

  1. In the navigation panel of Admin Studio, click Resources > Jobs.
  2. For each job disabled, in the State column, click Revert.

Restarting queue processor rules

To restart Queue processors, complete the following steps:

  1. In the navigation panel of Admin Studio, click Resources > Queue processors.
  2. For each Queue processor you want to restart, in the State column, click Start.

Restarting listeners

To restart configured listeners, complete the following steps:

  1. In the navigation panel of Admin Studio, to display the Listeners table, click Resources > Listeners.
  2. In the top right corner above the Listeners table, in the Start / restart listener pulldown, select Start or Restart by type.
  3. Place your cursor in the box below the Start / restart listener pulldown and press the down arrow key.
  4. Choose the type of listener to restart and click Apply.
  5. Repeat steps 3 and 4 for the other types of configured listeners.
  6. To see all Active listeners, click the refresh icon.
  7. Select each listener to restart and click Restart.

For additional information, see Restarting a listener.

A listener successfully starts on the node type that is specified in its configuration; when you restart all configured listeners in a batch, each listener attempts to restart on all nodes. For information purposes, Pega Platform returns exception errors for listeners attempting to restart on node types that do not match the listener configuration.

DSM clients only: Resuming data flows

To resume all of the data flows that you paused, complete the following steps:

  1. In the navigation panel of Dev Studio, click Configure > Decisioning > Decisions > Data Flows.
  2. To resume batch processing data flows, click the Batch processing tab. For all of the dataflows in this page, in the Action column, select Resume.
  3. To resume real-time processing data flows, click the Real-time processing tab. For all of the dataflows in this page, in the Action column, select Resume.

Published May 20, 2019 — Updated August 12, 2019

Have a question? Get answers now.

Visit the Pega Support Community to ask questions, engage in discussions, and help others.