IBM Maximo Anywhere Version 7 Release 6. Configuring Maximo Anywhere IBM

Transcription

1 IBM Maximo Anywhere Version 7 Release 6 Configuring Maximo Anywhere IBM

2 Note Before using this information and the product it supports, read the information in Notices on page 31. This edition applies to version 7, release 6, modification 0 of IBM Maximo Anywhere and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright IBM Corporation 2013, US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

3 Contents Configuring Maximo Anywhere Application definition files Data resources in the application definition Enabling the Anywhere Administration application. 6 Modifying apps with the Anywhere Administration application Defining work list queries Creating queries in Maximo Asset Management. 8 Creating OSLC resource queries Adding queries to mobile apps Configuring blind and non-blind counts Specifying criteria for retrieving lookup data Configuring page sizes for retrieving data Failure reporting implementation in Maximo Anywhere Configuring maps Map positioning information Service addresses Enabling the auto-locate cron task Cron task system properties Configuring access to a map service provider.. 19 Enabling the map view Adding maps to ios devices Activating GPS Configuring route lines Configuring zoom levels Enabling Real Signature for Maximo Anywhere mobile apps Recording signatures with Real Signature Activating bar code scans Connecting Bluetooth bar code scanners to mobile apps Enabling encryption of the local data store Changing the heartbeat interval Attachments properties Timeout properties Notices Trademarks Terms and conditions for product documentation.. 33 IBM Online Privacy Statement Copyright IBM Corp. 2013, 2016 iii

4 iv Configuring Maximo Anywhere

5 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,

6 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\maximoanywhere\apps\ AssetAudit\artifact install_home\maximoanywhere\apps\ AssetDataManager\artifact install_home\maximoanywhere\apps\ Inspection\artifact install_home\maximoanywhere\apps\ IssuesReturns\artifact install_home\maximoanywhere\apps\ PhysicalCount\artifact install_home\maximoanywhere\apps\ ServiceRequest\artifact install_home\maximoanywhere\apps\ TransfersReceiving\artifact install_home\maximoanywhere\apps\ WorkApproval\artifact install_home\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

7 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

8 <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=" 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=" name="additionalasset" pagesize="1000" additionaldata="true"> 4 Configuring Maximo Anywhere

9 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

10 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 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 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.

11 Procedure 1. From the worklight.properties file in the 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 ANYWHERE_INSPECTOR. 7. In the Applications tab, 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 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

12 Before you begin Enable the Anywhere Administration application. About this task 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 Data Work list queries Downloaded Maps 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. About this task 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

13 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

14 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 About this task 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 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

15 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. About this task 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 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

16 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=" 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. 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. About this task 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. 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 To create a blind count or change a non-blind count into a blind count: 1. In the app.xml file, create a local attribute for the count. 12 Configuring Maximo Anywhere

17 2. Add the local attribute to the list of query bases in the blind count section. To change the count from a blind count to a non-blind count: 3. Remove the local attribute for the count from the list of query bases in the blind count section of the app.xml 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. About this task 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. 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 " /> Configuring Maximo Anywhere 13

18 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 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 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. 14 Configuring Maximo Anywhere

19 About this task 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 download or refresh lookup data on mobile devices. The default page size for most lookup and system resources is By reducing the page size, you can improve the response time for the retrieval of data. By increasing the page size, you can reduce the number of requests that are issued by the application to retrieve the full result set. Procedure 1. In the MaximoAnywhere\apps\app_name\artifact directory, open the app.xml file. 2. In the data section of the file, update the value of the pagesize attribute for the resource or resources that you want to configure. pagesize is an attribute of the root element of the resource. 3. Save the file. 4. Build and deploy the application. Failure reporting implementation in Maximo Anywhere By default, the query that downloads failure data 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. To narrow the scope of the query for failure data, you can add a WHERE clause to the querybases element in the application definition file (app.xml). The criteria in the WHERE clause are resolved dynamically when lookup data is retrieved from the provider application. For example, you can download work orders with failure codes that are assigned to a specific organization. If the organization that is specified for work orders in Maximo Asset Management contains the word ORG A, then only the work orders for that organization are downloaded. To limit the records that are downloaded, add the following to the end of the querybases section: <whereclause clause="spi_wm:orgid= ORG A "/> In the application definition file, there are several querybases sections of code. The querybases section that you must modify is located within the following code: <resource providedby="/oslc/sp/smarterphysicalinfrastructure" describedby=" name="failurelistresource" pagesize="1000" additionaldata="true"> Configuring Maximo Anywhere 15

