Skip to main content

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

Creating file listeners to ingest customer data

Updated on May 30, 2022

This content applies only to Pega Cloud environments

Create file listeners to listen for the arrival of the manifest file in your repository, run a preprocessing check to validate the files against the manifest file, and if the check is successful, start the ingestion process.

The goal of this procedure is to create the following rules with sample parameter values:

Rule typeRule nameRuleset
File listenerUPlusAccountFileListenerUPlusCDH-Rules
File listenerUPlusSubscriptionFileListenerUPlusCDH-Rules
File listenerUPlusHoldingFileListenerUPlusCDH-Rules
Important: When you configure these rules in your system, use the values that are appropriate for your system.
  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the Integration-Resources category, and then click File Listener.
  3. On the File Listener tab, click Create.
  4. On the New tab, configure the following parameters:
    1. In the Short description field, enter a meaningful description of the file listener, for example, File listener for Account class.
    2. In the Listener Name field, enter a name for the file listener, for example, UPlusAccountFileListener.
  5. Click Create and open.
  6. In the Listener nodes section, configure the following parameters:
    1. In the Startup option field, select NodeClassification based startup.
    2. In the Classifications section, click the Add a row icon to add a row.
    3. In the Node Type field, enter BackgroundProcessing.
    Listener nodes configuration
    The Background Processing node type is selected.
  7. In the Source properties section, in the Source location field, enter the path to the folder in your repository where the files to be ingested will be stored.
  8. In the Source name mask field, enter the source name mask for the file listener.
    • For UPlusAccountFileListener, enter account_manifest*.xml.
    • For UPlusSubscriptionFileListener, enter subscription_manifest*.xml.
    • For UPlusHoldingFileListener, enter product_holding_manifest*.xml.
    Source properties configuration
    The source location field points to the folder with the files to be ingested.
  9. Select the Disable case sensitivity check box.
  10. In the Listener properties section, configure the following parameters:
    1. In the Concurrent threads field, enter 1.
    2. In the Service package field, select the name of the service package that you created earlier, which in this example was UPlusIngestionFileProcessing.
    3. In the Service class field, select Default.
    4. In the Service method field, select the name of the service file that you configured earlier, which in this example was UPlusProcessManifestFile.
    Listener properties configuration
    The listener is configured to use the ingestion service package and service file.
  11. Click the Process tab.
  12. In the Cleanup section, in the File operation field, select Keep.
  13. Click Save.
  14. Repeat steps 3 through 13 to create the other two file listeners:
    • UPlusSubscriptionFileListener
    • UPlusHoldingFileListener
    • Previous topic Creating a service file to ingest customer data
    • Next topic Starting file listeners 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