Skip to main content

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

Configuring a file listener to ingest customer data

Updated on August 3, 2022

This content applies only to Pega Cloud environments

Create a file listener that listens for the arrival of a manifest file in the repository, and then triggers the data ingestion.

You can use repository APIs for all file-related operations. For more information, see Repository APIs.

Pega Customer Decision Hub Implementation Guide
  1. Create a ManifestDetails page property in the Data-Ingestion-Manifest class.
  2. Create a file service to process the files.

    The file service might use a parse rule for XML, structured, or delimited data, or a JSON data transform to read the file and map the data to fields on the clipboard. In the file service, use the ManifestDetails page property as the context page, as in the following example:

    Example of a parse rule for XML
    A Parse XML rule in Dev Studio. The ManifestDetails page property is configured as the context page.

    For more information, see:

  3. Create an activity that calls the svcAddWorkObject function.

    The activity process the files and creates a work object for each record. For more information, see Creating an activity.

  4. Create a service file rule to process the manifest file before the data ingestion.

    When you configure the service file, ensure that you enter the following values:

    1. On the Method tab, select File at a time.
    2. On the Request tab, in the Parse segments section, call the file service that you configured in step 2.
    3. In the Final activity field, call the svcAddWorkObject activity that you configured in step 3 to invoke the ingestion case.
    Note: You can use the service file rule to verify whether all the files from the manifest file exist, and whether the files' size in the Pega Cloud repository matches the files' size in the manifest file. If there is a mismatch, not all the files were transferred to the repository and the data ingestion process failed.
    Example of a service file for data ingestion
    A service file in Dev Studio labeled Ingestion with a parse rule and a final activity configured.

    For more information, see Service File rules.

  5. Create a service package to group related service file rules.

    For more information, see Creating a service package.

  6. Configure a file listener.

    When you configure the file listener, ensure that you enter the following values:

    1. In the Source location field, enter the path to the folder with the manifest and data files.
    2. In the Service package, Service class, and Service method fields, enter the details of the service file that you configured in step 5.
  • Previous topic Configuring a repository to ingest customer data
  • Next topic Configuring a file data set to ingest customer data

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