Documentation

Amazon Simple Storage Service

Amazon’s simple storage service (S3) is a cloud-based storage solution that DXP’s S3 Store uses to seamlessly store files to the cloud. Once you have an AWS account and have created an S3 bucket, you can configure the S3 store.

When you create an AWS account, Amazon assigns you unique keys that link you to your account. You’ll use these keys to configure the S3 Store in the next section.

S3 uses the concept of buckets for file storage. In Amazon’s UI, create a bucket for your DXP files. Make sure to configure the bucket in a geographical region that is as close as possible to your DXP server host.

Note

No action is required to support AWS Signature Version 4 request authorization.

Configuring the Store

Configure the store following these steps:

  1. Amazon S3 requires a SAXParser. If your application server doesn’t already have SAXParser, you can download the Xerces SAXParser to your application server’s global library folder, such as /lib/ext on Tomcat or /module on JBoss EAP and WildFly.

  2. Specify the SAXParser in a system-ext.properties file using this property:

    org.xml.sax.driver=com.sun.org.apache.xerces.internal.parsers.SAXParser
    
  3. Copy the system-ext.properties file to a folder that resides in the DXP application class path (for example: /WEB-INF/classes/).

  4. Configure portal-ext.properties with this property:

    dl.store.impl=com.liferay.portal.store.s3.S3Store
    
  5. Restart DXP.

  6. In the Control Panel, navigate to ConfigurationSystem SettingsFile Storage.

  7. In the S3 Store screen, configure the store:

    • Bucket Name: Your bucket’s name.

    • Access Key: Your AWS access key.

    • Secret Key: Your secret key.

    • S3 Region: The geographic region; the default is us-east-1.

    Amazon S3 Store Configurations

  8. Leave the other fields as the default settings.

  9. Click Save.

Your DXP instance is now using the Amazon S3 store.

Using the Store in a Clustered Environment

Follow these steps to use S3 Store in a clustered environment:

  1. If your application server doesn’t already have SAXParser, copy Xerces SAXParser to each node’s application server global library folder.

  2. Copy the system-ext.properties file to the DXP application’s /WEB-INF/classes/ folder.

DXP is using the Amazon S3 store throughout your cluster.

Database Rollback Limitation

Warning: If a database transaction rollback occurs in a Document Library, the transaction’s file system changes are not reversed. Inconsistencies between Document Library files and those in the file system store can occur and may require manual synchronization. All of the DXP stores except DBStore are vulnerable to this limitation.

Consult the Amazon Simple Storage documentation for additional details on using Amazon’s service.