Data Set rule form - Completing Data Sets

Your data set configuration depends on the data set type that you select. You can create the following types of data sets.

Database Table

Define the keys.

  • The Database Table section displays the database table name that the class is mapped to.
  • In the Selectable Keys section, add as many keys as necessary, and map each key to a property.
  • In the Partitioning key section, select the property used to split the data into as many equal segments as possible, across the Pega Platform nodes.
    • To ensure a balanced distribution, select a property that is suitable for partitioning. For example, if the table containins customer information, country information is a suitable property for partitioning because it contains enough shared distinct values, but email address is not because it typically has as many distinct values as customer entries.
    • Another consideration is the correlation between number of segments (the grouped distinct values delivered by the property) and number of Pega Platform nodes. An ideal distribution would have as many segments as Pega Platform nodes.

Decision Data Store

Note: You can create this data set when you have at least one Decision Data Store node in the cluster.

This data set stages data for fast decisioning. You can use it to quickly access data by using a particular key.

Define the keys when you create the data set.

  • The keys that you specify in a data set define the data records managed in the Cassandra internal storage. Add as many keys as necessary, and map each key to a property.
  • The first property in the list of keys is the partitioning key used to distribute data across different decision nodes. To keep the decision nodes balanced, make sure that you use a partitioning key property with many distinct values.
  • Changing keys in an existing data set is not supported. You have to create another instance.

To troubleshoot and optimize performance of the data set, you can trace its operations. For more information, see Tracing Decision Data Store operations.


The File data set reads data from a file in the CSV or JSON format that you upload and stores the content of the file in a compressed form in the pyFileSourcePreview clipboard property. You can use this data set as a source in Data Flow rules instances to test data flows and strategies.

For configuration details, see Creating File data set.


The HBase data set reads and saves data from an external Apache HBase storage. You can use this data set as a source and destination in Data Flow rules instances.

For configuration details, see Creating HBase data set.


The HDFS data set reads and saves data from an external Apache Hadoop File System (HDFS). You can use this data set as a source and destination in Data Flow rules instances. It supports partitioning so you can create distributed runs with data flows. Because this data set does not support the Browse by key option, you cannot use it as a joined data set.

For configuration details, see Creating HDFS data set.


The Kafka data set is a high-throughput and low-latency platform for handling real-time data feeds that you can use as input for event strategies in Pega Platform. Kafka data sets are characterized by high performance and horizontal scalability in terms of event and message queueing. Kafka data sets can be partitioned to enable load distribution across the Kafka cluster. You can use a data flow that is distributed across multiple partitions of a Kafka data set to process streaming data.

For configuration details, see Creating a Kafka configuration instance and Creating a Kafka data set.


Kinesis data set connects to an instance of Amazon Kinesis Data Streams to get data records from it. Kinesis Data Streams capture, process, and store high volume of data in real time. The type of data includes IT infrastructure log data, application logs, social media, market data feeds, and web clickstream data . The data records in a stream are distributed into groups that are called shards. For more information on the Amazon Kinesis Data Streams, see the Amazon Web Services (AWS) documentation.

For configuration details, see Creating a Kinesis data set.

Monte Carlo

The Monte Carlo data set is a tool for generating any number of random data records for a variety of information types. When you create an instance of this data set, it is filled with varied and realistic-looking data. This data set can be used as a source in Data Flow rules instances. You can use it for testing purposes in the absence of real data.

For configuration details, see Creating Monte Carlo data set.

Social media

You can create the following data set records for analyzing text-based content that is posted on social media:

Note: Facebook, Twitter, and YouTube data sets are available when your application has access to the Pega-NLP ruleset.


This type of data set allows you to process a continuous data stream of events (records).

Stream tab

The Stream tab contains details about the exposed services (REST and WebSocket). These exposed services handle a stream data set as a resource located at http://<HOST>:7003/stream/<DATA_SET_NAME>, for example:

You can use the Pega-provided load balancer to test how Data Flow rules that contain data sets of type Stream are distributed in multinode environments by specifying partitioning keys.

Use this feature only for testing purposes, in application environments whose Production level setting is set to 1, 2 ,or 3.

Settings tab

From the Settings tab you can set additional options for your stream data set. After saving the rule instance, you cannot change the settings.


The REST and WebSocket endpoints are secured by using the Pega Platform common authentication scheme. Each post to the stream requires authenticating with your user name and password. By default the Enable basic authentication check box is selected.

In the Retention period field, you specify how long the data set keeps the records. The default value is 1 day.

In the Log file size field, you specify the size of the log files, between 10 MB and 50 MB. The default value is 10 MB.

Visual Business Director

The Visual Business Director data set stores data that you can view in the Visual Business Director planner to assess the success of your business strategy. To save data records in the Visual Business Director data set, you can, for example, set it as a destination of a data flow.

One instance of the Visual Business Director data set called Actuals is always present in the Data-pxStrategyResults class. This data set contains all the Interaction History records. For more information on Interaction History, see the Pega Community article Interaction History data model.

For configuration details, see Creating Visual Business Director data set.