Configuring Maximo Anywhere

50 Pages·2017·1.16 MB·English

IBM Maximo Anywhere
Version 7 Release 6
Configuring Maximo Anywhere
IBM
Note
Before using this information and the product it supports, read the information in “Notices” on page 41.
This edition applies to version 7, release 6, modification 2 of IBM Maximo Anywhere and to all subsequent releases
and modifications until otherwise indicated in new editions.
© Copyright IBM Corporation 2013, 2017.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Configuring Maximo Anywhere. . . . . 1 Locating devices on a map . . . . . . . 24
Application definition files. . . . . . . . . . 1 Configuring Esri maps. . . . . . . . . . 25
Data resources in the application definition . . . . 3 Map positioning information . . . . . . 25
Enabling the Anywhere Administration application . 6 Enabling the auto-locate cron task. . . . . 27
Modifying apps with the Anywhere Administration Configuring access to a map service provider 29
application . . . . . . . . . . . . . . . 7 Enabling the Esri map view . . . . . . . 30
Defining work list queries. . . . . . . . . . 8 Activating GPS . . . . . . . . . . . . 32
Creating queries in Maximo Asset Management . 8 Configuring route lines . . . . . . . . . 33
Creating OSLC resource queries . . . . . . . 9 Configuring zoom levels . . . . . . . . . 34
Adding queries to mobile apps. . . . . . . 10 Recording and storing signatures . . . . . . . 34
Enabling push notifications for Maximo Anywhere Enabling Real Signature for Maximo Anywhere
mobile apps . . . . . . . . . . . . . . 12 mobile apps . . . . . . . . . . . . . 35
Configuring blind and non-blind counts. . . . . 17 Recording signatures by using Real Signature . . 36
Specifying criteria for retrieving lookup data . . . 18 Activating bar code scans. . . . . . . . . . 36
Enabling the ability to refresh any changes to the Connecting Bluetooth bar code and RFID scanners
lookup or system data. . . . . . . . . . . 20 to mobile apps . . . . . . . . . . . . . 37
Configuring page sizes for retrieving data . . . . 20 Enabling encryption of the local data store . . . . 37
Configuring administrator control of undo actions Changing the heartbeat interval . . . . . . . 38
on work order transactions . . . . . . . . . 21 Attachments properties . . . . . . . . . . 38
Failure reporting implementation in Maximo Timeout properties . . . . . . . . . . . . 39
Anywhere. . . . . . . . . . . . . . . 21
Configuring maps . . . . . . . . . . . . 22 Notices . . . . . . . . . . . . . . 41
Configuring IBM Maximo Spatial Asset Trademarks . . . . . . . . . . . . . . 43
Management maps . . . . . . . . . . . 22 Terms and conditions for product documentation. . 43
Enabling the auto-locate cron task. . . . . 22 IBM Online Privacy Statement . . . . . . . . 44
Enabling the IBM Maximo Spatial Asset
Management map view . . . . . . . . 23
© Copyright IBM Corp. 2013, 2017 iii
iv Configuring Maximo Anywhere
Configuring Maximo Anywhere
You can configure Maximo Anywhere to suit the business needs of your
organization. You can define work list queries and other settings for retrieving data
from the server. You can enable maps, attachments, bar code scans, and data
encryption. Configuration settings can apply at an application or system level.
Application definition files
An application definition is an XML file that defines the user interface and data
resources of a Maximo Anywhere mobile app. You can configure the app by
editing the application definition, or, if it is enabled, the Anywhere Administration
application.
Maximo Anywhere includes mobile apps that are built and deployed to the mobile
workforce to support business operations.
Mobile apps
You can make the following changes to all mobile apps:
v Specify the queries that determine which work list records can be retrieved from
the server
v Define the lookup data that can be retrieved from the server
v Restrict access to the status change feature by user group
v Enable encryption of the local data store for the app
v Define the frequency with which local data changes are sent by the app to the
server
v Define the timeout value for requests that are issued by the app to the server
You can make the following changes to the Asset Audit app:
v Enable bar code scans
You can make the following changes to the Asset Data Manager app:
v Enable bar code scans
You can make the following changes to the Inspection app:
v Enable the map view
v Enable bar code scans
v Enable attachments
v Enable GPS
v Record and store signatures with either electronic signature or Real Signature
You can make the following changes to the Issues and Returns app:
v Enable bar code scans
You can make the following changes to the Physical Count app:
v Enable bar code scans
You can make the following changes to the Service Request app:
© Copyright IBM Corp. 2013, 2017 1
v Enable bar code scans
You can make the following changes to the Transfers and Receiving app:
v Enable bar code scans
You can make the following changes to the Work Execution app:
v Enable the map view
v Enable bar code scans
v Enable attachments
v Enable GPS
v Record and store signatures with either electronic signature or Real Signature
The application definition for a mobile app is in the application root directory and
has the name app.xml.
Table1. Directories for the app.xmlfiles
App Directory
Maximo Anywhere Asset Audit app install_home\Anywhere\MaximoAnywhere\
apps\AssetAudit\artifact
Maximo Anywhere Asset Data Manager app install_home\Anywhere\MaximoAnywhere\
apps\AssetDataManager\artifact
Maximo Anywhere Inspection app install_home\Anywhere\MaximoAnywhere\
apps\Inspection\artifact
Maximo Anywhere Issues and Returns app install_home\Anywhere\MaximoAnywhere\
apps\IssuesReturns\artifact
Maximo Anywhere Physical Count app install_home\Anywhere\MaximoAnywhere\
apps\PhysicalCount\artifact
Maximo Anywhere Service Request app install_home\Anywhere\MaximoAnywhere\
apps\ServiceRequest\artifact
Maximo Anywhere Transfers and Receiving install_home\Anywhere\MaximoAnywhere\
app apps\TransfersReceiving\artifact
Maximo Anywhere Work Approval app install_home\Anywhere\MaximoAnywhere\
apps\WorkApproval\artifact
Maximo®Anywhere Work Execution app install_home\Anywhere\MaximoAnywhere\
apps\WorkExecution\artifact
After you change an application definition, you must build and deploy the app. If
you use the Anywhere Administration application, building and deploying the app
is not required. Depending on the type of change, the updated app is delivered to
users as a new app version or as a direct update:
v If the change includes new or updated native code, you must deploy the app as
a new app version. For example, when you enable the map view or bar code
scans, native code is added to the app during the build process. Users must
download and install the new app version from the server.
v If the change includes updated web resources, you can deploy the app without
changing the app version. Users can accept the change as a direct update of the
app version that is installed on their devices.
The application definition for mobile apps includes an attribute, requiredRole, that
specifies which user group in the provider application is authorized to use the
application. This attribute references one of the predefined user groups that are
2 Configuring Maximo Anywhere
deployed during installation to the provider application environment. At run time,
only users that belong to the specified user group can log in to the app.
For example, the requiredRole attribute in the application definition for the Work
Execution app references the ANYWHERE_TECHNICIAN security group in
Maximo Asset Management. Only users that belong to the
ANYWHERE_TECHNICIAN security group can log in to the Work Execution app.
Structure of application definition files
The <app> XML element is the root element of an application definition file. The
<app> element has three child elements that define the basic structure of the
application definition.
<ui> element
Contains the specifications for the views in the mobile app, including
views for the work list, record details, lookups, and dialog boxes.
<data> element
Contains the specifications for the data resources that are used by the app,
including work list, lookup, and system resources.
<messages> element
Contains messages that are displayed on the user interface and recorded in
the app log.
Related concepts:
“Data resources in the application definition”
The data that is used in a mobile app is specified in the application definition in
the form of OSLC resources. Resources are categorized as primary, supporting,
lookup, or system resources. These categories determine how the resources are
specified in the application definition and how they are managed at run time.
Related tasks:
“Enabling the Anywhere Administration application” on page 6
By default, the Anywhere Administration application is disabled. When you use
the Anywhere Administration application to modify mobile apps, you do not need
to rebuild and deploy the apps.
Data resources in the application definition
The data that is used in a mobile app is specified in the application definition in
the form of OSLC resources. Resources are categorized as primary, supporting,
lookup, or system resources. These categories determine how the resources are
specified in the application definition and how they are managed at run time.
An OSLC resource represents a business, configuration, or domain object that
belongs to the provider application. A resource is defined in the provider
application by a shape document that describes the structure of the resource and
all possible properties. The resource is published for integration by an OSLC object
structure. The resource is registered with a service provider that specifies and
manages the data operations that are available for the resource to consumer
applications.
In Maximo Anywhere, where mobile apps act as consumers, the application
definition specifies the resources that are used by the mobile application. The
Configuring Maximo Anywhere 3
<data> XML element contains the specifications for all resources. The main
characteristics of a resource are defined by the attributes of the root element,
<resource>.
Table2. Attributes of the <resource> element
Attribute Specifies Usage
providedBy The service provider that is used for Required for primary, lookup, and
data operations on this resource. system resources. A service provider
reference is required for resources
that are retrieved from the provider
application as independent entities.
The service provider specifies
whether data for the resource can be
updated, created, or deleted by the
consumer application. For the
primary resource, the service
provider also specifies which queries
are available to consumer
applications.
describedBy The shape document that defines the Required for primary, lookup, and
resource. system resources. The specifications
for these resources in the application
definition must conform to the shape
document definition.
name A unique name that is used for Required for all resources.
references to this resource in the
application definition.
pageSize The number of resource instances Required for primary, lookup, and
that can be retrieved at a time from system resources.
the provider application. If, during
query execution, the number of
matching resource instances exceeds
the page size value, the value is used
to break down the result set into
subsets that are retrieved in
successive calls.
additional Whether the resource is a lookup Required with a value of truefor all
Data resource. lookup resources.
isSystem Whether the resource is a system Required with a value of truefor all
resource. system resources.
The following example shows the attributes that define the primary resource,
workOrder, in the application definition for the Work Execution app:
<resource providedBy="/oslc/sp/WorkManagement"
describedBy="http://jazz.net/ns/ism/work/smarter_physical_infrastructure#WorkOrder"
name="workOrder"
pageSize="100"
[...]>
The following example shows the attributes that define a lookup data resource,
additionalasset, in the application definition for the Work Execution app:
<resource providedBy="/oslc/sp/AssetManagement"
describedBy="http://open-services.net/ns/asset#Asset"
name="additionalasset"
pageSize="1000"
additionalData="true">
4 Configuring Maximo Anywhere
The <resource> element is parent to the <attributes> element. This element
contains a list of attributes that specify the resource data that is used by the mobile
app. The attributes that are listed correspond to properties that are defined by the
resource shape document in the provider application.
Primary resource
The primary resource represents the top-level object in the work list record. The
primary resource can be a parent to one or more supporting resources. A supporting
resource represents a child object in the work list record. The primary resource can
have a one-to-one or a one-to-many relationship with a supporting resource. When
a one-to-many relationship exists between the primary and supporting resources,
the data for the supporting resource is rendered as a list of child objects in the
work list record.
For example, the work order is the primary resource in work list records for the
Work Execution app. The work order resource can be related to supporting
resources such as asset, location, task, and labor. A work order can have a single
main asset or location and multiple tasks and labor assignments. Tasks and labor
assignments are displayed as lists within the work order.
In the application definition, primary and supporting resources are defined as
separate entities. The primary resource has the following characteristics:
v References to the service provider and shape document for the primary resource
in the provider application.
v A list of the queries that are used during run time to retrieve work list records
from the server. The list is contained in the <queryBases> element.
v A page size value that specifies the maximum number of work list records that
can be retrieved in each request.
v Simple and complex attributes for the properties of the primary resource as
defined in the shape document. Simple attributes represent data that is local to
the primary resource. Complex attributes refer to supporting resources.
A supporting resource includes simple attributes for data that belongs to the
supporting resource but is used in the work list record. Supporting resources are
dependent on the primary resource to which they are related. Unlike the primary
resource, supporting resources are not retrieved independently from the provider
application and do not require references to a service provider and shape
document.
Lookup resources
During run time, users can change supporting data in the work list record in
accordance with business rules and application capabilities. Many changes involve
the use of a lookup control to reference and select data that is external to the work
list record. Examples of lookup data include the assets, tools, and materials that
can be added to a work order.
Users must download lookup data to make it available in the mobile app. Locally
stored lookup data can be refreshed be on demand.
Lookup objects are represented in the application definition as lookup resources. A
lookup resource has the following characteristics:
v An additionalData attribute with a value of true.
Configuring Maximo Anywhere 5
v References to the service provider and shape document for the lookup resource
in the provider application.
v A page size value that specifies the maximum number of records that can be
retrieved in each request.
v Simple attributes for the properties of the lookup resource as defined in the
shape document.
System resources
A system resource represents an object that is external to the work list record but is
required to support system operations in the mobile app. For example, the
following resources are classed as system resources for the Work Execution app:
v The domain value lists that are used to change work order status and other
work list record attributes.
v The labor and labor craft resources for the current user that are required for
labor reporting.
v Labor timer settings that are active in the provider application and are required
for local validation of labor transactions.
System data is automatically downloaded when a user first logs in to the
application. If the download fails, the user cannot log in. Locally stored system
data is refreshed whenever the user refreshes lookup data.
In the application definition, a system resource has an isSystem attribute with a
value of true. Other characteristics are the same as the characteristics of the lookup
resource.
Enabling the Anywhere Administration application
By default, the Anywhere Administration application is disabled. When you use
the Anywhere Administration application to modify mobile apps, you do not need
to rebuild and deploy the apps.
Before you begin
From Maximo Asset Management, in the System Properties application, specify the
host name value for the mxe.oslc.webappurl property. The mxe.oslc.webappurl
property defines the public URL to find the OSLC resources. The default URL is
http://localhost/maximo/oslc/.
About this task
You enable the Anywhere Administration application by setting the si.adminmode
property in the worklight.properties file. After the Anywhere Administration
application is enabled, you must load data into this application. You must load
data any time that you add data resources to the provided Maximo Anywhere
apps, remove data resources from the apps, or create custom apps.
You run an Ant script utility to load the data into the Anywhere Administration
application. The utility is named admin-config-loader.xml and is in the
Anywhere\MaximoAnywhere folder.
Data resources, such as provided queries and map settings, that are set in the
app.xml file are ignored in favor of any data resources set by using the Anywhere
Administration application.
6 Configuring Maximo Anywhere