Stream-based encryption

Stream-based encryption provides an alternative method for encrypting export files using PGP. Instead of encrypting the entire file in memory after it is generated, this option encrypts the data as it is written. This approach supports processing files that would otherwise cause OutOfMemory errors with the previous method and can also help reduce memory usage and improve performance for large export files.

This option is available for the following Job Scheduler export tasks:

  • CSV Query Export
  • Export Query Enhanced
  • Fixed Width Query Export
  • Payroll Export
  • Payroll Export Enhanced
  • Payroll Export - Off Cycle Retros
  • ERP Work Detail Export
  • ACA Service Hours Export
  • HR Export
Note: This option is not available for Payroll Export Wizard summary screens such as reexport, on-cycle, and off-cycle terminated, which continue to use in-memory encryption.

Prerequisites

  • The PGP Encrypt File check box must be selected. If PGP Encrypt File is not enabled and you select Use stream-based encryption, an inline validation error is displayed.
  • A valid PGP key must be configured.

Configuration

In Config mode, the Use stream-based encryption option is a hidden parameter. To enable it, open the applicable export task in Config mode, ensure that PGP Encrypt File is selected, then select Use stream-based encryption and save the task configuration.

Default behavior

This table shows the default values for the Use stream‑based encryption option:

Scenario Default value
New installations Not selected
Upgrades from previous releases Not selected

Administrators can opt in on a per-task basis. Existing export tasks continue to function using in-memory encryption unless this option is explicitly enabled.

Performance

Stream‑based encryption reduces processing time for large export files by encrypting data as it is written instead of loading the entire file into memory first. For example, a 5.5 GB file takes approximately 15 minutes to encrypt. Actual performance may vary depending on system resources and file content.