Opqo supports setting Maximo configuration information by scanning a QR code containing the necessary details.


The QR code must contain a serialized JSON object, with the following properties:



NameData TypeNotes
hostStringRequired.  The hostname of the Maximo environment to connect to.  Should contain only the hostname.
nameStringOptional.  The name of the connection to display to the user.
typeStringOptional. "PROD" for production environments, any other value for non-production  The value for non-production environments is displayed to the user.
sslBooleanOptional. Whether the connection should use SSL.  If not specified, the default is: true.
portIntegerOptional.  The port to connect to the Maximo server on.  Must be a valid TCP port.

If not specified, will use the standard HTTP/S ports (80/443), depending on whether ssl is used or not.
utcertBooleanOptional.  Whether to accept untrusted/self-signed SSL certificates when connecting to Maximo and ssl is enabled.

If not specified, the default value is "false".
appStringOptional. The Maximo app context.

If not specified, the default value is "maximo".  
apiStringOptional. The Maximo API context for the REST API.

If not specified, the default value is "oslc"
authStringOptional. The authentication method to use when connecting to Maximo.

Valid values are:
  • "standard"
  • "maxauth"
  • "ldap"
  • "saml"

"standard": For Maximo environments configured with internal authentication, LDAP (BASIC auth) or Forms authentication.  This also includes MAS development environments.

"maxauth": For Maximo environments configured with internal authentication. This option will only send the MAXAUTH header for authentication. Typically not required, as "standard" should suffice.

"ldap": For Maximo environments configured with LDAP authentication. This option will only send the HTTP BASIC authentication header for authentication. Typically not required, as "standard" should suffice.

"saml": For Maximo environments configured with SAML authentication.

If not specified, the default value is "standard"



Example


An example QR code and content is shown below, for connecting to the Opqo demo environment:



{
  "host": "opqo-demo.sharptree.io",
  "ssl": true,
  "name": "Opqo Demo"
}




Please do not hesitate to contact us or create a support ticket if you have questions or require our assistance.