Opqo allows users to report issues as either work orders or services requests, where a work order may be reported as a quick report, providing the user with an assigned work order that they can work with immediately within Opqo, even when created offline.

Opqo contains a default configuration for these options, which can be modified via configuration.

Existing options can be modified via the usual mechanism, by add a configuration map to the moduleconfig section of the STAUTOSCRIPT.STAMCONFIG automation script, as described in the Configuration Overview article.

The default configuration contains the following modules, which appear as menu items:

On the main work tab

Type	Module	Identifier
Quick Report	ReportNewIssueModule	CreateNewLocal
Report Issue (WO or SR)	ReportNewIssueModule	CreateNewRemote

On the work order detail screen

Type	Module	Identifier
Follow-up Quick Report	ReportFollowupIssueModule	CreateFollowupLocal
Follow-up Issue (WO or SR)	ReportFollowupIssueModule	CreateFollowupRemote

Note that identifiers are used to distinguish between multiple instances of the same module type. Configuration modifications can be targeted to a specific instance via the identifier, or to all modules of that type, by omitting the identifier.

For example, this configuration targets only Quick Reports:

{
  "module": "ReportNewIssueModule",
  "id": "CreateNewLocal",
  ...
}

Whereas this configuration targets reporting all new issues:

{
  "module": "ReportNewIssueModule",
  ...
}

Configuration Options

ReportNewIssueModule and ReportFollowupIssueModule share the following configuration options:

Property Name	Value
title	The title of the menu option shown to the user
fields	A list of Report Issue Field Modules to display. See below for more details.
options	A list of Report Issue type
woFieldValues	A JSON map containing hardcoded values to set on created work orders. The keys of the map are the work order attribute names, with the values being the value to set.
srFieldValues	A JSON map containing hardcoded values to set on created service requests. The keys of the map are the work order attribute names, with the values being the value to set.

The default configuration for ReportNewIssueModule is as follows:

{
  "module": "ReportNewIssueModule",
  "id": "CreateNewLocal",
  "fields": [
    {
      "module": "ReportIssueDescriptionFieldModule"
    },
    {
      "module": "ReportIssueWoWorkTypeFieldModule"
    },
    {
      "module": "ReportIssueDoclinksFieldModule"
    }
  ],
  "options": [
    {
      "method": "QuickReport"
    }
  ]
},
{
  "module": "ReportNewIssueModule",
  "id": "CreateNewRemote",
  "fields": [
    {
      "module": "ReportIssueDescriptionFieldModule"
    },
    {
      "module": "ReportIssueWoWorkTypeFieldModule"
    },
    {
      "module": "ReportIssueDoclinksFieldModule"
    }
  ],
  "options": [
    {
      "method": "ServiceRequest"
    },
    {
      "method": "WorkOrder"
    }
  ]
}

ReportFollowupIssueModule has the following additional configuration options:

Property Name	Value
woCrossoverFields	A JSON map defining the fields to be copied from the originating work order to a follow-up work order. The keys are the attribute names on the originating work order, with the values being the attributes name on the destination work order.
srCrossoverFields	A JSON map defining the fields to be copied from the originating work order to a follow-up service request. The keys are the attribute names on the originating work order, with the values being the attributes name on the destination service request.

The default configuration for ReportFollowupIssueModule is as follows:

{
  "module": "ReportFollowupIssueModule",
  "id": "CreateFollowupLocal",
  "fields": [
    {
      "module": "ReportIssueDescriptionFieldModule"
    },
    {
      "module": "ReportIssueWoWorkTypeFieldModule"
    },
    {
      "module": "ReportIssueDoclinksFieldModule"
    }
  ],
  "options": [
    {
      "method": "QuickReport"
    }
  ]
},
{
  "module": "ReportFollowupIssueModule",
  "id": "CreateFollowupRemote",
  "fields": [
    {
      "module": "ReportIssueDescriptionFieldModule"
    },
    {
      "module": "ReportIssueWoWorkTypeFieldModule"
    },
    {
      "module": "ReportIssueDoclinksFieldModule"
    }
  ],
  "options": [
    {
      "method": "ServiceRequest"
    },
    {
      "method": "WorkOrder"
    }
  ]
}

Fields

The fields property contains a list of modules that allow user's to enter information to be collected and added to the work order or service request that is created. The fields are displayed in the order they appear in the list.

Some fields are applicable to both work orders and service requests, while others are specific to one or the other. When a field is configured that does not support the selected method, it is simply not displayed.

The following sections provide details of the field modules that may be configured.

Description

The ReportIssueDescriptionFieldModule allows the user to enter a description of the issue.

