Attachment properties for S3 storage

You can configure the product so that it stores attachments in a Simple Storage Service (S3) cloud object storage.

Table 1. Properties for storing attachments in S3 cloud object storage
Property Description Value
mxe.cosaccesskey

The S3 access key.

Obtain this value from your S3 configuration.

mxe.cossecretkey

The S3 secret key.

Obtain this value from your S3 configuration.

mxe.cosendpointuri

The S3 endpoint URI that is used to access the S3 storage by the API.

Check with the COS provider for the proper URI syntax.

For example, for Amazon Simple Storage Service (S3), the value is https://s3.region.amazonaws.com.

For IBM Cloud Object Storage, the value is https://s3.us.cloud-object-storage.appdomain.cloud.

Obtain this value from your S3 configuration.

mxe.cosbucketname

The name of the S3 storage bucket where attachments are stored, for example, mxe.cosbucketname=maximoattachments.

Obtain this value from your S3 configuration.

mxe.attachmentstorage

The class that implements the S3 storage protocol. The product provides an implementation of the S3 storage protocol.

Always set to com.ibm.tivoli.maximo.oslc.provider.COSAttachmentStorage.

mxe.doclink.securedAttachment

For security, this property hides the file path of documents that were added by the Attached Documents feature.

Set this property to true so that the hyperlink for the attachment shows the application content root and the encrypted file name only.

Always set to true.

If this property is not set to true, other attachment storage protocols do not function.

mxe.doclink.doctypes.defpath

The default path for the doclinks folder where the attachments are stored. This path is a fixed value.

Note: The value for Microsoft Windowsis applicable only if you use Windows on a development or test environment.
Windows : Set to cos:doclinks\default
Linux® : Set to cos:doclinks/default
mxe.doclink.doctypes.topLevelPaths

The path to the directory which contains all child document folders. This path is a fixed value.

Always set to cos:doclinks for S3.

mxe.doclink.path01

The HTTP server path to link documents that are attached to records. This path is a fixed value.

Set this to match the URL of your UI server. For example, cos:doclinks=https://host/maximo/oslc/cosdoclinks.