20 Configuring maps Mobile workers can use the map view in the Maximo Anywhere Work Execution application and the Maximo Anywhere Inspection application to check the geographical location of work orders. To make the map view available, you must prepare the Maximo Anywhere environment and configure the application. Map positioning information Positioning information is the geographical coordinate data that is used to determine the location of a work order and add a position marker to the map. When a work order in the enterprise system contains positioning information, such as a service address, that information is provided to the IBM Maximo Anywhere Work Execution and IBM Maximo Anywhere Inspection apps when the work order is downloaded. If work orders in the enterprise system do not have positioning information, you need to configure the information on the enterprise system. Coordinates or work order positioning information is downloaded from the map service provider to the enterprise system environment. Directions and a route to work orders on the mobile worker's current work list are available when the mobile device is configured with a map service provider. If your enterprise system includes IBM Maximo Spatial Asset Management, positioning information is obtained from work order objects that are linked to a map feature. If Maximo Spatial Asset Management is not in your environment, positioning information is obtained by using non-linked objects. A non-linked object is a work order object that is not linked to a map feature. Non-linked objects therefore provide static geographic coordinate data that you must manually add and store in the service address object. Work order objects that can contain positioning information are work order, service address, asset, and location. When Maximo Spatial Asset Management is available, positioning information is obtained by using linked objects. A linked object is an object in a work order that is linked to a map feature in the designated GIS. A linked object can be the work order object itself, or the associated service address, asset, or location. The link between the object and the map feature enables the auto-locate function to dynamically obtain geographic coordinate data from the GIS when the cron task runs. If you do not use Maximo Spatial Asset Management, positioning information comes from static geographic coordinate data that is added and stored in the service address object. The static geographic coordinate data must be manually added into the Service Address application in Maximo Asset Management. The static geographic coordinate data can also be bulk loaded or migrated into the Integration Framework application in Maximo Asset Management. For offline Esri maps, you need to set up the TPK files for the geographic areas of your organization s work orders. The service address coordinate system must match the coordinate system that is used to create the offline map. The auto-locate function determines the geographical location of a record by processing the available positioning information in a defined sequence. The sequence is work order linked object, work order X/Y coordinates, work order 16 Configuring Maximo Anywhere

21 linked service address, work order service address X/Y coordinates, work order linked asset, work order asset X/Y coordinates, work order linked location, and work order location X/Y coordinates. You schedule the automatic location of work orders by using the cron task, WoAutoLocateCronTask. The following diagram shows the flow of data between the Maximo Anywhere app on the mobile device, the enterprise system, and the map service provider (Esri ArcGIS server). To provide a route and directions, Maximo Anywhere must be configured to use a map service provider. Esri ArcGIS server Coordinates Directions Enterprise system Mobile device Cron task Maximo Anywhere app Data (OSLC) Maximo Anywhere map plugin (native code) MobileFirst Server Adapter Data (JSON over HTTP) Offline map (TPK file) Map service provider API (Esri Android SDK) Data is downloaded from the enterprise system environment by way of MobileFirst Server to the mobile device. The exchange of data is represented in the diagram by OSLC, between the enterprise system environment and the MobileFirst Server, and by JSON over HTTP, between the MobileFirst Server and the mobile device. Related tasks: Enabling the auto-locate cron task on page 18 Maximo Anywhere provides a cron task, WoAutoLocateCronTask, that is set up to run the auto-locate function. By default, the cron task is not enabled because map support is optional in Maximo Anywhere. If you enable map capabilities, you must enable the cron task. Related information: Automatic location search order process for work orders Service addresses Service addresses in the enterprise system can provide map positioning information. If you do not use Maximo Spatial Asset Management, you can use the Service Address application to provide positioning information. Configuring Maximo Anywhere 17

