Document-Handler-Maximo¶

Stores the uploaded document on disk, creates a DOCLINK and set the relation to the owner.(WORKORDER, SR, ...)
In Maximo you have to create a DOCLINK-ObjectStructure with only the DOCLINK entity

Logo

In the insight.properties of Wildfly you have to set the following properties
- document.handler=maximo
- document.doclink.url
- has a default http://localhost:8080/insight-gateway/rest/maximo/os/doclink
- It's only necessary to set this property if name of DOCLINK-Objectstructure is not doclink
The file data can be processed in two different ways: (one of the properties must be set)
- Store the file to the file system. The insight middleware must be able to access the doclinks directory.
  - document.upload.folder=D:/documents
- Send the file data to the DOCLINKS object structure. No access to the doclinks directory needed. The file data must be loaded in the insight middleware memory.
  - document.doclink.mode=rest
  - default value is "rest" if property is not set
There are also the properties configured in the backendParams part of the Document-Configuration

The Document-Configuration must have specific backendParams set:

    "backendParams": {
            "OWNERTABLE": "WORKORDER",
            "OWNERID": "${WORKORDERID}",
            "SITEID": "${userData.siteid}"
        }

-> OWNERTABLE can be any Maximo-Entity, which can be used to attach DOCLINKS

-> There are additional backendParameters which can be added to change the default behavior.

-> URLTYPE -> Default: "FILE"

-> DESCRIPTION -> Default: "<file name> (mobile)"

-> DOCTYPE -> Default: "Attachments"

-> DOCUMENT -> Default: "MOBILE FILE"

-> Additional "DOCLINKS"-properties can be configured. These parameters are also saved.

Objectstructure security¶

if objectstructure security is enabled mxe.int.enableosauth=1 then make sure that security is directly configured on objectstructure doclink and appropriate secure-groups can access objectstructure doclink.

It is necessary sending Parameter "APP" with an apropriate value to maximo. If backendParams do not contain "APP" then insight sets "APP=COMMTMPLT" per default.

Secured attachments¶

if property mxe.doclink.securedAttachment=true is set than it is neccessary to use ObjectStructure for uploading and downloading documents. https://www.ibm.com/support/pages/how-prevent-unauthorised-access-doclinks-documents-when-mxedoclinksecuredattachment-set-true

Please make sure that properties are set

- document.handler=maximo
- document.mode=rest
- document.doclink.url=http://localhost:8080/insight-gateway/rest/maximo/os/doclink

And node for doclinks in treeConfig contains the following snippets:

            "fileLink": {
                "url": "insight/document/${DOCLINKSID}",
                "fileName": "${SIMPLENAME}"
              },                
            "attributes": [
                {
                    "name": "URLNAME",
                    "readonly": true,
                    "label": "URLNAME",
                    "type": "String"
                },                                                          
                {
                    "name" : "SIMPLENAME",
                    "label" : "SIMPLENAME",
                    "type" : "String",
                    "derived" : {
                        "regex" : ".+[\\\/](.+)$",
                        "attribute" : "URLNAME",
                        "replacement": "$1"                         
                    }
                }
            ]