Creating the Storage Destination

Note: You must define the "storage destination alias", to be used in the "Setting Purpose" field for each Dynamic System Setting. In the examples below, you will replace <destinationAlias> with your chosen text.

For example, for a storage destination alias of "corpS3", the following Setting Purpose

storage/class/<destinationAlias>:/type

would be entered as:

storage/class/corpS3:/type

In Designer Studio, Click on + Create > SysAdmin > Dynamic System Settings

1. Create a new record for each the following 4 required Dynamic System Settings
   1. Storage Destination Type
      1. Owning Ruleset:               Pega-Engine
      2. Setting Purpose:                storage/class/<destinationAlias>:/type
      3. Value:                                 aws-s3
      4. Short Description:           <provide description>
   2. Bucket Name
      1. Owning Ruleset:               Pega-Engine
      2. Setting Purpose:                storage/class/<destinationAlias>:/bucket
      3. Value:                                 <your S3 bucket name>
      4. Short Description:           <provide description>
   3. IAM User Access Key ID
      1. Owning Ruleset:               Pega-Engine
      2. Setting Purpose:                storage/class/<destinationAlias>:/accesskeyid
      3. Value:                                 <your IAM user Access Key ID>
      4. Short Description:           <provide description>
   4. IAM User Secret Access Key
      1. Owning Ruleset:               Pega-Engine
      2. Setting Purpose:                storage/class/<destinationAlias>:/secretaccesskey
      3. Value:                                 <your IAM user Secret Access Key>
      4. Short Description:           <provide description>
2. (Optional) To support S3 buckets that are encrypted via AWS KMS, create a new record for the following Dynamic System Setting
   1. KMS Encryption Key ID (Optional)
      1. Owning Ruleset:               Pega-Engine
      2. Setting Purpose:                storage/class/<destinationAlias>:/kmsencryptionkeyid
      3. Value:                                 <ARN of your KMS Encryption Key>
      4. Short Description:           <provide description>
3. (Optional) To scope your Storage Destination to a specific folder inside the S3 bucket, create a new record for the following Dynamic System Setting
   1. Root Path (Optional)
      1. Owning Ruleset:               Pega-Engine
      2. Setting Purpose:                storage/class/<destinationAlias>:/rootpath
      3. Value:                                 <existing S3 folder>
      4. Short Description:           <provide description>

Configuring the File Listener

1. To update an existing File Listener so that it will process files in the target S3 location, the Source location field needs to be updated.
2. In Designer Studio, open the FileListener rule to be modified
3. On the Properties tab, in the Source properties section, set the Source location value to: file://<storageDestinationAlias>:/
   • Note: Make sure to replace <storageDestinationAlias> with your chosen Storage Destination Alias from Creating the Storage Destination.
   • (Optional) You can specify a folder path (S3 prefix) in the Source location field
   • In the below screenshot, this File Listener has been configured to write to the Storage Destination named "externalcloud" and the folder "orders".

1. Click Save
2. From the Designer Studio menu, navigate to System > Operations > Listener Management
3. In the list on the bottom of the screen, select the checkbox next to the appropriate File Listener, and click the Restart button

When the File Listener begins running, it will process files in Storage Destination specified. In this case, it would be the target S3 bucket that was configured in the earlier steps.