Supported Methods	All
Maps to Maximo property	WORKORDER.DESCRIPTION SR.DESCRIPTION
Additional properties
required	A boolean value indicating whether this field is required. The default value is true

Example:

{
  "module": "ReportIssueDescriptionFieldModule",
  "required": true
}

Work Order Work Type

The ReportIssueWoWorkTypeFieldModule allows the user to select the work type for issues that create a work order.

If the values property contains only one value, the work type will automatically be set to this value and the field is not displayed to the user.

Supported Methods	QuickReport, WorkOrder
Maps to Maximo property	WORKORDER.WORKTYPE
Additional properties
values	An array of work types, as String values. The default value is: ["CM"]
defaultToFirstValue	A boolean value indicating whether to default the value to the first value in the list. The default is true
required	A boolean value indicating whether this field is required. The default value is true

Example:

{
  "module": "ReportIssueWoWorkTypeFieldModule",
  "values": ["CM", "EM"], 
  "defaultToFirstValue": true,
  "required": true
}

Attachments

The ReportIssueDoclinksFieldModule allows the user to add photos as attachments to the issue.

Note that currently, only one addToDocType can be specified, and if both work orders and service requests are available methods, must be valid for both types.

Supported Methods	All
Additional properties
addToDocType	The DOCTYPE of the folder to add the attachments to in Maximo. The default value is: Attachments
required	A boolean value indicating whether this field is required. The default value is false
allowDescription	A boolean value indicating whether the user is prompted to enter a description when adding an attachment. The default value is false

Example:

{
  "module": "ReportIssueDoclinksFieldModule",
  "addToDocType": "Attachments", 
  "required": true,
  "allowDescription": true
}

Work Order Supervisor

The ReportIssueWoSupervisorFieldModule allows the user to select the SUPERVISOR for issues that create a work order.

Supported Methods	QuickReport, WorkOrder
Maps to Maximo property	WORKORDER.SUPERVISOR
Additional properties
title	The title of the field to show to the user. This value is optional. If not specified, the title of the SUPERVISOR field in Maximo will be shown.
values	An array of PERSONID for the user to select from, as String values.
defaultToFirstValue	A boolean value indicating whether to default the value to the first value in the list. The default is true
allowExtendedSelection	A boolean value indicating whether the user is allowed to select a PERSONID from any PERSON record in Maximo.
required	A boolean value indicating whether this field is required. The default value is true

Note that one or both of these is required:

A non-empty list of values must be specified
allowExtendedSelection set to true

Example:

{
  "module": "ReportIssueWoSupervisorFieldModule",
  "title": "Supervisor", 
  "values": ["WILSON", "JOEO"],
  "defaultToFirstValue": false,
  "allowExtendedSelection": false,
  "required": true
}

Work Order Owner

The ReportIssueWoOwnerFieldModule allows the user to select the OWNER for issues that create a work order.

Supported Methods	QuickReport, WorkOrder
Maps to Maximo property	WORKORDER.OWNER
Additional properties
title	The title of the field to show to the user. This value is optional. If not specified, the title of the OWNER field in Maximo will be shown.
values	An array of PERSONID for the user to select from, as String values.
defaultToFirstValue	A boolean value indicating whether to default the value to the first value in the list. The default is true
allowExtendedSelection	A boolean value indicating whether the user is allowed to select a PERSONID from any PERSON record in Maximo.
required	A boolean value indicating whether this field is required. The default value is true

Note that one or both of these is required:

A non-empty list of values must be specified
allowExtendedSelection set to true

Example:

{
  "module": "ReportIssueWoOwnerFieldModule",
  "title": "Owner", 
  "values": ["WILSON", "JOEO"],
  "defaultToFirstValue": false,
  "allowExtendedSelection": false,
  "required": true
}

Work Order Lead

The ReportIssueWoLeadFieldModule allows the user to select the LEAD for issues that create a work order.

Supported Methods	QuickReport, WorkOrder
Maps to Maximo property	WORKORDER.LEAD
Additional properties
title	The title of the field to show to the user. This value is optional. If not specified, the title of the LEAD field in Maximo will be shown.
values	An array of PERSONID for the user to select from, as String values.
defaultToFirstValue	A boolean value indicating whether to default the value to the first value in the list. The default is true
allowExtendedSelection	A boolean value indicating whether the user is allowed to select a PERSONID from any PERSON record in Maximo.
required	A boolean value indicating whether this field is required. The default value is true

Note that one or both of these is required:

A non-empty list of values must be specified
allowExtendedSelection set to true

Example:

{
  "module": "ReportIssueWoLeadFieldModule",
  "title": "Lead", 
  "values": ["WILSON", "JOEO"],
  "defaultToFirstValue": false,
  "allowExtendedSelection": false,
  "required": true
}

