Collect Must-Gather Data for S3 Attachment Storage in IBM Maximo Application Suite Manage

• S3 Bucket Storage
  From the bucket information, please collect the following:

  • Bucket Name
  • apikey
  • access_key_id
  • secret_access_key
  • endpoint
• Manage System Properties
  From Manage, go to System Properties application.

  Collect the information from the following properties.

  • mxe.cosaccesskey
  • mxe.cosendpointuri
  • mxe.cosbucketname
  • mxe.cossecretkey
  • mxe.attachmentstorage
  • mxe.doclink.doctypes.defpath
  • mxe.doclink.doctypes.topLevelPaths
  • mxe.doclink.path01
  • mxe.doclink.securedAttachment

---

Here is a recommended document on the full setup of S3 Storage for Attachments : Configuring S3 Storage for Attachments. This document will help setup the S3 properties in Manage to properly connect with the S3 bucket. There is also a document with detailed steps to setup Maximo attachment configuration for AWS S3.

The main goal of these documents is focus on the Maximo/Manage system properties configuration.

Note that the steps to collect the information from the S3 bucket may differ from each provider and may also change along the time, as the cloud platforms like IBM Cloud and AWS are always under modification and improvements.The COS S3 Storage for Attachments will only work if mxe.doclink.securedAttachment is set as true.

It is important to notice that S3 for attachments does not support to upload new attachments to folders and sub-folders. The files are always uploaded to the root of the COS. That makes the maintenance of Manage Folders path not necessary, as this information is not considered for COS configuration. S3 expects all files to be in the top level directory as a result any files in lower directory levels will not be found by Maximo.

Existing files that were migrated from older Maximo environments with the original sub-folders structure may be located by Manage in S3. To deal with this set the mxe.cosnestedfile system property to 1. This allows documents in lower directories to be found by Manage.

When using Secure Attachment (mxe.doclink.securedAttachment is set to true) attachments are downloaded rather than opened in the browser by design. It is possible Opening attachments in browser in Manage. You can set the system property mxe.doclink.attachmentOpenMethod to inline or attachment depending on desired results (Inline: file opens in browser. Attachment: file downloads).

• Some common questions to ask when troubleshooting S3 for Attachments
  • Details of environment on which this issue is occurring.
  • Does the environment come from an upgrade from Maximo 7.6?
  • Does it have migrated documents from Maximo 7.6?
  • Are the COS system properties properly setup with the S3 information?
  • Is the secured attachments properly set as true?
  • Are you seeing any error message in the screen when trying to open the attachment?
  • What internet browser are you using?
  • Does the issue occur on a different browser?
  • Did the user clear the browser cache and try again?  
• Troubleshooting steps
  1. Review bucket information and parameters.
  2. Review System Properties configuration in Manage.
  3. Make sure that mxe.doclink.securedAttachment is set as true.
  4. Manage expects all documents uploaded from Manage UI to be in the root folder of the COS.
  5. Only migrated documents can exist in sub-folders of the COS.

Title	Description
Search all S3 for Attachments doclinks documents on IBM Support Portal	Shows a list of all documents tagged with this topic.