Configuring system properties for persistent storage

To implement attached document features for persistent storage in Maximo® Manage, administrators specify system properties to define parameters, such as a default file path, maximum file size, attachment security, and other relevant properties.

About this task

This task describes how to configure the system properties that are needed to set up attachments if you provisioned storage for attachments by using the Kubernetes persistent volume (PV) framework. The topic describes the basic properties that you must configure after you deploy Maximo Manage. However, you might need to specify other properties for your implementation. For more information, see Attached document properties.

Before you begin

You must have authorization to edit system properties for attached documents.

Procedure

  1. In the System Properties application, in the Property Name field, filter for attached document property or properties that you want to configure.
  2. Configure the system properties for attached documents as shown in the following table.
    Table 1. Required system properties for attached documents
    Property Description Value
    mxe.doclink.doctypes.defpath The default file directory to use for folders in the attached documents library.

    Specifies the default path for the directory that you set up for attached documents on your persistent storage volume. Your documents are stored in this directory.

    This value must be configured before you can attach documents and requires a live refresh.

    		 Specify the path to the directory that you set up in your persistent storage volume. For example,
    Linux® : /d01/doclinks
    Note: The value for Microsoft Windowsis applicable only if you use Windows on a development or test environment.
    Windows : H:\doclinks
    mxe.doclink.doctypes.topLevelPaths Specifies the attachments directory that stores all document folders in your persistent storage volume.

    The Default File Path value that is entered in the Manage All Documents Folder window must be a subdirectory of this value.

    This value cannot be null.

    When you complete the system property configurations, restart the server bundle pod to implement the changes.

    		 The default location is the directory on the persistent storage volume. For example, \doclinks.
    mxe.doclink.path01

    The HTTP Server path to link documents that are attached to records.

    The server name in the path must be a fully qualified server name.

    This property requires a live refresh.

    /d01/doclinks=https://hostname//maximo/oslc/doclinks

    For example:

    /d01/doclinks=https://host//maximo/oslc/doclinks
    mxe.doclink.securedAttachment

    The value that you specify for this property determines whether the application displays the file path of attached documents.

    Setting this property to true prevents the application from displaying the file path of attached documents. The application displays only the content root and the file name.

    Setting the property to true makes all attached document requests go through the Maximo Manage server instead of an HTTP web server and provides an extra layer of security to the stored documents.

    The default value for this property is false.

    For Maximo Manage deployments on Red Hat® OpenShift®, set this property to true.
    mxe.report.AttachDoc.validateURL

    Determines whether the URL of the attached document needs to be validated before the document is printed.

    		 The default value for this property is 1.

    For Maximo Manage, set this property to 0.
  3. Restart the server bundle pod.
    If you have multiple server bundles, restart all of them.