22 The Maximo Service Address application is licensed with Maximo Anywhere. If you have Maximo Spatial Asset Management, when you install Maximo Anywhere, the version of the Service Address application in Maximo Asset Management is upgraded to the Maximo Spatial Asset Management version. The upgraded version of the Service Address application supports linked objects that include map positioning information. The service address object in the Service Address application includes X/Y coordinate fields for positioning information. This positioning information can be manually added into the application. In addition, when Maximo Spatial Asset Management is installed and linked to the Esri ArcGIS server, the map feature linked objects can be used to obtain positioning information. The Service Address application can be configured with either latitude and longitude fields or X/Y coordinate fields. However, to support map capabilities in Maximo Anywhere, the application must be configured with X/Y coordinate fields. The service address coordinate system that is used for work orders and related objects must match the coordinate system that is used to create the offline maps (TPK files). In addition, the service address coordinate system must match the map that is set up in the Esri ArcGIS server. Enabling the auto-locate cron task Maximo Anywhere provides a cron task, WoAutoLocateCronTask, that is set up to run the auto-locate function. By default, the cron task is not enabled because map support is optional in Maximo Anywhere. If you enable map capabilities, you must enable the cron task. About this task The auto-locate function in Maximo Asset Management updates or adds positioning information to work orders. This positioning information is used in the Maximo Anywhere Work Execution and Maximo Anywhere Inspection apps to plot work order locations on the map view. The WoAutoLocateCronTask runs the auto-locate function. This cron task includes two cron task instances: v By default, the WoAutoLocateInstance instance selects work orders that have a scheduled or target start date that occurs within two days of the current time. Schedule this instance to run every 24 hours so that positioning information is updated or added to all work orders that are due to start within two days. v By default, the EmergentWoTask instance selects work orders that were approved or started in the 5-minute period before the current time. Schedule this instance with the frequency that work orders might be approved or started so that positioning information is updated or added to these work orders. You can change the work order selection criteria for both cron task instances by modifying the WO_WHERECLAUSE parameter. For the EmergentWoTask instance, you can modify the EMERG_WO_TIME parameter. Procedure 1. In the Cron Task Setup application in Maximo Asset Management, open the WoAutoLocateCronTask record. 2. Define the settings for each cron task instance: 18 Configuring Maximo Anywhere

23 a. Set a schedule for the cron task instance. At a minimum, the value of the EMERG_WO_TIME parameter should equal the number of minutes set in the schedule. This parameter acquires all work orders that were modified from the time the schedule runs, to twice the value of this parameter. For example, if this parameter is set to 5 minutes, all work orders that were modified in the previous 10 minutes are acquired. b. Specify a user with the necessary privileges, such as maxadmin. The user must have access for the actions that the cron task performs. c. Select the Active and Keep History check boxes. d. In the Max Number of History Records field, enter e. Optional: To change the criteria for work order selection, update the WO_WHERECLAUSE parameter. 3. From the Select Action menu, select Reload Request. 4. Select the cron task, and click OK. Cron task system properties The WoAutoLocateCronTask cron task instances have two associated system properties. To change the value of a property, use the System Properties application of Maximo Asset Management. Table 3. Cron task system properties Property Description Default value mxe.plussng.max.recs.returned. arcgis.server mxe.plussng.cron.max.autoloc. grp.objects The maximum number of records that are returned by the Esri ArcGIS server at one time. The value is the lowest number of records that is allowed for a client to receive from any map services that are used by Maximo Spatial Asset Management in the Esri ArcGIS server. This system property applies only if Maximo Spatial Asset Management is deployed to the enterprise system environment. The maximum number of work orders with location objects to be processed at one time. The value limits the query that is set up for the auto-locate cron task instances if the query returns large numbers of work orders with location objects Configuring access to a map service provider A map service provider is required for providing routing and driving directions to work orders in the map view. The configuration information is valid for all apps that include the map view and that are deployed in the current environment. Before you begin Both the mobile device and the Esri ArcGIS server should be configured for secure communication. Configuring Maximo Anywhere 19

24 About this task Information that is used to access the Esri ArcGIS server is not added to the worklight.properties file by default because map support in Maximo Anywhere is optional. You configure this authentication information by editing this file. When an app with the map view is started, information is transferred to the app so that the mobile workers can use the routing service. Procedure 1. From the maximoanywhere_home\maximoanywhere\server\conf directory, edit the worklight.properties file and set the following properties: Property si.map.esri.authentication.isenabled si.map.esri.username si.map.esri.password si.map.esri.routeservice Description Enables authentication to the Esri ArcGIS server. Set this property to 1 to enable authentication. The user name that is used to access the routing service on the Esri ArcGIS server. The password that is used to access the routing service on the Esri ArcGIS server. The secure URL of the routing service on the Esri ArcGIS server. Set this property to, for example, rest/services/world/route/naserver/ Route_World 2. Save and close the file. 3. Optional: Encrypt the worklight.properties file by using the encrypt.bat file encryption process. The si.map.esri.password.enc property contains an encryption value similar to HhMEhpY3f6F6rlJQ17qwbw\=\=. 4. Build and deploy the application. 5. Restart MobileFirst Server. Related concepts: Deploying applications to the server Related information: Android developer help Esri ArcGIS server help Storing properties in encrypted format Enabling the map view The map view provides mobile workers with the geographical location of work orders in their current work list. Before mobile workers can get directions in the Work Execution and Inspection apps, the map view must be enabled. Before you begin For the Esri map service provider, you must have a license from Esri. For offline maps: v You must create maps that are compatible with and supported by the Esri map service provider. 20 Configuring Maximo Anywhere