Skip to main content

Using Pega Cloud File Storage

Suggest edit Updated on December 1, 2021

Pega Cloud File storage is a file storage solution that Pega integrates into Pega Platform to support your Pega applications as a repository for your Pega Cloud services application case attachments, SFTP Service transactions, Business Intelligence Exchange (BIX) extract files, and archived case files.

Key benefits

  • Integrated beginning with Pega Platform 7.3

    Pega Cloud File storage is pre-configured to support your Pega Cloud applications. Disk space is pre-allocated with separate sub-folders for your cloud environments (development, staging, and production). Default paths are configured for each environment, and security settings used default to the credentials and keys in your Pega Cloud profile.

  • Cost-effective cloud file storage

    Pega Cloud File storage is a cost-effective solution for storing archived cases, case attachments, BIX data extracts, and data uploaded through the Pega Cloud SFTP service. Pega Cloud production subscription clients receive 500 GB of file storage to use across all environments in the subscription. Pega Cloud production subscribers can purchase additional Pega Cloud File storage in 500 GB increments. Pega Cloud File storage costs significantly less than our cloud database storage and is priced well below many of our competitors.

  • No limits on file counts or total storage size

    By not limiting the number or size of files stored, Pega Cloud File storage can scale to your business needs. Individual files can be up to 5 TB.

  • Secure, private, and reliable solution

    Pega Cloud File storage is highly reliable, private, and secure. Only your applications can access your storage space, and data is encrypted both in transit and at rest.

  • The same support staff for both your application and your cloud file storage

    The Pega Cloud Support team provides support for Pega Platform, strategic application solutions, and Pega Cloud File storage. This breadth of knowledge results in faster and more effective responses, which third-party storage providers cannot match. Pega support services are available 24 hours a day, seven days a week.

  • Soft limits on storage space

    By providing soft limits on storage space, Pega Cloud File storage gives you time to clean up your storage space or purchase additional storage, averting an out-of-space crisis.

  • Data retention policy

    For archived case data, you can apply a data retention policy to delete archived files from Pega Cloud File storage. For more information, see Case archiving and purging overview.

    After you delete a file in Pega Cloud File storage, such as by using a data retention policy or REST API, you can recover the file within 30 days of deletion (see Recovering deleted Pega Cloud File storage files).

    Pega otherwise does not delete any data in your Pega Cloud File storage repository until Pega decommissions an environment upon your request.

    For more information about Pega Cloud File storage, contact you Pega Account Executive.

Overview of repository names Pega Cloud services provides by default

When Pega Cloud services provisions your environment, it creates two repositories in your Pega Cloud File storage for your environment, pegacloudfilestorage and for SFTP, a mapping from pegacloudrepository to pegacloudfilestorage/sftp. To see both of these destinations in the Storage Destinations view in Dev Studio, from the header of Dev Studio, click ConfigureSystemSettingsFile Storage.

Pega Platform structures the Pega Cloud File storage directory using the logic displayed in the following image.

Pega Cloud File Storage directory structure

You must select or reference the appropriate repository record for your Pega Cloud File storage repository and the associated sub-folder when using Pega Platform to perform the following actions:

Usingpegacloudfilestorage (/attachments, /archive)MethodUsing pegacloudrepository (/bix)Method
When selecting Pega Cloud File storage for your application content storageSelect pegacloudfilestorage from the repository list, then browse for the /attachments sub-folder.When using REST API to add or delete SFTP filesEnter pegacloudrepository in the destination field.
When sourcing case or pulse attachments from Pega Cloud File storageSelect pegacloudfilestorage from the repository list, then browse for the /attachments sub-folder.When configuring an activity to obtain your BIX extract filesEnter pegacloudrepository in the repository name field. Pega Platform automatically creates the /bix sub-folder after you run an initial extraction process.
When using REST or SOAP API to send file attachments from Pega Cloud File storageSelect from the pegacloudfilestorage repository list, then browse for the /attachments sub-folder.When configuring your Pega Cloud SFTP service or BIX FTP listener to access your BIX extract filesIn the BIX/sharedpath DSS, enter the filespec file://pegacloudrepository:/bix.
When using REST or SOAP API to process inbound file attachments for storage in Pega Cloud File storageEnter pegacloudfilestorage in the repositoryName field, then /attachments in the folderPath field.When using REST API to create additional sub-folders in the /sftp directorySee article.
When using a file listener to process storage in a repository (does not apply to extract files)Enter filespec file://pegacloudfilestoragein the repositoryName field, then /attachments in the folderPath field.
When using the Connect-FTP method to obtain Pega Cloud File storage filesEnter file spec file://pegacloudfilestorage:/attachments in the remoteFile field as an example.When using the Connect-FTP method to obtain Pega Cloud File storage filesEnter file spec file://pegacloudrepository:/bix in the remoteFile field, as an example.
Improving performance by archiving cases

