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 Application definition files.......... 1 Data resources in the application definition.... 3 Enabling the Anywhere Administration application. 6 Modifying apps with the Anywhere Administration application............... 7 Defining work list queries.......... 8 Creating queries in Maximo Asset Management. 8 Creating OSLC resource queries....... 9 Adding queries to mobile apps....... 10 Enabling push notifications for Maximo Anywhere mobile apps.............. 12 Configuring blind and non-blind counts..... 17 Specifying criteria for retrieving lookup data... 18 Enabling the ability to refresh any changes to the lookup or system data........... 20 Configuring page sizes for retrieving data.... 20 Configuring administrator control of undo actions on work order transactions......... 21 Failure reporting implementation in Maximo Anywhere............... 21 Configuring maps............ 22 Configuring IBM Maximo Spatial Asset Management maps........... 22 Enabling the auto-locate cron task..... 22 Enabling the IBM Maximo Spatial Asset Management map view........ 23 Locating devices on a map....... 24 Configuring Esri maps.......... 25 Map positioning information...... 25 Enabling the auto-locate cron task..... 27 Configuring access to a map service provider 29 Enabling the Esri map view....... 30 Activating GPS............ 32 Configuring route lines......... 33 Configuring zoom levels......... 34 Recording and storing signatures....... 34 Enabling Real Signature for Maximo Anywhere mobile apps............. 35 Recording signatures by using Real Signature.. 36 Activating bar code scans.......... 36 Connecting Bluetooth bar code and RFID scanners to mobile apps............. 37 Enabling encryption of the local data store.... 37 Changing the heartbeat interval....... 38 Attachments properties.......... 38 Timeout properties............ 39 Notices.............. 41 Trademarks.............. 43 Terms and conditions for product documentation.. 43 IBM Online Privacy Statement........ 44 Copyright IBM Corp. 2013, 2017 iii
iv Configuring Maximo Anywhere
Configuring Maximo Anywhere Application definition files 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. 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. Table 1. Directories for the app.xml files App Maximo Anywhere Asset Audit app Maximo Anywhere Asset Data Manager app Maximo Anywhere Inspection app Maximo Anywhere Issues and Returns app Maximo Anywhere Physical Count app Maximo Anywhere Service Request app Maximo Anywhere Transfers and Receiving app Maximo Anywhere Work Approval app Maximo Anywhere Work Execution app Directory install_home\anywhere\maximoanywhere\ apps\assetaudit\artifact install_home\anywhere\maximoanywhere\ apps\assetdatamanager\artifact install_home\anywhere\maximoanywhere\ apps\inspection\artifact install_home\anywhere\maximoanywhere\ apps\issuesreturns\artifact install_home\anywhere\maximoanywhere\ apps\physicalcount\artifact install_home\anywhere\maximoanywhere\ apps\servicerequest\artifact install_home\anywhere\maximoanywhere\ apps\transfersreceiving\artifact install_home\anywhere\maximoanywhere\ apps\workapproval\artifact 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>. Table 2. Attributes of the <resource> element Attribute Specifies Usage providedby describedby name pagesize additional Data issystem The service provider that is used for data operations on this resource. The shape document that defines the resource. A unique name that is used for references to this resource in the application definition. The number of resource instances that can be retrieved at a time from 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. Whether the resource is a lookup resource. Whether the resource is a system resource. Required for primary, lookup, and 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. Required for primary, lookup, and system resources. The specifications for these resources in the application definition must conform to the shape document definition. Required for all resources. Required for primary, lookup, and system resources. Required with a value of true for all lookup resources. Required with a value of true for all 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 6 Configuring Maximo Anywhere 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/. 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.
Procedure 1. From the worklight.properties file in the Anywhere\MaximoAnywhere\server\ conf folder, locate the si.adminmode property and set this property to true. 2. Run the build all command, which is build.cmd on Windows or build.sh on UNIX and Linux systems. The.apk or.ipa artifact file is generated, and all distributable files for the Maximo Anywhere project are deployed to MobileFirst Server. 3. Deploy the project WAR file to MobileFirst Server. a. From the Server Configuration Tool, select Replace the project WAR file of a deployed runtime. b. Complete the steps in the wizard. 4. Optional: To run the import utility in a development environment, specify the user name and password as arguments for the file. a. In MobileFirst Studio, add the admin-config-loader.xml Ant file to the Ant view. b. Right-click on the admin-config-loader.xml Ant file and select Run as > Ant Build. c. On the Main tab, add the user name and password for the adapter in the Arguments field. -Dadapter.connection.user=<user_name> -Dadapter.connection.password=<password> 5. Load data into the Anywhere Administration application. Environment In a development environment in MobileFirst Studio In a production environment Action Run the admin-config-loader.xml file from the Ant view. Run this command: ant -f admin-config-loader.xml allapps The allapps parameter searches all the application folders for the provided Maximo Anywhere apps and any apps that you created. 6. From Maximo Asset Management, in the Security Groups application, open each of the security groups associated with the Maximo Anywhere apps, for example, ANYWHERE_INSPECTOR. 7. In the Applications tab for each of the security groups, find the Anywhere Administration application and grant rights to it. 8. Access the Anywhere Administration application from the Integration module within Maximo Asset Management. Related concepts: Maximo Anywhere security groups Related information: MobileFirst Server Configuration Tool Modifying apps with the Anywhere Administration application When you use the Anywhere Administration application to modify mobile apps, you do not need to rebuild and deploy the apps. When you define the group that can see the modifications to the apps, different users can see different types of data. Configuring Maximo Anywhere 7
Before you begin Enable the Anywhere Administration application. When you define data resources, such as work list queries and map settings, in the Anywhere Administration application, these resources override any provided resources that are set in the app.xml file. Procedure 1. Access the Anywhere Administration application from the Integration module within Maximo Asset Management and select the Maximo Anywhere app that you want to modify. 2. Select the tab for the type of data that you are changing: Tab List Data Lookup Data Settings Notification Events Data Work list queries Downloaded Maps Push notifications Defining work list queries 3. Optional: To set the group for a data resource, in the row for that resource, select the Detail Menu icon, and pick a group from the list. 4. To create a new query, click New Row and create a query. To modify an existing query, select the Detail Menu icons for that row, and pick new values for the query. 5. Optional: To see a list of all the global properties that can be modified for the Maximo Anywhere mobile apps, click Anywhere Global Properties. Group settings are not enabled for these properties. 6. On your mobile device, log out of the modified app and then log back in to it again to see the configuration changes in that app. The work list queries that you define for a mobile app determine which records can be retrieved from the server by mobile users. You create custom queries in Maximo Asset Management. You implement these queries in the mobile app by updating the application definition and deploying a new application version. You can also implement these queries by using the Anywhere Administration application if it is enabled. Creating queries in Maximo Asset Management When you create queries in Maximo Asset Management, you specify search criteria that suit the requirements of the target user groups in Maximo Anywhere. You create work list queries in the Maximo application that authorizes access to the primary resource for the mobile app. The authorizing application must be registered with the object structure for the primary resource. For example, the primary resource in the Maximo Anywhere Work Execution app is the work order. In Maximo Asset Management, the Work Order Tracking application is registered 8 Configuring Maximo Anywhere
as the authorizing application for the oslcwodetail object structure and work order resource. Therefore, you create queries for the Work Execution app in the Work Order Tracking application. The queries that you create in the Maximo application must be saved and marked public. Public queries are automatically added to the service provider that manages the associated resource data. These queries are implemented and used by consumers such as mobile applications to retrieve data from the provider application. The search criteria that you define for a query determine the search results that are returned during run time. The actual result set for individual users can be different depending on their access rights in Maximo Asset Management. For example, a user belongs to a security group that is authorized to see work orders for the Site A, but not Site B. When this user runs a query in the app to retrieve all work orders in the preventive maintenance backlog, work orders for Site A, but not for Site B, are downloaded to the device. The search criteria can include constants that are resolved dynamically when the query is executed in Maximo Asset Management. The result set is filtered by the value that is returned for the resolved constant. For example, the default query, WORKIOWN, for the Work Execution app includes a constant, :USER. When the query is executed, this constant is resolved to return all work orders that are owned by the current user. Procedure 1. In Maximo Asset Management, open the application that authorizes access to the primary resource for the mobile application. 2. On the List tab, click Advanced Search, use one of the available options to specify the search criteria, and click Find. Verify that the query returns the expected search results. 3. Click Save Query and specify a name that uniquely identifies the query. The query name cannot include any spaces. 4. Select Public. 5. Click OK. What to do next Use the query name that you specified in Maximo Asset Management to add the query to the application definition for the mobile application. Creating OSLC resource queries In Maximo Asset Management, an OSLC resource can be associated with an application through the object structure. The public queries that you create are added to the service provider as query capabilities for the resource. You can use the defined queries to access the OSLC resource. If you support multiple versions of a Maximo application that uses the same resource, you can define the resource queries for each version of the application. Before you begin You can add queries for the following apps: v Asset Audit v Asset Data Manager Configuring Maximo Anywhere 9
v Inspection v Service Request v Work Approval v Work Execution You cannot add queries for the following apps: v Issues and Returns v Physical Count v Transfers and Receiving You can enable resource queries from a saved query of an application or by defining a query by using an automation script. Procedure 1. In the OSLC Resources application, select the OSLC resource. 2. From the Select Action menu, select Resource Query Definition. 3. Specify the query for the resource. Query For a query that is saved in the application For a query that is created from an automated script Action Specify the application and the query or copy all public queries that are associated with the application. Specify the name of the query script. 4. Specify the unique URI name that is used by the query and save the record. 5. 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/. 6. Import the updated OSLC resource from Maximo Asset Management into Maximo Anywhere. The OSLC resource is imported to Resource Description Framework (RDF) files. What to do next Add the OSLC resource query and URI to the app.xml file for the mobile app. Related information: Importing OSLC resources to Maximo Anywhere Adding queries to mobile apps To enable mobile users to retrieve work list records from the server, you must add at least one query to each mobile app. You add queries to a mobile app by including them in the application definition file. You can also add queries by using the Anywhere Administration application if it is enabled. Before you begin You can add queries for the following apps: v Asset Audit 10 Configuring Maximo Anywhere
v Asset Data Manager v Inspection v Service Request v Work Approval v Work Execution You cannot add queries for the following apps: v Issues and Returns v Physical Count v Transfers and Receiving The queries that you want to implement in the mobile application must be saved as public queries in Maximo Asset Management. In the application definition, you add queries to the specifications for the work list view and the primary resource. Each query must correspond to, and have the same name as, a public query in Maximo Asset Management. The public query, in turn, corresponds to a query in the service provider for the primary resource. Each application definition includes three system queries, Records Created Locally, Records with Errors, and Search Results, that are used for system functions in the mobile app. You must not remove or modify the code for these queries. Procedure 1. In the Anywhere\MaximoAnywhere\apps\app_name\artifact directory, open the app.xml file with an XML editor. 2. Add a query to the work list view. The work list view is the first view that is defined in the UI section of the application definition. a. In the <queries> element for the work list view, add a child element called <query>. b. Use the querybase attribute to specify the name of the public query in Maximo Asset Management. The query name is case sensitive. c. Use the label attribute to specify the query label that is displayed in the work list menu. d. Optional: To define this query as the default query for the work list view, specify the query label as the value of the label attribute for the parent <view> element. In this example, three queries are added to the work list view for the Work Execution app: <view id="workexecution.workitemsview" label="work I Own" saveonshow="true" <queries resource="workorder"> <query label="work I Own" querybase name="workiown"> <query label="assigned to My Labor" querybase name="workformylabor"> <query label="work Assigned to My Crew" querybase name="workformycrew"> <...> </queries> <...> </view> 3. Add the query that you specified in step 2 to the primary resource. The primary resource is the first resource that is defined in the data section of the application definition. Configuring Maximo Anywhere 11
a. In the <querybases> element for the primary resource, add a child element called querybase. b. Use the name attribute to specify the name of the public query in Maximo. The query name is case sensitive. c. Use the queryuri attribute to specify how to retrieve the query records from Maximo. In this example, three queries are added to the primary resource, workorder, for the Work Execution app: <resource providedby="/oslc/sp/workmanagement" describedby="http://jazz.net/ns/ism/work/ smarter_physical_infrastucture#workorder" name="workorder" pagesize="100" class="application.business.workorderobject"> <...> <querybases> <querybase name="workiown" queryuri="/oslc/os/oslcwodetail?savedquery=workiown"> <querybase name="workformylabor" queryuri="/oslc/os/oslcwodetail?savedquery=workformylabor"> <querybase name="workformycrew" queryuri="/oslc/os/oslcwodetail?savedquery=workformycrew"> </querybases> <...> </resource> 4. Save the file. 5. Build and deploy the application. What to do next Log in to the application and check that the queries that you added appear in the work list menu. Verify that the result set is the same when you run the query in the provider application and in the mobile app. Related concepts: Data resources in the application definition on page 3 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. Enabling push notifications for Maximo Anywhere mobile apps By using push notifications, you can notify workers about assigned work, such as emergency work orders. Push notifications are enabled, by default, on both the Maximo Anywhere Inspection app and the Maximo Anywhere Work Execution app. You can enable push notifications for both Android and ios devices. Before you begin Maximo Asset Management 7.6.0.4 or greater with the latest interim fix is required for push notifications. In Maximo Asset Management, ensure that the Java Message Service (JMS) queues are configured for either your WebLogic Server or your WebSphere Application Server. In Maximo Asset Management, in Endpoints, configure the URL property of the Anywhere Inspection End Point and the Anywhere Work Execution End Point to use the MobileFirst host name and port number. By default, the URL property is configured to point to a MobileFirst server at local host:1080, but you must change this property to be the actual host name and port number of the MobileFirst server. 12 Configuring Maximo Anywhere
In the MobileFirst adapter, ensure that an event source is declared. Android devices must be registered with Google and have internet connectivity to access Google services. ios devices must be registered with Apple and have internet connectivity to access Apple services. On ios, to send push notifications, the following sandbox servers must be accessible from MobileFirst Server: v gateway.sandbox.push.apple.com:2195 v feedback.sandbox.push.apple.com:2196 On ios, to send push notifications, the following production servers must be accessible from MobileFirst Server: v gateway.push.apple.com:2195 v Feedback.push.apple.com:2196 v 1-courier.push.apple.com 5223 On Android, the following steps are required if your organization has a firewall that restricts the traffic to or from the internet: v Configure the firewall to allow connectivity with Google Cloud Messaging (GCM) in order for your GCM client apps to receive messages. The ports to open are 5228, 5229, and 5230. GCM typically uses only 5228, but it sometimes uses 5229 and 5230. GCM does not provide a specific IP address. You must allow your firewall to accept outgoing connections to all IP addresses contained in the IP blocks listed in Google ASN of 15169. For more information, see Implementing an HTTP Connection Server. v Ensure that your firewall accepts outgoing connections from MobileFirst Server to android.googleapis.com on port 443. For Maximo Asset Management Server, the Maximo Anywhere push notification rules are configured as part of Maximo Asset Management, which uses Maximo Integration Framework, endpoints, and JMS services to push notifications to MobileFirst Server. The Maximo Asset Management Server must be able to communicate with MobileFirst Server on port 443, port 80, or the MobileFirst configuration port. For information about MobileFirst push notification architecture, see the MobileFirst Knowledge Center. Push notification is the ability of a mobile device to receive messages that are pushed from a server. Notifications are received regardless of whether the app is running. Each app that is enabled for push notifications has an adapter for this capability. In Maximo Anywhere, the notifications are in two forms: v A notification that allows the user to launch-in-context to the specific record v An alert that sends information to a user Procedure 1. To enable push notifications in Maximo Asset Management, on the Maximo Asset Management administrative workstation, in the install_home\7600\ maximo\applications\maximo\mboejb\ejbmodule\meta-inf directory, uncomment the NOTF MDB text blocks in the following files: Configuring Maximo Anywhere 13
v ejb-jar-notf.xml v weblogic-ejb-jar-notf.xml v ibm-ejb-jar-bnd-notf.xmi 2. Rename the following files: File name ejb-jar.xml weblogic-ejb.xml ibm-ejb-jar-bnd.xmi New file name ejb-jar-old.xml weblogic-ejb-jar-old.xml ibm-ejb-jar-bnd-old.xmi 3. Rename the following files: File name ejb-jar-notf.xml weblogic-ejb-jar-notf.xml ibm-ejb-jar-bnd_notf.xmi New file name ejb-jar.xml weblogic-ejb-jar.xml ibm-ejb-jar-bnd.xmi 4. Set up the Java Message Service (JMS). 14 Configuring Maximo Anywhere
Option In WebSphere Application Server environments Description Add a logical address for the notification bus destination queue (NOTFBD) in the service integration bus: 1. In the WebSphere Application Server Network Deployment administrative console, click Service Integration > Buses. 2. Click intjmsbus and then, under Destination resources, click Destination. 3. Click New, ensure that the Queue option is selected as the destination type, and click Next. 4. In the Identifier field, enter NOTFBD and, in the Description field, enter Notification Queue, then click Next. For the identifier, you must use this value and it must contain only uppercase letters. 5. In the Bus Member drop-down list, choose Node=ctgNode01:Server=MXServer. 6. Click Next, review your selections, and click Finish to complete the creation of the NOTFBD bus destination queue. 7. Click Buses > intjmsbus > Destinations and click NOTFBD. 8. Select None as the exception destination value, verify that Keep count of failed deliveries per message is enabled, and click Apply and then Save. Create the NOTF JMS queue: 1. From the WebSphere Application Server Network Deployment administrative console, click Resources > JMS > Queues. 2. In the Scope drop-down list, choose Node=ctgNode01:Server=MXServer and click New. 3. Verify that the Default Messaging Provider option is selected and click OK. 4. In the Name field, enter NOTF. This value must contain only uppercase letters. 5. In the JNDI name field, enter jms/maximo/int/queues/notf. 6. In the Bus name field, enter intjmsbus. 7. In the Queue name field, enter NOTFBD and click OK and then Save. Enter the activation specifications: 1. From the WebSphere Application Server Network Deployment administrative console, click Resources > JMS > Activation specifications. 2. In the Scope field, enter Cell=ctgCell01, Node=ctgNode01, and Server=WLServer, and click New. 3. Verify that Default Messaging Provider is selected and click OK. 4. In the Name field, enter notfact. 5. In the JNDI name field, enter notfact. 6. In the Destination JNDI name field, enter jms/maximo/int/queues/notf. 7. In the Bus name field, enter intjmsbus. 8. In the Maximum batch size field, enter 10. 9. In the Maximum concurrent MDB invocations per endpoint field, enter 5 and click OK and then Save. Configuring Maximo Anywhere 15
Option In WebLogic Server environments Description 1. In the WebLogic Server Administration Console, go to Services > Persistent Stores, and create the following file stores: v sqinstore v cqinstore v sqoutstore For each file store, specify an existing directory in the system, for example, c:\jms, and set each target value to AdminServer. 2. Go to Services > Messaging > JMS Servers and create three JMS Servers and set each target value to AdminServer: v sqinserver v cqinserver v sqoutserver For the sqinserver JMS Server, enter sqinstore for the persistent store. For the cqinserver JMS Server, enter cqinstore for the persistent store. For the sqoutserver JMS Server, specify sqoutstore for the persistent store. 3. Go to Services > Messaging > JMS Modules, create a JMS module named intjmsmodule, and set the descriptor file name value to jms/intsmsmodule-jms.xml. 4. Create four Queue type resources for the intjmsmodule module: v notf v sqin v sqout v cqin For the notf queue, specify jms/maximo/int/queues/notf for the JNDI name, create a new subdeployment with the same name, notf, and select notf as the target. For the sqin module, specify jms/maximo/int/queues/sqin for the JNDI name, create a new subdeployment with the same name, sqin, and select sqinserver for the target. For the sqout module, specify jms/maximo/int/queues/sqout for the JNDI name, create a new subdeployment with the same name, sqout, and select sqoutserver for the target. For the cqin module, specify jms/maximo/int/queues/cqin for the JNDI name, create a new subdeployment with the same name, cqin, and select cqinserver for the target. 5. Create a Connection Factory type resource named intjmsconfact. For the intjmsconfact resource, specify jms/maximo/int/cf/ intcf for the JNDI name. Go to Advanced Targeting and create a new subdeployment with the same name, intjmsconfact. Select AdminServer, sqinserver, sqoutserver, cqinserver as the targets. Set the XA option for the connection factory and then activate all the changes. 6. Restart WebLogic Server. 16 Configuring Maximo Anywhere
5. For Maximo Asset Management 7.6.x, use the Tivoli 's process automation engine configuration tool and select Update Database and Build and Deploy Application EAR files. For Maximo Asset Management 7.5.x, run the buildmaximoear.cmd command. 6. In the maximoanywhere_home\anywhere\maximoanywhere directory, edit the build.properties file with the appropriate values for all of your apps in which you are enabling push notifications. Specify the android.pushsender.key and android.senderid properties for Android devices and the ios.pushsender.password property for ios devices. These values must be the same for all of the apps that use push notifications. Save and close the file. 7. On ios, obtain an appn-certificate-production.p12 file for all of your apps in which you are enabling push notifications from the Apple Push Certificates Portal. Put a copy of each appn-certificate-production.p12 file in the maximoanywhere_home\anywhere\maximoanywhere\apps\app_name\certificate directory. 8. In the maximoanywhere_home\anywhere\maximoanywhere\apps\app_name directory, edit the app-feature.properties file for each app in which you are enabling push notifications. Locate the pushnotification.enabled property, and set this property to true. Save and close the file. 9. Run the build clean update-platform option of the build.cmd command on Windows or the build.sh command on UNIX and Linux systems. 10. Redeploy the project WAR file to MobileFirst Server. a. From the Server Configuration Tool, select Replace the project WAR file of a deployed runtime. b. Complete the steps in the wizard. 11. Run the build all option of the build.cmd command on Windows or the build.sh command on UNIX and Linux systems. Related tasks: Modifying apps with the Anywhere Administration application on page 7 When you use the Anywhere Administration application to modify mobile apps, you do not need to rebuild and deploy the apps. When you define the group that can see the modifications to the apps, different users can see different types of data. 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. Configuring blind and non-blind counts Counts for the Physical Count app are either blind or non-blind. Blind counts are the default. To create blind counts or change non-blind counts into blind counts, you edit the app.xml file. You can also create these counts by using the Anywhere Administration application if it is enabled. In a blind count, the app requires a numeric value for the item's balance that corresponds to what is in the inventory. In a non-blind count, the app requires a numeric value only if the current balance for that item differs from what is in the inventory. Configuring Maximo Anywhere 17
If the query base is not defined in the blindcountquerybases section of the app.xml file, then the count is a non-blind count. Procedure 1. To create a blind count, in the app.xml file, create a local attribute for the count. 2. Add the local attribute to the list of query bases in the blind count section. 3. To change the count from a blind count to a non-blind count, in the app.xml file, remove the local attribute for the count. Find the local attribute in the list of query bases in the blind count section of the file. Example The following example of a blind count section of an app.xml file includes a list of blind count query bases: <!-- BlindCount QueryBases --> <resource name="blindcountquerybases"> <attributes> <localattribute name="getcentralstoreroom" datatype="boolean" /> <localattribute name="getatlantastoreroom" datatype="boolean" /> </attributes> <whereclause /> </resource> 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. Modifying apps with the Anywhere Administration application on page 7 When you use the Anywhere Administration application to modify mobile apps, you do not need to rebuild and deploy the apps. When you define the group that can see the modifications to the apps, different users can see different types of data. Specifying criteria for retrieving lookup data To narrow the scope of the query for a lookup resource, you can add a WHERE clause to the resource in the application definition file. You can also add these WHERE clauses by using the Anywhere Administration application if it is enabled. The criteria in the WHERE clause are resolved dynamically when lookup data is retrieved from the provider application. By default, the query for a lookup resource retrieves all records, or instances of the resource, that are available in the provider application. Depending on the requirements of your mobile app users, you might want to filter the result set to match custom criteria. You specify those criteria by adding a WHERE clause to the lookup resource in the application definition file. The application definition file for a mobile app can include predefined WHERE clauses for lookup and system resources. The criteria that are expressed in a predefined WHERE clause are required by the mobile app to support system operations and must not be modified. However, you can add additional criteria to predefined WHERE clauses by using the and operator to add custom criteria. 18 Configuring Maximo Anywhere
Maximo Anywhere supports the OSLC WHERE clause. The criteria in an OSLC WHERE clause have a standard format that comprises an attribute, an operator, and a constant. For example, the following WHERE clause can be added to the additionallocations lookup resource to retrieve locations in SITE A only: <whereclause clause="spi:siteid= SITE A " /> The where clause includes the following items: siteid An attribute of the additionallocations lookup resource. = A comparison operator that expresses equality. No spaces are allowed before or after comparison operators. SITE A A constant that expresses the site value criteria for matching location records. The criteria in a WHERE clause are typically based on attributes of the lookup resource to which the WHERE clause applies. However, a WHERE clause can also include criteria that are based on system resource attributes. For example, the following WHERE clause finds the mylaborcraftrate resource for the labor record that is associated with the current user. The labor record for the current user is given as [${mylabor.laborcode}], where laborcode is an attribute of the mylabor system resource. spi:defaultcraft is an attribute of the mylaborcraftrate system resource: <whereclause clause="spi:laborcode in [${mylabor.laborcode}] and spi:defaultcraft=1" /> You must not create circular references in WHERE clauses that use attributes from other resources. For example, if the WHERE clause for resource A uses an attribute from resource B, the where clause for resource B must not use an attribute from resource A. The application XSD cannot validate the content of the <whereclause> element. If you add WHERE clauses to the lookup resources in an application definition file, you must test the updated runtime application before you deploy it to a production environment. Procedure 1. In the Anywhere\MaximoAnywhere\apps\app_name\artifact directory, open the app.xml file. In the data section of the file, locate the resource that you want to configure. 2. In the <whereclause> element, specify the criteria as the value of the clause attribute and save the file. 3. Build and deploy the application. 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. Modifying apps with the Anywhere Administration application on page 7 When you use the Anywhere Administration application to modify mobile apps, you do not need to rebuild and deploy the apps. When you define the group that can see the modifications to the apps, different users can see different types of data. Configuring Maximo Anywhere 19
Enabling the ability to refresh any changes to the lookup or system data You can enable refresh of any data changes rather than having to refresh the complete set of lookup or system data. To enable the ability to refresh any changes to the lookup or system data, you specify a value for each of the following global properties: Lookup.data.delta.support By default, this property is set to true, which enables refresh of only the changes to the lookup data. Specify false to disable this function. Lookup.data.delta.autorefresh By default, this property is set to true, which enables automatic refresh of only the changes to the lookup data. Specify false to disable this function. Lookup.data.delta.autorefresh.numbers.retry By default this property is set to 3. If the default value is used, the notification to refresh the data is sent three times. After three times, refresh is disabled until the next session. System.data.delta.support By default, this property is set to true, which enables refresh of only the changes to the system data. Specify false to disable this function. Procedure 1. In Maximo Asset Management, from the Integration module, open the Anywhere Administration application and click Anywhere Global Properties. 2. Set the Lookup.data.delta.support, Lookup.data.delta.autorefresh, and System.data.delta.support properties to true. 3. Set the number of auto refresh tries for the Lookup.data.delta.autorefresh.numbers.retry property. 4. On your mobile device, log out of the modified app and then log back in to see the configuration changes in that app. Configuring page sizes for retrieving data To increase or reduce the number of records that are retrieved from the server at a time, you can configure the page size for primary, lookup, and system resources. The page size of a data resource in the application definition file defines the number of records that are retrieved from the server at a time. If the size of the result set exceeds the page size value, the result set is divided into subsets that are retrieved as separate pages in successive requests. You can specify different values for individual resources: v The page size for the primary resource determines the number of work list records that can be retrieved in a results page when users select a work list query in a mobile app. The default page size for primary resources is 100. v The page size for a lookup or system resource determines the number of records that can be retrieved in a results page for that resource type when users 20 Configuring Maximo Anywhere