IBM Maximo Anywhere Version 7 Release 6
Planning, installation, and deployment
IBM Note Before using this information and the product it supports, read the information in “Notices” on page 71.
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
Chapter 1. Planning to deploy Maximo Maximo Anywhere security groups in Maximo Anywhere ...... 1 Asset Management ...... 38 System requirements for Maximo Anywhere, Enabling Maximo Asset Management MobileFirst Server, and MobileFirst Studio .... 1 applications for maps and labor reporting ... 40 System architecture and components ...... 3 Maximo Asset Management system options that Deployment topologies ...... 6 affect mobile apps ...... 40 Development environment...... 7 Single-server deployment of Maximo Anywhere Chapter 3. Updating the Maximo and MobileFirst Server ...... 8 Anywhere components...... 43 Multiple-server deployment of Maximo Anywhere Updating the required components ...... 43 and MobileFirst Server ...... 9 Updating MobileFirst Server...... 44 Installation overview ...... 12 Updating the Maximo Anywhere build environment 44 Installation planning worksheet ...... 14 Updating the MaximoAnywhere project in Installation checklist for Maximo Anywhere ... 15 MobileFirst Studio ...... 45 What's new in application definitions in 7.6.2 ... 46 Chapter 2. Installing the Maximo Anywhere components...... 19 Chapter 4. Installing help locally.... 49 Installing the Maximo Asset Management required Installing help ...... 49 components ...... 19 IBM Knowledge Center configuration ..... 50 Automatically updating the database and Help components ...... 51 building and deploying the EAR file ..... 20 Maximo Asset Management documentation library 52 Manually updating the database and building and deploying the EAR file ...... 20 Chapter 5. Building and deploying Updating the database and building the EAR Maximo Anywhere apps ...... 55 file ...... 20 Application deployment process for Maximo Deploying the EAR file on WebSphere Anywhere apps ...... 55 Application Server ...... 21 Deploying Maximo Anywhere apps to MobileFirst Deploying the EAR file on WebLogic Server 21 Server ...... 57 Installing MobileFirst Server ...... 21 Deploying apps from the command line to Installing MobileFirst Server by using the WebSphere Application Server ...... 57 installation program ...... 22 Deploying apps by using MobileFirst Studio .. 59 Installing the MobileFirst Server Administration Properties files ...... 60 Services ...... 23 Maximo Anywhere directory structure .... 62 Setting the Java heap size on the JVM for Configuring MySQL Database ...... 62 WebSphere Application Server or WebSphere Adding digital signatures to Maximo Anywhere Application Server Liberty ...... 24 apps...... 63 Preparing the Maximo Anywhere environment .. 25 Deploying apps to a secure server ...... 64 Installing the Android development tools ... 25 Installing Maximo Anywhere apps on mobile Installing the iOS development tools ..... 27 devices ...... 64 Installing the Windows development tools ... 29 Installing Maximo Anywhere apps on Windows Installing Maximo Anywhere ...... 30 devices ...... 65 Creating a MobileFirst runtime environment ... 31 Testing apps ...... 66 Installing an integrated development environment 32 Setting up the Android emulator ...... 66 Silent mode: Installing Maximo Anywhere .... 34 Recording a response file for silent installation . 34 Chapter 6. Uninstalling Maximo Installing the required components in silent mode ...... 34 Anywhere, MobileFirst Server, and Installing Installation Manager in silent mode .. 36 MobileFirst Studio ...... 69 Parameters for silent mode installation ... 36 Installing Maximo Anywhere in silent mode .. 37 Notices ...... 71 Setting up Maximo Asset Management for Maximo Trademarks ...... 73 Anywhere ...... 37 Terms and conditions for product documentation.. 73 Adding users to the Maximo Anywhere security IBM Online Privacy Statement ...... 74 groups ...... 38
© Copyright IBM Corp. 2013, 2017 iii iv Planning, installation, and deployment Chapter 1. Planning to deploy Maximo Anywhere
IBM® Maximo Anywhere must be deployed with selected IBM MobileFirst Platform Foundation components to an enterprise system that includes Open Services for Lifecycle Collaboration (OSLC) provider capabilities.
The installation of Maximo Anywhere involves deploying components that are specific to Maximo Anywhere and other components that are specific to MobileFirst.
During the Maximo Anywhere installation, you must perform tasks that are outlined in the IBM MobileFirst Platform Foundation version 7.1.0 IBM Knowledge Center. Before you install Maximo Anywhere, read the installation and deployment information.
To access the documentation, you must have an internet connection.
System requirements for Maximo Anywhere, MobileFirst Server, and MobileFirst Studio Your environment must meet all of the software and hardware requirements for Maximo Anywhere, MobileFirst Server, and MobileFirst Studio.
A complete list of hardware and software requirements for your product is available in the Maximo Anywhere information in the System Requirements section of the Maximo® Asset Management wiki.
The MobileFirst system requirements are available in the IBM Support Portal.
You must have administrative user rights on all the computers that are used for the Maximo Anywhere 7.6.2 installation. Enterprise system Tivoli®'s process automation engine is the enterprise platform for products such as IBM Maximo Asset Management, IBM TRIRIGA® Application Platform, and Maximo industry solutions. The process automation engine and the supporting middleware together comprise the enterprise system. Maximo Anywhere 7.6.2 must be installed with Maximo Asset Management 7.5.0.6 or later, or version 7.6 or later. Maximo Integration Framework is also required and is included as an iFix for Maximo Asset Management 7.5.0.6 or later versions. If Maximo Asset Management 7.6 is installed, the correct version of the Integration Framework might already be deployed. The installation program detects the required components if they are already installed. The Maximo Integration Framework component includes OSLC object structures that the enterprise system requires to support Maximo Anywhere. With OSLC integration, the enterprise applications can share data with Maximo Anywhere. You can verify that the required components are installed by logging into Maximo Asset Management and selecting Help > System Information.
© Copyright IBM Corp. 2013, 2017 1 Maximo Anywhere supports IBM Maximo Spatial Asset Management 7.5.0.1 or later versions to provide positioning information that determines the location of a work order on a map. Maximo Spatial Asset Management is an optional component. If Maximo Spatial Asset Management is not in your environment, positioning information is obtained by using non-linked objects. Maximo Anywhere version 7.6.2 To configure, build, and deploy the Maximo Anywhere mobile apps, the following prerequisite software must be installed. v The Oracle Java Development Kit (JDK) is a prerequisite for Android and iOS development, and its subcomponent, the Java Runtime Environment (JRE), is required to run MobileFirst Studio. v The Android SDK is required to build the Maximo Anywhere apps for Android mobile devices. v To install mobile apps on iOS devices, a set of Apple-registered accounts is required so that you can build the iOS apps in your environment. If you are installing Maximo Anywhere on a Mac OS X computer, you must install the iOS development tools first. v Xcode IDE is required to build the Maximo Anywhere apps so that they can be deployed on iOS mobile devices. v Microsoft Visual Studio is required to build Maximo Anywhere apps so that they can be deployed on Windows mobile devices. v To set up an integrated development environment, you must install Eclipse IDE for Java™ EE Developers and MobileFirst Studio. v To preview the deployed applications in the MobileFirst Studio mobile browser simulater, you must install Google Chrome. IBM MobileFirst® Platform Server 7.1.0 MobileFirst Server is required to deploy Maximo Anywhere in a production environment. Ensure that you have installed the latest interim fix. You must deploy MobileFirst Server on a Windows, Linux, or AIX® computer. MobileFirst Server must be deployed to an application server. The application server can be configured with a specific profile for MobileFirst Server. If you plan to use Application Center to distribute Maximo Anywhere apps to iOS devices, you must configure the MobileFirst Server to listen through SSL. In a production environment, MobileFirst Server requires a production-grade database instance. You can configure an existing database server for MobileFirst Server by creating a database instance or database schemas.
Application servers Databases
v IBM WebSphere® Application Server v IBM DB2® Liberty v Oracle Database v IBM WebSphere Application Server v MySQL Database v Apache Tomcat
2 Planning, installation, and deployment Table 1. Supported application servers and databases.
For compatible products and versions, see the IBM MobileFirst Platform Foundation 7.1.0 detailed system requirements.
Restrictions: v MobileFirst Server is not supported on Mac OS X computers. v MobileFirst Server does not support Oracle WebLogic Server. If your enterprise environment runs WebLogic Server, install IBM WebSphere Application Server Liberty or Apache Tomcat to host MobileFirst Server. v MobileFirst Server does not support Microsoft SQL Server. If your enterprise environment runs SQL Server as the database, you must use MySQL Database, Oracle Databaseor IBM DB2 as the database platform for MobileFirst Server. IBM MobileFirst Platform Studio You must install Oracle JDK before you install MobileFirst Studio. The Oracle JDK includes the Java Runtime Environment (JRE), which MobileFirst Studio requires to build the Maximo Anywhere applications. To configure the mobile apps, install the required development tools in combination with MobileFirst Studio. For more information, see Installing an integrated development environment. Mobile devices The Maximo Anywhere mobile apps can be deployed to Android, iOS, or Windows mobile devices. In a development environment, you can also test the apps in the MobileFirst Studio mobile browser simulator, the Android Emulator, or the iOS Simulator. For a full list of operating systems and supported screen sizes, see the Maximo Anywhere system requirements.
System architecture and components Maximo Anywhere and MobileFirst form a mobile application platform that integrates with the Maximo Asset Management enterprise system. Maximo Anywhere provides the content that is required to build mobile apps for Maximo Asset Management. The MobileFirst components function as middleware by enabling integration with the enterprise system and by supporting the deployment of apps to mobile devices.
Maximo Integration Framework is included in the Maximo Asset Management 7.6 environment. This framework is required to enable the integration between Maximo Asset Management and external applications. The Integration Framework includes the OSLC capabilities and service providers that are used by the Maximo Anywhere apps to retrieve and process enterprise data.
OSLC is installed on the Maximo Asset Management administrative workstation as part of the Maximo Anywhere package.
The following figure shows the system architecture of Maximo Anywhere and highlights the relationship with key components in Maximo Asset Management and MobileFirst.
Chapter 1. Planning to deploy Maximo Anywhere 3 Build environment
Maximo Anywhere build server
Maximo Maximo Anywhere project administrative workstation App Adapter
Build EAR file Build and deploy
Runtime environment
Maximo enterprise application MobileFirst server
OSLC service MobileFirst Application Center provider Login Console Data module Native apps
Adapter
Maximo database
Data Install
MobileFirst Mobile device database
Maximo Anywhere app
Local data store
Figure 1. Maximo Anywhere system architecture and components
The following required components must be deployed to the Maximo Asset Management environment to support the Maximo Anywhere apps: Maximo Integration Framework This framework is required to enable the integration between Maximo Asset Management and external applications. The Integration Framework includes the OSLC capabilities and service providers that are used by the Maximo Anywhere apps to retrieve and process enterprise data. For Maximo Asset Management 7.5 environments, you must install the Integration Framework manually. Maximo Asset Management 7.6 environments include the Integration Framework. IBM OSLC Content package 7.6.0 OSLC resources define the metadata for business objects of OSLC service providers. The OSLC resources are used by the mobile apps to retrieve and process application data from the service providers in Maximo Asset Management. Maximo Anywhere Enablement 7.6.2 The enablement package includes application files, license enablement files,
4 Planning, installation, and deployment and cron task automation. The enablement package also includes the Anywhere Administration application, which is deployed as part of the MaximoAnywhere project.
The following components are deployed when you implement Maximo Anywhere: IBM Maximo Anywhere A collection of resources that are required for integration and deployment on the MobileFirst platform. These resources include a MobileFirst-compatible project and an OSLC adapter. The OSLC adapter manages communications between MobileFirst Server and the provider application, Maximo Asset Management. Before run time, the Maximo Anywhere project WAR, the applications, and the OSLC adapter must be deployed to MobileFirst Server. The mobile apps can be configured, tested, and deployed to an emulator or a mobile device. IBM MobileFirst Platform Server for MobileFirst Consumer Edition A runtime container for the OSLC adapter and server-based application components. MobileFirst Server includes an administrative console and an app store for publishing mobile apps within the organization. MobileFirst Server must be deployed to an application server. The same application server can be used to deploy both Maximo Asset Management and MobileFirst Server. Application Center The Application Center is an enterprise app store that you can use for deploying the Maximo Anywhere apps to mobile devices in your organization. Application Center is automatically installed with MobileFirst Server. Application Center is composed of a server component, a repository, the Application Center console, and a mobile client app. v Server component: The server component is a Java Enterprise application that must be deployed in a web application server, such as WebSphere Application Server. The server component consists of an administration console and a mobile client. The mobile client installs the apps that are available to the client component. Several services compose the Application Center server component, such as a service that lists the available apps, and a service that delivers the app binary files to the mobile device. v Repository: The repository stores the apps that can be installed on mobile devices. The repository is a database that also stores information, such as feedback about the apps, and the amount of storage that an app uses. v Application Center console: The Application Center console is a web application that is used to manage the repository. You must have system administrator privileges to access the Application Center console. v Mobile client: The mobile client runs on mobile devices and is used to install the apps that reside in the repository. IBM MobileFirst Platform Studio for MobileFirst Consumer Edition (Optional) An Eclipse-based integrated development environment that can be deployed with Maximo Anywhere.
Chapter 1. Planning to deploy Maximo Anywhere 5 MobileFirst Studio is installed as an Eclipse add-on by using a P2 Eclipse update. MobileFirst Studio is used to configure and test the Maximo Anywhere apps, and to manage the build and deployment process.
The following items are not included in the Maximo Anywhere product license. However, you can deploy these items to the Maximo Anywhere environment to extend and complement the capabilities that are available in the product itself. Map services The map view uses positioning data that is provided by Maximo Asset Management. Maximo Asset Management can be configured to obtain this positioning data from ArcGIS, an external geographic information system. You can also configure the map view to show a route and directions between work order locations. To support this configuration, you must either have permissions from the map service provider, Esri or you must install and obtain a license for IBM Maximo Spatial Asset Management. Mobile Device Management You can deploy IBM MaaS360 Mobile Device Management with Maximo Anywhere to complement the mobile app management capabilities that MobileFirst provides. IBM MaaS360 Mobile Device Management provides mobile device management capabilities, including security management, for your mobile organization.
Deployment topologies A development environment is created by installing Maximo Anywhere and MobileFirst Studio on the same computer. A production environment is created by installing Maximo Anywhere and MobileFirst Server in a single-server or multiple-server deployment.
You use a development environment to configure and test the Maximo Anywhere mobile apps before they are deployed to the production server. A test instance or a development instance of Maximo Asset Management is required, either on the same computer or on a remote computer.
You can set up a pre-production test environment or a small-scale production environment on a single server. A single-server deployment features Maximo Anywhere and MobileFirst Server installed on the same computer. A pre-production instance of Maximo Asset Management is also required, either on the same computer or on a remote computer. The pre-production instance of Maximo Asset Management must closely match the production environment so that the application configurations can be tested before you move to a production environment.
For medium and large enterprises, creating a production environment involves installing the components on more than one computer. MobileFirst Server must first be deployed to an application server. A production instance of Maximo Asset Management must be available on a different computer than the Maximo Anywhere and MobileFirst components.
MobileFirst Studio is an optional integrated development environment. If you want to use MobileFirst Studio to test, configure, and build the Maximo Anywhere applications, you must install it on the same computer as the Maximo Anywhere component.
6 Planning, installation, and deployment The Maximo Anywhere computer functions as a build server from which the application build and deployment processes are run. Cluster environments
To introduce high availability and scalability to your Maximo Anywhere deployment, you can set up a MobileFirst Server cluster environment. The MobileFirst cluster can be integrated with a basic or advanced enterprise system topology.
You can create a cluster either by setting up multiple application server host computers or by using multiple Java virtual machines (JVMs) that share the MobileFirst Server database instance. Each node of a MobileFirst Server cluster requires a separate copy of the MobileFirst web application archive (WAR) project file.
If you plan to set up a clustered environment, configure the cluster before you install MobileFirst Server and Maximo Anywhere.
Hardware-based or software-based load balancers regulate the data activity across multiple web servers. For more information, see the clustering information in the IBM MobileFirst Platform Foundation 7.1.0 IBM Knowledge Center. Related information: Optimizing system performance
Clustering of MobileFirst Server Development environment A development environment can be used to configure, test, and build the Maximo Anywhere mobile apps before they are deployed to a production environment.
To create a development environment, you install MobileFirst Studio and Maximo Anywhere on a single computer. A test instance or a development instance of Maximo Asset Management is also required, either on the same computer or on a remote computer.
Maximo Asset Management
MobileFirst Studio Maximo Anywhere
Figure 2. A Maximo Anywhere development environment.
Before you install MobileFirst Studio and Maximo Anywhere, you must install a collection of required components on the Maximo Asset Management computer.
MobileFirst Studio is an Eclipse-based integrated development environment. You must install MobileFirst Studio within an existing Eclipse client. Update your Eclipse environment by installing the development tools for the Android or iOS mobile platform. Example: Creating an Android development environment
Dale is a system administrator who is responsible for implementing Maximo Anywhere in his enterprise. He wants to test and configure the Maximo Anywhere
Chapter 1. Planning to deploy Maximo Anywhere 7 apps before he deploys them to the production environment. To do this, he designates one computer as a development environment.
Before Dale begins, he prepares the enterprise system to support Maximo Anywhere.
He creates a test instance or a development instance of Maximo Asset Management and backs up the system.
On the computer where Maximo Asset Management is installed, he installs the Maximo Asset Management required components.
If using Maximo Asset Management 7.6, he runs the Configuration Tool to update the database and rebuild and redeploy the Maximo EAR files.
On a designated development computer, Dale installs Oracle JDK, Android SDK, and Eclipse. He then installs MobileFirst Studio as a P2 Eclipse update.
Dale starts the launchpad and installs Maximo Anywhere. During the installation, he selects Embedded Server within MobileFirst Studio.
When the installation is complete, Dale can configure and test the Maximo Anywhere mobile apps. He can build the apps and deploy them to the Android Emulator. Single-server deployment of Maximo Anywhere and MobileFirst Server For small enterprises, a single-server deployment can be used for production purposes. Larger enterprises can use a single-server deployment as a pre-production test environment.
To create a single-server deployment, you install MobileFirst Server and Maximo Anywhere on a single computer. A test instance or a production instance of Maximo Asset Management is also required, either on the same computer or on a remote computer.
Maximo Asset Management
MobileFirst Server Maximo Anywhere
Figure 3. A single-server deployment of Maximo Anywhere and MobileFirst Server.
You can configure an instance of WebSphere Application Server, WebSphere Application Server Liberty, or Apache Tomcat for use with MobileFirst Server.
You can also configure an existing production database, such as DB2, Oracle Database, or MySQL Database.
To configure the Maximo Anywhere applications for your organization, you modify the properties files and the application definitions. You can build, deploy, and preview the mobile apps in the MobileFirst Operations Console. You can then deploy the apps to the Application Center where mobile workers can download them to a mobile device.
8 Planning, installation, and deployment Example: Creating a single-server deployment
Ian is a system administrator who is responsible for implementing Maximo Anywhere in a small enterprise. He wants to create a small-scale production environment.
Ian performs any necessary backup of the system and sets up a production instance of Maximo Asset Management.
He creates a production database instance on the Maximo database server.
He installs the required components on the computer where Maximo Asset Management is installed.
If using Maximo Asset Management 7.6, he runs the Configuration Tool to update the database and rebuild and redeploy the Maximo EAR files.
On the same computer, he installs MobileFirst Server and uses the MobileFirst Server Configuration Tool to install the MobileFirst Server Administration Services.
Ian installs Maximo Anywhere and again uses the MobileFirst Server Configuration Tool to install the MobileFirst runtime environment.
When the configuration is complete, Ian can download the Maximo Anywhere apps from the Application Center and install them on a mobile device. Multiple-server deployment of Maximo Anywhere and MobileFirst Server A multiple-server deployment is suitable for medium and large enterprises and is deployed by installing Maximo Anywhere and MobileFirst Server on separate computers. A production instance of Maximo Asset Management on a remote computer is also required.
If you use WebSphere Application Server as the enterprise application server, you can create a new profile for MobileFirst Server. You must also create a database instance or multiple database schemas on the enterprise database server.
The Maximo Anywhere build server is used to configure, build, and deploy the apps to MobileFirst Server. Mobile workers can then download the apps to their mobile devices from the Application Center.
You can create a MobileFirst Server cluster and integrate it with a basic or an advanced enterprise system topology. An enterprise system topology contains an OSLC provider cluster, which can consist of either multiple WebSphere Application Server instances or multiple Oracle WebLogic Server instances.
Chapter 1. Planning to deploy Maximo Anywhere 9 HTTP/HTTPS MobileFirst web server load balancer
Maximo Anywhere apps
MobileFirst server MobileFirst database cluster
Application server Maximo Anywhere build server
HTTP/HTTPS Enterprise system environment
Web server load balancer
OSLC provider Maximo database cluster
Application server Firewall
Figure 4. A Maximo Anywhere multiple-server deployment (basic topology).
The MobileFirst Server cluster supports only multiple instances of WebSphere Application Server.
In an advanced enterprise system topology, you can isolate processes that require the use of an application server into separate clusters. For example, you can isolate the user interface applications into one cluster and isolate cron tasks and reporting processes into other clusters.
The MobileFirst Server cluster and the OSLC provider cluster can be integrated in an advanced enterprise system topology.
10 Planning, installation, and deployment HTTP/HTTPS MobileFirst MobileFirst MobileFirst web server load server cluster database balancer
Maximo Application Anywhere server apps
Maximo Anywhere build server
Enterprise system environment OSLC provider cluster
Application server
User interface cluster
Application server Maximo database Integration cluster
Application server
HTTP/HTTPS Web server load HTTP/HTTPS balancer
Maximo Asset Cron Management cluster applications Application server Reporting database Reporting cluster
Application Firewall server
Figure 5. A Maximo Anywhere multiple-server deployment (advanced topology). Example: Creating a multiple-server deployment
Ian is a system administrator who is responsible for implementing Maximo Anywhere in a production environment.
Before he begins, he creates a database instance or multiple database schemas on the production database server. MobileFirst Server can be configured to share the existing database server with the enterprise system.
Ian installs or identifies an application server for use with MobileFirst Server. For example, he installs WebSphere Application Server Liberty or creates a new instance of WebSphere Application Server.
On the computer where Maximo Asset Management is installed, Ian starts the launchpad and installs the Maximo Asset Management required components.
Chapter 1. Planning to deploy Maximo Anywhere 11 If using Maximo Asset Management 7.6, he runs the Configuration Tool to update the database and rebuild and redeploy the Maximo EAR files.
On a designated host server computer, Ian starts the launchpad and installs MobileFirst Server. He starts the MobileFirst Server Configuration Tool and installs the MobileFirst Server Administration Services.
On a separate computer, he starts the launchpad and installs Maximo Anywhere. During the installation, Ian specifies the host name of the MobileFirst Server computer.
When the installation is complete, Ian copies the MaximoAnywhere.war file from the Maximo Anywhere computer to the MobileFirst Server computer.
On the MobileFirst Server computer, Ian starts the MobileFirst Server Configuration Tool and adds a MobileFirst runtime environment.
When the configuration is complete, Ian can download the Maximo Anywhere apps from the Application Center and install them on a mobile device. Related tasks: Configuring the application server Related information:
Typical topologies of a MobileFirst instance
Clustering with MobileFirst Server
Installation overview The Maximo Anywhere installation involves preparing target computers and existing middleware for installation, and installing key components for Maximo Anywhere and MobileFirst Server.
The Maximo Anywhere launchpad is a centralized interface where you can start the installation programs. Maximo Anywhere and MobileFirst Server are installed by using IBM Installation Manager. Installation Manager is a tool that guides you through the installation of IBM products.
Before you install the product, you must extend the enterprise system to support Maximo Anywhere.
Ensure that either Maximo Asset Management 7.5.0.6 or later, or Maximo Asset Management 7.6 or later is installed.
On the Maximo Asset Management administrative workstation, start the Maximo Anywhere launchpad and install the required components to extend the enterprise system for Maximo Anywhere.
Before you install Maximo Anywhere and MobileFirst Server, ensure that your environment contains an application server and a database instance.
If your enterprise environment runs IBM WebSphere Application Server, you can create a profile for MobileFirst Server.
12 Planning, installation, and deployment A cluster is created by implementing multiple host servers or by configuring multiple JVMs. If you want to set up a MobileFirst cluster, do so before you install MobileFirst Server and Maximo Anywhere.
You must prepare the Maximo Anywhere environment by installing development tools. MobileFirst Studio is an optional component and can be installed as part of the Eclipse integrated development environment (IDE) workbench. For Android app development, the Android SDK and the Oracle JDK are both required to build the mobile apps. For iOS app development, XCode and Apple developer profiles are required on a Mac OS X computer. For Windows app development, Microsoft Visual Studio is required to build the mobile apps.
Administrative user rights are required to install all of the components that are delivered with Maximo Anywhere version 7.6.2. You must have root user authorization for UNIX and Linux systems. Required components
Maximo Asset Management requires a set of components to be deployed before Maximo Anywhere is installed. The Maximo Asset Management required components include OSLC object structures and licenses to enable a set of extra applications in Maximo Asset Management. Maximo Integration Framework must also be installed. The Service Address application is used with the map feature and the Crews and Crew Types applications are used for labor reporting. The Anywhere Administration application allows you to administer the Maximo Anywhere mobile apps from one central location. Maximo Anywhere, MobileFirst Server, and MobileFirst Studio
Before you install Maximo Anywhere and the MobileFirst components, you must install prerequisite software and configure the database server.
In most production environments, MobileFirst Server is installed on a different computer than Maximo Anywhere. You must deploy MobileFirst Server to an application server before you install Maximo Anywhere. You can install MobileFirst Studio and Maximo Anywhere on the same target computer and streamline the configuration and testing of the mobile apps before they are deployed. Silent installation
A silent installation is useful for installing Maximo Anywhere and MobileFirst Server in the following scenarios: v You are installing the components on a group of computers that are configured in the same way. v You are installing the components on a production server that is behind a firewall. The use of remote desktop access software can be restricted by firewalls, so system administrators can be prevented from using the launchpad to install the components. v You are installing the components on a computer that cannot display an Eclipse user interface.
Chapter 1. Planning to deploy Maximo Anywhere 13 Silent installation eliminates the need to use the graphical user interface (GUI) of the installation program to collect installation data. You can run a silent installation of Maximo Anywhere, MobileFirst Server, and Installation Manager from a command line.
Silent installations that are conducted with Installation Manager are defined by an XML response file. The response file can be used to install, update, and uninstall products.
You can use the Installation Manager GUI to record installation preferences and actions in a response file. By default, a response file is not recorded, so you must enable the recording by setting the record environment variable to true before you start the launchpad.
Installation planning worksheet Use the planning worksheet to record the information that you need during the installation process, such as system settings, properties, and user names.
Variable Default value Example value Your value Maximo Anywhere Windows: C:\IBM\Anywhere installation directory UNIX and Linux: opt/ibm/Anywhere MobileFirst Server On Windows: http Administration protocol On Mac OS X: https MobileFirst Server hostname.yourdomain.com or Administration host name 1.234.567.89 or localhost MobileFirst Server 9080 Administration port (Stand-alone server) MobileFirst Server 10080 Administration port (Embedded server) MobileFirst Server wladmin Administration context root MobileFirst Server MaximoAnywhere Administration runtime context root MobileFirst Server Administration user name MobileFirst Server Administration password Application Center protocol On Windows: http
On Mac OS X: https Application Center host hostname.yourdomain.com or name 1.234.567.89 or localhost Application Center port On Windows, UNIX, and Linux: 9080
On Mac OS X: none
14 Planning, installation, and deployment Variable Default value Example value Your value Application Center context applicationcenter root Application Center user appcenteradmin name Application Center password Android platform directory C:\Users\Administrator\ Downloads\android- sdk_r22.6.2-windows\ android-sdk-windows\ platforms\android-19 Oracle JDK directory Windows: C:\Program Files\Java
UNIX and Linux:/usr/java Maximo Server protocol http Maximo Server host name hostname.yourdomain.com or 1.234.567.89 or localhost Maximo Server port 9080 or 80 Maximo Server context root maximo
Table 1. Variables and values for system settings, properties, and user names.
Installation checklist for Maximo Anywhere You can use the checklist to ensure that all installation steps completed successfully. Print this topic and check each task as you complete it. To access the links, you must have an internet connection. Preparing for installation
Done Task Ensure that your environment meets all of the software and hardware requirements for Maximo Anywhere and IBM MobileFirst Platform Foundation. To build mobile apps for Windows devices, you must use a Windows computer. To build mobile apps for iOS devices, you must use a Mac OS X computer. Prepare your build environment by installing the required development tools for your chosen platform. Print the installation planning worksheet and use it during the installation.
Table 1. Planning checklist.
Chapter 1. Planning to deploy Maximo Anywhere 15 Installing IBM Maximo Anywhere
Done Task On the computer where Maximo Asset Management is installed, download the Maximo Anywhere product software from IBM® Passport Advantage®. . Install the Maximo Asset Management required components. Create or identify a database instance to use with MobileFirst Server. Install or identify an application server to use with MobileFirst Server. On a designated server computer, install MobileFirst Server. Install the MobileFirst Server Administration Services by using the MobileFirst Server Configuration Tool. On the build computer, prepare the Maximo Anywhere build environment. On the build computer, install Maximo Anywhere. On the MobileFirst Server computer, add a MobileFirst runtime environment by using the configuration tool. On the computer where Maximo Anywhere is installed, run the build all command. If your computer is a Windows system, use the build.cmd file. If your computer is a UNIX or Linux system, use the build.sh file. This step generates the distributable files for the Maximo Anywhere project and deploys them to MobileFirst Server. Install the Maximo Anywhere apps on mobile devices. Optional: On the build computer, to create an integrated development environment, install MobileFirst Studio.
Table 2. Installation checklist. Configuring IBM Maximo Anywhere and Maximo Asset Management
Done Task Add users to the Maximo Anywhere security groups. Enable Maximo Asset Management applications for maps and labor reporting.
16 Planning, installation, and deployment Done Task Set up Maximo Asset Management to include the following data: v Ensure that your user has an associated labor code. v Ensure that your user has authorization to at least his own labor code. v Ensure that your user has a default insert site defined. v Ensure that your user has a default time zone defined.
Table 3. Configuration checklist. Verifying the installation
Done Task Test the Maximo Anywhere apps on mobile devices.
Table 4. Verification checklist.
Chapter 1. Planning to deploy Maximo Anywhere 17 18 Planning, installation, and deployment Chapter 2. Installing the Maximo Anywhere components
After you plan your environment, you install Maximo Anywhere and MobileFirst on one or more computers. Before you begin
Ensure that either Maximo Asset Management 7.5.0.6 or later, or Maximo Asset Management 7.6 or later is installed.
Download the Maximo Anywhere product software from IBM Passport Advantage®. About this task
Maximo Anywhere 7.6.2 includes the following compressed files: v Max_Anywhere_V762_for_Max75.zip v Max_Anywhere_V762_for_Max76.zip v MaxAny_762_MobileFirst_71.zip
You must extract the compressed files on multiple computers. The contents of the Install folder in the MaxAny_762_MobileFirst_71.zip file must always be copied into the Install folder of the Max_Anywhere_V762_for_Max7x folder on the target system.
Maximo Asset Management version Files to extract
7.6 or later v Max_Anywhere_V762_for_Max76.zip v MaxAny_762_MobileFirst_71.zip
7.5.0.6 or later v Max_Anywhere_V762_for_Max75.zip v MaxAny_762_MobileFirst_71.zip
Table 1. The files to extract according to your Maximo Asset Management version.
Installing the Maximo Asset Management required components You extend Maximo Asset Management with components that include OSLC object structures and licenses that enable a set of applications. About this task
Running the launchpad executable file as an administrator ensures that you have the permissions to update the existing installation directory. Procedure 1. On the computer where Maximo Asset Management is installed, extract the Max_Anywhere_V762_for_Max7x.zip for your version to the Maximo Asset Management installation directory. 2. Start the launchpad by right-clicking the launchpad file and selecting Run as administrator. If your computer is a 64-bit system, use the launchpad64 file. If your computer is a UNIX or Linux system, use the launchpad.sh file.
© Copyright IBM Corp. 2013, 2017 19 3. On the Install IBM Maximo Asset Management Required Components pane, click Install. If you are using Maximo Asset Management 7.5.0.6 or later, you must select the installation directory. 4. Complete the installation wizard. 5. Deploy the product by updating the database and building and deploying the Maximo EAR file. v If you are using Maximo Asset Management 7.5.0.6 or a later version, change to the tpae_home\maximo\tools\maximo directory and run updatedb. Then, manually build and deploy the Maximo EAR file. v If you are using Maximo Asset Management version 7.6, allow the IBM Tivoli process automation engine configuration utility to start and select Update Database and Build and Deploy Application EAR Files to complete the configuration. 6. Verify that the required components are installed by logging in to Maximo Asset Management and selecting Help > System Information. Ensure that IBM Maximo Integration Framework is listed as one of the installed components. What to do next
If you plan to install Maximo Anywhere and MobileFirst Server on different computers, copy the installation images to the target computers. Automatically updating the database and building and deploying the EAR file If you deferred the configuration step during installation, you can use the configuration wizard to deploy the product. Before you begin
Ensure that the installation of the required components on the Maximo Asset Management computer is complete. Procedure 1. Start the configuration wizard by double-clicking the ConfigUI file in the install_home/ConfigTool directory. 2. On the home screen of IBM Tivoli's process automation engine configuration utility, select Update Database and Build and Deploy Application EAR Files. 3. Complete the configuration wizard. Manually updating the database and building and deploying the EAR file If you did not use the configuration wizard, you must manually update the Maximo database and build and deploy the EAR file. If your deployment uses Oracle WebLogic Server, you are required to complete the manual steps. Updating the database and building the EAR file Before you can deploy the product, you must update the Maximo database and build the Maximo EAR file.
Procedure 1. Open a command prompt and change to the install_home\maximo\tools\ maximo directory.
20 Planning, installation, and deployment 2. Run the following command: updatedb 3. Change to the install_home\maximo\deployment directory and run the following command: buildmaximoear Deploying the EAR file on WebSphere Application Server If you did not use the configuration wizard, Maximo Asset Management includes a command line tool, which you can use to manually deploy the EAR file.
Before you begin
Ensure that you updated the Maximo database and built the EAR file.
About this task
Maximo Asset Management includes a command line tool, which is located in the install_home\ConfigTool\scripts\ directory. Command-line configuration quickly updates configuration values without using the configuration wizard. You can use the command line tool to build and deploy the EAR file.
The EAR file is installed on WebSphere Application Server during the Maximo Asset Management installation.
Deploying the EAR file starts the application server.
Procedure 1. Open a command prompt and change to the install_home\ConfigTool\ scripts\ directory. 2. On Windows systems, run the following command: reconfigurePae.bat -action updateApplication -deploymaximoear
On UNIX or Linux systems, run the following command: reconfigurePae.sh -action updateApplication -deploymaximoear Deploying the EAR file on WebLogic Server After you update the database and build the EAR file, you must deploy the EAR file from the WebLogic Server console.
About this task
To deploy the EAR file on WebLogic Server, follow the instructions in Deploying ear files.
Installing MobileFirst Server The installation program automatically creates a database instance for the MobileFirst Server environment. It also configures the application server that you assign to MobileFirst Server. Before you begin
Before you install MobileFirst Server, consider whether to use the automated method or to create a database instance manually. By using the manual method,
Chapter 2. Installing the Maximo Anywhere components 21 you can also create database schemas on a single instance. After the installation is complete, you must manually configure the application server to add the databases that you created.
For more information about planning the creation of databases, see the IBM MobileFirst Platform Foundation IBM Knowledge Center.
Restriction: MobileFirst Server is not supported on Mac OS X computers. If you want to build and deploy apps for iOS devices, you must install MobileFirst Server on a different operating system. Installing MobileFirst Server by using the installation program In a Maximo Anywhere deployment, MobileFirst Server includes three main components: MobileFirst Server Administration Services, MobileFirst Operations Console, and Application Center. You must deploy MobileFirst Server to an application server. Before you begin v Ensure that you installed the required components on the Maximo Asset Management administrative workstation. v Ensure that your environment includes one of the application servers that MobileFirst supports. For more information, see the system requirements for Maximo Anywhere, MobileFirst Server, and MobileFirst Studio. The installer for WebSphere Application Server Liberty is provided with MobileFirst. v If you are using WebSphere Application Server in your enterprise environment, create a new profile for MobileFirst Server. v To improve performance, set the Java heap size on the JVM for WebSphere Application Server or WebSphere Application Server Liberty before you install MobileFirst Server. About this task
To ensure that the launchpad program runs correctly, do not use any spaces in the directory path where the launchpad file is located.
Use the planning worksheet to collect the values that you enter, so that they can be used later in the installation.
During the installation, you might be required to exit the launchpad and restart the launchpad on a different computer.
When you start Installation Manager, you can check for the latest fix packs. Your IBM login credentials are required to access the fix pack download site. Procedure 1. On the computer where MobileFirst Server is installed, extract the Max_Anywhere_V762_for_Max7x.zip file for your version and the MaxAny_762_MobileFirst_71.zip file. Copy the contents of the MaxAny_762_MobileFirst_71\Install folder into the Max_Anywhere_V762_for_Max7x\Install folder. 2. Start the launchpad by right-clicking the launchpad file and selecting Run as administrator. Running the executable file as an administrator ensures that you have the permissions to update the existing installation directory. If your
22 Planning, installation, and deployment computer is a 64-bit system, use the launchpad64 file. If your computer is a UNIX or Linux system, use the launchpad.sh file. 3. On the Install IBM MobileFirst Server pane, click Install. 4. On the MobileFirst Information pane, select Stand-alone MobileFirst Server and complete the installation wizard. What to do next
In certain circumstances, you might be required to restart the application server. For more information, see Completing the installation. Related information:
Planning the creation of databases
Creating a profile for a WebSphere Application Server
Manually installing MobileFirst Server administration
Manually installing Application Center Installing the MobileFirst Server Administration Services After MobileFirst Server is installed, you must install and configure the Administration Services by using the MobileFirst Server Configuration Tool. Before you begin
Verify that the Application Center Console is installed by entering the Application Center URL in a web browser. The default URL is: http://localhost:9080/ appcenterconsole/login.html. About this task
Use the planning worksheet to collect the values that you enter, so that they can be used later in the installation.
Accept the default values that the MobileFirst Server Configuration Tool provides.
For more information about the tasks that can be completed by using the MobileFirst Server Configuration Tool, see the IBM MobileFirst Platform Foundation 7.1.0 IBM Knowledge Center. Procedure 1. On the computer where MobileFirst Server is installed, start the Server Configuration Tool.
Option Description On Windows In the Start menu, right-click IBM MobileFirst Platform Server 7.1 > Server Configuration Tool and select Run as administrator. On Linux In the desktop menu, click IBM MobileFirst Platform Server 7.1 > Server Configuration Tool. On Mac OS X In the Finder, browse to the mf_server_home/shortcuts/ directory and double-click the configuration-tool.sh file.
Chapter 2. Installing the Maximo Anywhere components 23 2. Select Create a MobileFirst Server Configuration. 3. Specify a name for the configuration and click OK. For example, enter Maximo Anywhere. 4. On the Configurations Details pane, make a record of the context root value for the MobileFirst Administration Services and click Next. The default context root value is /wladmin. 5. On the Console Settings pane, make a record of the context root value for the MobileFirst Operations Console. The context root value can be used to log in to the MobileFirst Operations Console and administer the mobile apps after Maximo Anywhere is installed. The default context root value is /worklightconsole. 6. In the Database Properties window, specify the database properties that you selected during the MobileFirst Server installation. 7. In the Application Server Choice window, specify the Application Center properties that you selected during the MobileFirst Server installation. Record the user name and password values in the planning worksheet. The user name and password are required to access the MobileFirst Administrative Services as part of the Maximo Anywhere installation. Click Save and Deploy. 8. Restart the application server. 9. Verify that the MobileFirst Operations Console is installed by entering the console URL in a web browser. The default URL is: http://localhost:9080/ worklightconsole/login.html. Setting the Java heap size on the JVM for WebSphere Application Server or WebSphere Application Server Liberty To improve the performance of the MobileFirst Server, you must increase the java heap size that is used by the Java virtual machine (JVM). You can set the Java heap size for the application server by modifying the jvm.options file. About this task
You can also modify the Java heap size for other types of application server.
You specify the minimum and maximum Java heap sizes as follows: v Minimum Java heap: -Xms
By default, the WebSphere Application Server and WebSphere Application Server Liberty are configured with the following JVM settings: -Xms4m -Xmx488m
You can override the default values by modifying the values in the jvm.options file in the installation directory. Procedure 1. Stop the server by running the following command: websphere_home\bin\server stop 2. Browse to the websphere_home\usr\servers\defaultServer\type directory and open the jvm.options file for editing. 3. Specify the following values to set the Java heap size:
24 Planning, installation, and deployment -Xms128m -Xmx512m 4. Save and close the jvm.options file. 5. Start the server by running the following command: websphere_home\bin\server start
Preparing the Maximo Anywhere environment Before you can build and deploy the Maximo Anywhere apps, you must install development tools that are specific to the mobile platform. About this task
To build the mobile apps for iOS devices, a Mac OS X computer is required. The order of installation is different on Mac OS X computers. For more information, see the technote Installing a Maximo Anywhere development environment on Mac OS X. Procedure 1. Prepare the computer for building the mobile apps:
Option Description Android Install the Android development tools. iOS Install the iOS development tools. Windows Install the Windows development tools.
2. Install Maximo Anywhere. 3. Create a MobileFirst runtime environment. 4. Deploy the apps from the command line. 5. Optional: Install an integrated development environment. Installing the Android development tools Oracle JDK and Android SDK are required to build Android mobile apps. Procedure 1. To install Oracle JDK version 8.0, from the Oracle Java SE downloads page, download the Java SE Development Kit for your operating system. 2. Run the executable file and proceed through the installation program. 3. Set the JAVA_HOME environment variable and specify the path to the directory where the JDK was installed:
Chapter 2. Installing the Maximo Anywhere components 25 Option Description
On Windows 1. Go to your computer's Advanced System Settings. 2. On the Advanced tab, click Environment Variables. 3. Under System Variables, click New. 4. Specify JAVA_HOME as the variable name and enter the path to the JDK installation directory as the variable value. Environment variable values cannot be separated by a space. If the Java installation directory contains a space in the path name, specify the shortened path name. For example, on Windows operating systems, enter a path such as C:\Progra~1\Java\jdk1.8.0_x. 5. Close all open windows. 6. Verify that the JAVA_HOME system environment variable is defined by opening a new command prompt and running the following command: SET JAVA_HOME
A value is returned such as: JAVA_HOME=C:\Progra~1\Java\jdk1.8.0_x
On UNIX or Linux 1. At a command line, run the following command: vi ~/.bash_profile 2. Set the variables by running the following command and replacing the java_path variable with the Java path that you specified: export JAVA_HOME=java_path export PATH=$JAVA_HOME/bin:$PATH 3. Save and close the .bash profile, and run the following command to apply the changes: source ~/.bash_profile 4. Verify that the JAVA_HOME system environment variable is defined by opening a new command line and running the following command: echo $JAVA_HOME
4. To install the Android SDK, go to the Android developers' website and click to see other download options. 5. In the section with the SDK tools, download the SDK for your operating system and extract the compressed file on your computer. 6. Start the installation wizard.
26 Planning, installation, and deployment Option Description On Windows From the extracted directory, run the SDK Manager.exe file. On UNIX or Linux Open a terminal and navigate to the android_home/tools/ directory, then run the following command: android sdk
7. Under Tools, select Android SDK Tools Revision 22 or later and the latest Android SDK build tools. Also, select an Android package with an API of 14 or greater and click Install Packages. Installing the iOS development tools A Mac OS X computer with Oracle JDK and Xcode installed is required to build the iOS mobile apps. About this task
You use your Apple ID to enroll in a developer program. You can enroll in the iOS Developer Program as an individual or a company in which an individual is a one-person team.
You can also enroll in the iOS Developer Enterprise Program as a company, which authorizes you to create proprietary in-house iOS apps. The procedure for setting up the iOS Developer Enterprise account might include extra steps.
The person who creates the team becomes the team agent who is the legal contact and administrator of the team and has all privileges and full access to Member Center and iTunes Connect. The team agent is required to complete steps 5-7. iOS developers might require the assistance of the team agent to complete the procedure.
You create provisioning profiles to manage the use of iOS apps that you develop.
A development provisioning profile regulates the development and testing of apps to a specific number of devices. Development provisioning profiles for the apps must contain the IDs of the devices on which the app is installed. You can register more iOS devices and add them to the provisioning profiles.
A distribution provisioning profile provides access to the app store from all of the devices in your enterprise. Procedure 1. Install Oracle JDK version 8.0. a. From the Oracle Java SE downloads page, download the Java SE Development Kit for your operating system. b. Run the executable file and complete the installation program. c. In a terminal, go to the home directory cd ~. d. Enter echo $JAVA_HOME. e. If the result is empty, enter sudo nano .bash_profile. This step requires your system password. f. In the .bash_profile file window, enter export JAVA_HOME=$(/usr/libexec/ java_home), and save and close the file.
Chapter 2. Installing the Maximo Anywhere components 27 g. To reload the terminal and read what you put in the files, enter source ~/.bash_profile. h. Enter echo $JAVA_HOME. Verify that the path is /Library/Java/ JavaVirtualMachines/jdk_version/Contents/Home. 2. Create an environment.plist file in the ~/Library/LaunchAgents/ directory and specify the following content, which substitutes your actual level of JDK. Replace the value jdk1.8.0_x.jdk with the value of your installed version.
App name Example bundle ID Asset Audit com.company_name.maximoanywhere.AssetAudit Asset Data Manager com.company_name.maximoanywhere.AssetDataManager Inspection com.company_name.maximoanywhere.Inspection Issues and Returns com.company_name.maximoanywhere.IssuesReturns Physical Count com.company_name.maximoanywhere.PhysicalCount Service Request com.company_name.maximoanywhere.ServiceRequest Transfers and Receiving com.company_name.maximoanywhere.Transfers Work Approval com.company_name.maximoanywhere.WorkApproval
28 Planning, installation, and deployment App name Example bundle ID Work Execution com.company_name.maximoanywhere.WorkExecution
To specify an identifier to represent a single app, click Explicit App ID and enter a unique ID for the app. Repeat this step for each app that you support. 8. From the maximoanywhere_home\MaximoAnywhere\apps\app_name directory, open the application_descriptor.xml file and change the bundle ID strings to match the bundle IDs that you created. 9. To support command line builds of our app, you must create a distribution provisioning profile. Ensure that you select the distribution certificate when creating this provisioning profile. a. Create a distribution provisioning profile for each app by using Member Center. When you generate a distribution provisioning profile, you are not required to provide IDs of the devices. b. Download each app's provisioning profile to your Mac OS X computer. Every time that a provisioning profile is updated, you must download the profile to the build server. When you run the app build and deployment process, the provisioning profiles are collected and stored in the iOS application archive file (IPA). 10. Run the following command: ./build.sh all 11. Optional: To test the app on a local device using Xcode, you must register the Device IDs for all of your test devices. You must also create a Developer Provisioning Profile for the app. While creating the provisioning profile, ensure that you select your developer certificate while creating the app and also the Device IDs of your test devices. a. Create a developer certificate for a development provisioning profile. Download the certificate and add it to the Keychain application. b. Register the Device IDs in Member Center. You can locate the unique device identifier (UDID) by connecting your device to the Mac OS X computer while Xcode or iTunes are running. c. Download the developer provisioning profile to your Mac OS X computer. Installing the Windows development tools Microsoft Visual Studio is required to build apps for Windows devices. Before you begin v Ensure that your Windows computer is running a supported operating system. For more information, see the System Requirements section of the Maximo Asset Management wiki. v Windows devices require Visual C++ redistributable packages, which must be installed if they are not already on the device. For more information, see Visual C++ Redistributable for Visual Studio 2012. About this task
Visual Studio Community 2015 is the recommended version.
Restriction: Visual Studio Express for Web is not supported.
Chapter 2. Installing the Maximo Anywhere components 29 Procedure 1. From the Visual Studio website, select a supported version of Visual Studio and click Download. 2. Run the vs_community.exe file. 3. Complete the installation wizard.
Installing Maximo Anywhere Install Maximo Anywhere on a designated build computer. You use the build computer to build the mobile apps and deploy them to MobileFirst Server. Before you begin v Ensure that the required enablement components are installed on the computer where Maximo Asset Management is installed. v If you are installing a production environment, ensure that MobileFirst Server is installed. v Ensure that the JAVA_HOME environment variable is defined on all target computers. About this task
The Maximo Anywhere installation image contains the MaximoAnywhere project and the mobile apps.
The production build computer must be continuously connected to the network and undergo regular system backups.
To ensure that the launchpad program runs correctly, the directory path where the launchpad file is located must not contain any spaces. Running the launchpad executable file as an administrator ensures that you have the permissions to update the existing installation directory.
Restriction: The Maximo Anywhere launchpad program is not supported on Mac OS X. To start the installation on Mac, you must start IBM Installation Manager manually. Procedure 1. On the computer where Maximo Anywhere is installed, extract the Max_Anywhere_V762_for_Max7x.zip file for your version. If you plan to install either MobileFirst Server or MobileFirst Studio as part of an integrated development environment, then also extract the MaxAny_762_MobileFirst_71.zip file. 2. Start the launchpad.
Option Description Windows, Linux, or UNIX Right-click the launchpad file and select Run as administrator. If your computer is a Windows system, use the launchpad64.exe file. If your computer is a UNIX or Linux system, use the launchpad.sh file.
30 Planning, installation, and deployment Option Description
Mac OS X 1. From the Maximo Anywhere installation image, open the Install > IM folder and expand the installer.macOS compressed file. 2. Ensure that the path to the Userinst executable file does not contain any spaces or parentheses. Double-click the Userinst executable file.
3. On the Install IBM Maximo Anywhere pane, click Install. 4. If you deployed MobileFirst Server to a stand-alone application server, select Stand-alone MobileFirst Server. If you are setting up an integrated development environment with MobileFirst Studio, select Embedded Server within MobileFirst Studio and complete the installation wizard. 5. After the installation is complete, copy the MaximoAnywhere.war file to the computer where MobileFirst Server is installed.
Creating a MobileFirst runtime environment After Maximo Anywhere is installed, you must set up and configure a MobileFirst runtime configuration by using the MobileFirst Server Configuration Tool. Before you begin
Ensure that Maximo Anywhere is installed. If you installed Maximo Anywhere on a different computer than the MobileFirst Server computer, ensure that the MaximoAnywhere.war file is copied over. About this task
Use the installation planning worksheet to record the values that you enter so that they can be used later in the installation. Procedure 1. On the computer where MobileFirst Server is installed, start the Server Configuration Tool.
Option Description On Windows In the Start menu, click IBM MobileFirst Platform Server 7.1 > Server Configuration Tool. On Linux In the desktop menu, click IBM MobileFirst Platform Server 7.1 > Server Configuration Tool.
2. Select Add a MobileFirst runtime environment to a configuration and specify a name for the new runtime environment. For example, enter MaximoAnywhere. Use the scroll bar to see the MobileFirst project configuration. 3. On the MobileFirst runtime environment pane, browse to the MaximoAnywhere.war file that was generated on the Maximo Anywhere computer. Specify the MobileFirst project context root and click Next. This value must match the runtime context root that you specified during the Maximo Anywhere installation.
Chapter 2. Installing the Maximo Anywhere components 31 4. Specify the database settings in the subsequent panes and click Save and Deploy. After the runtime configuration is saved, you can redeploy the MaximoAnywhere.war file at any time by selecting it in the MobileFirst Server Configuration Tool. 5. Restart MobileFirst Server. 6. On the computer where Maximo Anywhere is installed, run the build all command. If your computer is a Windows system, use the build.cmd file. If your computer is a UNIX or Linux system, use the build.sh file. This step generates the distributable files for the project and deploys them to MobileFirst Server. Results
After the deployment is complete, the MaximoAnywhere project and apps are available in the MobileFirst Operations Console and the Application Center Console.
Installing an integrated development environment You can create an integrated development environment (IDE) by installing the Eclipse IDE and MobileFirst Studio. You can use the IDE to develop, test, and configure mobile apps before you deploy them to MobileFirst Server or to mobile devices. Before you begin v Ensure that Maximo Anywhere is installed on the computer where you are installing the IDE. v It is recommended that you install the IDE on a computer that is independent of the server. v Depending on the mobile platform that you plan to develop apps for, ensure that you installed the Android, iOS, or Windows development tools. v Oracle JDK version 8 (v1.8) is required to run Eclipse and to build apps for Android, iOS, and Windows devices. v To preview the apps in the MobileFirst Studio mobile browser simulator, install Google Chrome. v To allow Eclipse to install the required plugins, ensure that your firewall is temporarily disabled. v If you are installing an integrated development environment on a Mac OS X computer, follow the instructions in this technote: Installing a Maximo Anywhere development environment on Mac OS X. About this task
MobileFirst Studio is an Eclipse-based development environment that can be used to configure the Maximo Anywhere apps. You install MobileFirst Studio from the Eclipse integrated development environment (IDE) workbench. A set of platform development tools are also required to build and deploy the mobile apps.
You can use the mobile browser simulator, the Android Emulator, or the iOS Simulator to view and test the mobile apps.
You can customize the mobile apps when they are deployed. For more information, see Customizing Maximo Anywhere mobile apps.
32 Planning, installation, and deployment Procedure 1. Install Eclipse IDE: a. Go to Eclipse IDE for Java EE Developers and download Eclipse IDE for Java EE Developers (Eclipse Kepler 2). b. Extract the compressed folder and run the Eclipse application. 2. Set up your Eclipse development environment: a. Check whether the Eclipse JSDT plug-in is installed. The JavaScript Development Tool (JSDT) plug-in helps you navigate through the Java Script code in Eclipse. 1) Select Help > About Eclipse > Installation Details and click the WTP icon (Eclipse Web Tools Platform). 2) In the About Eclipse Features window, browse the Feature Name list for Eclipse JavaScript Development Tools. b. If the JavaScript Development Tools plug-in is not already installed, complete the following steps: 1) Select Help > Install New Software > Add. 2) In the Add Repository window, specify the following URL in the Location field: http://download.eclipse.org/webtools/repository/ kepler. 3) In the Name field, specify Eclipse WTP. 4) Select Web Tools Platform (WTP) 3.5.1 (or later) > JavaScript Development Tools and install the plug-in. c. Set Google Chrome as the default web browser by selecting Window > Preferences > General > Web Browser > Use external web browser. If Chrome is not available in the External web browsers window, click New, specify Chrome in the Name field and browse to the Chrome.exe file which is in the C:\Program Files (x86)\Google\Chrome\Application directory on Windows systems. Click OK to apply your changes. Alternatively, you can set your default web browser to Chrome. 3. Install MobileFirst Studio Consumer Edition: a. In Eclipse, select Help > Install New Software > Add. b. In the Add Repository window, click Archive. c. Browse to the MaxAny_762_MobileFirst_71/MobileFirstStudio.zip folder and click Open > OK. d. On the Available Software pane, select IBM MobileFirst Platform Studio Development Tools. The following items are selected for installation: IBM Dojo Mobile Tools, IBM jQuery Mobile Tools, and IBM MobileFirst Platform Studio. e. Click Next > Next > Finish. f. Restart Eclipse to apply the changes. 4. Import the MaximoAnywhere project into MobileFirst Studio. a. In Eclipse, click File > Import > General, select Existing Projects into Workspace and click Next. b. Click Select root directory and specify the path to \IBM\Anywhere. c. Select the MaximoAnywhere project and click Copy projects into workspace. Click Finish. d. In the Project Explorer pane, expand all nodes. Right-click the OSLCGenericAdapter folder and select Run As > Deploy MobileFirst Adapter.
Chapter 2. Installing the Maximo Anywhere components 33 e. Right-click the application folder and click Run As > Run on MobileFirst Development Server. f. To preview the app, right-click the application folder and click Run As > Preview. 5. To build apps for Android devices, install the Android Development Tools (ADT) plug-in: a. In Eclipse, select Help > Install New Software > Add. b. In the Add Repository window, specify the following URL in the Location field: https://dl-ssl.google.com/android/eclipse/. c. In the Name field, specify Android Development Tools and click OK. d. On the Available Software pane, click Select All > Next > Next > Finish. e. Restart Eclipse and specify a workspace directory. f. Open the Eclipse Preferences window and specify the Android SDK path. Click Apply > OK to apply the changes. g. On the Welcome to Android Development pane, select Use existing SDKs and browse to the SDK directory. Click OK > Next > Finish.
Silent mode: Installing Maximo Anywhere You can run a silent installation of Maximo Anywhere, MobileFirst Server, and Installation Manager from a command line. Silent installations that are conducted with Installation Manager are defined by an XML response file. Recording a response file for silent installation A response file collects data and records the selections that you make when you use the Installation Manager. If you want to run a silent installation, you must record the installation settings. About this task
When you use the Installation Manager to install the components, an XML response file can be recorded. The response file can be used for future silent installations of Maximo Anywhere and MobileFirst Server. Once your system is set up to record a response file, the response file is overwritten with each subsequent use of the installation program.
To record a response file, set the record environment variable to true before you start the launchpad. Alternatively, if you want to run the installation program from a command line, use the -record parameter. Procedure 1. Open a command line and run the set record=true command on Windows or the export record=true command on UNIX or Linux. 2. Start the Maximo Anywhere launchpad and proceed with the installation. 3. Click Finish. A response file is generated in the user home directory. The response file is marked with a time stamp, for example, tpaeInstallerRsp20130716105150.xml. Installing the required components in silent mode For Maximo Asset Management 7.5.0.6 or later, the required components can be installed silently by running an executable file on the computer where Maximo
34 Planning, installation, and deployment Asset Management is installed. In a Maximo Asset Management 7.6 environment, you use Installation Manager to install the required components in silent mode. About this task
The process automation engine executable file is called install.exe or install.bin. You reuse this file to install the Maximo Anywhere components. Procedure
Maximo Asset Management version 7.5.0.6 or later: 1. From the Install directory of the Maximo Anywhere installation image, copy the Payload.zip folder to the directory where the install.exe or install.bin is stored. The default directory is C:\IBM\SMP\madt on Windows or /opt/IBM/SMP/madt on UNIX or Linux systems. 2. From the samples folder of the Maximo Anywhere installation image, copy the response_install_Anywhere_Enablement.xml file to a local directory. 3. Verify that the response file contains the Maximo Asset Management installation directory. The default value is C:\\IBM\\SMP on Windows or /opt/IBM/SMP on UNIX and Linux. 4. Change to the directory where the installation executable file is stored and run the following command:
Option Description On Windows install.exe -f response file path and name
For example, run the following command: install.exe -f C:\temp\ response_install_Anywhere_Enablement.xml On UNIX or Linux ./install.bin -f response file path and name
For example, run the following command: ./install.bin -f /temp/ response_install_Anywhere_Enablement.xml
Maximo Asset Management version 7.6 or later: 5. Open the response file for editing and modify the values for your operating system. Ensure that the value for the repository location is correct. 6. Change directory to the tools directory where Installation Manager was installed and run the following command: imcl -input responsefilename -log logfilename -acceptLicense
Specify the path and name of the existing response file and log file that you want to use. The -acceptLicense parameter is used to accept the license automatically. For example, on Windows, run the following command: imcl -input C:\tmp\response_install_Anywhere_Enablement.xml -log C:\tmp\silent_install_log.xml -acceptLicense Related information:
Silent installation properties
Chapter 2. Installing the Maximo Anywhere components 35 Installing Installation Manager in silent mode Installation Manager is the tool that is used to install Maximo Anywhere and MobileFirst Server. Installation Manager can itself be installed in silent mode. About this task
The Installation Manager folder includes the silent-install.ini initialization file, which contains default parameters and values that are required for silent installation. You can use the initialization file to set the values for the silent installation process. A range of parameters can be modified in the silent-install.ini file. Procedure 1. Browse to the Install\IM folder of the Maximo Anywhere installation image and copy the Installation Manager folder for your system to a local directory. For example, copy the installer.win64 if your computer is running a Windows 64-bit operating system. 2. Optional: To modify the installation parameters, edit the silent-install.ini file. 3. From a command line, change to the directory where you copied the Installation Manager folder and run one of the following commands. Specify the path and the name of the log file that you want to create:
Option Description On Windows installc.exe –-launcher.ini silent-install.ini -log logfilename-acceptLicense On UNIX or Linux ./installc --launcher.ini silent-install.ini -log logfilename-acceptLicense
For example, run the following command for Windows: installc.exe –-launcher.ini silent-install.ini -log C:\tmp\ silent_install_log.xml -acceptLicense Related information:
Install Installation Manager silently Parameters for silent mode installation You can modify the silent-install.ini initialization file by updating the parameters for your environment.
Parameter Description -vm Specifies the Java launcher. In silent mode, always use java.exe on Windows, and java on other operating systems. -nosplash Suppresses the splash screen. --launcher.suppressErrors Suppresses the JVM error dialog. -silent Runs the Installation Manager program in silent mode. -input Specifies that an XML response is used as the input for the Installation Manager program.
36 Planning, installation, and deployment Parameter Description -log Generates a log file that records the result of the silent installation. The log file is an XML file, for example, c:\mylogfile.xml or /root/mylogs/mylogfile.xml
Installing Maximo Anywhere in silent mode To install in silent mode, a response file is required. You can generate a response file by completing a successful installation of Maximo Anywhere with the Installation Manager. Alternatively, you can use a sample response file that is provided in the Maximo Anywhere installation image. Before you begin
Installation Manager must be installed on the target computer.
Copy a generated response file or a sample response file with the necessary changes to the target computer. A sample response file is provided for your operating system in the Max_Anywhere_V762_for_Max76\samples folder of the Maximo Anywhere compressed installation image.
For Windows installations, use the response_install_Maximo_Anywhere_Win.xml response file.
For Mac OS X installations, use the response_install_Maximo_Anywhere_UnixMac.xml response file. About this task
You can copy the Maximo Anywhere response file to multiple computers to run silent installations.
You must ensure that all values in the response file are valid for the target system. Procedure 1. Open the response file for editing and modify the values for your operating system. Ensure that the value for the repository location is correct. 2. Change directory to the tools directory where Installation Manager was installed and run the following command: imcl -input responsefilename -log logfilename -acceptLicense
Specify the path and name of the existing response file and log file that you want to use. The -acceptLicense parameter is used to accept the license automatically. For example, on Windows, run the following command: imcl -input C:\tmp\response_install_Maximo_Anywhere_Win.xml -log C:\tmp\silent_install_log.xml -acceptLicense
Setting up Maximo Asset Management for Maximo Anywhere You must add users to the predefined Maximo Anywhere security groups and enable applications in Maximo Asset Management.
Chapter 2. Installing the Maximo Anywhere components 37 Adding users to the Maximo Anywhere security groups When mobile workers manage records, they must have the authority to use the Maximo Anywhere mobile apps. You authorize access to the Maximo Anywhere apps by adding users to the predefined security groups in Maximo Asset Management. About this task
The user and group association are retrieved from Maximo Asset Management during authentication. If the user does not belong to the security group that is associated with the app, login fails. For each app, this security control is implemented in the application definition file. In this file, the requiredRole attribute specifies the security group that is authorized to use the app.
By default, the Maximo Anywhere security groups do not include any users. You must add the relevant users, including predefined users such as MAXADMIN, before you deploy the associated apps. Procedure 1. In the Users application of Maximo Asset Management, create the user records. 2. In the Security Groups application, select the Maximo Anywhere group to which you want to add a user. 3. If your user is in a MAXADMIN group, clear the independent flag for that security group. 4. From the Users tab, click New Row. 5. Select a user. The associated user information populates the other fields. 6. Save your changes. What to do next
The Maximo Anywhere security groups do not include authorizations for specific sites, labor, storerooms, or GL components. You must create separate security groups to implement security controls for these items.
Users of the Maximo Anywhere Work Execution app must have a labor record. If a user does not have a labor record, login fails. Maximo Anywhere security groups in Maximo Asset Management Maximo Asset Management includes predefined security groups for the Maximo Anywhere apps. You use these security groups to grant authorization to use the Maximo Anywhere apps. The number of authorized users for each app must comply with the terms of the Maximo Anywhere product license. App authorizations
The following security groups are included in the required components that are deployed during installation to the Maximo Asset Management environment: ANYWHERE_TECHNICIAN Grants authorization to use the Maximo Anywhere Work Execution app. ANYWHERE_APPROVER Grants authorization to use the Maximo Anywhere Work Approval app.
38 Planning, installation, and deployment ANYWHERE_PHYSICAL_COUNT Grants authorization to use the Maximo Anywhere Physical Count app. ANYWHERE_INSPECTOR Grants authorization to use the Maximo Anywhere Inspection app. ANYWHERE_ASSET_AUDITOR Grants authorization to use the Maximo Anywhere Asset Audit app. ANYWHERE_ASSET_MANAGER Grants authorization to use the Maximo Anywhere Asset Data Manager app. ANYWHERE_ISSUES_RETURNS Grants authorization to use the Maximo Anywhere Issues and Returns app. ANYWHERE_SERVICE_REQUEST Grants authorization to use the Maximo Anywhere Service Request app. ANYWHERE_TRANSFERS Grants authorization to use the Maximo Anywhere Transfers and Receiving app.
These security groups are used to implement security at two levels: v Authorization to use the associated mobile app. This type of control is provided by the app itself. Only users who belong to the associated security group can log in to the app. If you remove a user from the associated security group, authorization is revoked the next time that the user logs in to the app through the server. v Authorization to read, create, and update data for the OSLC resources that are used in the associated mobile app. This type of control is provided by the Maximo application that is registered with the object structure for the resource. The security group identifies the authorizing application for each object structure and specifies the application-level signature options that are required to provide the appropriate level of data access. Users who belong to the security group automatically have the appropriate level of access for all data operations in the associated app.
By default, these security groups do not include any users. You must add the relevant users, including system users such as MAXADMIN, before you deploy the associated apps.
The Maximo Anywhere security groups do not include authorizations for specific sites, labor, storerooms, or GL components. To ensure complete access to Maximo Anywhere, click the Sites tab and select Authorize group for all sites. Click the Labor tab and select Authorize group for all labor. Product license compliance
The terms of your Maximo Anywhere license specify the number of users that are entitled to use each mobile app. To comply with the terms of your product license, the number of users in the Maximo Anywhere security groups must not exceed the number of users that are entitled to use the associated apps.
Chapter 2. Installing the Maximo Anywhere components 39 Enabling Maximo Asset Management applications for maps and labor reporting The Maximo Anywhere required components contain licenses for more Maximo Asset Management applications. You enable the Service Address application for use with the map feature and the Crews and Crew Types applications are used for labor reporting. About this task
This procedure grants access to administrators to configure the features of the applications. Procedure 1. In Maximo Asset Management, go to the Security Groups application and select the group to which you want to grant access. For example, specify MAXADMIN. 2. On the Applications tab, select Grant access for the applications that you want to enable. 3. Save the group. Related concepts: Map positioning information Maximo Asset Management system options that affect mobile apps The settings that you define in the Organizations application in Maximo Asset Management apply to the relevant enterprise system applications and to the associated mobile apps.
The options that affect the mobile apps are system-wide. You cannot define settings that are organization-specific or site-specific.
The following table specifies the options that affect the mobile apps. Configurable options are accessed from the Select Action menu in the Organizations application and are grouped by business object.
Option group Option description Example Timer Options Automatically change the If a work order is approved, work order status from the status automatically Approved to In Progress changes to In Progress when when a user starts a labor you start the timer. timer. Automatically change the When you stop the timer for work order status to a labor transaction, the status Complete when a user stops of the work order changes to a labor timer. Complete. Labor Options Future labor transaction You can specify the number tolerance in hours. A labor of hours in the future that transaction is not valid if it labor transactions can be includes a future start or entered. You might want to stop time that exceeds the enter time for future labor if specified tolerance. you know that you are going to perform a task but want to report the time now.
40 Planning, installation, and deployment Option group Option description Example Edit Rules Work order edit settings. For each work order status, Some fields do not apply to you can specify the types of the mobile apps, and are data that can be edited. For excluded from the mobile example, if a work order is apps or are read-only in the in Approved status, you can mobile apps. specify that the asset field can be edited.
Time zones
When mobile workers use mobile apps, the time zone at the server might be different from their time zones. With the Users application in Maximo Asset Management, you must specify the time zone in the user record for each mobile worker. The mobile apps use this information to calculate the difference between the server time and the device time.
For example, in labor transactions, the start and end times are adjusted and reported accurately based on the time zone that is set in your user record. Setting the time zone is important for these types of transactions, especially if you want to report hours for labor that is to be done in the future.
Chapter 2. Installing the Maximo Anywhere components 41 42 Planning, installation, and deployment Chapter 3. Updating the Maximo Anywhere components
To update your environment to Maximo Anywhere 7.6.2, you must update the components on one or more computers. About this task
You can update to Maximo Anywhere 7.6.2 from the following versions: v Maximo Anywhere 7.5.2.1 v Maximo Anywhere 7.5.2.2 v Maximo Anywhere 7.6 v Maximo Anywhere 7.6.1
Maximo Anywhere 7.6.2 includes the following compressed files: v Max_Anywhere_V762_for_Max75.zip v Max_Anywhere_V762_for_Max76.zip v MaxAny_762_MobileFirst_71.zip
You must extract the compressed files on multiple computers. The contents of the Install folder in the MaxAny_762_MobileFirst_71.zip file must always be copied into the Install folder of the Max_Anywhere_V762_for_Max7x folder on the target system.
Maximo Asset Management version Files to extract
7.6 or later v Max_Anywhere_V762_for_Max76.zip v MaxAny_762_MobileFirst_71.zip
7.5.0.6 or later v Max_Anywhere_V762_for_Max75.zip v MaxAny_762_MobileFirst_71.zip
Table 1. The files to extract according to your version of Maximo Asset Management.
When you launch Installation Manager from the launchpad, Installation Manager updates to the latest version and restarts. After the update is complete, you can begin the update process from the launchpad.
Updating the required components You must update the required components on the computer where Maximo Asset Management is installed. Procedure 1. On the computer where Maximo Asset Management is installed, extract the Max_Anywhere_V762_for_Max7x.zip for your version to the Maximo Asset Management installation directory. 2. Start the launchpad by right-clicking the launchpad file and selecting Run as administrator. If your computer is a 64-bit system, use the launchpad64 file. If your computer is a UNIX or Linux system, use the launchpad.sh file. 3. On the Install or Update IBM Maximo Asset Management Required Components pane, click Install. The Installation Manager wizard starts.
© Copyright IBM Corp. 2013, 2017 43 4. On the Installation Manager home screen, click Update and complete the update wizard. 5. Deploy the product by updating the database and building and deploying the Maximo EAR file. v If you are using Maximo Asset Management 7.5.0.6 or a later version, change to the tpae_home\maximo\tools\maximo directory and run updatedb. Then, manually build and deploy the Maximo EAR file. v If you are using Maximo Asset Management version 7.6, allow the IBM Tivoli process automation engine configuration utility to start and select Update Database and Build and Deploy Application EAR Files to complete the configuration.
Updating MobileFirst Server You can either update MobileFirst Server to version 7.1.0 or install MobileFirst Server 7.1.0 as a fresh instance on a new server. About this task
For more information about the update process, see updating to MobileFirst Server V7.1.0 in a production environment. Procedure 1. On the computer where MobileFirst Server is installed, extract the Max_Anywhere_V762_for_Max7x.zip file for your version and the MaxAny_762_MobileFirst_71.zip file. Copy the contents of the MaxAny_762_MobileFirst_71\Install folder into the Max_Anywhere_V762_for_Max7x\Install folder. 2. Start the launchpad by right-clicking the launchpad64.exe file and selecting Run as administrator. If your computer is a Windows system, use the launchpad64.exe file. If your computer is a UNIX or Linux system, use the launchpad.sh file. 3. On the Install or Update IBM MobileFirst Server pane, click Install. The Installation Manager wizard starts. 4. On the Installation Manager home screen, click Update and complete the update wizard.
Updating the Maximo Anywhere build environment To build and deploy the apps, you must update the computer where Maximo Anywhere is installed. About this task
Running the executable file as an administrator ensures that you have the permissions to update the existing installation directory. Procedure 1. On the computer where Maximo Anywhere is installed, extract the Max_Anywhere_V762_for_Max7x.zip file for your version. If you plan to update either MobileFirst Server or MobileFirst Studio, then also extract the MaxAny_762_MobileFirst_71.zip file.
44 Planning, installation, and deployment 2. Start the launchpad by right-clicking the launchpad64.exe file and selecting Run as administrator. If your computer is a Windows system, use the launchpad64.exe file. If your computer is a UNIX or Linux system, use the launchpad.sh file. 3. On the Install or Update IBM Maximo Anywhere pane, click Install. The Installation Manager wizard starts. 4. On the Installation Manager home screen, click Update and complete the update wizard. 5. If an error occurs with the anywhere-rdfs-puller.xml file after Maximo Anywhere is updated, you can run the script manually. For more information, see Importing OSLC resources to Maximo Anywhere. a. If you had any custom timeouts in the OSLCGenericAdapter.xml file, these are overwritten during the update. Ensure that the following properties are set to the correct values:
Ensure that your queryUri matches the URI of your OSLC resource. 6. Go to the maximoanywhere_home\Anywhere\MaximoAnywhere\apps\app_name directory for each app and, in the app-feature.properties file, ensure that the properties that you require are set to true. 7. Migrate the artifact configurations. You can find the original files in your backed up directory, for example in MaximoAnywhere_b4_7.6.2. a. Use a graphical file-comparison program to compare your modified 7.6.1 app.xml file to the 7.6.2 app.xml file. b. Copy any additional JavaScript or XML files that you created in the old environment to the new environment. 8. After the update is complete, copy the MaximoAnywhere.war file to the computer where MobileFirst Server is installed. 9. On the computer where MobileFirst Server is installed, start the Server Configuration Tool and redeploy the MaximoAnywhere.war file. 10. Restart MobileFirst Server. 11. On the computer where Maximo Anywhere is installed, run the build all command. If your computer is a Windows system, use the build.cmd file. If your computer is a UNIX or Linux system, use the build.sh file.
Updating the MaximoAnywhere project in MobileFirst Studio The method that you use to update the MaximoAnywhere project in MobileFirst Studio depends on the way that you imported the project when you installed Maximo Anywhere. Before you begin
Ensure that you have updated Maximo Anywhere to version 7.6.2.
Chapter 3. Updating the Maximo Anywhere components 45 About this task
If your environment already includes MobileFirst Studio 7.1, you do not need to complete these steps.
The MaximoAnywhere project was set up by using one of the following options: v The Copy Projects into workspace check box was cleared in Eclipse. Eclipse uses the files that are in the installation directory. v The Copy Projects into workspace check box was selected in Eclipse. Eclipse uses copies of the MaximoAnywhere files, which are stored separately from the installation directory. Procedure 1. On the computer where Maximo Anywhere 7.6.2 and MobileFirst Studio 6.3.0 is installed, ensure that you have extracted the MaxAny_762_MobileFirst_71.zip file. 2. If the Copy Projects into workspace check box was cleared in Eclipse, complete the following procedure: a. Start MobileFirst Studio 6.3.0, right-click the MaximoAnywhere project and click Close. b. Start the launchpad and on the Install or Update IBM Maximo Anywhere pane, click Install. c. In IBM Installation Manager, click Update and complete the update wizard. Maximo Anywhere is updated to version 7.6.2. d. In MobileFirst Studio, update to version 7.1.0, but use the MobileFirstStudio.zip file that is located in the MaxAny_762_MobileFirst_71 folder. This step requires you to restart MobileFirst Studio. e. After MobileFirst Studio 7.1.0 restarts, right-click the MaximoAnywhere project and select Open Project. 3. If the Copy Projects into workspace check box was selected in Eclipse, complete the following procedure: a. Ensure that the MaximoAnywhere installation directory contains the most recent file changes. b. Start the launchpad and on the Install or Update IBM Maximo Anywhere pane, click Install. c. In IBM Installation Manager, click Update and complete the update wizard. Maximo Anywhere is updated to version 7.6.2. d. Start MobileFirst Studio 6.3.0, right-click the MaximoAnywhere project, click Delete and select Delete project contents on disk. This step removes the project files and deletes the contents from the hard disk drive. e. In MobileFirst Studio, update to version 7.1.0, but use the MobileFirstStudio.zip file that is provided in the MaxAny_762_MobileFirst_71 folder. This step requires you to restart MobileFirst Studio. f. After MobileFirst Studio 7.1.0 restarts, import the MaximoAnywhere project from the original installation directory.
What's new in application definitions in 7.6.2 The application definition file (app.xml) contains new content in Maximo Anywhere 7.6.2. You can enable the IBM Maximo Spatial Asset Management map view.
46 Planning, installation, and deployment The application definition files for each of the mobile apps are located in the maximoanywhere_home\ Anywhere\MaximoAnywhere\apps\app_name\artifact directory.
The Maximo Spatial Asset Management map view provides mobile workers with the geographical location of work orders in their current work list. Also, you can locate on maps objects that are associated with assets, and locations, as well as work orders. You can also see, for example, pumps, and valves that you configure in Maximo Spatial Asset Management in a map running using Maximo Anywhere. Learn more about map capabilities.
Chapter 3. Updating the Maximo Anywhere components 47 48 Planning, installation, and deployment Chapter 4. Installing help locally
Product help for Maximo Anywhere is provided online in IBM Knowledge Center. If you want to install help locally, you can download IBM Knowledge Center and help packages from Fix Central.
Installing help You can download help packages from Fix Central that contain the same documentation packages that are available online in IBM Knowledge Center. You add the help packages and configuration files to a local installation of IBM Knowledge Center Procedure 1. To download a locally-installable version of IBM Knowledge Center and help packages from Fix Central, follow the instructions at http://www- 01.ibm.com/support/docview.wss?uid=swg24041962. 2. Extract the IBM Knowledge Center package to the location where you want to install it. The default installation location is C:\KnowledgeCenter. If you install IBM Knowledge Center to a different location, you must update the path value in the taxonomy.properties file for each help package that you install. 3. Extract a help package to a temporary location. The extracted files include one or more plugin folders, a properties file and a taxonomy file. 4. Copy all com.ibm.prod.doc plugin folders from the help package to the install_home/KnowledgeCenter/usr/content/KCXhtml directory. 5. Copy the properties file to the configuration directory, for example to install_home/KnowledgeCenter/usr/conf/SSLKT6_7.6.0.5.properties. 6. Open the taxonomy.properties file in a text editor and update the path value, if necessary, to point to the installed location. For example, change the value of the Path property from C:/KnowledgeCenter/usr/content/KCXhtml to E:/IBM/SMP/KnowledgeCenter/usr/content/KCXhtml, where IBM Knowledge Center is installed at E:/IBM/SMP/KnowledgeCenter. 7. Replace the install_home/KnowledgeCenter/usr/taxonomy/ KC_taxonomy.ditamap with the version of the KC_taxonomy.ditamap file that is included in the help package. 8. In the install_home/KnowledgeCenter/bin directory, click startKC.bat on Windows or startKC.sh on Linux or AIX to start IBM Knowledge Center. 9. In a browser, open http://install_home:port/kc to view the product help, for example http://127.0.0.1:9090/kc. 10. In Maximo Anywhere, redirect the application help links to point to your local installation of IBM Knowledge Center: a. In the System Properties application, filter for mxe.help properties. b. Change the mxe.help.host and mxe.help.port properties to the host and port values for your local installation of IBM Knowledge Center, such as the default host value of 127.0.0.1 and default port value of 9090. c. Change the mxe.help.path property value from /support/knowledgecenter/ to /kc/. d. Save the changes and click Live Refresh to update the values in the product database.
© Copyright IBM Corp. 2013, 2017 49 11. To stop IBM Knowledge Center, in the install_home/KnowledgeCenter/bin directory, click stopKC.bat on Windows or stopKC.sh on Linux or AIX.
IBM Knowledge Center configuration IBM Knowledge Center requires minimal configuration to run help packages for IBM products in your local environment. You can also configure it to provide different content in separate instances of IBM Knowledge Center or to run existing Eclipse help plugins in IBM Knowledge Center. Changing the IBM Knowledge Center URL
If you install IBM Knowledge Center on your local computer, when you start the server, the help is available in a browser at the default URL of http://localhost:9090/kc. The host value changes, depending on where you install IBM Knowledge Center. If the default port is already in use, you can change the port value in the kc_ant.properties file in the etc directory.
If you want to provide different help to different audiences or if you want to host help for product versions that are not compatible with each other, you can install multiple instances of IBM Knowledge Center on the same computer . You rename the additional instances to unique directory names, such as KnowledgeCenter2 and KnowledgeCenter3, and you configure the kc_ant.properties file in the etc directory so that each instance runs on a different port. Maintaining taxonomy files
Each product version in the IBM software catalog has a unique taxonomy value that forms part of the URL for the product help on www.ibm.com. For example, the taxonomy value for Maximo Asset Management, version 7.6.0.5, is SSLKT6_7.6.0.5, and the URL for the product welcome page is http://www.ibm.com/support/knowledgecenter/SSLKT6_7.6.0.5/com.ibm.mam.doc/ welcome.html. The taxonomy.properties file and the KC_taxonomy.ditamap file control the taxonomy values in IBM Knowledge Center.
Each help package includes a taxonomy.properties file that is specific to the product version. You must add this file to the usr/conf directory in IBM Knowledge Center. If you add help packages for multiple products to IBM Knowledge Center, the usr/conf directory must contain a separate taxonomy.properties file for each help package.
The KC_taxonomy.ditamap file lists each product version in the IBM software catalog, and the file is frequently updated as new products and new versions of products are released. A basic version of the KC_taxonomy.ditamap file is provided as a placeholder in the usr/taxonomy directory in IBM Knowledge Center but it does not contain a comprehensive list of product taxonomy values. You must replace this placeholder file with the version of the KC_taxonomy.ditamap that is included in the help package.
When you add multiple help packages to IBM Knowledge Center, each help package includes a KC_taxonomy.ditamap file. Because of the dynamic nature of this file, the included KC_taxonomy.ditamap files might be at different versions. Always use the most recent version of the file because taxonomy values are added to the file incrementally.
50 Planning, installation, and deployment Troubleshooting
When you start IBM Knowledge Center after adding a new help package, index and cache files are created to enable faster search and retrieval of help topics. If the new help topics do not show in a browser, check if subdirectories were created for the product version in the runtime/diskcache and runtime/index directories. If these subdirectories were not created, check that the taxonomy.properties file exists in the usr/conf directory and that it contains the correct path to the main help plugin in the usr/content/KCXhtml directory. If the taxonomy.properties is in the correct location and contains the correct path to the help plugin, it is likely that you forgot to add the latest version of the KC_taxonomy.ditamap to the usr/taxonomy directory.
After troubleshooting, before you start IBM Knowledge Center, you can delete the product version subdirectories in the runtime/diskcache and runtime/index directories, to ensure that the content is fully refreshed.
Help components Help components include a locally-installable version of IBM Knowledge Center and help packages that contain content plugins for product versions. You can download a locally-installable version of IBM Knowledge Center to deploy help packages in your local environment. IBM Knowledge Center A standalone help system that includes a WebSphere Application Server Liberty, version 8.5.5.x, embedded server. IBM Knowledge Center is distributed to Maximo customers on https://www-933.ibm.com/support/ fixcentral/. IBM Knowledge Center is available for Windows, Linux, or AIX platforms and you can run IBM Knowledge Center on a local computer, server, or read-only media. After you extract the IBM Knowledge Center package, you add product help packages to it to deploy help in your local environment. You can use IBM Knowledge Center to host help packages for several products at the same time, if the products are on compatible release versions. If you want to host help packages that are not compatible with one another, you can run additional instances of IBM Knowledge Center that you configure to run on different ports. Help packages Contain the same documentation that is available on http:// www.ibm.com/support/knowledgecenter and include one or more content plugins that contain topics in their appropriate directories and the navigation files that control the table of contents for the topics. Help packages also include the following files that are required by IBM Knowledge Center: v A taxonomy.properties file contains the taxonomy value for the product version and the path to the main toc.ditamap file for the plugin or plugins in the help package. v The KC_taxonomy.ditamap file lists the taxonomy values for all products in the IBM software catalog. A basic version of this file is included in IBM Knowledge Center but this version of the file is not up-to-date. The KC_taxonomy.ditamap file that is included in the help package is the current version of the file when the help package is created.
Chapter 4. Installing help locally 51 Help packages include instructions for where to add the plugins and the additional files to IBM Knowledge Center. IBM Knowledge Center versions The locally-installable versions of IBM Knowledge Center are based on IBM Knowledge Center, version 1.5. This version has a different look and feel to IBM Knowledge Center, version 2.0, which is on http://www.ibm.com/support/knowledgecenter. The functionality is similar but there are some differences in navigation and search. PDF creation is not supported on the locally-installable version. When a locally-installable IBM Knowledge Center, version 2.0, is available, it will be distributed to customers who want to update their local version.
Maximo Asset Management documentation library The help packages in the documentation library mirror the product catalog and installation environment. Either the Maximo Asset Management help package or the Maximo Asset Management Multitenancy help package must be installed in the same IBM Knowledge Center environment where you install help packages for industry solutions and add-on products.
The Maximo Asset Management and Maximo Asset Management Multitenancy help packages contain multiple plug-ins. Help packages for industry solutions and add-on products contain one or more plug-ins. When a help package contains multiple plug-ins, one plug-in acts as the navigation plug-in. A navigation plug-in contains the main toc.ditamap file that controls the table of contents for all plug-ins in the help package. The taxonomy.properties file that is included in the help package specifies the path to the main toc.ditamap file.
Maximo Asset Management and Maximo Asset Management Multitenancy help packages include reuse plug-ins. These plug-ins contain topics only. Consuming plug-ins control the table of contents and metadata for the reused topics. The content is used extensively by other help plug-ins and you must install reuse plug-ins in IBM Knowledge Center to provide coherent content and ensure that links resolve. Maximo Asset Management help package
This help package includes the following plug-ins: com.ibm.mam.doc Navigation plug-in, containing the welcome page and product overview, and help for planning, getting started, and managing financial processes. com.ibm.mam.inswas.doc Help for installing Maximo Asset Management on WebSphere Application Server. com.ibm.mam.inswl.doc Help for installing Maximo Asset Management on Oracle WebLogic Server. com.ibm.mbs.doc Reuse plug-in, containing help for administering Maximo Asset Management, application design, workflow design, working with Migration Manager, implementing high availability, and application help.
52 Planning, installation, and deployment com.ibm.mif.doc Reuse plug-in, containing help for integrating Maximo Asset Management data with external applications. com.ibm.support.mbs.doc Reuse plug-in, containing troubleshooting and support information for Maximo Asset Management and for industry solutions and add-on products. Troubleshooting topics for industry solutions and add-on products are visible only if that help plug-in is installed in IBM Knowledge Center. Maximo Asset Management Multitenancy help package
This help package contains a subset of the plug-ins in the Maximo Asset Management help package and the content is aimed at tenants in a multitenancy environment. You cannot install Maximo Asset Management plug-ins and Maximo Asset Management Multitenancy plug-ins in the same instance of IBM Knowledge Center environment. If you want to support both libraries, you must configure separate instances of IBM Knowledge Center to support them.
This help package includes the following plug-ins: com.ibm.mt.doc Navigation plug-in, containing the welcome page and product overview, and help topics for planning, getting started, and managing financial processes. Content also includes topics that are specific to a tenant in a multitenancy environment. com.ibm.mbs.doc Reuse plug-in. Topics are filtered to exclude information that is not relevant to tenants in a multitenancy environment. com.ibm.mif.doc Reuse plug-in. Topics are filtered to exclude information that is not relevant to tenants in a multitenancy environment. Industry solution and add-on help packages
The help packages for industry solutions and add-on products are intended for use with the associated version of the Maximo Asset Management help package. You can check which version of Maximo Asset Management or Maximo Asset Management is a prerequisite for an industry solution or add-on product version at https://www.ibm.com/developerworks/community/wikis/home?lang=en#!/ wiki/IBM%20Maximo%20Asset%20Management/page/Other%20Maximo %20products%20system%20requirements. You can install non-recommended versions of help packages together but some links might not resolve or some of the features that are described in topics might not be available to users.
Chapter 4. Installing help locally 53 54 Planning, installation, and deployment Chapter 5. Building and deploying Maximo Anywhere apps
Before mobile users can download Maximo Anywhere apps, the apps must be built and deployed to MobileFirst Server. This process occurs automatically for the provided Maximo Anywhere apps during the installation of Maximo Anywhere. If you change the configuration of these apps and are not using the Anywhere Administration application, you must manually build and deploy the apps.
Application deployment process for Maximo Anywhere apps Maximo Anywhere apps are generated in the build server and then deployed to the runtime environment, which includes MobileFirst Server.
On the build server, you use the adapter and application files to generate the deployable files. You then deploy the project and the deployable files into the runtime environment. From MobileFirst Studio or the operating system command line, you run commands or tasks to deploy the apps to MobileFirst Server.
The following figure shows the relationship between the build server and the runtime environment. It also shows how the project and files are deployed to the MobileFirst Server so that the apps are available for download to a mobile device.
Figure 1. How the project and files are deployed so that they are available for download.
The build server contains both the adapter and the applications. When you generate deployable files, the WAR file, the ADAPTER file, the WLAPP file, and the APK, IPA, or APPX file are created. When you deploy the project and these
© Copyright IBM Corp. 2013, 2017 55 files to the runtime environment, which includes MobileFirst Server, the applications and adapter are available for download to a mobile device.
The deployable files are in either the maximoanywhere_home\Anywhere\ MaximoAnywhere\bin directory or the maximoanywhere_home\Anywhere\ MaximoAnywhere\apps\app_name\operating_system\native\bin directory: WAR file A web archive (WAR) file. Each Maximo Anywhere project includes two WAR files. The WAR files are used to package distributable application files and related project resources and to deploy them to MobileFirst Server. To support servlet version 3.0 and servlet version 2.4 application servers, there are two WAR files: v The MaximoAnywhere.war file for servlet version 3.0 application servers, WebSphere Application Server 8, WebSphere Application Server 8.5, WebSphere Application Server Liberty, and Apache Tomcat v The MaximoAnywhere2.4.war file for servlet version 2.4 application server: WebSphere Application Server 7 After you install Maximo Anywhere, both of these WAR files are automatically updated with the host information. When you deploy either of the WAR files to the MobileFirst Server and run the build all command, the MaximoAnywhere.war file is updated with the Maximo Anywhere distributable application files and related project resources. ADAPTER file A MobileFirst adapter that is deployed to MobileFirst Server. This file contains server code that does tasks such as retrieving data from a remote database. Adapter code is accessed by MobileFirst applications through a simple invocation API. WLAPP file Metadata and web resources of a Maximo Anywhere app that is deployed to MobileFirst Server. MobileFirst Server uses this file to identify mobile apps. APPX file A Windows mobile binary file that is ready for deployment to a mobile device. APK file An Android mobile binary file that is ready for deployment to a mobile device. IPA file An iOS mobile binary file that is ready for deployment to a mobile device.
You can deploy apps from MobileFirst Studio or the operating system command line. MobileFirst Studio MobileFirst Studio includes the Mobile Browser Simulator for testing your apps, but it does not include the Application Center for downloading your apps. WebSphere Application Server Liberty profile A dynamic profile that restricts WebSphere Application Server to use only the features that are required by the applications that are deployed to the
56 Planning, installation, and deployment server. This profile includes the Application Center for downloading apps to mobile devices. WebSphere Application Server Liberty does not support clustered environments. WebSphere Application Server full profile The full profile supports clustered environments and advanced configurations. WebSphere Application Server includes Application Center for downloading apps to mobile devices.
If you deploy apps from MobileFirst Studio, you run the adapter and apps deployment tasks. The adapter and apps are deployed to MobileFirst Server and available for download.
With MobileFirst Studio, the Application Center is not available. You test your apps by using either the Run as > Android Application menu option for Android apps or the Run as > Xcode project for iOS apps.
For Windows apps, you test your apps by using the Run as > Visual Studio Project menu option within Visual Studio Windows Simulator.
If you deploy apps from the operating system command line, you also deploy a WAR file to MobileFirst Server. This WAR file is created during the Maximo Anywhere installation process. You deploy the WAR file with the MobileFirst Server Configuration tool. This WAR file contains properties that control the Maximo Anywhere app features, such as timeout values. Whenever you change the properties of the apps, you need to redeploy the WAR file.
After you deploy the WAR file by using the MobileFirst Server Configuration Tool, you run the build all-deploy command. After the apps and the WAR file are deployed to the server, mobile users can download the apps from the Application Center to their mobile devices. Related reference: “Properties files” on page 60 The process for building and deploying apps requires input from configurable properties files that belong to the application. “Maximo Anywhere directory structure” on page 62 The Maximo Anywhere directory contains the files that are required to generate Maximo Anywhere apps. This directory includes predefined content for generating mobile apps that integrate with provider applications in the enterprise system. The application deployment process also generates a set of files.
Deploying Maximo Anywhere apps to MobileFirst Server Apps must be deployed to the server before they can be downloaded to mobile devices. You can deploy apps from MobileFirst Studio or the operating system command line. Deploying apps from the command line to WebSphere Application Server You can deploy apps from the command line for environments that do not include IBM MobileFirst Platform Studio but that do include one of the IBM WebSphere Application Server profiles.
Chapter 5. Building and deploying apps 57 Before you begin v Install Maximo Anywhere. v Add users to the Maximo Anywhere security groups. v If you plan to preview the deployed apps in the MobileFirst Operations Console, Google Chrome must be installed on the IBM Maximo Anywhere build server. The preview function for the deployed apps does not support other web browsers. To avoid app login issues due to cached data, you can enable private browsing in Google Chrome. v The IBM MobileFirst Platform Server instance and the Application Center console must be running. v Verify that the MobileFirst Server properties and the Application Center properties are correct for your environment. Procedure 1. Deploy the distributable files to the MobileFirst Server: a. On the Maximo Anywhere build server, in the maximoanywhere_home\ Anywhere\MaximoAnywhere directory, open the build.properties file. b. Choose one of the following options for building the apps:
Option Action To build all applications Run the build all command. This command is build.cmd on Microsoft Windows, and build.sh on UNIX and Linux systems. The .apk, .ipa, or .appx artifact file is generated and all distributable files for the Maximo Anywhere project are deployed to MobileFirst Server. To build only some Specify a comma-separated list of apps. The possible values applications are AssetDataManager, Inspection, IssuesReturns, PhysicalCount, ServiceRequest, WorkApproval, AssetAudit, Transfers, and WorkExecution. For example, to build and deploy the IBM Maximo Anywhere Inspection app and the IBM Maximo Anywhere Service Request app, run the following command: appsToBuild=Inspection, ServiceRequest.
2. Verify deployment of the Maximo Anywhere apps in the MobileFirst Operations Console. In Google Chrome, open the MobileFirst Operations Console and select Preview as common resources for any Maximo Anywhere app. What to do next v Install the Application Center mobile client on an Android mobile device or an iOS mobile device so that you can download the Maximo Anywhere apps. For apps that run on Windows devices, follow the instructions for installing a Windows Store application on a Windows device and follow the instructions for licensing and installing the product keys. v Add digital signatures to Maximo Anywhere apps. Related information:
Application Center setup information
Mobile client setup
58 Planning, installation, and deployment Deploying apps by using MobileFirst Studio MobileFirst Studio includes an embedded instance of MobileFirst Server, which means that you do not need to deploy the WAR file. MobileFirst Studio also includes the Mobile Browser Simulator for testing your apps. Before you begin v Set up Maximo Asset Management for Maximo Anywhere. v If you plan to preview the deployed apps in the Mobile Browser Simulator, Google Chrome must be installed in the development environment. The preview function for deployed apps does not support other web browsers. Procedure 1. In MobileFirst Studio, import the Maximo Anywhere project. a. Right-click inside the Project Explorer, and select Import. From the Import window, select Existing Projects into Workspace and click Next. b. Browse to the maximoanywhere_home folder, select the Anywhere\ MaximoAnywhere folder, select Copy projects into workspace, and click Finish. 2. Set the Ant file path. a. From the Window menu, select Preferences. Expand Ant and then select Runtime. b. Select Ant Home Entry and click Ant Home. c. In the Browse for Folder window, expand maximoanywhere_home > Anywhere > MaximoAnywhere > build > tools > ant and click OK. 3. Add the build.xml file to the Ant view. Select the build.xml file from MaximoAnywhere and drag the build.xml file to the Ant view. 4. Expand the build.xml file in the Ant view and double-click the all task. 5. From the Project Explorer, deploy the adapter. a. Select MaximoAnywhere > Adapters and right-click OSLCGenericAdapter. b. Select Run As > Deploy MobileFirst Adapter. 6. Build and deploy the Maximo Anywhere Asset Audit app. a. Under MaximoAnywhere > apps, right-click AssetAudit. b. Select Run As > Run on MobileFirst Development Server. 7. Repeat step 6 for each of the following applications: v AssetDataManager v Inspection v IssuesReturns v PhysicalCount v ServiceRequest v Transfers v WorkApproval v WorkExecution 8. Verify the application deployment in MobileFirst Operations Console by right-clicking the app and selecting Run As > Preview. 9. Test your app on your mobile device, Android emulator, or iOS Simulator. To test the app on the Android emulator, you must first set up the emulator. To test the app on a mobile device, connect that device to your computer.
Chapter 5. Building and deploying apps 59 Device type Steps
Android 1. In the Project Explorer, select the Android project that is under the app that you are testing and select Run as > Android Application. 2. Select Launch a new Android Virtual Device for the Android emulator or Launch a new Android Device for an Android mobile device.
iOS 1. Under MaximoAnywhere > apps > app_name > iphone, select Run as > Xcode project. 2. From the Xcode window, choose the simulated device or mobile device on which you want to test the app, and click the Play icon.
Windows 1. Open Microsoft Visual Studio. 2. From the menu bar, select FILE > Open > Project/Solution. 3. From the MaximoAnywhere/apps/ application_name/windows/native directory, select the *.jsproj file. 4. In Visual Studio, select the index.html file, and then click Simulator to run the simulator.
Related concepts:
Mobile browser simulator
iOS Simulator Related tasks: “Setting up the Android emulator” on page 66 The Android emulator can show you what your Android apps look like and help you test app behavior. “Testing apps” on page 66 After you deploy an app, you must verify that data is exchanged between the enterprise system database and the mobile application. You can use a mobile device, the Mobile Browser Simulator, an Android emulator, or the iOS Simulator to test apps. Properties files The process for building and deploying apps requires input from configurable properties files that belong to the application.
You can configure the app by editing the configurable properties files, or, if it is enabled, the Anywhere Administration application. If you configure the app with the Anywhere Administration application, those configuration changes have precedence over any configuration changes made to the configurable properties files. worklight.properties Contains application configuration properties: v MobileFirst Server database connection
60 Planning, installation, and deployment v MobileFirst Server security v Map service provider authentication v Heartbeat interval v Timeout and wait times v Log line limit v Authentication method v Maximo context v Download and upload of attachments v Size of attachments v Location of base directory for attachments v Tokens v Display lock times build.properties Contains information about the application definition location, the API version, and whether an app is deployed. The build.properties file also contains information about the OSLC adapter and the setting for enabling data encryption. This file also contains the properties for MobileFirst Server, the Application Center, and the WAR file. The build.properties file defines the instance of MobileFirst Server to which the app is deployed. During installation, the build.properties file is copied to the maximoanywhere_home\Anywhere\MaximoAnywhere directory and updated with values that are provided to the installer. If you change the environment after you install Maximo Anywhere, the build.properties file is not automatically updated. You might need to update the build.properties file in the following situations: v If you change the enterprise server in your environment, you must change the adapter.connection properties. v If you move the WAR file from its default location on the MobileFirst Server computer, you must change the project.config.war.file.name property in the build.properties file. v If you decide to build only a certain subset of the app files, you must change the build.target property. The build target determines what to build. Setting this property to all builds and deploys all of the files. Setting this property to mobilefirst builds the WAR file, the adapter file, and the WLAPP file, and deploys them to the MobileFirst Server. app-feature.properties Contains information about the settings for features that you can enable during the build process: v Maps are enabled with the map.enabled property v GPS is enabled with the gps.enabled property v Bar code scanning is enabled with the barcode.enabled property v Attachments are enabled with the attachments.enabled property v Push notifications are enabled with the pushnotification.enabled property v Undo actions for work order transactions are enabled with the custom.undo.process.enabled property
Chapter 5. Building and deploying apps 61 Maximo Anywhere directory structure The Maximo Anywhere directory contains the files that are required to generate Maximo Anywhere apps. This directory includes predefined content for generating mobile apps that integrate with provider applications in the enterprise system. The application deployment process also generates a set of files.
The Maximo Anywhere directory includes the application definition file and a set of properties files.
File Description Path app.xml Defines the user interface, maximoanywhere_home\ data elements, and associated Anywhere\MaximoAnywhere\ business rules for an app apps\app_name\artifact worklight.properties Contains configuration maximoanywhere_home\ parameters for apps Anywhere\MaximoAnywhere\ server\conf build.properties Contains the variable aspects maximoanywhere_home\ of the build process and Anywhere\MaximoAnywhere defines the target server to which an app is deployed app-feature.properties Contains variable aspects of maximoanywhere_home\ the build process Anywhere\MaximoAnywhere\ apps\app_name MaximoAnywhere.war Packages distributable maximoanywhere_home\ application files and related Anywhere\MaximoAnywhere\ project resources and deploys bin them to MobileFirst Server.
Table 1. The directory structure of the application file and the properties files.
The application deployment process generates another set of files. These files are created after you run the build all command from the command line or you run the adapter and apps deployment tasks in MobileFirst Studio.
File Description Path OSLCGenericAdapter.adapter Contains server adapter code maximoanywhere_home\ Anywhere\MaximoAnywhere\ bin application_name.wlapp Contains server artifacts maximoanywhere_home\ Anywhere\MaximoAnywhere\ bin application_name.apk Contains client artifacts maximoanywhere_home\ Anywhere\MaximoAnywhere\ application_name.ipa bin application_name.appx
Table. 2 The directory structure of the generated files. Configuring MySQL Database Extra configuration might be required before you can load mobile app .apk files to the MobileFirst Server when MySQL Database is used. With MySQL Database, the .apk file must not be bigger than 10% of the innodb_log_file_size value.
62 Planning, installation, and deployment Procedure 1. Stop the WebSphere Application Server. 2. Stop the MySQL service. 3. From the C:\ProgramData\MySQL\MySQL Server 5.6\ directory, open the my.ini file for editing and update the innodb_log_file_size value. For example, if the .apk file is 37 MB, the innodb_log_file_size variable must have more than 370 MB plus the sum of all other variable length fields. 4. Start the MySQL service. 5. Start WebSphere Application Server.
Adding digital signatures to Maximo Anywhere apps Maximo Anywhere apps must be digitally signed before they can be run on a device, distributed for testing, or submitted to the store. About this task
For apps that run on Android devices, follow the instructions in the Android documentation for signing Android APK files.
For apps that run on iOS devices, follow the instructions in the iOS documentation for maintaining your signing identities and certificates.
For apps that run on Windows devices, certificates must be installed on the devices as trusted certificates. Maximo Anywhere provides default certificates, but these certificates are temporary and eventually must be replaced with a certificate that you create. The default certificates are in the windows\native directory on each app. Each certificate is named MaximoAnywhere_TemporaryKey.pfx. You can update the certificate at any time. Procedure 1. From the mobilefirst_install_dir/MobileFirst_Platform_Server/ ApplicationCenter/installer directory, download and extract the IBMApplicationCenterWindowsStore.zip file on your device. 2. Run IBMApplicationCenter.exe. 3. Enter your product key. Microsoft product keys are required for sideloading apps that are not published to Windows Store. The product keys must be licensed in Microsoft and installed on the mobile device operating system. 4. If you do not want to use a default certificate, create your own *.pfx certificate. This process must be completed for each app individually: a. On your development workstation, open Visual Studio Tools and double-click the *.jsproj file that is in the windows/native directory. b. From the Solution Explorer, double-click the package.appxmanifest file, and then click the Packaging tab. c. In the Choose Certificate dialog box, select one of the options for including a *.pfx certificate, and click Save. The certificate is copied to the windows\native directory for the app. 5. Start the IBM MobileFirst Platform Application Center app, and connect to your IBM MobileFirst Platform Server. 6. After your MobileFirst Server connects, download and install the Maximo Anywhere apps onto your device. Related information:
Chapter 5. Building and deploying apps 63 IBM MobileFirst application authenticity overview
Deploying apps to a secure server The Secure Socket Layer protocol ensures secure transactions between servers and clients. The MobileFirst platform supports SSL between MobileFirst Server and the enterprise server. In Maximo Anywhere, the enterprise server is the Maximo server.
To protect the communication between a MobileFirst Server and the enterprise system, configure SSL for MobileFirst adapters and back-end servers.
To protect the communication between the client apps and the MobileFirst Server, configure SSL.
Installing Maximo Anywhere apps on mobile devices For Android and iOS devices, you install the Maximo Anywhere applications using the Application Center console through an internet browser. For Windows devices, the Application Center mobile client must be installed before the apps can be installed.
The Application Center console is a web application for managing the repository of mobile apps. The Application Center mobile client is a secure catalog of available Windows mobile apps. You must log in to the Application Center to download the mobile client to your devices.
If you are using MobileFirst Studio and you want to run on a connected mobile device, under MaximoAnywhere > apps, right-click the app and select Run As > Run on device.
For Android apps, follow the instructions in the MobileFirst documentation for installing the client on an Android mobile device.
For apps that run on Android devices, follow the instructions for building and running from the command line on the Android developers website.
For apps that run on iOS devices, follow the instructions in the MobileFirst documentation for installing the client on an iOS mobile device.
For apps that run on Windows devices, follow the instructions for installing a Windows Store application on a Windows device and follow the instructions for licensing and installing the product keys. Related concepts:
The Application Center mobile client Related tasks:
Adding an app to the Application Center Related information:
Specific platform requirements
64 Planning, installation, and deployment Installing Maximo Anywhere apps on Windows devices To install the apps on Windows devices, you must install the Application Center mobile client. The Application Center mobile client is a secure catalog of available mobile apps. Before you begin
Ensure that you have installed the Windows development tools and the Visual C++ redistributable packages are installed on the target Windows devices.
Import your certificate PFX file into the Trusted People store on each tablet.
For Windows 8.1 devices, run Powershell and accept the terms for the developer license.
For Windows 10 devices, from the Settings menu, enable sideloading of apps. For more information, see sideloading apps in Windows 10. About this task
You can install Maximo Anywhere mobile apps on Windows 8.1 (64-bit and excluding RT) or Windows 10 devices.
Certificates are used to sign the apps. The certificates must be installed on the mobile devices as trusted certificates. Maximo Anywhere provides default certificates. The default certificates are in the windows\native directory for each app. Each certificate is called MaximoAnywhere_TemporaryKey.pfx. This certificate is temporary and must be replaced with your own certificate. Procedure 1. From the mobilefirst_install_dir/ApplicationCenter/installer directory, download the IBMApplicationCenterWindowsStore.zip file to your Windows device. 2. Extract the IBMApplicationCenterWindowsStore.zip file, and run IBMApplicationCenter.exe. 3. Enter the Microsoft Windows product key. Product keys are required for sideloading apps that are not published in the Windows Store. The product keys must be licensed through Microsoft and installed on the mobile device operating system. For more information, see sideloading Windows apps. 4. Replace the temporary certificate with your own certificate. a. In Visual Studio Tools, open the app by double-clicking the *.jsprojfile that is in the windows\native directory. b. From Solution Explorer, select the package.appxmanifest file and click the Packaging tab. c. In the Choose Certificate window, select one of the options for including a *.pfx certificate. The certificate is copied to the windows\native directory for the app. d. Click Save. e. Repeat this process for each Maximo Anywhere app. 5. Start the Application Center app on your device. The context is applicationcenter. 6. Connect to your MobileFirst Server and download and install the Maximo Anywhere apps.
Chapter 5. Building and deploying apps 65 Testing apps After you deploy an app, you must verify that data is exchanged between the enterprise system database and the mobile application. You can use a mobile device, the Mobile Browser Simulator, an Android emulator, or the iOS Simulator to test apps. About this task Mobile device A mobile device is the most accurate way to test apps. To test your apps on a mobile device, you install the Application Center client on the mobile device and download the apps that you want to test. Mobile browser simulator In the Mobile Browser Simulator of MobileFirst Studio, you can test your apps on many different types of devices. The Mobile Browser Simulator contains settings that you can use to duplicate the look of your devices. To view the apps in the Mobile Browser Simulator in MobileFirst Studio, you must configure the web browser view to use Google Chrome as the external web browser. Android emulator To test your Android apps on your workstation rather than on a mobile device, you can use the emulator. The emulator is not as accurate a representation as a mobile device. The Android emulator requires that you download the APK file from the Application Center unless you are working with MobileFirst Studio. iOS Simulator To test your iOS apps on your workstation instead of on a mobile device, you can use the iOS Simulator. The iOS Simulator is not as accurate a representation as a mobile device. Visual Studio Windows Simulator To test your Windows apps on your workstation instead of on a mobile device, you can use the Windows Simulator. The Windows Simulator is not as accurate a representation as a mobile device. Procedure 1. Log in to a Maximo Anywhere app and search for a known work order. 2. In a Maximo Asset Management application, such as Work Order Tracking, use the same search criteria. 3. Compare the results to ensure that they are the same. Related concepts:
Mobile browser simulator
iOS Simulator
Visual Studio Windows Simulator Setting up the Android emulator The Android emulator can show you what your Android apps look like and help you test app behavior.
66 Planning, installation, and deployment Before you begin v Install the Oracle Java Development Kit. v Install the Android Software Development Kit.
If you are testing a new instance of a previously deployed application, clear the browser cache. In Google Chrome, go to Settings > Apps, and select the app whose data you want to clear. Click Clear Data. Procedure 1. From the AndroidSDK\adt-bundle-windows-x86_64\eclipse directory, run the SDK Manager.exe file. 2. In the SDK Manager, select Tools > AVD Manager and click New. 3. In the CPU/ABI field, select Intel Atm (x86). 4. Select the Hardware keyboard present check box and the Display a skin with hardware controls check box. 5. For SD Card Size, enter 1 GB and click OK. 6. Select your Android Virtual Device (AVD) and click Start. 7. Install the Application Center mobile client on the emulator. a. From a browser, enter the following URL: http://hostname:portnumber/ appcenterconsole/installers.html where hostname is the address of the server and portnumber is the number of the port where the Application Center is installed. b. Enter your user name and password. c. Click IBM App Center and Install Now. d. On the Notification tab, select the downloaded APK file. e. At the prompt, scroll to the bottom of the window and click Install. 8. Start the Application Center and download the apps that you want to test on your emulator.
Chapter 5. Building and deploying apps 67 68 Planning, installation, and deployment Chapter 6. Uninstalling Maximo Anywhere, MobileFirst Server, and MobileFirst Studio
You use Installation Manager to uninstall Maximo Anywhere, the mobile apps, and MobileFirst Server. If MobileFirst Studio is installed, you uninstall it from the Eclipse client. Procedure 1. To uninstall Maximo Anywhere, the mobile apps, and MobileFirst Server:
Option Description
On Windows 1. Click Start > All programs > IBM Installation Manager. 2. Start the IBM Installation Manager program and click Uninstall. 3. Select the packages that you want to uninstall and complete the wizard. 4. Manually remove any residual folders, for example, \Anywhere\ MobileFirst_Platform_Server. 5. Restart the server.
On Mac OS X 1. In the /Users/administrator directory, open the file Maximo_install.location. 2. Record the IM_install_dir property. For example, /Users/administrator/IBM/ anywhereinstall/ eclipse=IM_install_dir. 3. Change directory to the IM_install_dir directory and start Installation Manager. 4. Select Uninstall and select the package that you want to uninstall. 5. Complete the uninstallation wizard.
2. To uninstall MobileFirst Studio: a. In Eclipse, click Help > About Eclipse > Installation Details. b. From the Installed Software tab, select the following items and complete the wizard: v IBM Dojo Mobile Tools v IBM jQuery Mobile Tools v IBM MobileFirst Platform Studio 3. To remove the MaximoAnywhere project: a. In Eclipse, from the Project Explorer window, right-click the MaximoAnywhere project. b. Select Delete. c. Select Delete project contents on disk and click OK.
© Copyright IBM Corp. 2013, 2017 69 70 Planning, installation, and deployment Notices
This information was developed for products and services offered in the US. This material might be available from IBM in other languages. However, you may be required to own a copy of the product or product version in that language in order to access it.
IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing IBM Corporation North Castle Drive, MD-NC119 Armonk, NY 10504-1785 US
For license inquiries regarding double-byte character set (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:
Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan Ltd. 19-21, Nihonbashi-Hakozakicho, Chuo-ku Tokyo 103-8510, Japan
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some jurisdictions do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.
Any references in this information to non-IBM websites are provided for convenience only and do not in any manner serve as an endorsement of those
© Copyright IBM Corp. 2013, 2017 71 websites. The materials at those websites are not part of the materials for this IBM product and use of those websites is at your own risk.
IBM may use or distribute any of the information you provide in any way it believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:
IBM Director of Licensing IBM Corporation North Castle Drive, MD-NC119 Armonk, NY 10504-1785 US
Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.
The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.
The performance data and client examples cited are presented for illustrative purposes only. Actual performance results may vary depending on specific configurations and operating conditions.
Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.
This information is for planning purposes only. The information herein is subject to change before the products described become available.
This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to actual people or business enterprises is entirely coincidental.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. The sample
72 Planning, installation, and deployment programs are provided "AS IS", without warranty of any kind. IBM shall not be liable for any damages arising out of your use of the sample programs.
Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the web at "Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.
Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.
Linux is a trademark of Linus Torvalds in the United States, other countries, or both.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Terms and conditions for product documentation Permissions for the use of these publications are granted subject to the following terms and conditions. Applicability
These terms and conditions are in addition to any terms of use for the IBM website. Personal use
You may reproduce these publications for your personal, noncommercial use provided that all proprietary notices are preserved. You may not distribute, display or make derivative work of these publications, or any portion thereof, without the express consent of IBM. Commercial use
You may reproduce, distribute and display these publications solely within your enterprise provided that all proprietary notices are preserved. You may not make derivative works of these publications, or reproduce, distribute or display these publications or any portion thereof outside your enterprise, without the express consent of IBM. Rights
Except as expressly granted in this permission, no other permissions, licenses or rights are granted, either express or implied, to the publications or any information, data, software or other intellectual property contained therein.
Notices 73 IBM reserves the right to withdraw the permissions granted herein whenever, in its discretion, the use of the publications is detrimental to its interest or, as determined by IBM, the above instructions are not being properly followed.
You may not download, export or re-export this information except in full compliance with all applicable laws and regulations, including all United States export laws and regulations.
IBM MAKES NO GUARANTEE ABOUT THE CONTENT OF THESE PUBLICATIONS. THE PUBLICATIONS ARE PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
IBM Online Privacy Statement IBM Software products, including software as service solutions, (“Software Offerings”) may use cookies or other technologies to collect product usage information, to help improve the end user experience, to tailor interactions with the end user or for other purposes. In many cases no personally identifiable information is collected by the Software Offerings. Some of our Software Offerings can help enable you to collect personally identifiable information. If this Software Offering uses cookies to collect personally identifiable information, specific information about this offering’s use of cookies is set forth below.
Depending upon the configurations deployed, this Software Offering may use session and persistent cookies that collect each user’s name, user name, password, or other personally identifiable information for purposes of session management, authentication, single sign-on configuration or other usage tracking or functional purposes. These cookies can be disabled, but disabling them will also likely eliminate the functionality they enable.
If the configurations deployed for this Software Offering provide you as customer the ability to collect personally identifiable information from end users via cookies and other technologies, you should seek your own legal advice about any laws applicable to such data collection, including any requirements for notice and consent.
For more information about the use of various technologies, including cookies, for these purposes, see IBM’s Privacy Policy at http://www.ibm.com/privacy and IBM's Online Privacy Statement at http://www.ibm.com/privacy/details in the section entitled “Cookies, Web Beacons and Other Technologies” and the "IBM Software Products and Software-as-a-Service Privacy Statement" at http://www.ibm.com/software/info/product-privacy.
74 Planning, installation, and deployment Notices 75 IBM®
Printed in USA