Pega Platform automatically creates the pegacloudfilestorage/archive repository record sub-folder when you run the initial archival job.

Accessing and managing files in your Pega Cloud File storage pegacloudfilestorage repository

For Pega Cloud services environments, Pega uses Pega Cloud File storage as the default repository, which appears as pegacloudfilestorage in the list of repositories in RecordsSysAdminRepository.

Pega Cloud services does not allow direct access to the filesystem in a Pega Cloud File storage repository; instead you manage your files in a Pega Cloud File storage repository with the following methods:

  • using the Repository API to interact with your files
  • using an SFTP client to add or delete files in their dedicated SFTP sub-folder
  • configuring a file listener to process your files
Tasks to manage your files on your Pega Cloud File storage repository using these methods include:

Using Pega Cloud File storage repository records and sub-folders

Pega Cloud File storage stores applicable files in different sub-folders depending on the feature Pega Cloud File storage utilizes.

Pega Cloud File Storage default directory display using your browser

Select the appropriate record for the following Pega Platform features and use cases:

  • The pegacloudfilestorage record maps to the sub-folders /attachments for case attachments and \archive for archived case files.

    Caution: The pegacloudfilestorage record also contains the /sftp sub-folder, but do not select or use the /sftp sub-folder for case attachments and Pulse comments.
    • To configure the location for Pega application case attachments, use the pegacloudfilestorage repository record and the /attachments sub-folder.
    • To reference archived case data in Pega Cloud, use the pegacloudfilestorage/archive repository record sub-folder, which Pega Platform automatically creates when you run the initial archival job. For case archiving information, see Improving performance by archiving cases.
    • To create a temporary file storage location sub-folder in pegacloudfilestorage, use the following method:

      1. In the navigation pane of Dev Studio, go to RecordsData ModelData Page.
      2. In the Data Page instance list, filter the Page Name column for D_pxNewFolder and select it.
      3. In the Actions list, select Run.
      4. In the Run Data Page: New Folder dialog window, specify your new sub-folder by entering the following information:
        1. In the repositoryName field, enter pegacloudfilestorage.
        2. In the folderPath field, enter your new folder name. For example, enter new_folder to create pegacloudfilestorage\new_folder.
      5. To create the folder, in the Run Data Page: New Folder dialog window, select Run.

        For more information about Pega repository APIs, see Repository APIs.

  • The pegacloudrepository record maps to the pegacloudfilestorage/sftp subfolder for files you export from Pega Platform using the SFTP Service and the /bix subfolder for extract files. To reference the location used by the Pega Cloud SFTP service, or BIX extract files, use pegacloudrepository.
    • When you manage files using an SFTP client configured to use your Pega Cloud SFTP service URL, the pegacloudrepository record in Pega Platform automatically directs your connection to the pegacloudfilestorage/sftp sub-folder. From the client, your access to this folder originates at the filepath, /. For example:

      sftp> put test.txt
      Uploading test.txt to /test.txt
      test.txt 100% xxxKB xxMB/s  00:01
      sftp> get test.txt
      Fetching /test.txt to test.txt
      /test.txt 100% xxxKB xxMB/s   00:01
    • To reference, export, or delete BIX extract files using the Pega Cloud SFTP service, BIX FTP server, or an activity, use pegacloudrepository/bix sub-folder.

      Pega Platform creates the /bix sub-folder after you run an initial extraction process. For more information, see Overview of BIX extractions in Pega Cloud environments.

  • To send files to your FTP server through a Connect-FTP method, you can source the file location using either pegacloudfilestorage and pegacloudrepository with the file specification format file://pegacloudfilestorage:/attachments or file://pegacloudrepository:/bix.

    For more information, see the Connect-FTP method.

Recovering Pega Cloud File storage files

Pega Cloud services backs up files to Pega Cloud File storage for disaster recovery. You can contact Pega Cloud services to restore Pega Cloud File storage files for 30 days from the deletion date. Pega Cloud services does not recover files that have been deleted for more than 30 days.

To request that Pega Cloud recover files within the 30-day window, select New request in My Support Portal. Include the name of each file and the date when each file was present in your Pega Cloud File storage repository.

After Pega Cloud services completes the service request, you can find your recovered files in their respective sub-folder.

Did you find this content helpful? YesNo

33% found this useful

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us