Configuring an FTP listener to access BIX data extracts in Pega Cloud environments

After a Business Intelligence Exchange (BIX) extraction process in a Pega Cloud environment, obtain the BIX extract files from your Pega Cloud File Storage repository. You can use an FTP listener rule to push the extract files to your enterprise SFTP server.

Before you begin: Set up an SFTP server in your domain with an SFTP or SSH client (if one does not already exist).
The BIX extraction process for XML and CSV formats, as well as their manifest files, places the BIX extract files into your Pega Cloud File Storage repository. Clients do not have direct access to the Pega Cloud File Storage repository and must push the extract files to an SFTP server in your enterprise network using a BIX-specific FTP listener in Pega Platform. Pega Cloud environments also support the use of the Pega Cloud SFTP service to pull the extract files onto an SFTP server in your enterprise. For details, see Configuring the Pega Cloud SFTP service to access BIX extract files. For more information about enabling the FTP listener, see About FTP Server data instances.
  1. In the navigation pane of Dev Studio, click Create > SysAdmin > Dynamic System Settings.
  2. Define a relative path on the destination SFTP site where the files will be sent with the following actions:
    1. In the Name field, enter a short description for the rule.
    2. In Owning Ruleset, enter the owning ruleset for BIX.
    3. In Setting Purpose, enter BIXFTPRelativeRemotePath.
    4. Click Create and open.
    5. In Value, enter the target path to which to push the BIX extraction files.
  3. To provide an access location and credentials to your SFTP server, click Integration-Resources > FTP Server.
    1. Select the BIXFTPServer.
    2. On the Environment tab, enter your SFTP server Host name and port number.
    3. In Authentication, click the properties icon to define a user name and password with which to access the SFTP server.
    4. Click Save.
    5. Return to the BIXFTPServer rule and click Save.
    6. In the BIXFTPServer rule BIXFTPServer, click Test Connectivity to verify the configuration and save this instance.
    7. Click Test Connectivity in BIXFTPServer to confirm connectivity.
  4. To configure the Service Package data instance with the operator access group that has privileges to run a BIX extraction process, click Integration-Resources > Service Package.
    1. Select BIXFTPServicePackage.
    2. In the Service access group, enter the access group for the operator with privileges to run the BIX extraction process.
    3. Click Save.
  5. To enable the BIXFTPListener, click Integration-Resources > File Listener.
    1. Select BIXFTPListener.
    2. Clear the Block Startup check box.
    3. Click Save.
  6. From Admin Studio, verify that the BIXFTPListener is running.
  7. You can test the BIX extraction process, and verify the success of the process after manually running an Extract rule, by confirming the arrival of the BIX extraction file on your SFTP server. When running a manual test, ensure that you only extract a small number of class instances. For more information, see Creating and running an Extract rule.