Service Request Owner

The ReportIssueSrOwnerFieldModule allows the user to select the OWNER for issues that create a service request.

Supported Methods	ServiceRequest
Maps to Maximo property	SR.OWNER
Additional properties
title	The title of the field to show to the user. This value is optional. If not specified, the title of the OWNER field in Maximo will be shown.
values	An array of PERSONID for the user to select from, as String values.
defaultToFirstValue	A boolean value indicating whether to default the value to the first value in the list. The default is true
allowExtendedSelection	A boolean value indicating whether the user is allowed to select a PERSONID from any PERSON record in Maximo.
required	A boolean value indicating whether this field is required. The default value is true

Note that one or both of these is required:

A non-empty list of values must be specified
allowExtendedSelection set to true

Example:

{
  "module": "ReportIssueSrOwnerFieldModule",
  "title": "Owner", 
  "values": ["WILSON", "JOEO"],
  "defaultToFirstValue": false,
  "allowExtendedSelection": false,
  "required": true
}

PERSONID Field

The ReportIssuePersonIdFieldModule allows the user to select a PERSONID field that is not covered by the more specialized fields, above.

Properties
mboName	The name of the MBO the field belongs to. This will also specify which method the field applied to. Value values are: sr workorder This field is required.
attributePath	The name of the Maximo attribute to set. This field is required.
title	The title of the field to show to the user. This value is optional. If not specified, the title of the OWNER field in Maximo will be shown.
values	An array of PERSONID for the user to select from, as String values.
defaultToFirstValue	A boolean value indicating whether to default the value to the first value in the list. The default is true
allowExtendedSelection	A boolean value indicating whether the user is allowed to select a PERSONID from any PERSON record in Maximo.
required	A boolean value indicating whether this field is required. The default value is true

Note that one or both of these is required:

A non-empty list of values must be specified
allowExtendedSelection set to true

Example:

{
  "module": "ReportIssuePersonIdFieldModule",
  "mboName": "sr",
  "attributePath": "affectedpersonid",
  "title": "Affected Person", 
  "values": ["WILSON", "JOEO"],
  "defaultToFirstValue": false,
  "allowExtendedSelection": true,
  "required": false
}

Work Order Attribute

The ReportIssueWoAttributeFieldModule allows the user to provide a value for a specified WORKORDER attribute.

Data entry will be based on the type of the Maximo attribute, with the following notes:

If the attribute has an associated ALN, NUMERIC or SYNONYM domain, the user will select from the values in the domain. Other domain types are not supported.
Long description fields are supported, however rich text formatting is not supported.

Properties
attributePath	The name of the WORKORDER attribute to set. This field is required.
title	The title of the field to show to the user. This value is optional. If not specified, the title of the field in Maximo will be shown.
required	A boolean value indicating whether this field is required. The default value is false

Example:

{
  "module": "ReportIssueWoAttributeFieldModule",
  "attributePath": "description_longdescription",
  "title": "Details",
  "required": false  
}

Service Request Attribute

The ReportIssueSrAttributeFieldModule allows the user to provide a value for a specified SR attribute.

Data entry will be based on the type of the Maximo attribute, with the following notes:

If the attribute has an associated ALN, NUMERIC or SYNONYM domain, the user will select from the values in the domain. Other domain types are not supported.
Long description fields are supported, however rich text formatting is not supported.

Properties
attributePath	The name of the SR attribute to set. This field is required.
title	The title of the field to show to the user. This value is optional. If not specified, the title of the field in Maximo will be shown.
required	A boolean value indicating whether this field is required. The default value is false

Example:

{
  "module": "ReportIssueSrAttributeFieldModule",
  "attributePath": "reportedpriority",
  "title": "Priority",
  "required": true
}

Options

The options property contains the method that will be used to report the issue. When more than one option is present in the list, the user will be prompted to select the method they wish to use.

The available options are as follows:

Method	Description
QuickReport	Creates a work order in Maximo, and assigns it to the current user. The work order is available locally for the user to work with immediately, even when it is created offline.
WorkOrder	Creates a work order in Maximo. No local work order is created.
ServiceRequest	Creates a service request in Maximo.

Note: For more information on Opqo configuration and the role and contents of the STAUTOSCRIPT.STAMCONFIG script, see the Configuration Overview article.

If you have questions please do not hesitate to contact us or create a support ticket for more assistance.

Report Issue Print

Configuration Options

Description

Work Order Work Type

Attachments

Work Order Supervisor

Work Order Owner

Work Order Lead

Service Request Owner

PERSONID Field

Work Order Attribute

Service Request Attribute

Related Articles