Configuring S3 object storage

Important: This feature is available only in the feature channel. In Maximo® Real Estate and Facilities, customer-managed users can use the feature channel to update their nonproduction instances to preview new features. As a SaaS user, you can use this feature in your Maximo Application Suite as a Service environment. For more information, see What's new in the feature channel for Maximo Real Estate and Facilities.

Starting in IBM Maximo Real Estate and Facilities 9.2, you can configure S3 object storage, initially for file-based integrations in Data Integrator and Integration Object. This support provides a robust and secure replacement for using SFTP to work with files in the Maximo Real Estate and Facilities file system.

Before you begin

Before you configure S3 object storage, you need the following information.

  • S3 bucket name and region
  • S3 access key ID with appropriate permissions
  • S3 secret access key. For example, Amazon Web Services IAM permissions configured for the Amazon S3 bucket (read and write access).

About this task

Configure the S3 object storage connection through the Maximo Real Estate and Facilities Administrator Console or by updating database settings.

Procedure

  1. From the Maximo Real Estate and Facilities Administrator Console, go to System Info > Cloud Storage Integration.
  2. In Cloud Storage Type, selectS3.
  3. In Access Key ID, enter your access key ID.
    For example, the Amazon Web Services access key ID, which identifies your AWS account. You must have permissions to read from and write to the specified S3 bucket.
  4. In Secret Access Key, enter your S3 secret access key.
    Store the secret access key securely.
  5. In Remote Root (or Bucket), specify the S3 bucket name.
  6. In Region, select the region.
  7. Save the configuration settings.
    Maximo Real Estate and Facilities automatically initializes the required structure in the configured bucket.

Results

After you configure object storage, the supported file-based integrations use the S3 bucket for file operations. When you execute an integration with the file scheme, the system automatically uses S3 for uploading and downloading files.

The DataIntegrator and IntegrationObject top-level folders are created automatically.

In the DataIntegrator folder, the input, processing, output, log, and error folders are created and managed by the system.

With S3 enabled, the Data Integrator workflow is the same, but files are stored in the S3 bucket instead of the local file system.
  • Upload your batch input file to the S3 bucket in DataIntegrator/input.
  • In Maximo Real Estate and Facilities, create or update your Data Integrator record and provide the file name (no path is needed).
  • When the job runs, all file movements in S3 object storage are handled automatically by Maximo Real Estate and Facilities Platform.
    • The file is picked up from input and moved to processing during execution.
    • On success, the output is written to output or on failure, files are moved to error.
    • Execution logs are stored under log.

In the IntegrationObject folder, the Inbound, Outbound, and processed folders are created and managed by the system.

  • For inbound integration, upload files to the S3 bucket under IntegrationObject/Inbound.
  • When processed, the inbound files are moved to the processed folder.
  • Files that are generated by the outbound integration are moved to the Outbound folder.

What to do next

For more information about creating file-based integrations, see Importing or exporting data with files for the Integration Object and Uploading data for the Data Integrator.