IBM Maximo Asset PerformanceManagement - Predictive MaintenanceInsights On-Premises
IBM
ii IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Contents
Chapter 1. Product overview . . . . . . 1What's new . . . . . . . . . . . . . . . 3Accessibility features . . . . . . . . . . . 3
Chapter 2. Planning for deployment. . . 5Single-server installation . . . . . . . . . . 5Multiple-server installation . . . . . . . . . 5High-availability installation . . . . . . . . . 7Big data node installation . . . . . . . . . . 7
Chapter 3. Installing Maximo APM -Predictive Maintenance InsightsOn-Premises. . . . . . . . . . . . . 9Installing a standard configuration . . . . . . . 9
Prerequisites and installation preparation . . . . 9Install the Maximo APM - PredictiveMaintenance Insights On-Premises servers . . . 18Install the Maximo APM - PredictiveMaintenance Insights On-Premises server artifacts 35Client component installation . . . . . . . 52Stop and start solution software services. . . . 61Product license files . . . . . . . . . . 65Troubleshooting . . . . . . . . . . . . 65Supporting programs licensed with MaximoAPM - Predictive Maintenance InsightsOn-Premises . . . . . . . . . . . . . 72Programs not authorized by the Maximo APM -Predictive Maintenance Insights On-Premiseslicense . . . . . . . . . . . . . . . 74Administration tool and product portal reference 75
Installing a big data node configuration . . . . . 76Installing the product . . . . . . . . . . 76
Chapter 4. Using a standardconfiguration . . . . . . . . . . . . 87Building sample applications . . . . . . . . 87
Source code for the sample application . . . . 87Loading sample data for the sample application 88
Situational Awareness and UI and ServiceFramework . . . . . . . . . . . . . . 89
Managing the Standard Operating Procedures . . 89Extend situation awareness . . . . . . . . 99Customizing the solution using the UI andService Framework . . . . . . . . . . 109
Chapter 5. Using a big dataconfiguration . . . . . . . . . . . 155Provisioning the product . . . . . . . . . 155
Creating an instance . . . . . . . . . . 155Setting an API key . . . . . . . . . . 155Creating tenants . . . . . . . . . . . 156Creating users . . . . . . . . . . . . 156
Using the product . . . . . . . . . . . . 156Logging on . . . . . . . . . . . . . 157Downloading the tutorial and sample data . . 157Getting started . . . . . . . . . . . . 157Using data files. . . . . . . . . . . . 158Configuring training settings . . . . . . . 161Analysis results . . . . . . . . . . . 164Notification . . . . . . . . . . . . . 165Resetting the product. . . . . . . . . . 166
Integrating with other products . . . . . . . 166Integration with Watson IoT Platform . . . . 166Integration with Maximo Asset Management 167
Application programming interface . . . . . . 169Post entity data from Maximo AssetManagement . . . . . . . . . . . . 169Post event data from Maximo AssetManagement . . . . . . . . . . . . 171Post entity data in JSON format . . . . . . 172Post event data in JSON format . . . . . . 173Upload a file . . . . . . . . . . . . 174Download data . . . . . . . . . . . . 175Retrieve analysis results . . . . . . . . . 177Delete user data . . . . . . . . . . . 178View analysis status . . . . . . . . . . 179
Troubleshooting . . . . . . . . . . . . 180
iii
iv IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Chapter 1. Product overview
The IBM® Maximo Asset Performance Management - Predictive MaintenanceInsights On-Premises solution uses data from multiple sources to give you theinformation to make informed operational, maintenance, or repair decisions.
The Maximo APM - Predictive Maintenance Insights On-Premises solutionprovides two options: A standard configuration and a big data configuration.
Standard configuration
The standard configuration of Maximo APM - Predictive Maintenance InsightsOn-Premises provides you with operational intelligence data, which enables you toperform the following tasks:v Understand, monitor, predict, and control product and process variability.v Perform in-depth root cause failure analysis.v Identify incorrect operating practices.v Enhance equipment and process diagnostics capabilities.
It also provides you with asset performance management capabilities that help youto achieve these goals:v Have forward visibility into equipment and process performance.v Increase asset uptime.v Identify safety issues.v Identify improper maintenance procedures.v Optimize maintenance intervals and procedures.
Big data configuration
The big data configuration of Maximo APM - Predictive Maintenance InsightsOn-Premises focuses on the needs of the reliability engineer to identify andmanage asset reliability risks that could adversely affect plant or businessoperations. It applies machine learning and analytics to operational data generatedby critical assets to gain a better understanding of asset performance and thenoperationalize these analyses for continuous process improvement regardingmaintenance practices and resources.
IBM Maximo Asset Performance Management - Predictive Maintenance InsightsOn-Premises looks for patterns in how an equipment asset is used and theenvironment in which it is operating. It then correlates this information with anyknown failures in the equipment. These correlations are used to evaluate new dataabout the equipment asset, resulting in predictive scores that indicate the relativehealth of the equipment and the likelihood of future failures.
The ability to determine when maintenance should be performed on equipmentassets leads to the following business benefits:v You can estimate and extend the life of your assets.v You can increase the return on your assets.v You can optimize your maintenance, inventory, and resource schedules.
1
Maximo APM - Predictive Maintenance Insights On-Premises goes beyond bothpreventive and regularly scheduled maintenance to ensure asset performance,thereby enabling maximized value at every step of a process. Using Maximo APM- Predictive Maintenance Insights On-Premises, you can perform the followingtasks:v Predict the failure of an instrumented asset so that you can prevent costly
unexpected downtime.v Make adjustments to maintenance schedules and tasks to reduce repair costs and
minimize downtime.v Determine the most effective maintenance cycles.v Identify the root cause of asset failure faster so that you can take corrective
actions.
Instrumented assets generate data such as device ID, timestamp, temperature, andstatus code.
Examples of instrumented assets are manufacturing equipment, mining equipment,drilling equipment, farming equipment, security equipment, cars, trucks, trains,helicopters, engines, cranes, oil platforms, and wind turbines.
Data from instrumented assets and data from other sources such as maintenancerecords, maintenance logs, inspection reports, repair invoices and warranty claimscan be collected and used in models that predict when an asset is likely to fail.
Maximo APM - Predictive Maintenance Insights On-Premises helps an organizationoptimize its maintenance program by developing a set of recommendations tocarry out when specific changes in asset health are identified. Theserecommendations can be based upon analysis of historical maintenance records,best practices and procedures provided by subject matter experts, originalequipment manufacturer recommendations, as well as analysis of correlations thatindicate potential problems or pending asset failure. The goal of developing theseoptimized decisions or recommendations is to further improve maintenancepractices. When an anomaly in asset performance is identified specificrecommendations can be made to maintenance personnel in order to affect themost efficient remedy of the problem. In the case of a manufacturing organizationwhich provides service or warranty support for products that are used byhundreds or thousands of customers, the ability to monitor asset performance inthe field and proactively initiate a service call, in comparison to waiting for theclient to initiate a repair request or warranty claim, can significantly transform theway the manufacturer provides service. With a better understanding of assetusage and performance in the field manufacturer may wish to modify its warrantyprogram based upon asset usage or warranty costs. Additionally greater insightinto asset usage and performance can help the manufacturer to optimize the partsinventory and locations so as to reduce the volume of inventory and identifylocations to facilitate proactive customer service.
For example, an automobile assembly plant is a system that combines thousands ofpieces of equipment with interlocking pieces. It is critical that such a system is ableto work efficiently and produce safe, high quality products. Maximo APM -Predictive Maintenance Insights On-Premises looks for patterns in the usage andenvironmental information for equipment that correlate with failures that takeplace. These patterns are used to create predictive models to score incoming newdata in order to predict the likelihood of failure. Scores that are generated fromthis information give an indication of the health of the piece of equipment. Inaddition, key performance indicators (KPIs) are collected, which are used for
2 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
reporting. KPIs help to identify assets that do not conform to normal patterns ofbehavior. The plant employees can use dashboards and reports to monitor andtrack the lifecycle of each piece of equipment.
What's newThe What's new section contains a list of new, changed, and deprecatedconfiguration features for this release.
New features in the current release:
CognosIBM Cognos® Business Intelligence was updated to version 11.0.12.
IBM HTTP Server for WebSphere® Application ServerIBM HTTP Server for WebSphere Application Server was updated toversion 9.0.0.9.
IBM MQIBM MQ was updated to version 9.1.
SPSS Analytics Server
IBM SPSS® Analytics Server was updated to version 3.1.1.
SPSS Statistics ServerIBM SPSS Statistics Server was updated to version 25.0.
SPSS Modeler ServerIBM SPSS Modeler Server was updated to version 18.1.1.
SPSS Collaboration and Deployment ServicesIBM SPSS Collaboration and Deployment Services were updated to version8.1.1.
WebSphere Application Server Network DeploymentWebSphere Application Server Network Deployment was updated toversion 9.0.0.9.
WebSphere Application Server Network Deployment LibertyWebSphere Application Server Network Deployment Liberty was updatedto version 18.0.0.3.
Accessibility featuresAccessibility features help users who have a physical disability, such as restrictedmobility or limited vision, to use information technology products.
For information about the commitment that IBM has to accessibility, see the IBMAccessibility Center (www.ibm.com/able).
IBM Cognos HTML documentation has accessibility features. PDF documents aresupplemental and, as such, include no added accessibility features.
Report output
In IBM Cognos Administration, you can enable system-wide settings to createaccessible report output. For more information, see the IBM Cognos BusinessIntelligence Administration and Security Guide. In IBM Cognos Report Studio, you canenable settings to create accessible output for individual reports. For moreinformation, see the IBM Cognos Report Studio User Guide. You can access the
Chapter 1. Product overview 3
previously mentioned documents at IBM Knowledge Center (http://www.ibm.com/support/knowledgecenter).
4 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Chapter 2. Planning for deployment
You can deploy the product in a number of configurations.
Single-server installationIn a single-server IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises installation, the components for each node areinstalled to the same computer. Each node is configured to run on a separateWebSphere Application Server profile.
For example, the Predictive Analytics node components are installed to aWebSphere Application Server profile named CNDSProfile that is using portnumber 9082. Each profile runs on the same WebSphere Application Serverinstance.
The following table lists the port numbers for the WebSphere Application Serverinstance:
Table 1. Port numbers for WebSphere Application Servers
Component Admin port SSL admin port Application port
IBM SPSS 61 41 81
Important: A single-server installation should be used only for a test ordemonstration environment.
Multiple-server installationIn a multiple-server installation, each IBM Maximo Asset PerformanceManagement - Predictive Maintenance Insights On-Premises node provides aspecific function for the solution. Each node must be installed on a separatecomputer or on a separate virtual machine image from other nodes.
The following diagram shows the nodes in a multiple-server architecture.
5
Predictive Analytics node
The Analytics node provides predictive scores and offers recommendations.
This node has the following software installed:v IBM WebSphere Network Deploymentv IBM SPSS Collaboration and Deployment Servicesv IBM SPSS Modeler Serverv IBM SPSS Modeler Solution Publisherv IBM SPSS Modeler Server Premiumv IBM SPSS Data Access Packv IBM SPSS Modeler Collaboration and Deployment Services Adapterv IBM SPSS Decision Managementv IBM SPSS Statistics Serverv IBM SPSS Statistics Collaboration and Deployment Services Adapterv IBM DB2® Client
Business Intelligence (BI) node
The IIB node provides dashboards and reports.
This node has the following software installed:
Figure 1. Maximo APM - Predictive Maintenance Insights On-Premises nodes
6 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
v IBM Cognos Business Intelligencev IBM DB2 Client
Integration Bus node
The Integration Bus node processes events, updates the content for IBM CognosBusiness Intelligence, and triggers predictive scoring and decision management. Italso loads master data into the solution.
This node has the following software installed:v IBM WebSphere MQv IBM Integration Busv IBM Integration Explorerv IBM Integration Bus ODBC Database Extenderv IBM DB2 Clientv IBM WebSphere Network Deploymentv IBM HTTP Server
Data node
The data node provides the database server that contains the databases that areused by other products in the solution. The database acts as an event store andholds calculated key performance indicators (KPIs) and profiles. It also containssupporting master data for the solution.
This node has the following software installed:v IBM DB2 Enterprise Server Edition
High-availability installationYou can choose to copy the installation programs for all of the IBM Maximo AssetPerformance Management - Predictive Maintenance Insights On-Premisescomponent programs to a computer, and then manually install the componentsindividually.
This option does not install the programs or configure them. The installation andconfiguration must be done manually. Use this option to deploy Maximo APM -Predictive Maintenance Insights On-Premises if you have specific configurationrequirements that are not available from the single-server or multiple-serveroptions in the Maximo APM - Predictive Maintenance Insights On-Premisessolution installer. For information on how to install the individual components,refer to the component product documentation.
Big data node installationIn a big data node installation, WebSphere Application Server Liberty is installedon the application node. Maximo APM - Predictive Maintenance InsightsOn-Premises is installed on the same node and connected with the HortonworksData Platform cluster.
Chapter 2. Planning for deployment 7
8 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Chapter 3. Installing Maximo APM - Predictive MaintenanceInsights On-Premises
After you plan your deployment, you can install the servers, server artifacts, andclient components.
Installing a standard configurationComplete these tasks to install a standard configuration of Maximo APM -Predictive Maintenance Insights On-Premises. You can perform a multi-server orsingle-server installation.
Prerequisites and installation preparationBefore you install IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises, ensure that the computers that you use meetthe minimum requirements for operating systems, prerequisite software,processing, and disk space.
Important: The computers or virtual machines that you use for Maximo APM -Predictive Maintenance Insights On-Premises nodes must not have any of theincluded software already installed.
Supported operating systems and hardware requirementsReview the minimum hardware and operating system requirements before youinstall IBM Maximo Asset Performance Management - Predictive MaintenanceInsights On-Premises. The requirements apply for all computers or virtualmachines that you use for the installation.
For an up-to-date list of environments that are supported by Maximo APM -Predictive Maintenance Insights On-Premises, see the IBM Software ProductCompatibility Reports.
Server computers
The Maximo APM - Predictive Maintenance Insights On-Premises servercomponents must be installed on computers that are running the 64-bit Red HatEnterprise Linux Server Edition version 7.2 (x86_64) operating system.
Hardware requirements for a multiple server environment
At a minimum, each computer or virtual machine that hosts a MaximoAPM - Predictive Maintenance Insights On-Premises server component, ornode, must have the following hardware requirements:v 4 processorsv 8 GB of RAMv 500 GB of hard disk space
The computer from which you run the installation must have sufficientdisk space that is allotted to the / directory. For the computer where youare running the installation, the minimum recommended disk space for the/ directory is 150 GB. Each node computer should have a minimum of 100GB of disk space that is allocated to the / directory.
9
Important: If you are installing from the universal serial bus (USB) harddisk drive, you must have 300 GB of disk space allocated to the / directory.
If you are expecting to store large volumes of data, you might need toincrease your disk size.
Each node must be installed on a separate computer or on a separatevirtual machine image.
The home directory on the database node must have a minimum of 30 GB.
The temporary location of the solution installer is /var/chef/cache. Toaccommodate the solution installer files, there must be a minimum of 100GB on /var.
Hardware requirements for a single-server environment
At a minimum, the computer or virtual machine on which you installMaximo APM - Predictive Maintenance Insights On-Premises must havethe following hardware requirements:v 4 processorsv 8 GB of RAMv 500 GB of hard disk space
The computer from which you run the installation must have sufficientdisk space that is allotted to the / directory. For the computer where youare running the installation, the minimum recommended disk space for the/ directory is 400 GB.
Important: A single-server installation should be used only for a test ordemonstration environment.
User requirements
You must have root or sudo access to all of the computers on which youinstall a Maximo APM - Predictive Maintenance Insights On-Premisesnode, including the computer from which you run the installation.
Installation directory requirements
The file paths that you specify in the solution installer must not includeyour user home directory. For example, if you are a sudo user called“sample”, your home directory is /home/sample. Do not include this pathin the file paths that you specify when you are configuring the nodes insolution installer.
Server computers
The Maximo APM - Predictive Maintenance Insights On-Premises servercomponents must be installed on computers that run Microsoft Windows 2008Server (x86_64) operating systems.
Hardware requirements
At a minimum, each computer or virtual machine that hosts a MaximoAPM - Predictive Maintenance Insights On-Premises server component, ornode, must have the following hardware requirements:v 4 processorsv 32 GB of RAMv 300 GB of hard disk space
10 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
If you are expecting to store large volumes of data, you might need toincrease your disk size.
For best performance, each node should be installed on a separatecomputer or on a separate virtual machine image.
User requirements
You must have administrator access to all of the computers on which youinstall a Maximo APM - Predictive Maintenance Insights On-Premisesnode.
Client computers
The Maximo APM - Predictive Maintenance Insights On-Premises clientcomponents must be installed on computers that run Microsoft Windows 7 orMicrosoft Windows 8 operating systems.
At a minimum, the computer where you run the Deployment Wizard for the clientcomponents must have the following hardware requirements:v 2 processorsv 4 GB of RAMv 200 GB of hard disk space
Modifying the sudoers file for the user who runs the installationTo run the IBM Maximo Asset Performance Management - Predictive MaintenanceInsights On-Premises installation you must be either root user or have sudopermission on each node computer.
To install with sudo user permissions, you must also add the user to the sudoersfile.
Procedure1. Log in as root user.2. Enter the following command to open the sudoers file for editing:
visudo -f /etc/sudoers
3. At the end of the file, add the following line for your user:username ALL=(ALL) ALL
4. Press the Esc key, and enter :wq to save and close the file.5. Repeat these steps on each computer on which you install a Maximo APM -
Predictive Maintenance Insights On-Premises node.
Disabling requirettyBefore you install the product, you must disable the requiretty in the /etc/sudoersfile.
About this task
You disable requiretty on every node, including the staging node, in the/etc/sudoers file.
Procedure1. Log in as root user.2. To open the sudoers file for editing, enter the following command:
visudo -f /etc/sudoers.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 11
3. Go to the "Defaults requiretty" line and add a number sign (#) to the beginningof the line.
What to do next
Repeat these steps on each computer that you are going to install the product.
Installing required operating system packages for all nodesSpecific operating system packages must be installed on each computer or virtualmachine where you install an IBM Maximo Asset Performance Management -Predictive Maintenance Insights On-Premises node.
Ensure that the following packages are installed on every node in yourdeployment. These are the minimum versions required:v compat-libstdc++-33-3.2.3-72.el7.i686.rpm
v compat-libstdc++-33-3.2.3-72.el7.x86_64.rpm
v pam-1.1.8-18.el7.i686.rpm
v nfs-utils.rpm
v libaio.x86_64.rpm
v dos2unix.x86_64.rpm
v unzip.x86_64.rpm
v sed.x86_64.rpm
v openssl.x86_64.rpm
v libstdc++.i686.rpm
v libstdc++.x86_64.rpm
You can download the packages from a site such as pkgs.org or rpm.pbone.net.
Procedure1. Log on to the computer as the root user or as a user with sudo permissions.2. Type the following command to verify that an operating system package is
installed:rpm -qi full_package_name
For example, to verify that compat-libstdc++-33-3.2.3-69.el6.i686.rpm isinstalled, type rpm -qi compat-libstdc++-33-3.2.3-69.el6.i686.
Note: You might have to use sudo to run the command successfully.For example, enter sudo rpm -qi full_package_name.
3. Install any package that is not already installed.You must download any missing package, and then install the downloadedpackage by typing the following command:
Note: Download the latest version if the version of the package is not specifiedin the packages list.rpm -ihv full_package_name.rpm
For example, to install ccompat-libstdc++-33-3.2.3-72.el7.i686.rpm, type rpm-ihv compat-libstdc++-33-3.2.3-72.el7.i686.rpm.To install pam-1.1.1-18.el7.i686.rpm, use the following command: rpm -ihv-force pam-1.1.8-18.el7.i686.rpm.
4. Repeat these steps on each computer on which you install a Maximo APM -Predictive Maintenance Insights On-Premises node.
12 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
If you have yum repositories configured for your Linux operating systemcomputers, you can use the following command to install all of the prerequisiteRPMs:yum -y install --setopt=protected_multilib=false compat-libstdc++-33.i686 compat-libstdc++-33.x86_64 pam.i686 nfs* libaio dos2unix unzipsed openssl.x86_64 libstdc++.i686 libstdc++.x86_64
5. If there are messages that show a conflict with the x86_64 version and the i686version for certain rpm. You must install the x86_64 version and then install thei686 version.
Installing required operating system packages on the IIB nodecomputerSpecific operating system packages must be installed on the Linux operatingsystem computer or virtual machine where you install the Business Intelligence(BI) node node.
For a complete list of software requirements for IBM Cognos Business Intelligence,see the Cognos Business Intelligence 10.2.2 Supported Software Environments page(www.ibm.com/support/docview.wss?uid=swg27042164).
You must ensure that the following 32-bit packages are installed. These are theminimum versions required:v libgcc-4.8.5-11.el7.i686.rpm
v libselinux-2.5-6.el7.i686.rpm
v cracklib-2.9.0-11.el7.i686.rpm
v audit-libs-2.6.5-3.el7.i686.rpm
v pam-1.1.8-18.el7.i686.rpm
v libXtst-1.2.2-2.1.el7.i686.rpm
v apr-util-1.5.2-6.el7.i686.rpm
You can download the packages from a site such as pkgs.org or rpm.pbone.net.
Procedure1. Log on to the IIB node computer as the root user or as a user with sudo
permissions.2. Type the following command to verify that an operating system package is
installed:rpm -qi package_name
For example, to verify that libselinux is installed and what version you have,type rpm -qi libselinux.
Note: You might have to use sudo to run the command successfully.For example, enter sudo rpm -qi full_package_name.
3. Install any package that is not already installed.You must download any missing package, and then install the downloadedpackage by typing the following command:rpm -ihv full_package_name.rpm
For example, to install libselinux-2.5-6.el7.i686.rpm, type rpm -ihvlibselinux-2.5-6.el7.i686.rpm.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 13
Tip: If you have yum repositories configured for your Linux operating systemcomputers, you can use the following command to install all of the prerequisiteRPMs:yum -y install --setopt=protected_multilib=false libselinux.i686cracklib.i686 audit-libs.i686 pam.i686 libgcc.i686 libXtst.i686apr-util.i686
If you can't get the pam library downloaded, then manually download thelibrary on to the RHEL environment, and use the following command to installit: rpm –ihv –force pam library name.
Installing required operating system packages on the IntegrationBus node computerSpecific operating system packages must be installed on the Linux operatingsystem computer or virtual machine where you install the IBM Maximo AssetPerformance Management - Predictive Maintenance Insights On-PremisesIntegration Bus node node.
Ensure that the following 32-bit or 64-bit packages are installed. These are theminimum versions required:v gtk2-2.24.28-8.el7.i686.rpm
v libXtst-1.2.2-2.1.el7.i686.rpm
v libXtst-1.2.2-2.1.el7.x86_64.rpm
v glibc-2.17-157.el7_3.1.i686.rpm
v libgcc-4.8.5-11.el7.i686.rpm
v webkitgtk-2.4.9-1.el7.x86_64.rpm
You can download the packages from a site such as pkgs.org or rpm.pbone.net.
Procedure1. Log on to the computer as the root user or as a user with sudo permissions.2. Type the following command to verify that an operating system package is
installed:rpm -qi package_name
For example, to verify that gtk2 is installed and what version you have, typerpm -qi gtk2.
Note: You might have to use sudo to run the command successfully.For example, enter sudo rpm -qi full_package_name.
3. Install any package that is not already installed.You must download any missing package, and then install the downloadedpackage by typing the following command:rpm -ihv full_package_name.rpm
For example, to install gtk2-2.24.28-8.el7.i686, type rpm --ihvgtk2-2.24.28-8.el7.i686.rpm.
Tip: If you have yum repositories configured for your Linux operating systemcomputers, you can use the following command to install all of the prerequisiteRPMs:yum -y install --setopt=protected_multilib=false gtk2.i686 libXtst.i686glibc.i686 libgcc.i686 webkitgtk
14 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Additional prerequisites for the sudo userThere are additional prerequisites if you use the sudo user to install IBM MaximoAsset Performance Management - Predictive Maintenance Insights On-Premises.
Operating system group
Create an operating system group with the same name as the sudo user whoinstalls Maximo APM - Predictive Maintenance Insights On-Premises. For example,if SVC_PMIAdmin is a sudo user doing the installation, then you must create anoperating system with name SVC_PMIAdmin. Use the command sudo groupaddSVC_PMIAdmin. A group is also created for the new user. If the group does not exist,create one using the same syntax.
Adding each node computer to the hosts fileTo ensure that each IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises node computer can communicate properly, youmust add all node computers to the hosts file on each node computer.
For example, the hosts file on the data node computer must include the PredictiveAnalytics node, the Business Intelligence (BI) node and the Integration Bus nodecomputers.
Procedure1. On each node computer, open the /etc/hosts file.2. Ensure that each node computer is listed in the file. For example, ensure that
your hosts file contains values such as the following values:127.0.0.1 localhost.localdomain localhost##.##.##.## analytics_node_name.domain.com analytics_node_name##.##.##.## iib_node_name.domain.com iib_node_name##.##.##.## data_node_name.domain.com data_node_name##.##.##.## integrationbus_node_name.domain.com integrationbus_node_name##.##.##.## staging_node_name.domain.com staging_node_name
3. For each entry, ensure that the alias matches the first part of the hostname, forexample:9.9.9.9 hostname.example.com hostname
4. Save and close the file.
Installing Java on the Predictive Analytics node computerYou must install a Java™ Runtime Environment (JRE) on the computer you use asthe IBM Maximo Asset Performance Management - Predictive MaintenanceInsights On-Premises Analytics node.
You must install Java version 1.7 or later on the Analytics node computer.
Installing Python and PyXML on the Predictive Analytics nodecomputer (optional)If you want to use Python, then you must install Python and PyXML on thecomputer you use as the IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises Analytics node.
Install Python version 2.7.1 or later and PyXML version 0.8.4.
Procedure1. Log in to the Analytics node computer as the root user or as a user with sudo
permissions.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 15
2. Download and install Python version 2.7.1. You can download the installerfrom the Python web site (https://www.python.org/download/releases/2.7.1).
3. Download and install PyXML version 0.8.4. You can download the installerfrom the PyXML web site (https://pypi.python.org/pypi/PyXML/0.8.4).
Installing R software on the Predictive Analytics node computer(optional)If you want to use R, you must install R and Essentials for R software on thecomputer you use as the IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises Analytics node.
For more information about R and Essentials for R software for IBM SPSS, see theIBM SPSS documentation (https://www.ibm.com/developerworks/community/wikis/home?lang=en#!/wiki/We70df3195ec8_4f95_9773_42e448fa9029/page/Downloads%20for%20IBM%C2%AE%20SPSS%C2%AE%20Statistics).
Procedure1. Log in to the Analytics node computer as the root user or as a user with sudo
permissions.2. Download and install R software. You can download the installer from The
Comprehensive R Archive Network website (http://cran.r-project.org).
Setting ulimit values on nodes where WebSphere ApplicationServer is to be installedBefore you install IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises, you must ensure that you have appropriateulimit values on each node where WebSphere Application Server is to be installed.
About this task
You must set ulimit values on the Business Intelligence (BI) node and thePredictive Analytics node.
Procedure1. Log in to the Business Intelligence (BI) node computer as the root user or as a
user with sudo permissions.a. Go to the /etc/security directory.b. Open the limits.conf file for editing.c. Add the following lines to the file:
@root soft nofile 10000@root hard nofile 16384* soft nofile 10000* hard nofile 16384
d. Save and close the file.e. Restart the computer for the changes to take effect.
2. Log in to the Predictive Analytics node computer as the root user or as a userwith sudo permissions.a. Go to the /etc/security directory.b. Open the limits.conf file for editing.c. Add the following lines to the file:
@root soft nofile 10000@root hard nofile 16384* soft nofile 10000* hard nofile 16384
16 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
d. Save and close the file.e. Restart the computer for the changes to take effect.
Creating directories for the solution installerYou must create a directory on each computer on which you install an IBMMaximo Asset Performance Management - Predictive Maintenance InsightsOn-Premises component.
The solution installer uses the /opt/IBM directory to copy license files and otherfiles. This directory must exist on each node computer and on the computer onwhich you run the solution installer before you run the installation.
Procedure1. Create an /opt/IBM directory on each computer on which you are going to
install an IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises component.
2. Create an /opt/IBM directory on the computer on which you are going to runthe solution installer.
Mounting the USB hard disk driveThe installation files for IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises are provided on a universal serial bus (USB)hard disk drive. You can run the installation from the USB or you can copy thefiles to your computer before you start the installation. Before you do either, youmust mount the USB hard disk drive.
For more information about mounting USB hard disk drives, see the Red HatCustomer Portal (https://access.redhat.com/home).
Update the services file for IBM DB2 portsYou must update the /etc/services file before and after you install IBM MaximoAsset Performance Management - Predictive Maintenance Insights On-Premises.
Fast Communications Manager (FCM) is a feature of IBM DB2 that handlescommunications between database partition servers. When you install theinstance-owning database server on the primary computer, DB2 reserves a portrange according to the specified number of logical database partition servers thatare participating in the partitioned database environment. The default range is fourports in the range 60000-60003.
DB2 installation on data node fails if these port ranges are allocated to differentservices. Therefore, you must comment out the service entries that use this portrange in the /etc/services file until the Maximo APM - Predictive MaintenanceInsights On-Premises installation is complete.
After the installation of Maximo APM - Predictive Maintenance InsightsOn-Premises, replace the port range 60000-60003 entries in /etc/services file withany other available port ranges (the ports must be sequentially numbered).Uncomment the original service that uses the port range 60000-60003.
For more information about the port range, see Verifying port range availability onparticipating computers (Linux and UNIX) (www.ibm.com/support/knowledgecenter/SSEPGG_10.5.0/com.ibm.db2.luw.qb.server.doc/doc/t0011777.html).
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 17
Use the Bash shellUsers who run Deployment Wizard, and all other relevant application user IDs (forexample, db2inst1, db2fence1, mqmuser, sudo, and root), must use the Bash shell.
To check which shell is in use by the current user ID, enter echo $SHELL.
To change a user ID's shell, log in as root or sudo user and use the usermod -scommand. For example, to change the db2inst1 user ID's shell to Bash, enterusermod -s /bin/bash db2inst1.
Install the Maximo APM - Predictive Maintenance InsightsOn-Premises servers
You use the solution installer to deploy the component programs on the serversthat make up the solution.
The solution installer runs on a Linux version 7 (x86_64 with update 2) operatingsystem. It has a web interface that you use to define, validate, and install yourenvironment.
You define your environment by identifying node computers, and dragging thecomponent programs onto the nodes. The solution installer provides guidance forwhere you can add components and you can use it to validate the environmentthat you define.
Important: The operating system for the computer where you run the solutioninstaller must be set to use English as the language. The solution installer does notrun on other languages. The client computers must also be using English as thelanguage.
Installation processWith the IBM Maximo Asset Performance Management - Predictive MaintenanceInsights On-Premises server solution installer you can select the individualcomputers on which each solution node is to be installed and enter configurationinformation for each software component.
The diagram shows the installation process being run from one server, the stagingserver, and the IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises components are being installed to differentcomputers in a multiple server deployment.
18 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
In the diagram, the staging server represents the computer from which you run thesolution installer. In your installation, the staging server can also be used as a nodecomputer. If you use a separate computer as the staging server, that computermust also use the same operating system as the other computers on which youinstall a node. It must also have the same prerequisites.
If you are installing Maximo APM - Predictive Maintenance Insights On-Premiseson a single server, you can install the components to the same computer whereyou are running the installation.
Downloading and decompressing the installation filesYou must download the IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises solution from IBM Passport Advantage, andthen decompress the files to run the solution installer.
For more information about the files that you must download, see the downloaddocument for IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises at www.ibm.com/support/home/.
Procedure1. Access the IBM Passport Advantage® web site.
Tip: If you receive an error, try using a different web browser to accessPassport Advantage.
2. Sign in and navigate to the software downloads page.3. Find the eImages for IBM Maximo Asset Performance Management -
Predictive Maintenance Insights On-Premises.4. Download an eImage by selecting the check box for the name. Download all
eImages for IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises and all eImages for IBM IOT forManufacturing Foundation. When the download is complete, a DownloadComplete message is displayed. The location of the downloaded files isdisplayed in the message window. The downloaded files for IBM IOT for
Figure 2. IBM Maximo Asset Performance Management - Predictive Maintenance InsightsOn-Premises multiple server installation process
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 19
Manufacturing Foundation are the iotmf_server_1.1_l86-64_en.zip file andiotmf_ser_installer_1.1_l86-64_en.zip file.
5. You may want to copy the files to another directory for safekeeping. Makenote of this directory because you will refer to it again when you install theartifacts and the client components.
6. Decompress the eImage files.7. Decompress the pmi_svr_installer_1.0.2_l86-64_en.tar.gz file.
The file is decompressed to a directory that is named ServerInstallation. Youmust copy the server tar.gz files into the ServerInstallation/SolutionInstaller/NodeRoot/Downloads/Software directory.
8. Copy the other tar.gz files to the ServerInstallation/SolutionInstaller/NodeRoot/Downloads/Software directory.The tar.gz files that you need are pmi_svr_1.0.2_1_l86-64_en.tar.gz,pmi_svr_1.0.2_2_l86-64_en.tar.gz, and pmi_svr_1.0.2_3_l86-64_en.tar.gz.
9. Decompress the iotmf_server_1.1_l86-64_en.zip file to obtain theiotmf_server_1.1_l86-64_en.tar.gz file.
10. Copy the iotmf_server_1.1_l86-64_en.tar.gz file to the ServerInstallation/SolutionInstaller/NodeRoot/Downloads/Software directory.
11. You can manually decompress the files, or run thePMI_1.0.2_UncompressTarball.sh script to decompress the files.To run the script, enter sh PMI_1.0.2_UncompressTarball.sh.To manually decompress the files, enter tar xvf filesname.tar.gz.
Opening firewall ports for the solution installerYou can run the firewall.sh script to open the ports that are required on thecomputer on which you are running the IBM Maximo Asset PerformanceManagement - Predictive Maintenance Insights On-Premises solution installer.
You must also open ports on the target, or client, computers on which you areinstalling a IBM Maximo Asset Performance Management - Predictive MaintenanceInsights On-Premises node. You can use the client_firewall.sh script to open therequired ports.
The firewall.sh script opens the following ports on the solution installercomputer:v 8080 incomingv 443 incomingv 9683 incomingv 22 outgoing
On the target, or client computers, the client_firewall.sh script opens thefollowing ports:v 8080 outgoingv 443 incomingv 9683 outgoingv 22 incoming
Procedure1. Log on to the computer that contains the solution installer node as the root
user or as a user with sudo permissions.
20 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
2. Go to the directory where you decompressed the solution installer files, andrun the firewall script by typing the following command: sh firewall.sh if youare the root user or sudo sh firewall.sh if you are a user with sudopermissions. For example, go to the ServerInstallation/SolutionInstallerdirectory.
3. Copy the client_firewall.sh file onto each computer on which you are goingto install an IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises node.
4. Log on to each computer on which you are going to install an IBM MaximoAsset Performance Management - Predictive Maintenance Insights On-Premisesnode as the root user or as a user with sudo permissions.
5. Go to the directory where you copied the client_firewall.sh file, and run thescript by typing the following command: sh client_firewall.sh.
Starting the server solution installerYou run the server solution installer on a Red Hat Enterprise Linux operatingsystem. Use the server solution installer to define the servers in the IBM MaximoAsset Performance Management - Predictive Maintenance Insights On-Premisesenvironment. After the solution installer is running, you access the solutioninstaller interface from another computer by using a web browser and startdefining your environment.
Before you begin
In this task, you must have access to a computer that is separate from thecomputer that contains the installation files. This computer has the followingrequirements:v Has a monitor with a screen resolution that is greater than 1024 by 760.v The operating system uses English.v Has Google Chrome 44 or later, or Mozilla Firefox 38 or later installed on it. The
language of the installed web browser language must be English.
The installation files must be in a directory for which you have executepermissions.
Procedure1. Log on to the computer where you decompressed the installation files as the
root user or as a user with sudo permissions.2. Go to the ServerInstallation/SolutionInstaller directory where you
decompressed the solution installer files.3. If you are the root user, enter the following command: sh setup.sh. If you are
a user with sudo permissions, enter the following command: sudo sh setup.sh.4. Optional: For Apple Macbook users, if an error displays that states that a
cookbook failed to upload, do the following to resolve the issue.a. Open the terminal and run the following command: vi ~/.bash_profile.b. Add the following variables to the .bash_profile file and save the change:
export LC_ALL=en_US.UTF-8export LANG=en_US.UTF-8
c. Run the following command: source ~/.bash_profile.d. Run the echo $LANG command. If the result is en_US.UTF-8, you can
continue to the next step.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 21
5. Open a web browser on another computer, and go to the solution installerURL: https://servername:8080/UI/index.html.
Important: Do not use a web browser on the computer on which you arerunning the solution installer or any computer on which a Maximo APM -Predictive Maintenance Insights On-Premises component is being installed. Youmust use a web browser on another computer.
Results
Now you can access the solution installer from any computer in a Firefox orChrome web browser.
Using the solution installerYou use the solution installer to define your IBM Maximo Asset PerformanceManagement - Predictive Maintenance Insights On-Premises environment youwant to install.
You define the environment by identifying node computers and adding thesoftware that you want installed on each node. You create an installationconfiguration for your solution by dragging nodes onto a canvas and thendragging components into the nodes.
You can save your configurations. For more information, see “Saving and openingconfigurations” on page 29.
You can also load predefined configurations. For more information, see “Using apredefined configuration” on page 30.
Important: The solution installer runs on Google Chrome 44 or later or MozillaFirefox 38 or later. It does not run on Internet Explorer.
For more information about supported software, see the IBM Software ProductCompatibility Reports (www.ibm.com/support/docview.wss?uid=swg27041626).
Procedure1. Open the solution installer in a web browser.
After the solution installer is running, you can access the URL from anycomputer from a Firefox or Chrome web browser.The URL is https://servername:8080/UI/index.html, where servername is thename of the computer where you ran the solution installer.
Important: Do not use a web browser on the computer on which you arerunning the solution installer or any computer on which a Maximo APM -Predictive Maintenance Insights On-Premises component is being installed.You must use a web browser on another computer.Ensure that you are using an English language web browser to access thesolution installer URL.
2. On the license information page, click Accept.CAUTION:Declining the license allows you to uninstall the solution installer andremove all of the files from the solution installer directory.
3. Select New Configuration, and click OK.
22 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
4. From the Mandatory Software List pane, drag a Node object onto theConfiguration Editor pane.If you are installing IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises on four nodes, you must drag four Nodeobjects onto the Configuration Editor pane.A visual representation of an empty node is displayed.
5. In the Property Editor pane, select the node object, and enter the followinginformation.a. Enter a name for the node in Name, and press the Enter key. For example,
enter BI node.b. Enter the server name in Host Name, and press the Enter key.
Important: Unless you are using a single node configuration, ensure thatthe host names or IP addresses are for different computers. Do not use thesame computer for more than one Node object.
c. Enter the user who has access to install the components in User Name,and press the Enter key. For example, enter root or a user with sudopermissions.
d. Enter the user's password in User Password, and press the Enter key.e. Repeat these steps for each node object that you add. If you are installing
IBM Maximo Asset Performance Management - Predictive MaintenanceInsights On-Premises on four nodes, you must repeat these steps for eachof the four node objects.
Important: You must enter any mandatory information for nodes and otherobjects as indicated. Ensure that you review all of the properties to ensure thatthe values, both mandatory and optional, are valid.Ensure that you press the Enter key after you type a value for a property.
6. From the Mandatory Software List pane, create your environment bydragging each object onto the appropriate node in the Configuration Editorpane.
Tip: Valid drop zones are indicated in the Configuration Editor pane.Some restrictions are built into the placement of the objects. For example, ifyou are adding IBM Cognos BI Server to a node, then you must already haveWebSphere Application Server on that node, and the IBM Cognos BI Serverobject must be placed within the WebSphere Application Server object.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 23
Tip: Example environments are provided in the predefined configurations thatare included with the installation files. For more information, see “Using apredefined configuration” on page 30.
Note: If you add the IBM DB2 Data Server Runtime Client component tothe same node as the IBM DB2 Enterprise Server component, the IBM DB2Data Server Runtime Client component will not be installed.
7. After you add an object, select it, and modify any values in the PropertyEditor pane.When you add WebSphere Application Server to a node, you must providethe following information:v WebSphere Install Directory is the location where WebSphere Application
Server is to be installed.v WebSphere Application Port is the port number that you want to use for
WebSphere Application Server.v WAS Profile Admin User Name is the administrator user's user name for
WebSphere Application Server.v WAS Profile Admin Password is the password for the administrator user.
Important: Ensure that you press the Enter key after you type a value for aproperty.
8. From the Optional Software List, drag the objects to the node on which youwant the installation files copied. The optional software is not installed by thesolution installer. You must install the software manually. The installation filesare copied to the node you drag them to.Unless you change the default path, the optional software installation files arecopied to the /opt/IBM/OptSoftware directory on the node computer.
9. As you build your environment, click Validate to identify errors or incompleteinformation.
10. After all nodes are defined and each node is validated, click Run.
24 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Important: After you click the Run button, do not close the browser windowuntil the installation completes. If you close the browser, you cannot re-initiatethe session.
However, the installation does proceed even with the browser closed. But youcannot monitor the progress.
If the browser window closes, do the following steps:a. Do nothing until enough time elapses to allow the installation to complete.
Allow the installation at least 2 hours to complete.b. Open a new browser window, and open the solution installer again.c. Re-create the configuration that you used or open the saved session that
you used. You must ensure that all of the values that you entered in thefields are the same as the configuration that you used when the browserwindow closed.
d. Rerun the installation. The solution installer verifies that all of thecomponents are installed.After the solution installer completes, verify that the components areworking. For more information, see “Test the installation” on page 34.
Tip: If you click Validate before all the mandatory content is added, amessage indicates that the node is not valid. For example, if you validate theBI Node before you add the IBM DB2 Data Server Runtime Clientcomponent, then a message indicates that the node is not yet valid.
Configuration properties for the server components:
You must provide some configuration properties for each of the mandatorysoftware components.
If you select any components from the Optional Software List, you must providea deployment location for the installation files. You must manually install any itemthat you select from the Optional Software List.
IBM DB2 Enterprise Server properties
DB2 Server Install DirectoryThe location where IBM DB2 is to be installed on the data node computer.
Default: /opt/ibm/db2/V10.5
DB2 Database Port NumberThe port number that is used by IBM DB2.
Default: 50000
DB2 Server Admin User NameThe user ID that runs the administration server.
Default: dasusr1
This user must not exist on the computer.
DB2 Server Admin PasswordThe password for the user ID that runs the administration server.
The password cannot contain more than 8 characters and it must belowercase.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 25
DB2 Server Admin Home DirectoryThe home directory for the user ID that runs the administration server.This directory is on the data node computer's file system.
Default: /home/dasusr1
DB2 Instance Owner User NameThe user ID that controls the DB2 processes and owns the directories thatare used by the database instance.
Default: db2inst1
This user must not exist on the computer.
DB2 Instance Owner PasswordThe password for the DB2 instance owner user.
The password cannot contain more than 8 characters and it must belowercase.
DB2 Instance Owner Home DirectoryThe home directory for the DB2 instance owner user. This directory is onthe data node computer's file system.
Default: /home/db2inst1
DB2 Fenced User NameThe user ID that can run user-defined functions and store procedures.
Default: db2fenc1
This user must not exist on the computer.
DB2 Fenced User PasswordThe password for the DB2 fenced user.
The password cannot contain more than 8 characters and it must belowercase.
DB2 Fenced User Home DirectoryThe home directory for the DB2 fenced user.
Default: /home/db2fenc1
Database: SPSS properties
SPSS Database NameThe SPSS database that is used by the components that are installed on thePredictive Analytics node computer.
This component must be contained within IBM DB2 Enterprise Server.
Default: SPSSDB
Database: BI Content Manager properties
Content Manager Database NameThe IBM Cognos Analytics content store database.
This component must be contained within IBM DB2 Enterprise Server.
Default: COGNOSCS
26 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
IBM DB2 Data Server Runtime Client properties
The IBM DB2 Data Server Runtime Client component must be installed on eachnode, except for the data node computer.
If you are doing a multi node deployment, make sure all of the values in the IBMDB2 Data Server Runtime Client are the same on all the nodes.
Note: If you add the IBM DB2 Data Server Runtime Client component to thesame node as the IBM DB2 Enterprise Server component, the IBM DB2 DataServer Runtime Client component will not be installed.
DB2 RTC Install DirectoryThe location where the IBM DB2 client is to be installed.
Default: /opt/ibm/db2/V10.5
DB2 RTC Instance User NameThe user ID for the DB2 client.
Default: db2inst1
This user must not exist on the computer.
DB2 RTC Instance PasswordThe password for the DB2 client instance owner user.
DB2 Client Instance Home DirectoryThe home directory for the DB2 client instance owner user.
Default: /home/db2inst1
WebSphere Application Server properties
WebSphere Application Server must be installed on the nodes where you installIBM Cognos Business Intelligence and IBM SPSS Collaboration and DeploymentServices Server.
WebSphere Install DirectoryThe location where the WebSphere Application Server is to be installed.
Default: /opt/IBM/WebSphere/AppServer
WebSphere Application PortThe HTTP port number that is used by the WebSphere Application Serverprofile.
Default: 9080
WAS Profile Admin User NameThe administrative user name for the WebSphere Application Serverprofile.
WAS Profile Admin PasswordThe password for the administrative user.
IBM HTTP Server properties
IBM HTTP Server must be installed on the computer where you install IBMCognos Business Intelligence.
HTTP Server Install DirectoryThe location where IBM HTTP Server is to be installed.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 27
Default: /opt/IBM/HTTPServer
HTTP Server Port Number The port number that is used by HTTP Server.
Default: 81
IBM Cognos BI Server
IBM Cognos BI Server must be contained within WebSphere Application Serverin the Configuration Editor.
IBM Cognos BI Server Install DirectoryThe location where IBM Cognos BI is to be installed.
Default: /opt/ibm/cognos/analytics
IBM SPSS Modeler Server properties
SPSS Modeler Server Install DirectoryThe location where IBM SPSS Modeler Server is to be installed.
Default: /opt/IBM/SPSS/ModelerServer/18.1.1
IBM SPSS Statistics Server properties
SPSS Statistics Server Install DirectoryThe location where IBM SPSS Statistics Server is to be installed.
Default: /opt/IBM/SPSS/StatisticsServer25
IBM SPSS Data Access Pack properties
SPSS Data Access Pack Install DirectoryThe location where IBM SPSS Data Access Pack is to be installed.
Default: /root/SDAP712
IBM SPSS C&DS Server (including ADM) properties
IBM SPSS C&DS Server (including ADM) must be contained within WebSphereApplication Server in the Configuration Editor.
SPSS C&DS Server Install DirectoryThe location where IBM SPSS Collaboration and Deployment ServicesServer and Analytic Decision Management are to be installed.
Default: /opt/IBM/SPSS/Deployment/8.1.1/Server
SPSS C&DS Server Admin User NameThe IBM SPSS Collaboration and Deployment Services administrative user.
Default: admin
SPSS C&DS Server Admin PasswordThe password for the IBM SPSS Collaboration and Deployment Servicesadministrative user.
Default: admin
WebSphere MQ properties
WebSphere MQ Home DirectoryThe WebSphere MQ home directory.
28 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Default: /home
Change the home directory only if the home directory location in theuseradd file on the Linux System has been modified.
WebSphere MQ Account User NameThe WebSphere MQ user.
Default: mqmuser
WebSphere MQ Account PasswordThe WebSphere MQ user account password.
IBM Integration Bus properties
IBM Integration Bus must be contained within WebSphere MQ in theConfiguration Editor.
Integration Bus Install DirectoryThe location where IBM Integration Bus is to be installed.
Default: /opt/ibm/iib-10.0.0.7
IBM Analytical Foundation properties
In the Configuration Editor, IBM Analytical Foundation must be inside theWebSphere MQ component.
Analytical Foundation Shared Classes Directory
IBM Analytical Foundation install location.
Default: /var/mqsi/shared-classes
IBM Integration Bus Manufacturing Pack properties
In the Configuration Editor, IBM Integration Bus Manufacturing Pack must beinside the WebSphere MQ component.
Destination Directory
IBM Integration Bus Manufacturing Pack files location.
Default: /opt/IBM/IIBManufactPack/
Saving and opening configurations:
You can save IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises configurations and open existing configurationsin the solution installer.
Procedure
1. To save a configuration:a. In the solution installer, define your configuration.b. Enter a name in the Save Configuration box, and click the Save
Configuration icon .2. To open a saved configuration:
a. Click Open, and browse to the saved configuration file, and click Open.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 29
Using a predefined configurationThe solution installer contains predefined configurations for the most common IBMMaximo Asset Performance Management - Predictive Maintenance InsightsOn-Premises environments. Use these predefined configurations to simplify yourdeployment work.
About this task
The following predefined configurations are available:
Single-Node Configuration
All of the IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises components are installed on a singlecomputer with IBM DB2 Enterprise Server.
Note: A single-node configuration is intended for a demonstration ortesting environment. It should not be used for a production environment.
A single-node configuration contains the following components:
Four-Node Configuration
A typical IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises environment on four nodes: a data nodewith IBM DB2 Enterprise Server, a Business Intelligence node, an Analyticsnode, and an Integration Bus node.
A four-node configuration contains the following components:
30 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Procedure1. Open the solution installer in a web browser.
After the solution installer is running, you can access the URL from anycomputer from a Firefox or Chrome web browser.The URL is https://servername:8080/UI/index.html, where servername is thename of the computer where you ran the solution installer.
Important: Do not use a web browser on the computer on which you arerunning the solution installer or any computer on which a Maximo APM -Predictive Maintenance Insights On-Premises component is being installed. Youmust use a web browser on another computer.Ensure that you are using an English language web browser to access thesolution installer URL.
2. Select Predefined Configurations, and click OK.3. Select the configuration that you want to install, and click OK.
The configuration is displayed in the Configuration Editor pane.Icons appear on each component where configuration information is required.For example, where you must provide user names or passwords.
Important: Ensure that you change the server names to an actual server inyour environment. Default values are provided.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 31
4. Ensure all of the properties are valid for your environment for each of thecomponents and the nodes in the configuration.
Starting the installationThe solution installer installs the component products on each node computer.Before you start the installation, you can validate the configuration.
Procedure1. In the solution installer, open the configuration that you want to install.2. Click Validate. If errors or messages about missing information are displayed,
you must correct the error or provide the information before you can run theinstallation.
3. Click Run.
Cleaning up server residues if the server installation failsIf the Maximo APM - Predictive Maintenance Insights On-Premises installationfails, perform these tasks to clean up files that are related to the servercomponents.
After, you can restart the installation from the Using the solution installer topic inthe IBM Knowledge Center.
Cleaning up Db2 node residues:
Perform this task to clean up DB2 node residues after an installation fails.
Procedure
1. Run following commands:su db2inst1db2 list db directory
2. An entry like the following entry shows. If no entry shows, skip the db2stopforce command in step 3."Database 1 entry:
Database alias = SPSSDBDatabase name = SPSSDBLocal database directory = /home/db2inst1Database release level = 10.00Comment =Directory entry type = IndirectCatalog database partition number = 0Alternate server hostname =Alternate server port number ="
3. Run following commands:db2stop forceexitsu dasusr1db2admin stopexit
4. Run the following commands:cd /opt/ibm/db2/V10.5/instance/./db2ilist
5. Use the outputted instance name as the parameter and run the followingcommands:
32 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
./db2idrop db2inst1
./daslist
./dasdropcd ../install/./db2_deinstall -a
6. Run the following commands:userdel -r dasusr1userdel -r db2inst1userdel -r db2fenc1groupdel dasadm1groupdel db2iadm1groupdel db2fadm1
7. Run the following commands:cd /opt/ibm/rm -rf db2/cd /opt/IBM/rm -rf PMI_xxx/ For example, for the Maximo APM - Predictive MaintenanceInsights On-Premises 1.0 release, the command is rm -rf PMI_1.0/.
8. Open the /etc.services files with the following command and comment out anyentry that contains port 60000~60005:vi /etc/services
You can also refer to the Uninstalling DB2 on UNIX or Linux page forinformation about cleaning residues
Cleaning up Predictive Analytics node residues:
Perform this task to clean up Predictive Analytics (SPSS) node residues after aninstallation fails.
Procedure
1. Run the following command:/opt/IBM/InstallationManager/eclipse/tools/imcl listInstalledPackages
2. If no packages show, skip cleaning up the Predictive Analytics (SPSS) node. Ifpackages do show, run the following command to uninstall packages:/opt/IBM/InstallationManager/eclipse/tools/imcl uninstallAll
3. Run the following command:cd /opt/IBM/WebSphere/AppServer/profiles/CNDSprofile/bin
4. If the directory from step 3 does not show, skip the next command. If thedirectory does show, run the following command:./stopServer.sh server1
5. If under single node deployment mode, skip the next commands. If under fournode deployment mode, run the following commands:rm -rf /opt/ibm/rm -rf /opt/IBM/rm -rf /home/db2inst1/sqllib
Cleaning up Integration Bus node residues:
Perform this task to clean up Integration Bus (IIB) node residues after aninstallation fails.
Procedure
1. If under single node deployment mode, skip the next two commands. If underfour node deployment mode, run the following commands:
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 33
/opt/IBM/InstallationManager/eclipse/tools/imcl listInstalledPackages/opt/IBM/InstallationManager/eclipse/tools/imcl uninstallAll
2. Run the following commands:for i in `rpm -qa | grep -i mqseries | grep -i "7.5.0-4"`; do rpm -e--nodeps --noscripts $i; donefor i in `rpm -qa | grep -i mqseries`; do rpm -e --nodeps --noscripts$i; done
3. To verify that all related packages are uninstalled, run the following command.When you run the command, nothing should show.rpm -qa | grep -i mqseries
4. If under single node deployment mode, skip the next commands. If under fournode deployment mode, run the following commands:rm -rf /opt/ibm/rm -rf /opt/IBM/rm -rf /home/db2inst1/sqllib
Cleaning up Business Intelligence node residues:
Perform this task to clean up Business Intelligence (BI) node residues after aninstallation fails.
Procedure
1. If under single node deployment mode, skip the next two commands. If underfour node deployment mode, run the following commands:/opt/IBM/InstallationManager/eclipse/tools/imcl listInstalledPackages/opt/IBM/InstallationManager/eclipse/tools/imcl uninstallAll
2. Run the following commands:rm -rf /opt/ibm/rm -rf /opt/IBM/rm -rf /home/db2inst1/sqllib
Test the installationAfter the installation of the IBM Maximo Asset Performance Management -Predictive Maintenance Insights On-Premises server components is complete, youmust perform some additional configuration tasks and then test the installation.
Testing the database installation and configuration:
You can test the database installation and configuration by logging in to the IBMMaximo Asset Performance Management - Predictive Maintenance InsightsOn-Premises data node computer and listing the databases on the server. You canalso list the databases available on each node computer where the IBM DB2 clientwas installed.
Procedure
Log on to the data node computer.1. Open a terminal window, and change to the database instance owner user. For
example, su - db2inst1.2. Enter the following command to list the databases on the computer:
db2 list database directory
The following databases are listed:v COGNOSCS
34 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
v SPSSDB
Testing Cognos Business Intelligence:
Verify that you can access the IBM Business Intelligence portal.
Before you begin
Make sure the IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises solution services are running.
Procedure
Open a web browser and enter the following URL: http://servername:9300/bi/where servername is the name of IP address of the computer where the MaximoAPM - Predictive Maintenance Insights On-Premises server components areinstalled.If you changed the default port number to 80 for IBM HTTP Server, you canexclude the port number from the URL.
Install the Maximo APM - Predictive Maintenance InsightsOn-Premises server artifacts
The server artifacts include report content and workflows for IBM Maximo AssetPerformance Management - Predictive Maintenance Insights On-Premises.
Before you can install the server artifacts, you must uninstall the solution installerthat you used to install the servers.
You must do the following things on the computer that currently contains thesolution installer:v Uninstall the server solution installerv Install system files that are required for the artifact solution installerv Install the artifact solution installerv Use the artifact solution installer to install and configure Maximo APM -
Predictive Maintenance Insights On-Premises artifactsv Finish configuring the server components
Uninstalling the server solution installerBefore you can install the IBM Maximo Asset Performance Management -Predictive Maintenance Insights On-Premises server artifacts, you must uninstallthe server solution installer and then install the artifact solution installer.
When you uninstall the server solution installer, the processes that are used by thesolution installer are stopped and removed from your computer. All of the files inthe solution installer directory are also removed. This includes the IBM MaximoAsset Performance Management - Predictive Maintenance Insights On-Premisesserver component and server artifact installation files that you copied into thesolution installer directory. If you want to save those files, you must copy them toanother directory before you uninstall the solution installer.
Also, you can run a script on each node computer where you installed an IBMMaximo Asset Performance Management - Predictive Maintenance Insights
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 35
On-Premises component to remove the server solution installer processes. Ensurethat you copy the cleanupClient.sh file before you uninstall the server solutioninstaller.
Note: Uninstalling the server solution installer does not uninstall the IBM MaximoAsset Performance Management - Predictive Maintenance Insights On-Premisescomponent applications. If you want to uninstall those components, you must useeach component's uninstallation programs.
Procedure1. To remove the server solution installer processes on the client node computers,
do the following steps on each client node computer:a. From the installation computer, copy the ServerInstallation/
SolutionInstaller/cleanupClient.sh file onto each computer on which youinstalled an IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises component.
b. On the client node computer, go to the directory where you copied thecleanupClient.sh file.
c. Enter the following command: sh cleanupClient.sh.2. To remove the server solution installer from the installation computer, do the
following steps:a. Go to the ServerInstallation/SolutionInstaller directory.b. Enter the following command: sh cleanup.sh.c. Restart the installation computer.d. If under single node deployment mode, start the Maximo APM - Predictive
Maintenance Insights On-Premises services. For information about how tostart the services see, “Start solution services” on page 63.
Note: In the Start solution services topics, do all of the tasks except theStarting services on the Integration Bus node computer task. You shouldcomplete the Starting services on the Integration Bus node computer taskafter you complete the installation of the artifact.
What to do next
Install the artifact solution installer.
Installing and starting the artifact solution installerUse the artifact solution installer to install the artifacts on the IBM Maximo AssetPerformance Management - Predictive Maintenance Insights On-Premises servers.You access the artifact solution installer interface from another computer by usinga web browser.
Before you begin
You must have access to a computer that is separate from the computer thatcontains the installation files. This computer has the following requirements:v Has a monitor with a screen resolution that is greater than 1024 by 760.v The operating system uses English.v Has Google Chrome 47, or later, or Mozilla Firefox 38 or later installed on it. The
language of the installed web browser language must be English.
36 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
You must know the location of the pmi_art_installer_1.0.2_l86-64_en.tar.gz filethat you downloaded from Passport Advantage in “Downloading anddecompressing the installation files” on page 19.
The pmi_art_installer_1.0.2_l86-64_en.tar.gz file must be in a directory forwhich you have execute permissions.
Procedure1. Log on to the computer as the root user or as a user with sudo permissions.2. Go to the directory that contains pmi_art_installer_1.0.2_l86-64_en.tar.gz.3. If you are the root user, enter the following command: sh setup.sh. If you are
a user with sudo permissions, enter the following command: sudo sh setup.sh.After the artifact solution installer starts, open a web browser on anothercomputer, and go to the solution installer URL: https://servername:8080/UI/index.html.
Important: Do not use a web browser on the computer on which you arerunning the solution installer or any computer on which a Maximo APM -Predictive Maintenance Insights On-Premises component is being installed. Youmust use a web browser on another computer.
Checking prerequisites for Situational Awareness artifactsYou must run checks before proceeding to configure the Situational Awarenessartifacts and related artifacts.
About this task
Note: For a standard artifact installation, this topic can be skipped.
Since the Situational Awareness artifacts need ports for setting up the servers, it isessential to understand which ports are used. If necessary, a new set of ports canbe provided to the artifact installer when prompted.
Procedure1. To understand which ports are in use, run the following command from the
terminal as root user, and see if it returns any rows.netstat -an |grep 9080
2. Similarly, run the same command for different ports like the following.netstat -an |grep 9081netstat -an |grep 9082netstat -an |grep 9443netstat -an |grep 9444
3. If any of these ports are used, then you can run the same command to checkadditional ports. Typically, ports 9085 and 9448 are easily available.
Using predefined configurations to install server artifactsUse the solution installer to select and configure the artifacts in your solution.
Procedure1. Open the solution installer in a web browser.
After the solution installer is running, you can access the URL from anycomputer from a Firefox or Chrome web browser.The URL is https://servername:8080/UI/index.html, where servername is thename of the computer where you ran the solution installer.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 37
Important: Do not use a web browser on the computer on which you arerunning the solution installer or any computer on which a Maximo APM -Predictive Maintenance Insights On-Premises component is being installed. Youmust use a web browser on another computer.Ensure that you are using an English language web browser to access thesolution installer URL.
2. On the license information page, click Accept.CAUTION:Declining the license allows you to uninstall the solution installer andremove all of the files from the solution installer directory.
3. Select Predefined Configurations and click OK.4. Select one of the following node templates; 1 Node Template, 4 Node
Template, 1 Node SA Template, or 2 Nodes SA Template.For a multiple-server Maximo APM - Predictive Maintenance InsightsOn-Premises artifact installation, select 4 Node Template. For a single-nodeartifact installation, select 1 Node Template. For a single-node SituationalAwareness artifact installation, select 1 Node SA Template. For two-nodeSituational Awareness artifact installation, select 2 Nodes SA Template.Use 1 Node Template and 1 Node SA Template to install based on a previousone node server installation. Use 4 Node Template and 2 Nodes SA Templateto install based on a previous four node server installation.
5. Click all the boxes that have a red warning icon and complete the mandatoryfields in the Property Editor. For more information, refer to the Parameters forthe standard artifact installation section and the Parameters for the SituationalAwareness artifact installation section.
6. After all mandatory fields are completed, click Validate.7. After all nodes are defined, click Run.
Important: After you click the Run button, do not close the browser windowuntil the installation completes. If you close the browser, you cannot re-initiatethe session.
The installation continues even if you close the browser.
If the browser window closes, do the following steps:a. Do nothing until enough time elapses to allow the installation to complete.
Allow the installation at least 2 hours to complete.b. Open a new browser window, and open the solution installer again.c. Re-create the configuration that you used or open the saved session that
you used. You must ensure that all of the values that you entered in thefields are the same as the configuration that you used when the browserwindow closed.
d. Rerun the installation. The solution installer verifies that all of thecomponents are installed.After the solution installer completes, test the solution to verify that thecomponents are working.
Parameters for the standard artifact installationConfigure parameters for the standard artifacts that you are installing.
38 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Use the information in the following tables to configure parameters for theartifacts. The Property Editor displays some default values for each component.You can accept the default values or change them to suit your environment.
Table 2. Parameters for IBM DB2
Field Default or example value Description
Data Deployment Location /opt/IBM/PMI/Data The location where the serverartifacts are to be copied on thedata node computer.
DB2 Instance Home /home/db2inst1 The home directory of thedatabase instance owner.
DB Database InstanceUser Name
db2inst1 The user ID for the IBM Cognoscontent store database.
DB Database InstancePassword
This field does not have adefault value.
The password for the databaseinstance owner user.
Table 3. Integration bus parameters for IBM DB2
Field Default or example value Description
Install location of IIB /opt/IBM/IIB The location where IBMIntegration Bus is installed.This directory is on theIntegration Bus nodecomputer's file system.
DB2 Client install Location /opt/ibm/db2/v10.5 The IP address of theAnalytics nodecomputer.
Analytics Node IP There is no default for thisfield.
The IP address of thePredictive Analytics nodecomputer.
Analytics Node HTTPTransport Port
9080 The WebSphere ApplicationServer port number that isused on the Analytics nodecomputer.
DB2 Port Number 50000 The port number that is usedby the IBM DB2 server onthe data node computer.
Database Node IP There is no default for thisfield.
The IP address of the datanode computer.
DB2 Username db2inst1 The user ID that controls thedatabase processes and ownsthe directories that are usedby the database instance.
Message Queue Username mqmuser User ID created by installingthe message queue.
DB2 Database ServerInstance Password
There is no default for thisfield.
Password of DB2 Username.
Table 4. Business Intelligence parameters for IBM DB2
Field Default or example value Description
Business IntelligenceDeployment Location
/opt/IBM/PMI/Business_Intelligence
The location where theserver artifacts are to beinstalled on the IIB nodecomputer.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 39
Table 4. Business Intelligence parameters for IBM DB2 (continued)
Field Default or example value Description
Cognos Install Location /opt/ibm/cognos/analytics The location where IBMCognos BI is installed. Thisdirectory is on the IIB nodecomputer's file system.
WebSphere Install Location /opt/IBM/WebSphere/AppServer
The location whereWebSphere is installed. Thisdirectory is on the IIB nodecomputer's file system.
DB2 Instance HomeDirectory
/home/db2inst1 The home directory of thedatabase instance owner.
DB2 Client Install Location /opt/ibm/db2/v10.5 The location where the DB2client is installed on the IIBnode computer.
Cognos BI Dispatcher URI http://localhost:9300/p2pd/servlet/dispatch
The URL to the IBM CognosBI dispatcher, whereiib_node_name is the name orIP address of the IIB nodecomputer.
DB2 Instance User Name db2inst1 The user ID for the IBMCognos content storedatabase.
DB2 Instance Password There is no default value forthis field.
Password for the databaseinstance owner user.
DB2 Database Port Number 50000 The port number for the DB2server.
Database Node IP There is no default value forthis field.
The IP address of theAnalytics node computer.
Integration Bus Node IP There is no default value forthis field.
The IP address of theIntegration Bus nodecomputer.
WebSphere ApplicationServer Cognos ProfileAdministrative Username
admin The administrative username for the WebSphereApplication Server profilethat is used for IBM CognosBusiness Intelligence.
WebSphere ApplicationServer Cognos ProfileAdministrative Password
There is no default value forthis field.
The password for theadministrative user for theWebSphere ApplicationServer profile that is used forIBM Cognos BusinessIntelligence.
Business Intelligence NodeIP
There is no default value forthis field.
The IP address of theBusiness Intelligence node.
Table 5. Analytics parameters for IBM DB2
Field Default or example value Description
Analytics DeploymentLocation
/opt/IBM/PMI/Analytics The location where theserver artifacts are to beinstalled on the Analyticsnode computer.
40 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Table 5. Analytics parameters for IBM DB2 (continued)
Field Default or example value Description
SPSS Modeler Server InstallLocation
/opt/IBM/SPSS/ModelerServer/18.1.1
The location where theModeler Server is installed.
SPSS Data Pack InstallationLocation
/root/SDAP712 The directory where the IBMSPSS Data Access Pack isinstalled. This directory is onthe Analytics node computer.
SPSS CNDS Install Location /opt/IBM/SPSS/Deployment/8.1.1
The location where IBM SPSSCollaboration andDeployment Services isinstalled. This location is onthe Analytics node computer.
Integration Bus Node IP There is no default value forthis field.
The IP address of theIntegration Bus nodecomputer.
Database Node IP There is no default value forthis field.
The IP address of the datanode computer.
Database Username db2inst1 The user ID for the IBMCognos content storedatabase.
Database Password There is no default value forthis field.
The password for thedatabase instance owneruser.
Database Port 50000 The port number for thedatabase server.
Predefined templates for the server artifact installationThe artifact solution installer contains predefined configurations to install serverartifacts. You use the predefined configurations to simplify your deployment work.
All of the Maximo APM - Predictive Maintenance Insights On-Premises artifactsare installed on a single computer. The following predefined configurations areavailable:
Single-Node Template
A single-node configuration is intended for a demonstration or testingenvironment. It should not be used for a production environment.
A single-node configuration contains the following components:
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 41
Four-Node Template
A typical Maximo APM - Predictive Maintenance Insights On-Premisesartifacts deployment environment on four nodes contains the followingnodes: a data node with IBM Db2 Enterprise Server, a Business Intelligencenode, an Analytics node, and an Integration Bus node.
A four-node configuration contains the following components:
Single-Node Situational Awareness Template
All of the Situational Awareness artifacts are installed on a singlecomputer.
Figure 3. Single=Node Template
Figure 4. Four-Node Template
42 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Note: A single-node configuration is intended for a demonstration ortesting environment. It should not be used for a production environment.
A single-node Situational Awareness configuration contains the followingcomponents:
Two-Node Situational Awareness Template
A typical Situational Awareness artifact topology on two nodes containsthe following nodes: a data node with IBM Db2 Enterprise Server and anIntegration Bus node.
A two node Situational Awareness configuration contains the followingcomponents:
Figure 5. Single-Node Situational Awareness Template
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 43
Note: Install the Framework and Situational Awareness components on the IBMIntegration Bus (IIB) node and the database node. Oracle is not supported.
The Situational Awareness Application Artifact depends on the Framework LibertyArtifact, and the Framework Liberty Artifact depends on the Liberty Configuration.IHS Configuration should be dragged on the node where the HTTP Server located.By default, this is the IIB node. See the following figure.
These components must be installed at the same time.
Parameters for the Situational Awareness artifact installationConfigure parameters for the Situational Awareness artifacts that you are installing.
Use the information in the following tables to configure parameters for theartifacts. The Property Editor displays some default values for each component.You can accept the default values or change them to suit your environment.
Figure 6. Two-Node Situational Awareness Template
44 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Table 6. Parameters for Liberty Configuration
Field Default or example value Description
Liberty Install Location /opt/IBM/WebSphere/Liberty
The location whereWebSphere Libertyapplication server isinstalled. This is generally onan IIB node.
IBM Installation ManagerLocation
/opt/IBM/InstallationManager
The location where the IBMInstallation Manager isinstalled in an IIB node.
Liberty Controller ServerHTTP Port
9085 The HTTP port number ofthe Liberty controller server.Ensure that this port is not inuse.
Liberty Controller ServerHTTPS Port
9448 The HTTPS port number ofthe Liberty controller server.Ensure that this port is not inuse.
Liberty Framework ServerHTTP Port
9086 The HTTP port number to beused for the Frameworkserver. Ensure that this portis not in use.
Liberty Framework ServerHTTPS Port
9449 The HTTPS port number forthe Framework server.Ensure that this port is not inuse.
Liberty KeyStore Password Not applicable The password to be set forthe keystore for pluginconfiguration.
Liberty Admin userpassword
Not applicable The password to be set forthe administrative user.
IBM HTTP Server PluginInstall Location
/opt/IBM/WebSphere/Plugins
The installation location ofIBM HTTP server.
IBM HTTP Server NodeName
iib.ibm.com The node name where IBMHTTP Server is installed.
IBM HTTP Server Node SSHPort
22 The SSH port of the nodethat has IBM HTTP Serverinstalled on it.
IBM HTTP Server VM /Node User name
root The OS-level administrativeuser of the node that hasIBM HTTP Server installedon it.
IBM HTTP Server VM /Node password for theprovided user
Not applicable The password of the OS-leveladministrative user of thenode that has IBM HTTPServer installed on it.
Table 7. Parameters for the Framework Liberty Artifact
Field Default or example value Description
Data Node Host Name data.ibm.com The node or VM that hasdatabase server installed.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 45
Table 7. Parameters for the Framework Liberty Artifact (continued)
Field Default or example value Description
Password of Databaseinstance owner - db2inst1
Not applicable The user password providedfor the db2 instance owner(db2inst1 or xxxx)
Password for frameworkapplication admin user (Bob)
Not applicable The user password providedfor the frameworkapplication administrativeuser Bob.
Password for frameworkapplication sample user1
Not applicable The user password providedfor the frameworkapplication user – sampleuser 1.
Password for frameworkapplication sample user2
Not applicable The user password providedfor the frameworkapplication user – sampleuser 2.
Table 8. Parameters for the Situational Awareness Application Artifact
Field Default or example value Description
Password of frameworkadministrative user (Bob)
Not applicable The OS-level user passwordprovided for the frameworkapplication administrativeuser Bob.
Jena Server OS / VM Nodehostname
data.ibm.com The host name of the VM orNode which has the Jenaserver installed andconfigured.
Jena Server OS / VM Nodeuser
root The OS-level administrativeuser of the VM or node onwhich the Jena server isinstalled and configured.
Jena Server OS / VM Nodeuser password
Not applicable The password for theOS-level administrative userof the VM or node on whichthe Jena server is installedand configured.
Table 9. Parameters for the Situational Awareness Database Artifact
Field Default or example value Description
DB2 Server Install LocationDirectory
/opt/ibm/db2/V10.5 The path where the DB2database enterprise server isinstalled.
Table 10. Parameters for the IBM HTTP Server Configuration Artifact
Field Default or example value Description
IBM HTTP Server InstallLocation Directory
/opt/IBM/HTTPServer The location where the IBMHTTP server is installed.
IHS Plugin Install LocationDirectory
/opt/IBM/WebSphere/Plugins
The location where the IBMHTTP Server plugin isinstalled.
46 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Table 10. Parameters for the IBM HTTP Server Configuration Artifact (continued)
Field Default or example value Description
Liberty Keystore Password Not applicable The password for the Libertykeystore.
Cleaning up artifact files if the Situational Awareness artifactinstallation failsIf the Situational Awareness artifact installation fails, perform these tasks to cleanup files related to the Framework and Situational Awareness artifacts. After, runthe Situational Awareness installation again.
Cleaning up DB2 files:
Perform this task to clean up DB2 files after an installation fails.
Procedure
1. Log in to the database node computer as root.2. Run following command:
/opt/Jena/stopJena_Linux.sh
3. Run following command:rm -rf /opt/Jena/
4. Run following command:su - db2inst1 -c "db2stop force; db2start; db2 drop database IFEDB"
Cleaning up IBM Integration Bus files:
Perform this task to clean up IBM Integration Bus (IIB) files after an installationfails.
Procedure
1. Log in to the node where the HTTP server is installed. By default, this is theIIB node.
2. Run the following command:rm -rf /opt/IBM/WebSphere/Plugins/config/ihsserver1
3. Run the following command:rm -rf /opt/IBM/HTTPServer/cert/
4. Run the following command:/opt/IBM/WebSphere/Liberty/bin/server stop framework_server
5. Run the following command:/opt/IBM/WebSphere/Liberty/bin/server stop controller_server
6. Run the following command:rm -rf /opt/IBM/WebSphere/Liberty/usr/servers/
7. Run the following command:rm -rf /opt/IBM/energy/
8. Open the /opt/IBM/HTTPServer/conf/httpd.conf file in a text editor.9. Locate the following lines in the file. Delete these lines as well as the content
between the lines.LoadModule was_ap22_module /opt/IBM/WebSphere/Plugins/bin/64bits/mod_was_ap22_http.so
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 47
...WebSpherePluginConfig /opt/IBM/WebSphere/Plugins/config/ihsserver1/plugin-cfg.xml
Cleaning up artifact residues if the standard artifact installer failsIf the standard artifact installer fails during the artifact installation process, youmust perform certain steps to clean up the artifact residues. After, run the standardinstallation again.
About this task
If the BI or SPSS artifact fails during the installation process, no cleanup activity isnecessary. The BI and SPSS artifacts are written to rewrite or redeploy theconfiguration without any manual steps. If the DB2 or IIB artifact fails during theinstallation process, perform the following manual steps.
Procedure1. Cleaning up the DB2 residue. If the DB2 artifact fails at some intermediate
point during installation, perform the following steps to clean up the artifactresidue and rerun the DB2 artifact installer.a. Login as db2inst1 or db instance user, and run the following command.
db2 list db directory
Running this command displays a list of databases that were created in thathost within the instance. Check to see if the IBMPMI database is in that list.
b. If the IBMPMI database is not found, then you can rerun the DB2 artifactinstaller.
c. If the IBMPMI database is found, then run the following command to dropthat database.db2 drop db IBMPMI
Wait for a successful message that the database is dropped. Now, you canrerun the DB2 artifact installer.
2. Cleaning up the IIB residue. If the IIB artifact fails at some intermediate pointduring installation, perform the following steps to clean up the artifact residueand rerun the IIB artifact installer.a. Login as mqmuser. To check if pmibroker is created and running, run the
following command.mqsilist
b. If the response shows no broker, then you can rerun the IIB artifact installer.c. If the response shows that pmibroker is created, then run the following
commands in sequence to stop and delete that broker.mqsistop pmibroker
Wait for a successful response that the pmibroker is stopped. Then run thefollowing delete command.mqsideletebroker pmibroker
d. Run the following commands to stop and remove the MQ Manager.su - mqmuser/opt/mqm/bin/endmqm pmimanager/opt/mqm/bin/dltmqm pmimanager
Wait for a successful response that the pmibroker is deleted.
48 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Complete the configuration of the server componentsAfter you have installed the IBM Maximo Asset Performance Management -Predictive Maintenance Insights On-Premises server artifacts, you can complete theconfiguration of the server components.
Verifying the configuration of IBM SPSS Collaboration and DeploymentServices:
To complete the configuration of IBM SPSS Collaboration and Deployment ServicesServer, you must verify the URL Prefix value for your environment.
Procedure
1. Open a web browser.2. In the address bar, type the address for the Collaboration and Deployment
administration console.The address is http://analytics_node_name:9080/config, whereanalytics_node_name is the name or IP address for the Predictive Analyticsnode computer.
Important: If you are using a single node installation of Maximo APM -Predictive Maintenance Insights On-Premises, the port number is 9080. Forexample, the address is http://analytics_node_name:9080/config.
3. Enter the Login name and Password for the administrator user, and clickLogin.The default Login name is admin, and the default Password is admin.
4. On the Configuration panel, under Setup, click URL Prefix.5. In the URL Prefix box, verify that the address is http://
analytics_node_name:9080, where analytics_node_name is the name or IPaddress of the Analytics node computer.
6. If the value is correct, you do not have to complete the remaining steps in thistask.
7. If the value is not correct, enter the name or IP address of the Analytics nodecomputer, and click Set.
8. Open the WebSphere Administrative Console in your web browser.The address is https://analytics_node_name:9043/ibm/console, whereanalytics_node_name is the name or IP address for the Analytics nodecomputer. Port number 9043 is the default port for the WebSphereAdministrative Console.
9. Enter admin for both the User ID and Password, and click Log in.10. Under Applications > Application Types > WebSphere Enterprise
Applications, selectIBM_SPSS_Collaboration_and_Deployment_Services_8.1.1, and click Stop.
11. Select IBM_SPSS_Collaboration_and_Deployment_Services_8.1.1, and clickStart to restart the application and apply the changes.
Configure the Integration Bus node components:
To configure the Integration Bus node components, you must enable remote accessfor the queue manager.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 49
Configuring the WSJPA persistence provider:
You must configure the WebSphere Application Server persistence provider(WSJPA).
Procedure
1. In a web browser, open the WebSphere administrative console. The address ishttp://iib_node_name:9060/ibm/console where iib_node_name is the name or IPaddress for the IIB node computer and 9060 is the default port number for theWebSphere administrative console.
2. In the administrative console, click Servers > Server Types > WebSphereapplication servers > server_name > Container Services > Default JavaPersistence API settings.
3. Set the Java Persistence API (JPA) specification level to 2.0.4. Set the default persistence provider to
org.apache.openjpa.persistence.PersistenceProviderImpl.5. Click Apply and save the configuration.6. Run following commands to restart the PMQUIProfile on the IIB node.
cd /opt/IBM/WebSphere/AppServer/profiles/PMQUIProfile/bin./stopServer.sh server1./startServer.sh server1
Updating the software tag file:
For IBM Maximo Asset Performance Management - Predictive MaintenanceInsights On-Premises, you must copy the swidtag software tag file in the/var/PMI/iso-swid folder.
Procedure
1. Go to the /opt/IBM/PMI/Integration_Bus/ISOSWID_TAG/ folder. You will find theISOSWID_NonProduction_Tag and ISOSWID_Production_Tag folders that containthe non-production and production tags, respectively.
2. Copy the relevant non-production or production swidtag file and replace theexisting file in the /var/PMI/iso-swid folder.For example, if the Maximo APM - Predictive Maintenance InsightsOn-Premises product is used in production mode, copy the production swidtagfile from the ISOSWID_Production_Tag folder.
Enabling remote access for the queue manager:
For IBM Maximo Asset Performance Management - Predictive MaintenanceInsights On-Premises, you must start the queue manager command line processorto enable remote access to the queue manager.
Procedure
1. In a terminal window, go to the installation_location/iib-10.0.0.7/server/bin directory. For example, if you installed to the default location, go to the/opt/ibm/iib-10.0.0.7/server/bin directory.
2. Change to the mqmuser. For example, su mqmuser.3. Enter the following command to load the profile that is needed for the mqm
user, and press Enter:. ~/.bash_profile
50 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
4. In the mqsiCommandConsole, enter the following command to start the queuemanager:runmqsc queue_manager_name
For example, if your queue manager is named pciqmgr, enter:runmqsc pciqmgr
5. As the mqm user, enter the following command to start the queue manager:runmqsc queue_manager_name
For example, to use the default queue manager named pmimanager, enter:runmqsc pmimanager
6. Enter the following lines, and press Enter after each line:START LISTENER
ALTER QMGR CHLAUTH(ENABLED)
SET CHLAUTH(SYSTEM.BKR.CONFIG) TYPE(ADDRESSMAP) ADDRESS('*')MCAUSER('mqmuser')
SET CHLAUTH(SYSTEM.BKR.CONFIG) TYPE(BLOCKUSER) USERLIST('*NOACCESS')
END
Important: The ADDRESS(’*’) value in the command allows connections fromany IP address. Consider restricting the access to a single computer. For moreinformation about these values, see the WebSphere MQ documentation.
Configuring the Analytics nodeYou must install and configure IBM SPSS Collaboration and Deployment ServicesDeployment Manager on the Analytics node.
Procedure1. Install IBM SPSS Collaboration and Deployment Services Deployment Manager
on the Predictive Analytics node. See “Installing IBM SPSS Collaboration andDeployment Services Deployment Manager” on page 53.
2. Add a content server connection. See “Adding a content server connection forIBM SPSS Collaboration and Deployment Services” on page 54.
3. Import the resource definitions. See “Importing the resource definitions intoIBM SPSS Collaboration and Deployment Services” on page 56.
4. Add server and resource definitions. See “Adding server and resourcedefinitions to IBM SPSS Collaboration and Deployment Services” on page 57.
5. Perform “Updating database credentials and changing table names”
Updating database credentials and changing table namesIf you specified a user ID other than the default for the IBM Cognos content storedatabase, then you must update the credentials for the jobs in DeploymentManager.
Procedure1. Start Deployment Manager and select the Context Explorer tab.2. Expand the Content Repository folder.3. Right-click a job and select Open.4. Select a stream on the job and click the ODBC Data Sources tab.5. To change a database table name:
a. Click an entry under ODBC DSN and click the ellipsis.b. Select either Use ODBC DSN or Create New ODBC.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 51
c. Change the table name or create a new one and then save the job.6. To update database credentials:
a. Click an entry under Credentials and click the ellipsis.b. Select either Use Existing Credential or Create New Credential.c. Change the credentials or create a new one and then save the job.
Client component installationThere are several client components that are included with IBM Maximo AssetPerformance Management - Predictive Maintenance Insights On-Premises. You caninstall the components as you require.
Important: The client components must be installed on computers running theMicrosoft Windows 7 or Microsoft Windows 8 32 or 64-bit operating system.
Important: Install the client components only after you successfully install theserver components.
Client componentsClient components for IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises are available to be installed.
For more information about installing and using the client components, see thedocumentation provided with the component.
Important: After the client installation files are copied to your computer, somepaths for the compressed files can be long. You might need to use a decompressionutility other than the one provided by Microsoft Windows to decompress the files.
Database connectivity
Install IBM Data Server Runtime Client to enable connectivity to the databases. Ina multinode deployment, you must use the same configuration values for everyinstance of IBM Data Server Runtime Client that you install. The configurationvalues include the installation directory, instance name, instance password, andinstance home directory.
Predictive modeling and decision management
Install the following components so that you can modify or create predictivemodels and so that you can perform decision management tasks:v IBM SPSS Collaboration and Deployment Services Deployment Managerv IBM SPSS Modeler Client Premium
Optionally, install the following components:v IBM SPSS Statistics Clientv IBM SPSS Collaboration and Deployment Services Documentationv IBM Analytical Decision Management Documentationv IBM SPSS Modeler Premium Documentation
Business intelligence
Install IBM Cognos Framework Manager so that you can modify the reportingmodel metadata.
52 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Framework Manager is a 32-bit application so it requires the 32-bit IBM DataServer Runtime Client. Before you use IBM Cognos Framework Manager:1. Install IBM Data Server Runtime Client2. Restart the computer3. Catalog the databases
Optionally, install the following components:v IBM Cognos Dynamic Query Analyzerv IBM Cognos for Microsoft Officev IBM Cognos Software Development Kit
Integration Bus
Install the following components:v Integration Bus Toolkitv WebSphere MQ for Windows
Use the Integration Bus Toolkit to create, manage, deploy, and delete messageflows and associated resources in a development environment.
Installing the client componentsAfter you download the client package, install the client component installationprograms to a Microsoft Windows computer. You must run the installationprograms individually after they are copied to your computer.
Tip: You might need to adjust your Windows User Access Control (UAC) settingsso that you can run the client component installation programs.
Procedure1. Extract the Client package on a Microsoft Windows computer.2. In the extracted folder, open the disk1 folder.3. Right-click launchpad64.exe (in 64-bit Windows) or launchpad.exe (in 32-bit
Windows), and click Run as administrator.4. On the Welcome screen, click Next.5. If you accept the terms in the license agreement, click I accept the terms in
the license agreement, and click Next.6. Optional: Click Online Knowledge Center to review the documentation and
release notes. Click Next.7. Review the list of included components, and click Next.8. In the Destination Location box, type a valid path. Click Copy Installers to
copy the installers to the target location.9. After the installers are copied, click Next, and click Finish.
10. Open the target location and extract IBMPMI_Client_102.zip to get the clientcomponent installation programs.
Installing IBM SPSS Collaboration and Deployment ServicesDeployment ManagerYou must install IBM SPSS Collaboration and Deployment Services DeploymentManager to complete the configuration of IBM Maximo Asset PerformanceManagement - Predictive Maintenance Insights On-Premises.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 53
Install IBM SPSS Collaboration and Deployment Services Deployment Manager ona computer that has the Microsoft Windows 7 or Microsoft Windows 8 operatingsystems installed.
Procedure1. Go to the install_location\IBMPMI_Client_102\64 bit\
SPSS_CNDS_DeploymentManager or install_location\IBMPMI_Client_102\32bit\SPSS_CNDS_DeploymentManager_No directory.
2. Decompress the installation package.3. In the folder containing the installation files, double-click
DeploymentManager_win64.exe to start the IBM SPSS Collaboration andDeployment Services Deployment Manager installation.
4. Follow the steps in the wizard to install the client component.For more information about the installation of Deployment Manager, see theIBM SPSS Collaboration and Deployment Services Deployment Manager7Installation (www.ibm.com/support/knowledgecenter/SS69YH_7.0.0/cads_manager_install_ddita/model_management/thick/thick_install_overview.html).
Adding a content server connection for IBM SPSS Collaboration andDeployment Services:
You must add a connection to your IBM SPSS Collaboration and DeploymentServices repository in the IBM SPSS Collaboration and Deployment ServicesDeployment Manager client.
After you add the connection, the server folder displays in the Content Explorer,and you can log in to the server.
Procedure
1. On your Microsoft Windows computer, start IBM SPSS Collaboration andDeployment Services Deployment Manager. For example, click Start >Deployment Manager.
2. Click File > New > Content Server Connection.3. In the Connection Name box, enter a name for your Collaboration and
Deployment Services repository.4. In the Host box, enter the name or IP address of the Predictive Analytics node
computer.5. In the Port box, enter 9080.
The default port number that is used by the WebSphere Application Serverinstance is 9080.
Important: If you are using a single node installation of Maximo APM -Predictive Maintenance Insights On-Premises, the port number is 9082.
Note: If you are using Oracle Database, the default port number is 80.6. Click Finish.7. Click the connection name that you created.8. In the User ID and Password boxes, enter the credentials for the CNDS server.9. Click OK.
54 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Adding users and groups to IBM SPSS Collaboration and Deployment Services:
You use IBM SPSS Collaboration and Deployment Services Deployment Managerto manage users and groups. You must add an administrator user for IBM MaximoAsset Performance Management - Predictive Maintenance Insights On-Premises.
Procedure
1. In Deployment Manager, click Tools > Server Administration.2. Click Click here to define a new administrative server connection.3. In the Name box, enter a name for your server, and click Next.4. In the Host box, enter the name or IP address of Predictive Analytics node
computer.5. In the Port box, enter the port number of for the WebSphere instance. The
default value is 9080.
Important: If you are using a single node installation of Maximo APM -Predictive Maintenance Insights On-Premises, the port number is 9082.
6. Click Finish.7. Double-click the connection name that you created.8. In the User ID box, enter admin.9. In the Password box, enter admin.
10. Click OK.11. Expand Users and Groups, and double-click Local User Repository.12. Select Show all available users/groups.13. Click New Group.
a. Enter administrator.b. Select Show all available users.c. Under Available users, move the admin user to Groups contains users.d. Click OK.
14. Click New Group.a. Enter DM Administrator.b. Select Show all available users.c. Under Available users, move the admin user to Groups contains users.d. Click OK.
15. Click New Group.a. Enter DM Users.b. Select Show all available users.c. Under Available users, move the admin user to Groups contains users.d. Click OK.
16. Double-click Roles.17. Click New Role.
a. In the Role Name box, enter DM Administrator.b. Click Select All to add all actions for this user role.c. Click OK.d. Select the DM Administrator role, and click Edit Users and Groups.e. Click Show all available users/groups.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 55
f. Under Available users, move the DM Administrator group toUsers/Groups Assigned to Role.
g. Click OK.18. Click New Role.
a. In the Role Name box, enter DM User.b. Click Select All to add all actions for this user role.c. Click OK.d. Select the DM User role, and click Edit Users and Groups.e. Click Show all available users/groups.f. Under Available users, move the DM Users group to Users/Groups
Assigned to Role.g. Click OK.
Importing the resource definitions into IBM SPSS Collaboration andDeployment Services:
Maximo APM - Predictive Maintenance Insights On-Premises resource definitionsinclude credential definitions, data source definitions, message domains, promotionpolicies, server definitions, and server cluster specifications. These resources arerequired for running jobs.
You must import these resource definitions into IBM SPSS Collaboration andDeployment Services Deployment Manager.
The resource files are installed onto the Predictive Analytics node computer by theServer Artifact installer. You must copy the content files from the Analytics node tothe computer where you installed Deployment Manager.
Procedure
1. Copy the Analytics node contents to your Windows-based computer by usingeither an FTP client or by using a shared directory.The contents files are installed to /opt/IBM/PMI by default on the Analyticsnode computer.
2. Start Deployment Manager, and select the Content Explorer tab.3. Right-click Content Repository, and click Import.4. Browse to and select the pes files from the Analytics node server artifacts.
The artifacts include the following files:v PMIANALYTIC.pes
v PMI_DataLoad.pes
5. Click Open.6. Accept the default options in the Import window, and click OK.7. Repeat the previous steps to import each pes file.
Adding credential definitions to IBM SPSS Collaboration and DeploymentServices:
You must add user credential definitions in IBM SPSS Collaboration andDeployment Services Deployment Manager. You must add the credentials for yourIBM SPSS admin user, the database instance owner, and the root user on thePredictive Analytics node computer.
56 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
About this task
If any of the users already exist, then you must update the user passwords asdescribed in this procedure.
Procedure
1. In Deployment Manager, click Content Explorer.2. Expand Resource Definitions > Credentials.3. Right-click Credentials, and click New > Credentials Definition.
a. In the Name box, enter admin, and click Next.b. In the User ID box, enter admin.c. In the Password box, enter the password you entered for the WebSphere
Application Server Profile Administrative User Name.d. In the Security Provider box, select Local User Repository.e. Click Finish.
4. Right-click Credentials, and click New > Credentials Definition.a. In the Name box, enter db2inst1, and click Next.b. In the User ID box, enter db2inst1.c. In the Password box, enter the password for your db2inst1 user.d. Leave the Security Provider box blank.e. Click Finish.
5. Right-click Credentials, and click New > Credentials Definition.a. In the Name box, enter modeler, and click Next.b. In the User ID box, enter root.c. In the Password box, enter the password for the root user on the Analytics
node computer.d. Leave the Security Provider box blank.e. Click Finish.
Adding server and resource definitions to IBM SPSS Collaboration andDeployment Services:
You must add server and resource definitions in Deployment Manager.
If you are not using a computer that is running Microsoft Windows 7 or MicrosoftWindows 8 operating systems, some entries, such as server types, might notdisplay correctly.
Procedure
1.
Important: If any of the servers exist, then you must update their properties asdescribed in this procedure.In Deployment Manager, click Content Explorer.
2. Expand Resource Definitions.3. Perform the following steps to add server definitions:
a. Double-click localhost.b. In the Server URL field, type the IP address and HTTP Transport port of
the Analytics node. For example, http://analytics_node_name:Http_port_number/ .
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 57
c. Click Back and verify that the Name is localhost and the Type is ContentRepository Service.
d. Click Finish.e. Double-click modeler.f. Click Back and verify that the Name is modeler and the Type is Modeler
Service.g. Click Next.h. Type the host name in the Host field, 28057 in the Port field, and the SPSS
Modeler Server installation location the Default data path field.The default SPSS Modeler Server installation path is /opt/IBM/SPSS/ModelerServer/18.1.1/demos.
i. Click Finish.4. Perform the following steps to add resource definitions:
a. Expand the Credentials folder.b. Double-click admin.c. If you changed CADS credentials, update them, and click Finish. In the
Security Provider field, select Local User Repository.d. Double-click IBMPMI, enter the credentials for your Database, and click
Finish.e. Double-click modeler, enter the credentials of the target system, and click
Finish.
Installation of the Integration Bus clientsFor IBM Maximo Asset Performance Management - Predictive MaintenanceInsights On-Premises, you must install MQ Explorer, Integration Toolkit, andIntegration Explorer.
Installing MQ Explorer:
IBM Integration Explorer client application requires that MQ Explorer is installedon the same computer.
Procedure
1. Go to the install_location\IBMPMI_Client_102\64 bit\IBM_Integration_Bus_Toolkit\IBM_INTEGRATION_BUS_V10.0_WIND_64directoryfolder.
2. Decompress the installation file that is named 9.1.0.0-IBM-MQC-Win64.zip.3. In the decompressed directoryfolder, go to the MQServer directoryfolder, and
double-click MQLaunch.exe.4. Click Software Requirements, and ensure that you are using a supported
operating system.5. Click Network Configuration, and select No for Configuring WebSphere MQ
for Windows domain users.6. Click IBM MQ Installation, and click Launch IBM MQ Installer.7. On the Setup Type page, select Custom, and click Next.8. On the Features page, select only MQ Explorer to be installed.
Ensure that all other features are set to Do not install this feature.9. Click Next.
10. Click Install, and click Finish.
58 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Installing the Integration Bus client applications:
Install the IBM Maximo Asset Performance Management - Predictive MaintenanceInsights On-Premises Integration Bus client applications. The applications includeIBM Integration Toolkit and IBM Integration Explorer.
Before you begin
Ensure that MQ Explorer is already installed.
Procedure
1. Go to the install_location\IBMPMI_Client_102\64 bit\IBM_Integration_Bus_Toolkit\IBM_INTEGRATION_BUS_V10.0_WIND_64 directory.
2. Decompress the IIB_V10.0.0.7_WINDOWS_X86-64.zip installation file.3. In the decompressed directoryfolder, in the IIB_V10.0.0.7_WINDOWS_X86-64\
EAsmbl_image directoryfolder, double-click IIBSetup10.0.0.7.exe.4. Accept the license and click Install.5. Follow the steps to install IBM Integration Toolkit.
Connecting to your WebSphere MQ broker:
Connect to the queue manager you created on the IBM Maximo Asset PerformanceManagement - Predictive Maintenance Insights On-Premises Integration Bus nodecomputer.
Procedure
1. In a terminal window in the iib node, login as a mqmuser, and type thefollowing command (all on one line):setmqaut -m pmimanager -t queue -n SYSTEM.MQEXPLORER.REPLY.MODEL -g mqm
+browse -get +put
2. Go to the /opt/ibm/iib-10.0.0.7/server/sample/wmq directory and run thefollowing command:./iib_createqueues.sh pmimanager mqmuser
3. From the Start menu, click All Programs > IBM MQ > MQ Explorer.The first time that you start WebSphere MQ Explorer, you are prompted for aworkspace location.
4. In the MQ Explorer - Navigator, under IBM MQ, right-click QueueManagers, and select Add Remote Queue Manager.
5. Enter the name of your queue manager, select Connect directly, and clickNext. For example, enter pmimanager.
6. In the Connection details section, enter the following information, and clickNext.a. In the Host name or IP address box, enter the information for your
Integration Bus node computer.b. In the Port number box, enter the listener port number. The default is
1414.c. In the Server-connection channel box, enter SYSTEM.BKR.CONFIG
7. On the Specify user identification details page, select Enable useridentification.
8. In the Userid box, enter the local administrator user that was used to createthe broker.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 59
9. In the Userid box, enter mqm.10. The first time that you add a user, you must enable password saving. Click
Passwords Preferences Page, and then select Save passwords to file to enablethe feature, and click OK.
11. Click Enter password.12. Enter the user's password, and click OK.13. Click Finish. The queue manager appears in the list, and the status appears as
running.
Installing Framework Manager for IBM Maximo AssetPerformance Management - Predictive Maintenance InsightsOn-PremisesInstall IBM Cognos Framework Manager to create or edit models and publishpackages for IBM Cognos Business Intelligence.
If you install Framework Manager to the same computer as where you installedIBM Cognos Business Intelligence, you must install Framework Manager to adifferent location. Framework Manager is a 32-bit application and cannot beinstalled to the same location as the 64-bit IBM Cognos Business Intelligence servercomponents.
Procedure1. Go to the install_location\IBMPMI_Client_102\64 bit\CognosAnalytics\
Framework_Manager directoryfolder.2. Double-click the ca_model_win32_11.0.12.exe file.3. Follow the steps in the wizard to install the product.4. Start the IBM Cognos Configuration.5. In IBM Cognos Configuration, in the Explorer panel, select Environment.6. In the Gateway URI value, change localhost to the name or IP address of the
Business Intelligence (BI) node computer.7. In the Dispatcher URI for external applications value, change localhost to the
name or IP address of the Business Intelligence (BI) node computer.8. In the Dispatcher URI for external applications value, change 9300 to 9080.
9080 is the port number that is used by WebSphere Application Server for IBMCognos Business Intelligence.
9. Click File > Save.
Copying the license files to each client computerAfter you install the IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises client components, you must copy the swidtagfile and license folder from where you installed the artifacts to the computers onwhich you install an IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises client.
Important: Do not rename the folders or files.
Procedure1. Copy the swidtag file from the iso-swid folder where you installed the artifacts
to each computer on which you install a client.For example, copy the file so that you have a C:\IBM\PMI1.0.2\iso-swid folderthat contains a swidtag file.
60 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
2. Copy the license folder from the folder where you installed the artifacts toeach computer on which you install a client.For example, copy the folder and contents so that you have aC:\IBM\PMI1.0.2\license folder that contains the license files.
Stop and start solution software servicesIBM Maximo Asset Performance Management - Predictive Maintenance InsightsOn-Premises is an integrated solution that includes many products. If you muststop the services, you must do so in the correct order. The product services mustalso be started in the correct order.
Stop solution servicesYou must stop the IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises node services in a specific order.
Stop the node services in the following order:1. Business Intelligence (BI) node2. Integration Bus node3. Predictive Analytics node4. data node
Stopping services on the IIB node computer:
You must stop the IBM Cognos Business Intelligence services and IBM HTTPServer on the IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises Business Intelligence (BI) node computer.
You stop the IBM Cognos BI services by stopping the WebSphere ApplicationServer profile where IBM Cognos BI is running.
About this task
Use the following steps to stop IBM Cognos in silent mode.
Procedure
1. Go to the cognos_install_location/bin64 directory. For example, go to the/opt/ibm/cognos/analytics/bin64 directory.
2. Enter the following command:export JAVA_HOME=/opt/ibm/cognos/analytics/jre/./cogconfig.sh -stop
Stopping services on the Integration Bus node computer:
You must stop the IBM Integration Bus services on the IBM Maximo AssetPerformance Management - Predictive Maintenance Insights On-PremisesIntegration Bus node computer.
Procedure
1. Log in to the Integration Bus node computer as root.2. Change to the mqmuser. For example, enter the following command:
su - mqmuser
3. Go to the IBM Integration Bus bin directoryfolder. For example, go to/opt/ibm/iib-10.0.0.7/server/bin.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 61
4. Enter the following command:./mqsistop pmibroker -i
5. Enter the following command to verify that the services are stopped:./mqsilist pmibroker
6. Go to the Liberty installation location, for example, /opt/IBM/WebSphere/Liberty/, and stop the Liberty servers using the following commands:bin/server stop framework_serverbin/server stop controller_server
Stopping services on the Analytics node computer:
You must stop the IBM SPSS services on the IBM Maximo Asset PerformanceManagement - Predictive Maintenance Insights On-Premises Predictive Analyticsnode computer.
Procedure
1. Log in to the Analytics node computer as root.2. Go to the WebSphere Application Server CNDSprofile/bin directory. For
example, go to /opt/IBM/WebSphere/AppServer/profiles/CNDSprofile/bin.3. Enter the following command:
./stopServer.sh server1
stopserver.bat server1
4. Go to the IBM SPSS Modeler Server directory. For example, go to/opt/IBM/SPSS/ModelerServer/18.1.1.
5. Enter the following command:./modelersrv.sh stop
6. To verify whether any services are still running enter the following command:ps -ef | grep statisticsd
7. To stop any services that are still running enter the following command:kill -9 'cat statisticsd.pid'
Stopping services on the data node computer:
You must stop the IBM DB2 instance on the IBM Maximo Asset PerformanceManagement - Predictive Maintenance Insights On-Premises data node computer.
Procedure
1. Log in to the data node computer as root.2. Log in to the data node computer as the IBM DB2 administrator user.3. In a terminal window, type the following command to change the DB2 instance
owner:su - db2inst1
4. Enter the following command to stop the DB2 administration server:db2stop
5. For a Situational Awareness artifact installation, stop Jena on the data nodecomputer:/opt/Jena/stopJena_Linux.sh
62 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Start solution servicesYou must start the IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises node services in a specific order.
Start the node services in the following order:1. data node2. Predictive Analytics node3. Integration Bus node4. Business Intelligence (BI) node
Starting services on the data node computer:
You must start the IBM DB2 instance on the IBM Maximo Asset PerformanceManagement - Predictive Maintenance Insights On-Premises data node computer.
Procedure
1. Log in to the data node computer as root.2. Log in to the data node computer as the IBM DB2 administrator user.3. In a terminal window, type the following command to change the DB2 instance
owner:su - db2inst1
4. Click Start > IBM DB2 > DB2COPY1 (Default) > DB2 Command Window -Administrator.
5. Enter the following command to start the DB2 administration server:db2start
6. For a situational awareness artifact installation, start Jena on the data nodecomputer:/opt/Jena/startJena_Linux.sh
Starting services on the Analytics node computer:
You must start the IBM SPSS services on the IBM Maximo Asset PerformanceManagement - Predictive Maintenance Insights On-Premises Predictive Analyticsnode computer.
Procedure
1. Log in to the Analytics node computer as root.2. Go to the WebSphere Application Server CNDSprofile/bin directory. For
example, go to /opt/IBM/WebSphere/AppServer/profiles/CNDSprofile/bin.3. Enter the following command:
./startServer.sh server1
startserver.bat server1
4. Go to the IBM SPSS Modeler Server directory. For example, go to/opt/IBM/SPSS/ModelerServer/18.1.1.
5. Enter the following command:./modelersrv.sh start
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 63
Starting services on the Integration Bus node computer:
You must start the IBM Integration Bus services on the IBM Maximo AssetPerformance Management - Predictive Maintenance Insights On-PremisesIntegration Bus node computer.
Procedure
1. Log in to the Integration Bus node computer as root.2. Change to the mqmuser. For example, enter the following command:
su - mqmuser
3. Go to the mq bin directory. For example, go to /opt/mqm/bin.4. To load the profile for the mqm user, enter the following command and press
enter:.~/.bash_profile
5. To start the queue manager, enter the following command:strmqm queue_manager_name
For example, to start the default broker that is named pmimanager enter thefollowing command:strmqm pmimanager
6. Go to the IBM Integration Bus bin directory. For example, go to/opt/ibm/iib-10.0.0.7/server/bin.
7. Enter the following command:./mqsistart pmibroker
8. To verify that the services started, enter one of the following commands:./mqsilist pmibroker or ./mqsilist pmibroker -e pmigroup1. The./mqsilist pmibroker -e pmigroup1 command lists all entries that arerunning under pmigroup1.
9. Enter the following commands:runmqsc pmimanagerSTART LISTENEREND
10. Exit the mqmuser account and return to the root or sudo user account.11. Start the Liberty servers. Go to the Liberty installation location, for example,
/opt/IBM/WebSphere/Liberty/, and run the following commands:bin/server start controller_serverbin/server start framework_server
Starting services on the IIB node computer:
You must start the IBM Cognos Business Intelligence services and IBM HTTPServer on the IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises Business Intelligence (BI) node computer.
You start the IBM Cognos BI services by starting the WebSphere Application Serverprofile where IBM Cognos BI is running.
About this task
Use the following steps to start IBM Cognos in silent mode.
64 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Procedure
1. Go to the cognos_install_location/bin64 directory. For example, go to the/opt/ibm/cognos/analytics/bin64 directory.
2. Enter the following command:export JAVA_HOME=/opt/ibm/cognos/analytics/jre/./cogconfig.sh -s
Product license filesAfter you manually install IBM Maximo Asset Performance Management -Predictive Maintenance Insights On-Premises, you must ensure that theappropriate swidtag file and license directory exists on each computer on whichyou installed an Maximo APM - Predictive Maintenance Insights On-Premisescomponent.
License filesThe swidtag file and license directory must exist on the Maximo APM - PredictiveMaintenance Insights On-Premises node computer.
Note: Do not rename the directory or files.
If you installed on a Red Hat Enterprise Linux operating system by using thesolution installer, the license files are automatically copied to /opt/IBM/PMI_1.0.2/license and the swidtag files are automatically copied to/opt/IBM/PMI_1.0.2/iso-swid on the Maximo APM - Predictive MaintenanceInsights On-Premises node.
Updating your software tag file if you change product usageIf you change your usage of IBM Maximo Asset Performance Management -Predictive Maintenance Insights On-Premises, such as to a non-productionenvironment from a production environment, you must switch the software tagsfor your installation.
You must copy the appropriate software tag file to each computer on which anMaximo APM - Predictive Maintenance Insights On-Premises server or clientcomponent is installed.
Procedure1. On the computer where you decompressed the artifact files, go to the iso-swid
or iso-swid_NonProduction directory, and decompress the file, if applicable.2. Copy the swidtag file to each computer on which you installed an Maximo
APM - Predictive Maintenance Insights On-Premises component and replacethe existing file.For example, on Microsoft Windows operating systems, copy the file so thatyou have a C:\IBM\PMI1.0.2\iso-swid directory that contains a swidtag file. OnLinux operating systems, you would have an /opt/IBM/PMI1.0.2/iso-swiddirectory that contains a swidtag file.
TroubleshootingThis section contains troubleshooting information for the IBM Maximo AssetPerformance Management - Predictive Maintenance Insights On-Premisesinstallation.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 65
Cannot open the user interface for the installer in FirefoxThe user interface for the installer does not open in Firefox when you use thefollowing link: https://hostname:8080/UI/index.html
About this task
Complete the following steps to remove the cert8.db file from Firefox and to tryto open the user interface for the installer again.
Procedure1. In Firefox, select Open menu.2. Select Help > Troubleshooting Information.3. Select Open Folder.4. Delete the cert8.db file.5. Use the following link to reopen the user interface for the installer:
https://hostname:8080/UI/index.html
Progress bar shows null% as valueDuring the installation, the progress bar in the Run Progress box shows null%.
A value of null% in the progress bar does not indicate that the installation stopped.Allow the installation to proceed. The correct value is displayed when theinstallation is complete.
Installation stops abruptlyDuring the installation, an error is displayed in the solution installer and the logfile appears to have also ended abruptly.
This problem can occur because the underlying Chef server is overloaded withroles and is unable to process any new requests.
To resolve this problem, do the following steps:1. On the computer where you are running the solution installer, go to the
<solution_installer_path>/ServerInstallation/SolutionInstaller/NodeRoot/Mapper/roles directory.
2. List the files in the directory. For example, enter ls.Note the full name of the db2node#.json file. The # part of the file name is anumber.
3. Go to the /root/chef-repo directory.4. Enter the following command:
knife role from file <solution_installer_path>/ServerInstallation/SolutionInstaller/NodeRoot/Mapper/roles/db2node#.json
Ensure that you use correct # part of the file name.After the command has completed, you should see a message that says:Updated Role db2node#!
5. Go back to the solution installer, and run the installation again.
Run Progress box shows more nodes than are in yourconfigurationThe Run Progress box shows the installation progress. It might show more nodesthan you are using in your configuration.
66 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Allow the installation to proceed, and wait to ensure that each of the nodes thatare shown in the Run Progress box indicate that the installation is complete.
JAVA_HOME not set when starting IBM Cognos ConfigurationAfter you install IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises as a sudo user, you receive a message that theJAVA_HOME environment variable is not set.
You can resolve this be setting the JAVA_HOME environment variable. You must usethe JRE that is provided with the WebSphere Application Server installation.
Procedure1. On the Business Intelligence (BI) node computer, in terminal window, enter the
following command:export JAVA_HOME=/Cognos_install_location/analytics/jre
2. Go to the /opt/ibm/cognos/analytics/bin64 directory.3. Type the following command:
./cogconfig.sh
IBM Cognos Configuration starts.4. If you want to save this setting for future session, add the command to the
user's .bash_profile file.
“CONFIGURATION ERROR:Specified config file/etc/opscode/pivotal.rb does not exist” errorYou have reinstalled the solution installer after you used the cleanup.sh script, andwhen you run the solution installer you get an error message like the following:
ERROR: CONFIGURATION ERROR:Specified config file /etc/opscode/pivotal.rbdoes not existCould not find organisation solinst
ERROR: CONFIGURATION ERROR:Specified config file /etc/opscode/pivotal.rbdoes not existCould not find
These messages occur because one of the services that is used by the solutioninstaller is still running and a port is still in use.
To resolve this error, restart you machine, and then run the setup.sh script again.
Solution installer indicates successful completion but progressbars are not completeDuring the installation, a message in the solution installer indicates that theinstallation has completed successfully, but the Run Progress box shows that someinstallation tasks are not yet complete.
In this situation, you can check the log file to determine whether the installation iscompleted or not.1. On the computer where you are running the solution installer, go to the
<solution_installer_path>/ServerInstallation/SolutionInstaller/NodeRoot/Downloads/Logs directory or the <solution_installer_path>/ArtifactsInstallation/SolutionInstaller/NodeRoot/Downloads/Logsdirectory.
2. Enter the following command to view the log file:tail -f LOG_FILE_<timestamp>.log
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 67
3. If messages are still being written to the log file, that means that the installationis still in progress. In this case, you must wait until no further messages arewritten to the log file.
4. After no further messages are written to the log file, you can continue withinstallation by testing the products.
No Server Connection when you view log details from solutioninstallerWhile you are running an installation, you click Get Details and you get a NoServer Connection page in your web browser. This error can occur if the server isnot properly registered in the domain controller or the DHCP server.
To get the log file, you can log in to the computer where you are running thesolution installer, and go to the <solution_installer_path>/ServerInstallation/SolutionInstaller/NodeRoot/Downloads/Logs directory or the<solution_installer_path>/ArtifactsInstallation/SolutionInstaller/NodeRoot/Downloads/Logsdirectory.
Modeler Server type not displaying in resource definitionsIn IBM Maximo Asset Performance Management - Predictive Maintenance InsightsOn-Premises, if the Modeler Server type does not display in resource definitions inIBM SPSS Collaboration and Deployment Services Deployment Manager, tryclosing Deployment Manager and opening it again.
Error installing IBM Cognos BIThe IBM Cognos Business Intelligence installer requires a specific library file inorder to run.
If you encounter this error installing IBM Maximo Asset Performance Management- Predictive Maintenance Insights On-Premises, see the IBM support page(http://www.ibm.com/support/docview.wss?uid=swg21612290) for informationon how to correct the error.
Restarting the queue manager and brokerAfter a IBM Maximo Asset Performance Management - Predictive MaintenanceInsights On-Premises Integration Bus node server restart, you might need to restartthe queue manager and broker.
Procedure1. Log on to the Integration Bus node computer.2. In a terminal window, go to the installation_location/mqm/bin directory. For
example, if you installed to the default location, go to the /opt/mqm/bindirectory.
3. Change to the mqm user. For example, su mqmuser.4. To load the profile for the mqm user, enter the following command and press
enter:.~/.bash_profile
5. To start the queue manager, enter the following command:strmqm queue_manager_nameFor example, to start the queue manager that is named pmimanager, enter thefollowing command:strmgm pmimanager
6. Go to the IBM Integration Bus bin directory. For example, go to/opt/ibm/iib-10.0.0.7/server/bin.
68 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
7. To start the broker, enter the following command:mqsistart broker_nameFor example, to start the default broker that is named pmibroker, enter thefollowing command:mqsistart pmibroker
“Subscription to live feed failed” error in DashboardWhen you subscribe to a dashboard, you receive the following error message:“Subscription to live feed failed. Please connect to administrator.”
This issue can occur if the broker on the Integration Bus node computer is notrunning.
For more information about starting services on the Integration Bus nodecomputer, see “Starting services on the Integration Bus node computer” on page64.
Error loading shared libraries: libImbCmdLib.soAn error message that states libImbCmdLib.so: cannot open shared object file:No such file or directory can indicate that environment variables are not correct.
Verify the environment variables, specifically ones that are related to the IBMIntegration Bus broker.
Also, ensure that the link inside /opt/ibm/mqsi/9.0.0.2/lib/headless is removed.
Errors deploying Cognos BI server artifactsWhile you are deploying the IBM Cognos BI server artifacts, you receive errormessages in the master log. This issue can be caused by entering the incorrectvalue for the IBM Cognos BI dispatcher URI in the Deployment Wizard.
The following error message appears in the master log:[exec] java.net.MalformedURLException: For input string: "<port>"[exec] at java.net.URL.<init>(URL.java:613)[exec] at java.net.URL.<init>(URL.java:476)[exec] at java.net.URL.<init>(URL.java:425)[exec] at Import_Partial_Whole.connectToReportServer
(Import_Partial_Whole.java:353)[exec] at Import_Partial_Whole.main(Import_Partial_Whole.java:137)[exec] Exception in thread "main" java.lang.NullPointerException[exec] at Import_Partial_Whole.addArchive(Import_Partial_Whole.java:396)[exec] at Import_Partial_Whole.deployContent(Import_Partial_Whole.java:238)[exec] at Import_Partial_Whole.main(Import_Partial_Whole.java:149)
To resolve this problem, you must enter the host name and the port number forthe IBM Cognos Dispatcher URI in the Deployment Wizard. For example,http://hostname:port/p2pd/servlet/dispatch.
You must enter the correct hostname value and port number. The default portnumber is 9080.
IBM Integration Bus related nodes are missing after migrationAfter you migrate IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises, you open MQ Explorer and IBM IntegrationBus related nodes are missing.
You can resolve this issue by forcing the program to reinitialize the MBExplorerplugin.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 69
Procedure1. On the Integration Bus node computer, go to the MQExplorer_Installation/
eclipse/links directory. For example, go to the /opt/mqm/mqexplorer/eclipse/links directory.
2. Make a copy of com.ibm.wmadmin.broker.explorer.link as a backup. You willcopy this file back to this directory later.
3. Delete com.ibm.wmadmin.broker.explorer.link.4. Go to the /opt/mqm/bin directory.5. Enter the following command to start MQ Explorer:
./strmqcfg -c
6. After MQ Explorer is fully loaded, close the program.7. Go back to the /opt/mqm/mqexplorer/eclipse/links directory.8. Replace com.ibm.wmadmin.broker.explorer.link from your backup.9. Go back to the /opt/mqm/bin directory.
10. Restart MQ Explorer using the following command:./strmqcfg -c
Error configuring NFS mount settingsYou are configuring network file system (NFS) mounts on the Integration Bus nodeand the Predictive Analytics node computers to allow file transfers between thesenodes. When you restart the Linux services, an error occurs.
You enter the service portmap restart command and receive the following error:portmap: unrecognized service
To resolve the problem, restart the operating system and then reissue thecommand.
Initialization error when configuring IBM SPSS Collaboration andDeployment ServicesIn IBM Maximo Asset Performance Management - Predictive Maintenance InsightsOn-Premises, if the task for configuring the IBM SPSS Collaboration andDeployment Services displays a database initialization error, run the traceroutecommand to ensure communication between the Predictive Analytics node and thedata node.
Procedure1. On the Analytics node computer, enter the following command:
traceroute data_node_name
Where data_node_name is the name or IP address of the data node computer.2. Try the task again.
Error starting IBM HTTP ServerYou receive the following error when you start the IBM HTTP Server: error whileloading shared libraries: libexpat.so.0: cannot open shared object file: Nosuch file or directory.
The problem might be because you are trying to start IBM HTTP Server outside ofa WebSphere Application Server environment in which required libraries are notfound. To resolve the problem, see Troubleshooting IBM HTTP Server startup(www.ibm.com/support/knowledgecenter/SSZH4A_6.2.0/com.ibm.worklight.installconfig.doc/admin/t_troubleshooting_ihs_startup.html).
70 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Error executing action run on resource execute[extract_zip]When you start the artifacts solution installer after using it previously to install theartifacts, you get “Error executing action run on resource execute[extract_zip]”.
Procedure1. On each node where you have installed artifacts, delete the directory that
contains the artifacts. For example, on the data node computer, delete the/opt/IBM/PMI/Data directory.
2. Open the artifacts solution installer in a web browser.3. Click Run.
System error when you log in to the Maximo APM - PredictiveMaintenance Insights On-Premises dashboard applicationYou are logging in to the Maximo APM - Predictive Maintenance InsightsOn-Premises dashboard application and you receive a system error. This error canoccur if data was not loaded into the database.
To resolve this error, load the Maximo APM - Predictive Maintenance InsightsOn-Premises sample data into the database.
After the data is loaded, you can access the Maximo APM - Predictive MaintenanceInsights On-Premises dashboard application.
Error Forever Node.js module is not runningYou try to access the Forever log file using the forever list command and receivean error Forever Node.js module is not running.
About this task
Perform this task to install the Forever module so that you can access the Foreverlog file.
Procedure1. On the computer that contains the solution installer, make sure the Forever
module is not installed. Open a terminal window and enter the followingcommand: npm uninstall forever -g
2. Install the Forever module. Go to the /SolutionInstaller/NodeJS/ directoryand enter the following command: npm install forever-0.14.1.tgz -g TheForever module is installed and starts.
Results
You can now access the Forever log file.
Error running setup.shYou run setup.sh but receive the following error: ERROR: ArgumentError: invalidbyte sequence in US-ASCII.
About this task
This error occurs because the system from which you run the command is notusing the en_US.UTF-8 language. Perform this task to confirure your system to useen_US.UTF-8.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 71
Procedure1. Run the following command:
vi ~/.bash_profile
2. Add the following lines to the file:export LC_ALL=en_US.UTF-8export LANG=en_US.UTF-8
3. Save the file.4. Run the following command:
source ~/.bash_profile
5. Run the following command:echo $LANG
If the result is en_US.UTF-8, then the issue is resolved.
Error for yum command on BI nodeAfter you install a standard configuration, when you run a yum command on theBusiness Intelligence node, you get an error message.
About this task
The error is similar to the following:There was a problem importing one of the Python modules required to run yum.The error leading to this problem was:/usr/lib64/libxml2.so.2: symbol gzopen64, version ZLIB_1.2.3.3 not defined infile libz.so.1 with link time referencePlease install a package which provides this module, orverify that the module is installed correctly.
This error occurs if the /opt/ibm/cognos/analytics/bin64 directory is included inthe LD_LIBRARY_PATH system variable.
Procedure1. Check the LD_LIBRARY_PATH system variable:
echo $LD_LIBRARY_PATH
2. If the /opt/ibm/cognos/analytics/bin64 is present, remove it from theLD_LIBRARY_PATH system variable:a. Edit /root/.bash_profile:
vi /root/.bash_profile
b. Comment out or remove the /opt/ibm/cognos/analytics/bin64 directoryfrom the line export LD_LIBRARY_PATH=/opt/ibm/cognos/analytics/bin64
c. Save and exit.d. Run the following command:
source /root/.bash_profile
Supporting programs licensed with Maximo APM - PredictiveMaintenance Insights On-Premises
The following supporting programs are licensed with Maximo APM - PredictiveMaintenance Insights On-Premises.
Supporting programs
IBM Cognos Analytics Administrator
IBM Cognos Analytics Software Development Kit
72 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
IBM Cognos Framework Manager
IBM Cognos Analytics Samples
IBM Cognos Lifecycle Manager
IBM Cognos for Microsoft Office
IBM Cognos Cube Designer
IBM Cognos Dynamic Query Analyzer
IBM SPSS Analytical Decision Management
IBM SPSS Analytical Decision Management Application
IBM SPSS Collaboration and Deployment Services
IBM SPSS Collaboration and Deployment Services Deployment Manager
IBM SPSS Collaboration and Deployment Services Deployment Portal
IBM SPSS Modeler Premium Keyless
IBM SPSS Modeler Premium Server
IBM SPSS Modeler Solution Publisher
IBM SPSS Statistics Standard
IBM SPSS Statistics Server Standard
IBM SPSS Statistics Client/Developer Documentation
IBM SPSS Statistics - Essentials for Python
IBM SPSS Collaboration and Deployment Services Adapters for Statistics
IBM SPSS Data Access Pack
IBM SPSS Concurrent Licensing Tools
IBM DB2 Enterprise Server Edition
IBM WebSphere Application Server Network Deployment
IBM WebSphere Application Server Liberty Profile
IBM MQ
IBM Integration Bus
IBM Installation Manager and Packaging Utility for the Rational® SoftwareDevelopment Platform
IBM SPSS Analytic Server
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 73
IBM ILOG® CPLEX® Optimization Studio
IBM ILOG CPLEX Enterprise Server
IBM Integration Bus Manufacturing Pack for Enterprise
Programs not authorized by the Maximo APM - PredictiveMaintenance Insights On-Premises license
The following programs are not authorized with Maximo APM - PredictiveMaintenance Insights On-Premises, and the use of these programs is notauthorized by the Maximo APM - Predictive Maintenance Insights On-Premiseslicense.
IBM Cognos Analysis for Microsoft Excel (of IBM Cognos Analytics Administrator)
IBM Cognos Analysis Studio (of IBM Cognos Analytics Administrator)
IBM Cognos Business Intelligence Transformer (of IBM Cognos AnalyticsAdministrator)
IBM Cognos Connection Installer for IBM Cognos Insight® (of IBM CognosAnalytics Administrator)
IIBM Cognos Data Manager Connector (of IBM Cognos Analytics Administrator)
IBM Cognos Insight (of IBM Cognos Analytics Administrator)
IBM Cognos Metric Designer (of IBM Cognos Analytics Administrator)
IBM Cognos Metric Studio (of IBM Cognos Analytics Administrator)
IBM Cognos Metrics Manager (of IBM Cognos Analytics Administrator)
IBM Cognos Query Studio (of IBM Cognos Analytics Administrator)
IBM Cognos TM1® Package Connector (of IBM Cognos Analytics Administrator)
IBM DB2 Advanced Workgroup Server Edition (of IBM Cognos AnalyticsAdministrator and IBM SPSS Analytic Server)
IBM Tivoli® Directory Integrator Identity Edition (of IBM Cognos AnalyticsAdministrator)
IBM Cognos Business Intelligence Pattern (of IBM Cognos Analytics Administrator)
IBM Cognos Real-time Monitoring (of IBM Cognos Analytics Administrator)
IBM Data Studio (of IBM DB2 Enterprise Server Edition)
pureScale® Feature (of IBM DB2 Enterprise Server Edition)
IBM Mobile Database (of IBM DB2 Enterprise Server Edition Version)
IBM Mobile Database Sync (of IBM DB2 Enterprise Server Edition)
74 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
IBM Tivoli Storage Flashcopy Manager (of IBM DB2 Enterprise Server Edition)
IBM InfoSphere® Change Data Capture (of IBM DB2 Enterprise Server Edition)
IBM DB2 Connect™ 10.5 (component) ( of IBM DB2 Enterprise Server Edition)
IBM Spectrum Scale™ for AIX® 4.1.1 (of IBM DB2 Enterprise Server Edition)
IBM Spectrum Scale for Linux Multiplatform 4.1.1 (of IBM DB2 Enterprise ServerEdition)
J2SE Rule Execution Server (of IBM Integration Bus)
IBM Integration Bus Manufacturing Pack for Factory
IBM WebSphere Application Server Developer Tools for Eclipse (of IBM WebSphereApplication Server Network Deployment)
IBM DB2 Advanced Workgroup Server V11.1 (of IBM WebSphere ApplicationServer Network Deployment)
IBM WebSphere eXtreme Scale (of IBM WebSphere Application Server NetworkDeployment)
IBM WebSphere Application Server (of IBM SPSS Analytic Server)
Administration tool and product portal referenceThe administrative tools and portals for IBM Maximo Asset PerformanceManagement - Predictive Maintenance Insights On-Premises are in severallocations.
The following table shows you access information for the tools and portals. Unlessotherwise noted, the information applies to single or multinode configurations ofIBM Maximo Asset Performance Management - Predictive Maintenance InsightsOn-Premises.
Table 11. Administration tool and product portal reference
Administration tool or portaland description URL or location
BI node: WebSphereApplication ServerAdministrative Console
The WebSphere ApplicationServer Administrative Consoleis the administration tool forWebSphere.
The WebSphere ApplicationServer Administrative Consoleruns on each node computerwhere WebSphere is installed.
Use the console to start andstop applications.
http://server_node_name:9043/ibm/console
Where server_node_name is the name or IP address of anode computer where WebSphere is installed.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 75
Table 11. Administration tool and product portal reference (continued)
Administration tool or portaland description URL or location
IBM Cognos BusinessIntelligence
Use IBM Cognos Connectionto access reports.
Use IBM CognosAdministration to configureIBM Cognos BI. For example,add data source connections orset security.
http://iib_node_name:9300/bi/
Where iib_node_name is the name or IP address of IIBnode computer.
SPSS Node: WebSphereApplication ServerAdministrative Console
Use IBM SPSS Collaborationand Deployment ServicesDeployment Manager toconfigure IBM SPSS serversettings.
https://analytics_node_name:9043/ibm/console
Where analytics_node_name is the name or IP address ofPredictive Analytics node computer.
SPSS Collaborative &Deployment ServiceConfiguration
http://analytics_node_name:9080/config
Where analytics_node_name is the name or IP address ofPredictive Analytics node computer.
SPSS Collaborative &Deployment Service peb
http://analytics_node_name:9080/peb
Where analytics_node_name is the name or IP address ofPredictive Analytics node computer.
Installing a big data node configurationComplete these tasks to install a big data node configuration of Maximo APM -Predictive Maintenance Insights On-Premises, or to upgrade an existing installationto the latest version.
Installing the productBefore using Maximo APM - Predictive Maintenance Insights On-Premises, youmust install the server and artifacts. Follow these instructions to install the productor to upgrade an existing installation to the latest version.
System requirementsBefore installing Maximo APM - Predictive Maintenance Insights On-Premises,ensure that the target system meets the system requirements.
The computer where you run the installation must have sufficient disk space thatis allotted to the / directory. The minimum disk space for the / directory is 100GB.
The other system requirements for the installation server are as follows:v 4-core processorv 32GB memoryv Red Hat Enterprise Linux Server Edition version 7.5, x86_64.
76 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
The system that you use for the Maximo APM - Predictive Maintenance InsightsOn-Premises big data node server must meet the following requirements:v 4-core processorv 32GB memoryv 500GB hard diskv Red Hat Enterprise Linux Server Edition version 7.2, x86_64.
Deployment topologyThe topology of Maximo APM - Predictive Maintenance Insights On-Premises bigdata consists of the Application server and Hadoop nodes.
The following image shows the deployment topology of Maximo APM - PredictiveMaintenance Insights On-Premises big data configuration.
Hadoop nodes
The Maximo APM - Predictive Maintenance Insights On-Premises big data nodeaccesses the Hortonworks Data Platform nodes to read and write data.
Hortonworks Data Platform 2.6.1 and Ambari 2.5.1 are supported by Maximo APM- Predictive Maintenance Insights On-Premises. HDFS, HBase, and Spark are thecomponents for using Maximo APM - Predictive Maintenance InsightsOn-Premises big data configuration.
For more information about the hardware requirements for Hortonworks DataPlatform, refer to the Hortonworks Data Platform hardware recommendation site.
For more information about how to install the Hortonworks Data Platform 2.6.1cluster, refer to the Hortonworks Data Platform documentation site.
Application server
The cloud server profile and the provisioning console profile run on theapplication server.
Prerequisites and installation preparationBefore you install IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises, ensure that the computers that you use meetthe minimum requirements for operating systems, prerequisite software,processing, and disk space.
Important: The computers or virtual machines that you use for Maximo APM -Predictive Maintenance Insights On-Premises nodes must not have any of theincluded software already installed.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 77
Modifying the sudoers file for the user who runs the installation:
To run the IBM Maximo Asset Performance Management - Predictive MaintenanceInsights On-Premises installation you must be either root user or have sudopermission on each node computer.
To install with sudo user permissions, you must also add the user to the sudoersfile.
Procedure
1. Log in as root user.2. Enter the following command to open the sudoers file for editing:
visudo -f /etc/sudoers
3. At the end of the file, add the following line for your user:username ALL=(ALL) ALL
4. Press the Esc key, and enter :wq to save and close the file.5. Repeat these steps on each computer on which you install a Maximo APM -
Predictive Maintenance Insights On-Premises node.
Disabling requiretty:
Before you install the product, you must disable the requiretty in the /etc/sudoersfile.
About this task
You disable requiretty on every node, including the staging node, in the/etc/sudoers file.
Procedure
1. Log in as root user.2. To open the sudoers file for editing, enter the following command:
visudo -f /etc/sudoers.3. Go to the "Defaults requiretty" line and add a number sign (#) to the beginning
of the line.
What to do next
Repeat these steps on each computer that you are going to install the product.
Configuring passwordless authentication:
Before you install Maximo APM - Predictive Maintenance Insights On-Premises,you must configure passwordless SSH authentication from the center server to allHortonworks Data Platform nodes in your environment.
Procedure
1. Log in as root to the server that hosts Maximo APM - Predictive MaintenanceInsights On-Premises.
2. Edit the /etc/hosts file by using the following command:vi /etc/hostsAdd the following line to the file:
78 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
ip_address ambari_host_name ambariFor example, 9.123.19.23 hdp.ibm.com ambari
3. Generate an SSH authentication key pair:ssh-keygen -t rsa -b 2048
4. Copy the public key to an Hortonworks Data Platform node and edit the/etc/sudoers file for that node. The following steps use the ambari node as anexample:a. Run the following command to copy the public key to the node:
ssh-copy-id -i ~/.ssh/id_rsa.pub root@ambari
b. Run the following command to log in without using strict host keychecking:ssh -o "StrictHostKeyChecking no" root@ambari
c. Launch vi with superuser privileges. If you cannot use visudo, use sudo.visudo su
d. Change the permissions of the /etc/sudoers file:chmod 640 /etc/sudoers
e. Edit the /etc/sudoers file:vi /etc/sudoers
f. Find the following line in the file:Defaults requirettyChange this line to:#Defaults requiretty
g. Quit vi.h. Change the permissions of the /etc/sudoers file:
chmod 440 /etc/sudoers
Repeat these steps to copy the public key to all Hortonworks Data Platformnodes.
Preparing for installation:
Complete the following steps before you install Maximo APM - PredictiveMaintenance Insights On-Premises.
Procedure
1. On the system on which you will install Maximo APM - PredictiveMaintenance Insights On-Premises, open the /etc/hosts file.
2. Ensure that your Hortonworks Data Platform nodes are listed in the file, forexample:127.0.0.1 localhost.localdomain localhost##.##.##.## hdpmgmt01.domain.com hdpmgmt01##.##.##.## hdpmgmt02.domain.com hdpmgmt02##.##.##.## hdpslave01.domain.com hdpslave01##.##.##.## hdpslave02.domain.com hdpslave02##.##.##.## hdpslave03.domain.com hdpslave03
3. Save and close the file.4. Access the Ambari web user interface from a web browser by using the server
name (the fully qualified domain name) on which you installed the Ambariserver, and port 8080. For example, enter the following string in your browser:HTTP://node1.example.com:8080
5. Select Add New Hosts and go to the Install Options page. In Target Hosts,list the node where you will install Maximo APM - Predictive MaintenanceInsights On-Premises.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 79
6. In Host Registration Information, select one of the following options:v Provide your SSH Private Key to automatically register the host:
Click SSH Private Key. The private key file is /root/.ssh/id_rsa, if theroot user installed the Ambari server. If you installed as a non-root user,then the default private key is in the .ssh directory in the non-root user'shome directory.Click Register and Confirm.
v Register the host manually and do not use SSH.7. Verify that the hdfs and hbase services are available on the application node.
a. If Kerberos is enabled, run the following command:kinit –kt /etc/security/keytabs/hdfs.headless.keytabhdfs
b. Run the following command:hdfs dfs -ls /The result should list the directories under the root hdfs directory.
c. If Kerberos is enabled, run the following command:kinit –kt /etc/security/keytabs/hbase.headless.keytab hbase
d. Run the following commands:hbase shelllistThe result should not contain error messages. There are no tables inititally.
8. On each Hortonworks Data Platform management node and slave node,create OS-level users and groups by using the following commands:groupadd pmuseradd -g pm -s /bin/bash pmecho "pm:pw@pm" | chpasswduseradd -g pm -s /bin/bash demopmtenantecho "demopmtenant:pw@demo" | chpasswd
9. If Kerberos is enabled in the Hortonworks Data Platform cluster, you mustcreate a principal for Maximo APM - Predictive Maintenance InsightsOn-Premises in the Kerberos Key Distribution Center (KDC), generate arelated keytab file, and distribute the keytab file to all of Hortonworks DataPlatform cluster nodes and the Maximo APM - Predictive MaintenanceInsights On-Premises big data node.a. On the node where the KDC is installed, run the following commands:
kadmin.localkadmin.local: addprinc pmktadd -k /etc/security/keytabs/pm.keytab pmaddprinc demopmtenantktadd -k /etc/security/keytabs/demopmtenant.keytab demopmtenantkadmin.local: exit
b. Copy the /etc/security/keytabs/pm.keytab file and the/etc/security/keytabs/demopmtenant.keytab file to the/etc/security/keytabs directory on all of Hortonworks Data Platformcluster nodes and the Maximo APM - Predictive Maintenance InsightsOn-Premises big data node.
10. If Kerberos is enabled in the Hortonworks Data Platform cluster, make surethat Kafka is using a PLAINTEXT endpoint:a. Access the Ambari web user interface.b. Select the Kafka service.c. Open Configurations.
80 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
d. In Custom kafka-broker, check whether the value of thesecurity.inter.broker.protocol is PLAINTEXT. If the value is notPLAINTEXT, update the value, save, and then restart affected service.
11. If Python 2.7.11 has not been installed on the Hortonworks Data Platformslave nodes, complete the following steps on each node:a. Run the following commands:
yum install zlib-develyum install opensslyum install openssl-devel
b. Download http://python.org/ftp/python/2.7.11/Python-2.7.11.tgz.c. Extract the file using the following command:
tar -zxvf Python-2.7.11.tgz
d. Create the python2.7.11 directory:mkdir /usr/local/python2.7.11
e. Set the permissions for the directory using the following command:chmod 755 /usr/local/python2.7.11/
f. Change to the Python-2.7.11 directory:cd Python-2.7.11
g. Run the following command:./configure --prefix=/usr/local/python2.7.11
h. Run the following commands:makemake install
i. Run the following command:mv /usr/bin/python /usr/bin/python_old
j. Run the following command:ln -s /usr/local/python2.7.11/bin/python /usr/bin/python
k. Open yum in vi editor:vi /usr/bin/yum
l. Change #!/usr/bin/python to #!/usr/bin/python_oldm. Open urlgrabber-ext-down in vi editor:
vi /usr/libexec/urlgrabber-ext-down
n. Change #!/usr/bin/python to #!/usr/bin/python_old12. If numpy/Pandas/kafka-python has not been installed, complete the following
steps:a. Download get-pip.py from https://bootstrap.pypa.io/get-pip.pyb. Run the following command:
su root
c. Run the following command to install pip:python get-pip.py
d. Run the following command:ln -s /usr/local/python2.7.11/bin/pip /usr/bin/pip
e. Run the following commands:pip install numpypip install Pandaspip install kafka-pythonpip install happybase
13. If Kerberos is enabled in the Hortonworks Data Platform cluster, add hbasethrift server properties:a. Access the Ambari web user interface.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 81
b. Select the Hbase service.c. Open Configurations.d. In Custom hbase-site, click the Add Property link, copy
hbase.thrift.kerberos.principal=hbase into the properties area, thenclick Add.
e. Click the Add Property link, copy hbase.thrift.keytab.file=/etc/security/keytabs/hbase.headless.keytab into the properties area, andthen click Add
f. Restart the affected service.14. If Kerberos is enabled in the Hortonworks Data Platform cluster, add a new
custom kafka broker property:a. Access the Ambari web user interface.b. Select the Kafka service.c. Open Configurations.d. In Custom kafka-broker, click the Add Property link, copy
allow.everyone.if.no.acl.found=true into the properties area, then clickAdd.
e. Restart the affected service.15. Configure Python to use UTF8:
a. Change to the following directory:cd /usr/local/python2.7.11/lib/python2.7/site-packages
b. Create the sitecustomize.py file.c. Add the following contents to the file:
# encoding=utf8import sys# sys.setdefaultencoding() does not exist, here!reload(sys) # Reload does the trick!sys.setdefaultencoding(’utf8’)
16. Run the following command on one hdpmgmt node:su hbase -c "/usr/hdp/2.6.1.0-129/hbase/bin/hbase-daemon.sh startthrift -threadpool -m 200 -w 500"
17. If Kerberos is enabled in the Hortonworks Data Platform cluster, make surethat the default realm is PMQ.IBM.COM in the /etc/krb5.conf file.
Installing the serverPerform this task to install the server component.
Procedure1. Download the ServerInstallation.tar.gz file and the iotmf_server_1.1_l86-
64_en.tar.gz file to the system that you will use for the server. You can getServerInstallation.tar.gz from the IBM IOT for Manufacturing FoundationServer Installer 1.1 Linux x86-64 English package. You can getiotmf_server_1.1_l86-64_en.tar.gz from the IBM IOT for ManufacturingFoundation Server 1.1 Linux x86-64 English package.
2. Copy the ServerInstallation.tar.gz file to the installation directory(PM_install_dir) and decompress the file.The ServerInstallation directory is created.
3. Copy the iotmf_server_1.1_l86-64_en.tar.gz file to the PM_install_dir/ServerInstallation/SolutionInstaller/NodeRoot/Downloads/Softwaredirectory.
4. Run the following script to decompress the files:
82 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
5. Edit /etc/bashrc by using the following command:vi /etc/bashrcAdd the following lines to the file:export JAVA_HOME=jdk_installation_pathexport PATH=$PATH:$JAVA_HOME/binexport CLASSPATH=$CLASSPATH:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar
6. To set up the installer, go to the installer setup folder PM_install_dir/ServerInstallation/SolutionInstaller and then run the following script:./setup.sh
7. Access the installer by going to the following URL:https://hostname:8080/UI/index.htmlwhere hostname is the host name for installer. Review the license informationand then click Accept.
8. Click Predefined Configuration to load a predefined configuration thatincludes one node, WebSphere Application Server Liberty, ProvisioningConsole, IBM JDK Artifact, and Service Framework.
9. Change the values in the Property Editor to the configuration of your server.10. Click Validate to validate the configuration.11. Click Run to run the installation.12. In the installer setup folder, run the following script to clean up the
installation files:./cleanup.sh
13. Restart the server.
Installing the artifactsPerform this task to install the product artifacts.
Procedure1. Download the ArtifactsInstallation.tar.gz file to the system that you will
use for the server. You can get ArtifactsInstallation.tar.gz from the IBMMaximo Asset Performance Management Predictive Maintenance InsightsArtifact Installer 1.0.2 Linux x86-64 English package.
2. Copy the ArtifactsInstallation.tar.gz file to the PM_install_dir directory anddecompress the file.
3. To set up the installer, go to the installer setup folder and then run thefollowing script:./setup.sh
4. Access the installer by going to the following URL:https://hostname:8080/UI/index.htmlwhere hostname is the host name for installer. Review the license informationand then click Accept.
5. Click Predefined Configuration to load a predefined configuration thatincludes one node and the PM Artifact component.
6. Change the values in the Property Editor to the configuration of the PMArtifact.v Ambari host name refers to the name of host where the Ambari server is
installed. The artifact installer connects to the Ambari server to getHortonworks Data Platform service status and connection information. IfKerberos is enabled in Hortonworks Data Platform, set Kerberos is set assecurity authentication to True.
v The hbase keytab file and hdfs keytab file are files in the/etc/security/keytabs folder.
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 83
7. Change the values in the Property Editor to the configuration of the deployedtraining server.The subnet mask refers to the network that can access the shared folder of thetraining server. You can set this value as IP_of_VI_center_server/29.
8. Click Validate to validate the configuration.9. Click Run to run the installation.
10. In the installer setup folder, run the following script to clean up theinstallation files:./cleanup.sh
Product license filesAfter you manually install IBM Maximo Asset Performance Management -Predictive Maintenance Insights On-Premises, you must ensure that theappropriate swidtag file and license directory exists on each computer on whichyou installed a Maximo APM - Predictive Maintenance Insights On-Premisescomponent.
License files:
The swidtag file and license directory must exist on the Maximo APM - PredictiveMaintenance Insights On-Premises node computer.
Note: Do not rename the directory or files.
If you installed on a Red Hat Enterprise Linux operating system by using thesolution installer, the license files are automatically copied to /opt/IBM/PMI_1.0.2/license and the swidtag files are automatically copied to/opt/IBM/PMI_1.0.2/iso-swid on the Maximo APM - Predictive MaintenanceInsights On-Premises node.
Application licensing and the slmtag file:
A licensing application runs on the Maximo APM - Predictive MaintenanceInsights On-Premises Integration Bus node.
Here is a sample slmtag file with the following code.<SchemaVersion>2.1.1</SchemaVersion><SoftwareIdentity>
<PersistentId>2d6cc0b9a3824c59b5941447b706443d</PersistentId><Name>IBM IoT Predictive Maintenance and Optimization</Name><InstanceId>/IBM/IOTM/PMO</InstanceId>
</SoftwareIdentity><Metric logTime="2017-06-14T02:00:08+08:00">
<Type>ASSET</Type><SubType>NO_ASSETS</SubType><Value>44</Value><Period>
<StartTime>2017-06-13T02:00:08+08:00</StartTime><EndTime>2017-06-14T02:00:08+08:00</EndTime>
</Period></Metric><Metric logTime="2017-06-15T02:00:08+08:00">
<Type>ASSET</Type><SubType>NO_ASSETS</SubType><Value>44</Value><Period>
84 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
<StartTime>2017-06-14T02:00:08+08:00</StartTime><EndTime>2017-06-15T02:00:08+08:00</EndTime>
</Period></Metric>
TroubleshootingTroubleshooting topics can help you identify and recover from common issues.
Server validation fails with check_requiretty.sh error:
Validation fails during the server installation, and the log file shows an error aboutcheck_requiretty.sh.
About this task
This issue occurs because requiretty is enabled on the target machine. Completethe following steps to comment out the requiretty line in the /etc/sudoers file onthe target system.
Procedure
1. Run the following command:visudo
2. Comment out the requiretty line as follows:#Defaults requiretty
3. Save the file and exit.4. Retry the server installation and validation.
setup.sh fails with US-ASCII error:
On a MacBook, setup.sh fails and the log file contains the following message:ERROR: ArgumentError: invalid byte sequence in US-ASCII.
About this task
This error occurs because the default encoding of a MacBook is US-ASCII ratherthan UTF-8. Complete the following steps to change the encoding of a MacBook toUTF-8.
Procedure
1. Run the following command on the MacBook:vi ~/.bash_profile
2. Add the following lines to the file:export LC_ALL=en_US.UTF-8export LANG=en_US.UTF-8
3. Save the file.4. Run the following command:
source ~/.bash_profile
5. Run the following command:echo $LANGIf the result is en_US.UTF-8, the issue should be resolved.
Cannot open the user interface for the installer in Firefox:
The user interface for the installer does not open in Firefox when you use thefollowing link: https://hostname:8080/UI/index.html
Chapter 3. Installing Maximo APM - Predictive Maintenance Insights On-Premises 85
About this task
Complete the following steps to remove the cert8.db file from Firefox and to tryto open the user interface for the installer again.
Procedure
1. In Firefox, select Open menu.2. Select Help > Troubleshooting Information.3. Select Open Folder.4. Delete the cert8.db file.5. Use the following link to reopen the user interface for the installer:
https://hostname:8080/UI/index.html
86 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Chapter 4. Using a standard configuration
This section contains information about using a standard configuration of theproduct.
Building sample applicationsYou can use the IBM Maximo Asset Performance Management - PredictiveMaintenance Insights On-Premises sample application as a way to buildcustomized analytics applications with the provided IBM middleware.
This sample application solution can be applied to an asset failure predictionproblem. This prediction can help reliability engineers and asset maintenanceplanners to optimize their asset maintenance schedules and reduce maintenancecosts. In this app, the IBM Integration Bus (IIB) is used as a data ingest andanalytics interface. You can copy the data or configure the files in different foldersto load the data or trigger the analytics. The SPSS Modeler is used as an analyticsengine to train or score the failure prediction model. The SPSS Collaboration andDeployment Services (C&DS) server is used as a deployment platform to managethe analytics models. The DB2 server is used as a data storage for both analyticsand user reports. Finally, Cognos Analytics is used to display the analytics results.
Data model
The sample application has several restrictions on the data model.1. The master data must have two fixed columns: Resource_id and Resource_Type.
All other metadata can be any flexible data.2. The event data must have a Resource_id and at least one flag field to represent
an event.3. The analysis .json parameter file contains only three key-value pairs. All keys
are fixed.v AnalysisEntity maps to the Resource_id. The value can be one resource ID
or multiple resource IDs that are separated by commas.v AnalysisTarget maps to the flag field name.v AnalysisType supports only two values: analysis and scoring.
Source code for the sample applicationAll of the necessary source code is provided for you to modify the IBM MaximoAsset Performance Management - Predictive Maintenance Insights On-Premisessample application. This source code includes IBM Integration Bus (IIB) flow files,SPSS C&DS job files, data model files, and Cognos report files.
IIB flows
You can load the IIB flows, by using the .bar file and source .zip file, into the IIBtoolkit client. After the source code is loaded, you can edit the sample flows orlearn how to create a new flow. The IIB flow runs two jobs: (1) Listen to thespecified folder. After this folder has incoming data, send the data to the Analyticnode. (2) Trigger the C&DS jobs to process the data. Either load the data to thedatabase or run the analysis on existing data. Also, IIB can be used to receive
87
industrial data, such as Plant Information (PI) and Supervisory Control and DataAcquisition (SCADA) data.
C&DS jobs
You can import the provided C&DS .pes files into the C&DS server by using theC&DS client. Then, you can use the SPSS Modeler client to retrieve the streamfrom the C&DS server. Three streams are provided.1. Master data load. This stream reads the master data .csv file as input,
transforms the flat table data into key-value pair data, and inserts the data intothe database. You can read through the stream script to learn how to use thescript to control the stream execution. You can also learn how to performcomplex data transformations that use different predefined SPSS nodes.
2. Event data load. This stream reads the event data .csv file as input, and loadsthe data into the database.
3. Analysis stream. This stream accepts different parameters to run the analysis orscoring. This complex stream runs several ETL processes on the event data.v Feature extraction for all continuous data. New field Cumulative Sum
(CUSUM) to failure-to-exist data set.v Run feature selection. You can use the predefined SPSS feature selection
model.v Run data aggregation on different time intervals.v Run feature exclusion. You can exclude any feature that is not related to this
prediction model.4. Model analysis. Besides ETL, this stream also provides some model analysis
functions that you can reuse.v Run failure prediction with three predefined models. You can customize their
options or select a different model to run the analysis.v Provide feature prediction importance. Extract model information from the
Predictive Model Markup Language (PMML) .xml file by using scripts.v Provide the Key Performance Indicator (KPI) calculations on event data, such
as statistical calculations: Standard Deviation, Variance, Mean, Max, and Min.v Provide model accuracy computation. Compute the Normalized Mean
Square Error (NMSE) on different models.
Data model
You can modify and customize all of the database creation SQL files to constructyour own application solution. This data model includes both the data for analysisand the data for reports.
Cognos report
The Cognos report and Cognos Framework Manager (FM) model file are provided.You can redefine or customize your own FM model by using the CognosFramework Manager. You can modify the report by using the Cognos ReportStudio.
Loading sample data for the sample applicationYou can load sample master data and sample event data for the IBM MaximoAsset Performance Management - Predictive Maintenance Insights On-Premisessample application.
88 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
About this task
After successfully installing the artifacts, you must take the following steps.
Procedure1. Log in to Analytic node. Go to the /opt/IBM/PMI/Analytics/Setup folder.
Download the PMOAnalytic.pes and PMODataLoad.pes files to the C&DS clientmachine.
2. Import these two files into the C&DS server through the C&DS client. Edit theServers and Credentials according to your installation.
3. Log in to the IIB node as mqmuser. Go to the /var/PMO/MQSI/SampleData folder.You can find the sample master data, event data, and analytics parameter files.
4. Copy the PMOMaster.csv file to the /var/PMO/MQSI/masterdatain folder. Afterthis file is consumed, copy the PMOEvent.csv file to the /var/PMO/MQSI/eventdatain folder.
5. After both the master and event data are loaded, you can edit thePMOanalytic.json parameter file.a. Set the target field name to the AnalysisTarget.b. Set the actual asset ID to the AnalysisEntity.c. Set either analysis or scoring to the AnalysisType according to your
intended action. The analysis includes both the model training and scoring.The scoring runs the model score on the latest existing trained model only.
6. After analysis is complete, open the Cognos Analytics portal. The default URLis http://[ip]:9300/bi/. Under "Team Content/IBMPMI", open the "IBM PMIResource Health and Failure Prediction" report. In the report, you can select theTenantID Resource ("T1"), Resource Type, Resource ID, and Date, and then clickthe Run button. View the report.
Situational Awareness and UI and Service FrameworkSituational Awareness is an application that helps operators monitor asset statuschanges in real time with different views. The Situational Awareness applicationalso provides the Standard Operating Procedure feature to help users defineprocedure templates, and trigger the procedures if needed, usually when an assetis in abnormal status. The Situational Awareness application is based on a UI andService framework that is a programming model that enables developers to easilycustomize existing applications or create new applications. The UI frameworkhelps accelerate application development on the front end, and the REST serviceframework provides an extension mechanism that enables developers to developservices quickly.
Managing the Standard Operating ProceduresA Standard Operating Procedure (SOP) is a set of instructions that describes all therelevant steps and activities of a process or procedure.
When you define an SOP, you define activities that are included in the SOP. SOPenables an administrator to organize personnel, information, and tasks in responseto events and incidents in order to achieve a comprehensive control of theoperation. A SOP comprises of these components:
Standard Operating Procedure DefinitionAn SOP definition is the template that is used when a SOP is instantiatedin response to a particular occurrence. A SOP Definition is made up ofactivities that are described by Activity Definitions.
Chapter 4. Using a standard configuration 89
Activity DefinitionA SOP Definition contains one or more Activity Definitions. An activitydefinition sets the individual instructions that need to be performed as partof the SOP.
SOP InstanceA single Instance of an SOP in response to a particular event or occurrence.One SOP Definition can be used for many SOP Instances. An SOP Instancecan be in one of these states.v Activev Startedv Stoppedv Completedv Canceled
Activity Instance An Activity Instance is the instantiation of a single Activity Definition. Asingle Activity Definition can be used to create multiple Activity Instances.An Activity Instance can be in a number of states:v Activev Waitingv Startedv Skippedv Completed
ReferencesSupplemental information which is relevant to a Standard OperatingProcedure or Activity. References can also be used to define e-mailtemplates.
Roles There are two abilities, Owners and Readers. These can be set againstadministrative and user roles.v A Reader can monitor the activities that are associated with a standard
operating procedure.v An Owner can monitor and complete the activities that are associated
with the standard operating procedure.
Activity TypeThe Activity Type describes the response to the activity. The activities canbe of different types and execution models. Any combination of differentactivities in an SOP is allowed.v Manual: This type of activity must be manually carried out by the owner
of the SOP.v If-Then-Else Activity: A conditional activity that allows branching based
on specific criteria. The user can choose which of the SOP definitions toinstantiate when starting the activity. Either enter or select values forThen and Else.
v Alert Activity: This activity displays an e-mail template for the SOPowner to complete and send an email notification to predefinedpersonnel.
v REST Activity: An activity that creates a REST service call. The user canspecify the service URL and any required authentication information tobe invoked when the activity is started.
90 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
v SOP Activity: An activity that starts another standard operatingprocedure.
Roles for Standard Operating Procedures
The abilities for each of the roles for SOPs are as follows:
SOP Administrator roles
v View and delete an SOP definitionv Launch, view, and edit an SOP instancev Start and complete activities in an SOP instance
SOP author roles
v Create, edit, view, and delete an SOP definitionv Create an SOP draftv View, edit, and delete an SOP activityv Submit an SOP draft for approvalv Approve an SOP draft
Reference Librarian RoleCreate shared references
Owner Roles (SOP definition)
v Create an SOP draftv View, edit, and delete an SOP definitionv Edit and delete an SOP activityv Submit an SOP draft for approvalv Approve an SOP draftv Launch, view, and edit an SOP instance
Reader roles (SOP Definition)
v View an SOP definitionv View an SOP instance from My Activitiesv View an SOP activity, provided the user has Reader role in the Activity
definition
Owners roles (SOP activity)
v View an SOP instance from My Activitiesv Start and complete activities in an SOP instance for their own activities
from My Activities
Reader roles (SOP activity)View SOP instance from My Activities
Approval life cycle for an Standard Operating Procedure
An SOP definition can assume different status during its life cycle.v Draft: When the SOP is first created, a draft version is saved initially. From an
approved version of an SOP, it is also possible to create another draft version,when it is necessary to change the SOP definition using the approved version asa base. A draft can be edited, submitted for approval, or discarded.
v Pending approval: This is a draft SOP definition submitted for approval, readyto be approved or disapproved. The name of the version is defined in this status
Chapter 4. Using a standard configuration 91
and it will name the SOP definition version if approved. If this version is notapproved, the SOP definition goes back to the draft version status.
v Approved: When an SOP definition is approved it is ready to be launched.
Configuring Standard Operating Procedures for differentactivitiesOne of the important tasks for when defining a Standard Operating Procedures(SOP) is to define the set of activities that composes the procedure.
The activities can be of different types and execution models. Any combination ofdifferent activities in an SOP is allowed.
Configuring activities to start in sequence:
When you specify that activities are done in sequence, you will not be able to startan activity until the predecessor activity is completed.
Whether the activities of an SOP are executed sequentially or not is specified in theGeneral Settings section of the SOP definition.
Specify that activities must be executed sequentially where the activities must beexecuted in a chronological order or where activities depend on the result ofprevious activity.
Examples of sequential activities are:v MA1 - Approve an operation.v SA2 - Collect information about and incident area and the number of victims.v SA3 - Prepare personnel for standby.v SA4 - Redirect traffic to clear an incident area.
Configuring required activities:
A required activity is one that is mandatory in a Standard Operating Procedure(SOP). You cannot skip over an activity that is specified as a required activity inthe SOP definition.
Any of the activity types can be configured as required. Required is an attribute ofan activity therefore an SOP can have activities that are required and activities thatare optional (they can be skipped over). Examples of required activities are:v MA1 - Approve operation. Mandatory.v A2 - Collect information about incident area and number of victims. Optional.v A3 - Prepare personnel for standby. Optional.v A4 - Redirect traffic to clear incident area. Optional.
Configuring manual activities:
A manual activity type is an activity that must be manually performed by theowner once the Standard Operating Procedure is launched.
Manual activities are the most basic and essential type. Examples of manualactivities are:v A1 - Collect information about the incident area and number of victims.v A2 - Prepare personnel for standby.
92 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
v A3 - Redirect traffic to clear incident area.
Configuring conditional activities:
Conditional activities are conditional activities that allow branching based onIf-Then-Else criteria.
When the activity is launched, the operator decides whether to execute one set ofactions (Then) or another set (Else).
The conditional activity is useful in situations where you want to use the resultsfrom other activities to make a decision and launch a new SOP to respond to thesituation. Examples of a conditional activity is:v MA1 - Approve operation.v SA2 - Collect information about incident area and number of victims.v SA3 - Prepare personnel for standby.v SA3 If (team is not available = true) Then initiate contingency plan. Conditional
activity.v SA4 - Redirect traffic to clear incident area.
When the SOP instance runs, the operator decides whether to launch the Then SOPor the Else SOP, if one is available, by selecting Start Then or Start Else options inmy activity page.
Configuring notification activities:
Notification activities enable the operator to complete an email an send it. Theemail notification occurs as part of the required activity.
You need to set up an SMTP server to send the email notifications beforeconfiguring and launching a notification activity.
To set up an SMTP server, go to the sysprop.json table in the IFE database andupdate the following system properties in the SOP group:v MailServerHostname: hostname of the SMTPserverv MailServerPort: SMTP server portv MailSender: sender of emails to be sent by the activity in the From field.
Email templates can be created and then reused for a notification activity. All emailtemplates are stored as References.
Here are example templates There are some email examples created as references,please access them using these urls where <liberty server ip> is the ip address ofthe IFE server:
https://<liberty server ip>:9443/ibm/ife/sop/app/js/ife/sop/email/emailTemplate_fireEvent.txt
https://<liberty server ip>:9443/ibm/ife/sop/app/js/ife/sop/email/emailTemplate_bombThreat.txt
https://<liberty server ip>:9443/ibm/ife/sop/app/js/ife/sop/email/emailTemplate_disturbanceEvent.txt
Chapter 4. Using a standard configuration 93
https://<liberty server ip>:9443/ibm/ife/sop/app/js/ife/sop/email/emailTemplate_evacuation.txt
https://<liberty server ip>:9443/ibm/ife/sop/app/js/ife/sop/email/emailTemplate_prep_for_power_loss.txt
https://<liberty server ip>:9443/ibm/ife/sop/app/js/ife/sop/email/emailTemplate_radiationHazard.txt
https://<liberty server ip>:9443/ibm/ife/sop/app/js/ife/sop/email/emailTemplate_transitionToNewERlevel.txt
https://<liberty server ip>:9443/ibm/ife/sop/app/js/ife/sop/email/emailTemplate_weatherEvent.txt
To create a notification template:1. Create a text file that contains the email template. The To, Subject, and Body
fields are optional. Here is an example template:----------------------------------------------------------------------------------------------------------To:Subject:Attention: Emergency incident detectedBody:Emergency incident detected. Please contact administrator forfurther Information.
----------------------------------------------------------------------------------------------------------2. Publish the template in a location on the application server. Usually, the web
content directory of the Situational Awareness application, which is accessibleby the Situational Awareness application.
3. Create a reference in the Standard Operating Procedures References and pointthe address to the URL where the template is published.
4. Make sure the first line of the description field contains only the keywordNOTIFICATION.You can add further description details in subsequent lines.
Note: If you receive a 401 error when you try to load the template into the emailwindow, you need to include your credentials in the URI, for example:https://user_name:password@<host>:<port>/test-url/notification.
Defining a Standard Operating ProcedureDefine an SOP with all activities.
Procedure1. On the user interface, click Administration > Standard Operating Procedures
> SOP Definition.2. In the Basics section, define the basic information for the SOP.
a. Click Create.b. In the Basics section, type a name and description for the SOP.c. If the activities need to be carried out in a particular order, select Activities
are done in order in the General Settings field.d. Click Add References to add supplemental information.e. Click Next to go to the Roles section.
3. In the Roles section, define the roles for the SOP.
94 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
a. Select the Roles that will be assigned as Owners and Readers for the SOPcreated with this definition.v If you want the role to be able to monitor activities that are associated
with the standard operating procedure, select Reader.v If you want a role to be able to monitor and complete activities that are
associated with the standard operating procedure, select Owner.b. Click Next to go to the Activities section.
4. In the Activities section, define the activities for the SOP.a. Click Add.b. If the activity is required, select Required. If not, the SOP can move on to
the next activity during instantiation.c. Select Autostart if this activity is to start automatically without owner
operation.d. You can select the roles for the Owners and Readers. If not, the roles are
inherited from the SOP definition.e. Set the duration of the activity. The duration is the length the activity takes
once started.f. Type a description of the activity.g. Set the Activity type. The options are:v Manual Activityv If-Then-Else Activityv Alert Activityv REST Servicev SOP Activity
h. To add more activities click Add and define the next activity for the SOP.i. Click Next to go to the Summary section.
5. Review the SOP.a. Review the information in the summary.b. Click Save.
Important: The SOP is in now draft state. The SOP must be approvedbefore it can be instantiated.In the draft state, the SOP can be edited or deleted if not required.
Creating a reference for Standard Operating ProceduresReferences are supplemental information relevant to an SOP or an activity.References can also be used to define e-mail templates.
About this task
A user can create references for Standard Operating Procedures.
Procedure1. On the user interface, click Administration > Standard Operating Procedures
> References.2. Click Add.3. In the Name field, type the name of the reference.4. In the URI field, type or paste the web accessible address.5. In the Description field, type a description of the reference.
Chapter 4. Using a standard configuration 95
6. If you want to restrict the use of the reference, select the Private check box.Otherwise the reference can be shared to other users.
Editing a Standard Operating ProcedureEdit a Standard Operating Procure.
About this task
To be able to edit an approved Standard Operating Procedure (SOP), the SOP mustbe returned to a draft version.
Note: You can always edit an SOP in a draft version.
Procedure1. On the user interface, click Administration > Standard Operating Procedures
> SOP Definition.2. From the list of SOP definitions, select the SOP to be edited.3. From the Version field, select the version to be edited.4. Click Create Draft. The SOP state is now in draft.5. Click the SOP you want to edit.v To add an activity, click Add in the Activities tab.v To edit an activity, click the activity and then click Edit.v To delete an activity, click the activity and then click Delete.v To edit a role, select the Roles tab and then click Edit.v To edit references, select the References tab, click Edit or Delete for a specific
reference or click Add to add a new reference.6. When the edits are complete, click Save.
What to do next
Before the edits are accepted, you must submit the draft version for approval.
Submitting a draft Standard Operating Procedure for approvalYou can submit a draft version of an SOP for approval or discard it.
Before you begin
The SOP must be set to Draft version, and you must have the administrator role.
Procedure1. On the user interface, click Administration > Standard Operating Procedures
> SOP Definition.2. Select the SOP for submission that is in Draft state, and click Submit for
Approval.Attention: An SOP that has been submitted for approval cannot be edited.The administrator can either Approve or Disapprove the SOP.
Testing a Standard Operating ProcedureTest an approved version of a Standard Operating Procedure (SOP).
About this task
An SOP must be in an approved state before it can be tested.
96 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Procedure1. On the user interface, click Administration > Standard Operating Procedures.2. Click on the approved SOP Definition that you want to test.3. Click Definition Actions and from the drop-down list select Launch.
Once launched, the SOP Definition list will update to indicated the number ofActive SOPs based on this definition.The My Activities banner indicator shows that there are one or more activitiesthat require attention.
4. You can perform the SOP and check for completeness.5. If the SOP needs further work, click Create Draft to return the SOP to a draft
state.
Exporting a Standard Operating ProcedureYou can export your Standard Operating Procedure definitions as an XML file. Thiscapability is useful for migration purposes.
About this task
To export an SOP definition performs the following steps:
Procedure1. On the user interface, click Administration > Standard Operating Procedures
> SOP Definition.2. Select Standard Operating Procedures Definition administration page.3. From the Definition Actions drop-down list, select Export All.4. In the pop-up window that is displayed, click Save File > OK.5. Navigate to the directory where you want to save the SopDefinitions.xml file
and click Save.
Importing a Standard Operating ProcedureYou can import a previously exported Standard Operating Procedure definitionsfile. This capability is useful in cases where the organization has predefined SOPsthat were implemented using a different tool.
About this task
To import an SOP definition performs the following steps:
Procedure1. On the user interface, click Administration > Standard Operating Procedures
> SOP Definition.2. Select Standard Operating Procedures Definition administration page.3. From the Definition Actions drop-down list, select Import.4. In the Import Standard Operating Procedures window, select the XML file to
upload.The imported definitions are displayed in the list of SOP definitions. You canimport an SOP definition that has the same name as an existing SOP definition.In this case, the existing SOP definition is not overwritten. Instead, two SOPdefinitions with the same name are displayed in the list of definitions.
5. Click Import.
Chapter 4. Using a standard configuration 97
Reverting to a particular version of a Standard OperatingProcedureYou can revert back to a particular version of a Standard Operating Procedure(SOP).
About this task
The Standard Operating Procedures shows the latest version of a definition. If youneed to revert to a earlier version of a definition, you can use these steps.
Procedure1. On the user interface, click Administration > Standard Operating Procedures
> SOP Definition.2. From the list of SOP definitions, select the SOP to be edited.3. From the Version field, select the version to be reverted to.4. Click Create Draft. The SOP state is now in draft.
What to do next
Before the revert is accepted, you must submit the draft version for approval.
Viewing a Standard Operating ProcedureYou can view a Standard Operation Procedure (SOP) as an administrator.
There are two ways to view an SOP instance:v From the SOP Administration page.v From the My Activities widget.
Viewing a Standard Operating Procedure as an administrator:
You can view a Standard Operation Procedure (SOP) as an administrator.
About this task
To view the SOP instance from the SOP Administration do the following steps:
Procedure
1. On the user interface, click IFE Administration > Standard OperatingProcedures.
2. Click on the approved SOP Definition that you want to view.3. Click Definition Actions and from the drop-down list select Launch.
Once launched, the SOP Definition list will update to indicated the number ofActive SOPs based on this definition.
4. Click the approved SOP Definition.5. Click the Instances tab.6. Click the SOP instance to view the details.
Viewing a Standard Operating Procedure as a user:
You can view a Standard Operation Procedure (SOP) as a user.
98 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Before you begin
The Standard Operating Procedure must have been launched before a user canview the instance.
About this task
Users that are not authorized to view the Standard Operation ProceduresDefinition administration page, can view an SOP instance from My Activities.
Procedure
1. On the user interface, click Administration.2. Click the My Activities icon.3. Click the SOP instance you want to view.
Extend situation awarenessThe Situation Awareness Application consists of a presentation Layer, core Services,a core data model, data integration and an application content pack. Theapplication is consists of two parts: The front end and back end. The front endruns on the UI Framework and back end is part of the application content pack,that includes the service and data model.
Configuration of the front end developmentThe configuration based methodology for the front end development achieves arapid development for the application.
The entry configuration file main.json includes a series of sub-configuration filesdepending of the functionality required. The JSON format configuration files areresponsible for:v Create widget instancesv Configure widget parametersv Configure widgets containmentv Configure dependency injection among widgetsv Configure binding mechanism between source and target widgets so that the
changes happening in source widget can be notified to target widget
The list of the configuration files include:
main.json
entry configuration
layout.json
page layout relevant configuration
header.json
header bar relevant configuration
filter.json
filter relevant configuration
content.json
page content relevant configuration
map.json
Chapter 4. Using a standard configuration 99
map view relevant configuration
list.json
list view relevant configuration
previewCard.json
preview card relevant configuration
assetDetails.json
asset details relevant configuration
model.json
model relevant configuration
hierarchyModel.json
hierarchy model relevant configuration
bind.json
widget interaction relevant configuration
Model driven back end implementationThe back end implementation includes the REST service and the data model,where the data model is the base of the whole back end implementation.
Application REST Services:
All the REST services are configured in dno.xml. The implemented services are:
Table 12. Implemented Asset services
Service URL Create Update Read
/overheadline Yes Yes Yes
/substation Yes Yes Yes
/wind_farm Yes Yes Yes
Table 13. Implemented Measurement services
Service URL Create Update Read
/measurement Yes Yes Yes
/measurement_thresholdYes Yes Yes
/measurement_timeout Yes Yes Yes
Table 14. Implemented Reading services
Service URL Create Update Read
/health_index Yes Yes Yes
/health_index/byYear/health_index/byMonth/health_index/byDay/health_index/byHour/health_index/byMinute
No No Yes
100 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Table 14. Implemented Reading services (continued)
Service URL Create Update Read
/load_index Yes Yes Yes
/load_index/byYear/load_index/byMonth/load_index/byDay/load_index/byHour/load_index/byMinute
No No Yes
/impact_level Yes Yes Yes
/impact_level/byYear/impact_level/byMonth/impact_level/byDay/impact_level/byHour/impact_level/byMinute
No No Yes
Extending the applicationThree types of assets are implemented: overhead line, substation and wind farm.These are the steps to follow to add a new asset type called underground cable.
The procedures show an example of how to add underground cable to extend theapplication.
Extending the data model:
To extend the data model you need to identify the table and the relationships,create the objects and then load them into the database.
Procedure
1. Identify the table and the relationship to be created. The table is calledDNO.UndergroundCable.
2. Provide the database object creation script:CREATE TABLE DNO.UndergroundCable (
ASSET_ID INTEGER NOT NULL GENERATED BY DEFAULT AS IDENTITY(START WITH 1 INCREMENT BY 1 NO CYCLE CACHE 20 NO ORDER),
SERIAL_NUMBER VARCHAR(128) NOT NULL,NAME VARCHAR(128),DESCRIPTION VARCHAR(512),INSTALLATION_DATE DATE,STATUS SMALLINT,LOCATION DB2GSE.ST_GEOMETRY
)DATA CAPTURE NONECOMPRESS YES ADAPTIVEVALUE COMPRESSION;
3. Prepare the data to be loaded into database.a. Prepare the asset data for the new asset type underground cable and put
the following example content into a file called undergroundcable.csv andsave it in the directory /opt/IBM/energy/data/dno_sample/csv on theapplication server.
Chapter 4. Using a standard configuration 101
ASSET_ID,SERIAL_NUMBER,NAME,DESCRIPTION,INSTALLATION_DATE,STATUS,LOCATION3001,UGC_N1,Underground Cable N1,Underground Cable N1,2014-10-01,,"LINESTRING (-3.0894280 55.3783630, -3.1038610 55.3800519)"3002,UGC_N1,Underground Cable N1,Underground Cable N1,2014-10-01,1,"LINESTRING (-1.0903370 53.9502490, -1.1012380 53.9519670)"3003,UGC_N2,Underground Cable N2,Underground Cable N2,2014-10-01,1,"LINESTRING (-1.1012380 53.9519670, -1.1108510 53.9547951)"3004,UGC_N3,Underground Cable N3,Underground Cable N3,2014-10-01,1,"LINESTRING (-1.1108510 53.9547951, -1.1202921 53.9559570)"3005,UGC_N4,Underground Cable N4,Underground Cable N4,2014-10-01,1,"LINESTRING (-1.1202921 53.9559570, -1.1320510 53.9545429)"
b. Prepare the measurement data for the underground cable asset and appendthe example content into the file measurement.csv in the folder/opt/IBM/energy/data/dno_sample/csv on the application server.1201,undergroundcable,3001,UGC_3001_Impact_Level,Impact Level,Impact Level,Impact_Level,1202,undergroundcable,3002,UGC_3002_Impact_Level,Impact Level,Impact Level,Impact_Level,1203,undergroundcable,3003,UGC_3003_Impact_Level,Impact Level,Impact Level,Impact_Level,1204,undergroundcable,3004,UGC_3004_Impact_Level,Impact Level,Impact Level,Impact_Level,1205,undergroundcable,3005,UGC_3005_Impact_Level,Impact Level,Impact Level,Impact_Level,
c. Prepare measurement threshold data for the underground cable asset andappend the example content into the file measurement_threshold.csv in thefolder /opt/IBM/energy/data/dno_sample/csv on the application server.1201,0.0,3.0,01201,3.0,5.0,11201,5.0,6.0,21202,0.0,3.0,01202,3.0,5.0,11202,5.0,6.0,21203,0.0,3.0,01203,3.0,5.0,11203,5.0,6.0,21204,0.0,3.0,01204,3.0,5.0,11204,5.0,6.0,21205,0.0,3.0,01205,3.0,5.0,11205,5.0,6.0,2
d. Prepare the reading data for the underground cable asset and append theexample content as an example into the file impact_level.csv in the folder/opt/IBM/energy/data/dno_sample/csv on the application server.1201,"2014-01-01 08:58:00",4.01201,"2013-01-01 08:59:00",4.01201,"2012-01-01 09:00:00",3.01202,"2014-01-01 08:58:00",2.01202,"2013-01-01 08:59:00",3.01202,"2012-01-01 09:00:00",4.01203,"2014-01-01 08:58:00",2.01203,"2013-01-01 08:59:00",3.01203,"2012-01-01 09:00:00",4.01204,"2014-01-01 08:58:00",2.01204,"2013-01-01 08:59:00",3.01204,"2012-01-01 09:00:00",4.01205,"2014-01-01 08:58:00",2.01205,"2013-01-01 08:59:00",3.01205,"2012-01-01 09:00:00",4.0
4. Update the list of csv files in the config.properties in the folder/opt/IBM/energy/data/dno_sample/config.
102 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
csv.1=substationcsv.2=overheadlinecsv.3=wind_farmcsv.4=undergroundcablecsv.5=measurementcsv.6=measurement_thresholdcsv.7=health_indexcsv.8=impact_levelcsv.9=load_indexcsv.10=measurement_statuscsv.11=connection
5. Run the command: /opt/IBM/energy/data/runCSVLoader.sh/opt/IBM/energy/data/dno_sample/config/config.properties.
Extending the REST service:
Add the new resource to the service configuration file.
Procedure
Add a new section to the REST service xml configuration file.<resource>
<url>/undergroundcable</url><properties idProperty="ASSET_ID">
<property name="ASSET_TYPE" type="String" /><property name="ASSET_ID" type="Number" /><property name="SERIAL_NUMBER" type="String" /><property name="NAME" type="String" /><property name="DESCRIPTION" type="String" /><property name="INSTALLATION_DATE" type="Date" /><property name="STATUS" type="Number" /><property name="LOCATION" type="Geometry" />
</properties><query>select ’undergroundcable’ as ASSET_TYPE,
ASSET_ID,SERIAL_NUMBER,NAME,DESCRIPTION,INSTALLATION_DATE, STATUS,LOCATIONfrom dno.undergroundcable</query>
<create>MERGE INTO dno.undergroundcable TUSING TABLE(VALUES(CAST(:ASSET_ID AS INTEGER),
CAST(:SERIAL_NUMBER AS VARCHAR(128)),CAST(:NAME AS VARCHAR(128)), CAST(:DESCRIPTION AS VARCHAR(512)),CAST(:INSTALLATION_DATE AS DATE),CAST(:STATUS AS SMALLINT), db2gse.st_geomFromText(:LOCATION, 1003)))TMP(ASSET_ID, SERIAL_NUMBER, NAME, DESCRIPTION,
INSTALLATION_DATE, STATUS, LOCATION)ON T.ASSET_ID = TMP.ASSET_IDWHEN NOT MATCHED THEN INSERT(ASSET_ID, SERIAL_NUMBER, NAME, DESCRIPTION,
INSTALLATION_DATE, STATUS, LOCATION)VALUES(TMP.ASSET_ID, TMP.SERIAL_NUMBER, TMP.NAME, TMP.DESCRIPTION,
TMP.INSTALLATION_DATE, TMP.STATUS, TMP.LOCATION)WHEN MATCHED THEN UPDATE SET (SERIAL_NUMBER, NAME, DESCRIPTION,
INSTALLATION_DATE, STATUS, LOCATION)= (TMP.SERIAL_NUMBER, TMP.NAME, TMP.DESCRIPTION,
TMP.INSTALLATION_DATE, TMP.STATUS, TMP.LOCATION)</create>
</resource>
Extending the user interface:Procedure
1. Extend the data model. Add following json objects into model.json.{
"id": "undergroundCableModel","module": "ifef/model/Model",
Chapter 4. Using a standard configuration 103
"properties": ["criteria", "store"],"parameters": {
"timer": "@{timer}","storeModule": "ifef/model/Store","target": "/ibm/ife/sample/dno/api/undergroundcable","idProperty": "ASSET_ID"
}}
2. Extend the filter. Add a new filter for an underground cable asset type into thefile filter.json.{
"id": "undergroundcable_filter","module": "ifef/widget/filter/Filter","container": "group1","parameters": {
"label": "Underground Cable","style": "width: 100%;margin-top: 10px;","enabled":true,"pattern":"and","searchFields":[
{"name":"NAME", "type":"string", "label":"@{dno_nls.NAME}"
},{
"name":"SERIAL_NUMBER", "type":"string","label":"@{dno_nls.Serial_Number}", "regExp":"([A-Za-z0-9][A-Za-z0-9-_]*)"
},{
"name":"INSTALLATION_DATE", "type":"date","label":"@{dno_nls.Installation_Date}"
},{
"name":"STATUS","label":"@{dno_nls.STATUS}","type":"number","multiple":true,"options":[
{"label":"@{dno_nls.Critical}","icon":"/ibm/ife/widges/icons/critical.png","value":2
},{
"label":"@{dno_nls.Caution}","icon":"/ibm/ife/widges/icons/critical.png","value":1
},{
"label":"@{dno_nls.Acceptable}","icon":"/ibm/ife/widges/icons/critical.png","value":0
},{
"label":"@{dno_nls.NoReading}","icon":"/ibm/ife/widges/icons/critical.png","value":3
}]}
]}
}
3. Extend the map layer and the preview card.a. Add a new map layer for the underground cable into the file map.json.
104 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
{"id": "undergroundCableLayer","module": "ifef/widget/map/DataLayer","container": "map","properties": ["store", "selected", "criteria"],"parameters": {
"index":2,"map": "@{map}","keyFields": ["ASSET_TYPE", "ASSET_ID"],"styles": [ {
"condition": "STATUS==0","style": {
"stroke":{"type":"ol.style.Stroke","parameters": {
"color": "#699037","width": 2
}}
}},{
"condition": "STATUS==1","style": {
"stroke":{"type":"ol.style.Stroke","parameters": {
"color": "#FDBA1A","width": 2
}}
}},{
"condition": "STATUS==2","style": {
"stroke":{"type":"ol.style.Stroke","parameters": {
"color": "#C32E14","width": 2
}}
}},{
"condition": "STATUS==3","style": {
"stroke":{"type":"ol.style.Stroke","parameters": {
"color": "#EE3D96","width": 2
}}
}},{
"condition": "STATUS!=0 && STATUS!=1 && STATUS!=2 && STATUS!=3","style": {
"stroke":{"type":"ol.style.Stroke","parameters": {
"color": "#BBBBBB","width": 2
}}
Chapter 4. Using a standard configuration 105
}}]
}}
b. Add a new map preview card for the underground cable type into the filepreviewCard.json.{
"id": "undergroundCableMapPreviewCard","module": "ifef/widget/previewcard/PreviewCard","properties":["data"],"parameters": {
"titleProperty": "NAME","position": "_position","properties": [
{"label":"@{dno_nls.Asset_ID}", "name":"ASSET_ID", "isKey": true},{"label":"@{dno_nls.Serial_Number}","name":"SERIAL_NUMBER", "isKey": true},{"label":"@{dno_nls.NAME}","name":"NAME", "isKey": true},{"label":"@{dno_nls.Description}","name":"DESCRIPTION", "isKey": true},{
"label":"@{dno_nls.STATUS}","name":"STATUS","isKey": true,"render":{
"templates": [{
"condition":"STATUS==0","content":"<span style=’background-color:green’>${Acceptable}</span>","variables":{
"Acceptable":"@{dno_nls.Acceptable}"}
},{
"condition":"STATUS==1","content":"<span style=’background-color:orange’>${Caution}</span>","variables":{
"Caution":"@{dno_nls.Caution}"}
},{
"condition":"STATUS==2","content":"<span style=’background-color:red’>${Critical}</span>","variables":{
"Critical":"@{dno_nls.Critical}"}
}]
}},{"label":"@{dno_nls.Location}","name":"LOCATION"}
]}
}
4. Extend the list and list Container including preview card.a. Add a new list for the underground cable asset type in the file list.json.
{"id": "undergroundCableList","module": "ifef/widget/list/List","container": "listContainer","properties": ["store"],"parameters": {
"keyFields": ["ASSET_TYPE", "ASSET_ID"],"title": "@{undergroundCable_filter.label}","pageSize": 100,"paginationBar": [100,150,200,1000,0],"baseSort": [
106 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
{"attribute": "STATUS","descending": true
},{
"attribute": "SERIAL_NUMBER","descending": true
}],
"column": [{
"name": "@{dno_nls.STATUS}","field": "STATUS","sortable" : true,"style" : "@{statusFormatter.style}","decorator" : "@{statusFormatter.decorator}"
},{
"name": "@{dno_nls.Serial_Number}","field": "SERIAL_NUMBER","sortable" : true
},{
"name": "@{dno_nls.NAME}","field": "NAME","sortable" : true
},{
"name": "@{dno_nls.Installation_Date}","field": "INSTALLATION_DATE","sortable" : false
}]
}}
b. Add a new preview card for the underground cable type into the filepreviewCard.json.{
"id": "undergroundCablePreviewCard","module": "ifef/widget/previewcard/PreviewCard","properties":["data"],"parameters": {
"titleProperty": "NAME","position": "_position","properties": [
{"label":"@{dno_nls.Asset_ID}", "name":"ASSET_ID", "isKey": true},{"label":"@{dno_nls.Serial_Number}","name":"SERIAL_NUMBER", "isKey": true},{"label":"@{dno_nls.NAME}","name":"NAME", "isKey": true},{"label":"@{dno_nls.Description}","name":"DESCRIPTION", "isKey": true},{
"label":"@{dno_nls.Installation_Date}","name":"INSTALLATION_DATE","render":{
"dateFormatOptions":{"selector" : "date", "datePattern": "yyyy-MM-dd"}}
},{
"label":"@{dno_nls.STATUS}","name":"STATUS","isKey": true,
"render":{"templates": [{
"condition":"STATUS==0","content":"<span style=’background-color:green’>${Acceptable}</span>","variables":{
Chapter 4. Using a standard configuration 107
"Acceptable":"@{dno_nls.Acceptable}"}
},{
"condition":"STATUS==1","content":"<span style=’background-color:orange’>${Caution}</span>","variables":{
"Caution":"@{dno_nls.Caution}"}
},{
"condition":"STATUS==2","content":"<span style=’background-color:red’>${Critical}</span>","variables":{
"Critical":"@{dno_nls.Critical}"}
}]
}},{
"label":"@{dno_nls.Location}","name":"LOCATION"}
],"moreActions":[
{ "label":"@{nls.HighlightOnMap}","func":"@{highlightOnMap.highlightOnMap}"
}]
}}
c. Modify highlightOnMap to include undergroundcable in the filepreviewCard.json
{"id":"highlightOnMap","module":"ifef/widget/map/HighlightOnMap","parameters":{
"mapContainer":"@{mapTab}","typeProperty":"ASSET_TYPE","mappings":[
{"type":"overheadline","targetLayer":"@{overheadlineLayer}","dataIdProperty":"ASSET_ID","maxZoom":16
},{
"type":"undergroundcable","targetLayer":"@{undergroundCableLayer}","dataIdProperty":"ASSET_ID","maxZoom":16
},{
"type":"substation","targetLayer":"@{substationLayer}","dataIdProperty":"ASSET_ID","maxZoom":16
},{
"type":"wind_farm","targetLayer":"@{windFarmModelLayer}","dataIdProperty":"FARM_ID","maxZoom":16
}]
}}
108 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
5. Extend the logical Map: refer to section of New Application Development forthe Logical Map.
6. Extend the binding: modify the file bind.json as in the example:[{
"id":"filterBind","module":"ifef/behavior/Bind","parameters":{
"bindings":[...{"source": "@{undergroundcable_filter}", "sourceProp": "criteria", "target": "@{undergroundCableModel}", "targetProp": "criteria", "ignoreInitialSet": true},...
]}
},{ "id":"mapBind", "module":"ifef/behavior/Bind", "parameters":{
"bindings":[...{"source": "@{undergroundCableModel}", "sourceProp": "store", "target": "@{undergroundCableLayer}", "targetProp":"store"},...{"source": "@{undergroundCableLayer}", "sourceProp": "selected", "target": "@{undergroundCableMapPreviewCard}", "targetProp":"data"},...
]}
},{ "id":"listBind", "module":"ifef/behavior/Bind", "parameters":{
"bindings":[...{"source": "@{undergroundCableModel}", "sourceProp": "store", "target": "@{undergroundCableList}", "targetProp":"store"},...{"source": "@{undergroundCableList}", "sourceProp": "selected", "target": "@{undergroundCablePreviewCard}", "targetProp":"data"},...
]}
},{ "id":"logicMapBind", "module":"ifef/behavior/Bind", "parameters":{
"bindings":[{"source": "@{logicMapPreviewCardHelper}", "sourceProp": "selected", "target": "@{logicalMapPreviewCard}", "targetProp": "data"}
]}
},{ "id":"logicalMapLayoutBind", "module":"ifef/behavior/Bind", "parameters":{
"bindings":[{"source": "@{logicalMap}", "sourceProp": "layoutData", "target": "@{logicalMapLayouts}", "targetProp": "rawLayoutData"}
]}
},{ "id":"assetDetailBind", "module":"ifef/behavior/Bind", "parameters":{
"bindings":[...{"source": "@{undergroundCableLayer}", "sourceProp": "criteria", "target": "@{measurementModel}", "targetProp": "criteria", "ignoreInitialSet": true},...{"source": "@{undergroundCableList}", "sourceProp": "criteria", "target": "@{measurementModel}", "targetProp": "criteria", "ignoreInitialSet": true},...
...]
}}]
Customizing the solution using the UI and Service FrameworkYou can customize the solution to suit your business requirements.
Chapter 4. Using a standard configuration 109
Use the Administration Console view to register custom user interface componentsand to customize the user interface to suit your particular operation.
Customizing the user interfaceYou can use the extension capabilities that are provided by the user interfaceframework to build application user interfaces that meet your operationalrequirements.
UI Framework provides a number of reusable user interface components includingpages, styles, layouts, and widgets. You can also add custom widgets and layoutsto your solution by using the user interface extension framework. Use theAdministration Console view to register new user interface components, to addnew pages, and to configure the style, layout, widgets, access controls, andRepresentational State Transfer (REST) services for the pages in your solution.
Configuring pages:
If you are an administrator, you can add and configure custom pages. Each pagehas a style and a layout to manage the widgets on the page.
About this task
Use the Administration Console view to add and configure custom pages. Eachpage is defined by a set of properties, and each property value that you enter isvalidated by the solution upon entry. You can view pages that are provided withthe solution, but you cannot delete them, and you can edit only the layoutproperties for these pages.
Procedure
1. In the Administration Console view, click Page.Adding a custom page2. Click Create.3. In the Create a Page window, enter the details for your custom page.
a. In Title, enter a unique page title.b. Optional: In Description, enter a description of the page.c. In URI, enter a valid URI, for example /ibm/ife/sample/index/HTML.d. Click Save. The new page is listed under the Create button.e. For a newly created page, select Groups in the Access control field if you
want those groups to access this page. Click Save.
Editing information for a custom page4. Edit the page title, description, URI and access control for a custom page.5. Click Save to save the changes to the page's configuration.Deleting a custom page6. Click the delete icon for the custom page, and then in the confirmation
window, click Yes.
Note: You cannot delete a custom page if the page is included in theconfiguration of a page hierarchy.
110 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Configuring page hierarchies:
If you are an administrator, you can add and remove page hierarchies, and youcan configure the contents of page hierarchies. Page hierarchies that contain one ormore pages are displayed in the main navigation bar.
About this task
Use the Administration Console view to add, edit, and remove page hierarchies.Each hierarchy has a label and can contain one or more pages or page hierarchies.Each element of a page hierarchy is defined by a set of properties, and eachproperty value that you enter is validated by the solution upon entry. The positionof a page hierarchy in the main navigation bar is determined by the value of thehierarchy's sequence property. You cannot change the properties of system pagehierarchies that are provided with the solution, but you can remove them orchange their contents.
Procedure
1. In the Administration Console view, click Page Hierarchy.Adding a page hierarchy2. Add a label to create a new page hierarchy. You can add a top-level page
hierarchy or you can add a page hierarchy to an existing page hierarchy. Thelabel for a page hierarchy is displayed in the main navigation bar.v To add a top-level hierarchy, click Create.v To add a hierarchy in an existing page hierarchy, click the add icon for the
page hierarchy.3. In the Create an Item window, enter the label details for your custom page
hierarchy.a. In Type, select Label in the drop-down list to add a page hierarchy.b. In Name, enter a name for the page hierarchy. The name is displayed in
the main navigation bar.c. Optional: In Description, enter a description of the page hierarchy.d. In Sequence, enter a number greater than or equal to 0 as the sequence
number for the page hierarchy. The sequence number is a relative valuethat determines the position of a page hierarchy in relation to other pagehierarchies in the main navigation bar. For example, if you have twotop-level page hierarchies, then the page hierarchy with the lowersequence value is positioned to the left in the main navigation bar.
e. Click Save.
Note: A page hierarchy is not displayed in the main navigation bar until itcontains one or more pages.
Adding a page to a hierarchy4. Click the add icon for the page hierarchy.5. In the Create an Item window, enter the details for your custom page.
a. In Type, select Page from the drop-down list.b. In Name, enter the page name to display in the page hierarchy.c. Optional: In Description, enter a description of the page.d. In Sequence, enter a number greater than or equal to 0. The sequence
number is a relative value that determines the position of a page in ahierarchy in relation to other pages or page hierarchies.
Chapter 4. Using a standard configuration 111
e. In Page definition, select the page to add to the hierarchy from thedrop-down list.
f. Click Save.
Note: You must refresh the browser to display the new page in the mainnavigation bar.
Editing a page hierarchy6. Select a page hierarchy to edit the name, description, and sequence for the
page hierarchy.7. Select a page in a page hierarchy to edit the name, description, sequence, and
page definition for the page.8. Click Save.
Deleting a page hierarchy9. Click the delete icon for the page hierarchy, and then in the confirmation
window, click Yes.Deleting a page from a page hierarchy10. Click the delete icon for the page, and then in the confirmation window, click
Yes.
Configuring REST services:
If you are an administrator, you can register and configure customRepresentational State Transfer (REST) services.
About this task
Use the Administration Console view to register and configure custom RESTservices. Each service is defined by a set of properties, and each property valuethat you enter is validated by the solution upon entry.
Procedure
1. In the Administration Console view, click Service.Registering a custom REST service2. Click Create.3. In the Create a Service window, enter the details for your custom service.
a. In Name, enter the name of the service.b. In URI, enter the URI for the resource. For example, /ibm/ife/api/ui-
service/style.
Note: You can append /* to the base URI for the service to include all theresources that are managed by the service. For example,/ibm/ife/api/ui-service/*.
c. Optional: In Description, enter a description of the service.d. Click Save. The new service is listed under the Create button. Edit the
service to assign access rights to the service to user groups in your solution.
Editing a custom REST service4. Select the service and edit the values.
a. Edit the values for the name, URI, and description.b. For Access Control , assign access rights to the service for the user role
groups in your solution. For each user role group, you can select one or
112 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
more of the access controls that are labeled Create, Read, Update, andDelete. For more information about user role groups, see the related link.
c. Click Save to save the changes.
Deleting a custom REST service5. Click the delete icon for the service, and then in the confirmation window, click
Yes.
Configuring notificationsTo be able to receive notifications, the user must configure the notifications in theadministration page.
After Notifications are set up, the user is then able to receive notifications via theend user page, email or an SMS text message on a mobile communications system.
Making a subscription for Notification in Situational Awareness:
After Notification is set up you can receive Notification on your system dashboard.There are two extra methods for the user to receive notification, email and SMStext message.
About this task
On the Notification admin page, you can make a subscription for the systemnotification .
Procedure
1. On the user interface, click Administration > Notification > Allert Settings.2. Click System Message > Item Correlation.3. In the fields System Dashboard, email, SMS, you can select the check-box
Receive notifications for the method for receiving system notifications. You canalso select how long a message shows in your System Dashboard.
4. Click Save.
Configuring the applicationUI Framework provides the capability to configure the user interface, focusing onthe filter bar and the connectivity filter.
Configuring Time in the filter bar:
You can configure the options for the time filter in the tableAHA.ANALYSIS_YEAR.
The options for the time filter are derived from the configuration of year analysistable AHA.ANALYSIS_YEAR.
TIME_BUCKET
Interger, is the yearly interval to analyze the given scope.
ANALYSIS_DURATION
Integer, the number of years to be analyzed from the start year.
ANALYSIS_YEAR
Integer, the start year to take analysis as nnnn.
Chapter 4. Using a standard configuration 113
UI FrameworkThe user interface framework accelerates the development of an application on thefront end.
The UI framework consists of several parts:v Bootstrap
– Is based on HTML/JSP bootstrap– Calls runtime to load the configuration files.– Responsible for loading the javascript libraries and the cascading style sheets.
v Configuration– Is a JSON format configuration file.– Configures the widget parameters.– Configures the widget containment.– Configures the dependency injection.
v Runtime Library– Is a lightweight javascript library.– Enables the API to load configuration file and initialize UI widget.– Enables the API to dynamically add/remove widgets.
v Ready-to-use widgets - consists of:– Container widgets (BorderLayout, TabContainer, ContentPane,)– Functional widgets (Map, List, Chart,)– Data Model widgets– Property binding widgets– Behavior widgets
v Ready-to-use application template - The template includes html bootstrap code,the configuration file and custom widgets.
Bootstrap:
Bootstrap is an jsp file, that loads the style sheet, loads and initializes the JSPlibraries, defines the page level style and calls the runtime to load theconfiguration.
User can start from below default bootstrap as a template:v Import custom javascript libraries (e.g. jquery, react.js, etc...)v Import custom stylesheet
Configuration:
The configuration is managed by one JSON file that is loaded by Runtime andincludes other required JSON files.
Each item inside configuration file is composed of:v id - a unique id of the widget.v module - the module name the widget.v container - an optional container of the widget.v regions - an optional list of regions if the widget is a container.v parameters - optional parameters for the widget.
114 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Runtime library:
The Runtime library enables the API to dynamically manipulate UI configurations.
The commands for the Runtime Library are:
add: add new widget(s)Parameters:v widget: a widget configuration or an array of widget configurations, a
widget instance or array of widget instances.v container: optional, the ID of the container where the widgets are
added.v region: optional, the name of region of the container.
Returns: a dojo/Deferred object.
remove: remove widgetParameter:v id: The ID of the widget to be removed.
Returns: the array of the specified widget and its children that areremoved. The user can reattach them to another container or region bycalling an add command, or totally remove the widgets.
get: get widget instanceParameter:v id: the ID of the widget.
Returns: the widget instance of the specified ID.
load: load widget from fileParameters:v url: the address of the configuration file.
Returns:v dojo/Deferred object.
Note:
v The Runtime library also maintains a global registry of widgets, the contents ofthe registry changes when user calls an add, remove, or load command.
v The Runtime library can be used in both bootstrap and custom widgets.
Figure 7. Bootstrap and custom widgets
Chapter 4. Using a standard configuration 115
Ready-to-use widgets:
Ready-to-use widgets are widgets which can be used directly.
There are several types of widgets listed:v Container widgets
Dojo and IDX container widgets are available to use. The following list containsthe most common container. For other IDX container, please refer to IDXdocumentation.
v Reusable functional widgets: IFE provided widgets for a specific functionality:– Filter– Preview Card– Map– Data Layer– Logical Map– List– List Container– LineChart– BarChart– HeaderButton– Timer
v Behavior widgets– Property Binding Widgets. Property binding depends on the mechanism of
getting, setting, and watching for property changes, we leverage dojo/Statefuland dijit/_WidgetBase to provide this mechanism. For further informationrefer to Stateful and WidgetBase in the Dojo Toolkit Reference Guide.The example shows the binding from the checked property of countryFiltertofilterSelected property of countryLayer. When user checks the checkbox,countryLayer is notified: the _filterSelectedSetter method of countryLayerwill be called to execute the corresponding actions:
Figure 8. The filterSelected method
116 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
– Special Usage for Binding WidgetbindOnlyIfUnequal: only notify the target if the old value is not equal to newvalue.
convertor and func: function of injected convertor will be called before settingthe value to the target. The functions give a conversion between differentformats.
Figure 9. Execute action
Figure 10. Notifies the target if the two values do not agree
Chapter 4. Using a standard configuration 117
v Data Model widgets– Model
The Data Model widget wraps the service created by the service framework.Two parameters should be specified for it:target: The URL address of the service.idProperty: The ID property of the response value.
The Data Model widget provides two properties for binding:criteria: the filter criteria.store: the dojo store that provides access to data that is applied to the filtercriteria, where filter1 is the filter widget which provide filter criteria, andlayer1 is the map layer widget that consumes the dojo store:
– ModelSelector
Figure 11. Convertor and function
Figure 12. ID property of the response value
Figure 13. Provides access to data
118 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
The ModelSelector widget is used to dynamically determine the model at theruntime. Its parameter is models that lists each key associated with eachrespective model. The following figure is an example:
ModelSelector widget provides two properties available for binding:selector: the dojo object consists of a key and filter criteria.store: the dojo store that provides access to data that is applied according tothe selector. In the example, the selection in the measurement list triggers thechange of reading list.
Reusable widgets:
Widgets are provided that can be modified to the needs of the user.
The parameters for each of the widgets are set by the user, the properties set howthe widget displays in the user interface.
Filter widget:
The filter widget is used to organize the filter criteria for the result of IFE RESTservice.
The widget is made up of a check box and an additional dialog box.
ifef.widget.filter.Filter
label:
String, shows as the label for the check box, e.g. Name.
enabled:
Boolean, specifies whether the criteria is enabled or not.
searchFields:
An array, describes the search fields in the more dialog filter:
Figure 14. The Models parameter with associated keys
Figure 15. Provides access applied according to the selector
Chapter 4. Using a standard configuration 119
v name: String, the name of the field.v type: String, the type of field. Supports three string types: string, number,
date.v label: String, label of the field to show in the more dialog boxv regExp: String, regular expression that validates the user input value.
Available only when the type is string and ‘options’ is not defined.
options:An array, predefined values that the user can select:v label: the label shows from a drop-down list.v value: predefined values
The properties
The properties are:
criteria:
An object that describes filter criteria. The property is changed when the usereither clicks a check box or the More Filter dialog box is changed.
Example{
"id":"filter1","module":"ifef/widget/filter/Filter","container":"group1","properties":["criteria"],"parameters": {
"label": "Filter 1","enabled":true,"logistic":"and","searchFields":[
{"name":"name", "type":"string","label":"Name", "regExp":"([A-Za-z0-9][A-Za-z0-9-_]*)"},
{ "name":"createTime","type":"date", "label":"Create Time"},{"name":"updateTime","type":"dateTime", "label":"Update Time"},{"name":"isActive","type":"boolean", "label":"Active"},{
"name":"status","label":"Status", "type":"string", "multiple":true,"options":[{"label":"Critical","value":"1"},{"label":"Warning", "value":"2"},{"label":"Ok", "value":"3"},{ "label":"NoScore", "value":"4" }]}
]}}
PreviewCard widget:
The PreviewCard is a temporary card that shows the details panel for an asset,with the ability to select a More Details dialog box and an More Actions menu.
The user can select an asset from the map, then preview the details on a previewcard with the information of asset.
ifef.widget.previewcard.PreviewCard
titleProperty:
120 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
String, the name of property in the data object. The property value shows asthe title of preview card.
position:
A String or Array that specifies the position of the preview card. If it is astring, then the string content is the property name Position in the data object.The property name Position is defined by an array of two numbers in the dataobject or a domNode. If it is an array with two numbers, the preview cardshows in the fixed position. The first number of array specify x value and thesecond number specify y value of current page.
properties:
An array that specifies the properties that show on the preview card contentpanel or more details dialog box.v name: String, the property name.v label: String, label of property that shows on content panel.v isKey: Boolean, if true this property shows on content panel, if false the
property shows on the More details dialog box.v index: Numeric, if an index is specified, shows the indexed order.v render: Object, defines the rules to render the property value:
– numberFormatOptions: Object, shows the options to format a number asa string. Refer to the dojo/number document.
– dateFormatOptions: Object, shows the options to format a date as astring. Refer to the dojo/date/locale document.
v templates: Array, defines the conditions and template strings to renderproperty values.– condition: String, a condition returns either a true or false status. Any
property in data can be referenced as a condition, for example: STATUS=1– content: String, an html segment template that contains variables.– variables: Object, key or value pairs used to replace the variables in the
content.
moreActions:Array, shows the More actions menuv label: String, shows the name of the menu item.v children: Array, defines the sub-menu items.v func: Function, invoke when you click the menu item. Available when
sub-menu items are not specified.v options: Object, used by the ‘func’ function.
The properties
The properties are:
data:A key or value object, when the data is set the review card is filled by the dataobject, and shows.
Example
The example shows the use of a preview card.
Chapter 4. Using a standard configuration 121
{"id":"overheadlineMapPreviewCard","module":"ifef/widget/previewcard/PreviewCard","properties":["data"],"parameters": {
"titleProperty": "NAME","position": "_position","properties": [
{"label":"@{dno_nls.Asset_ID}", "name":"ASSET_ID", "isKey":true},{"label":"@{dno_nls.Serial_Number}","name":"SERIAL_NUMBER", "isKey":true},{"label":"@{dno_nls.NAME}","name":"NAME", "isKey": true},{"label":"@{dno_nls.Description}","name":"DESCRIPTION", "isKey":true},{
"label":"@{dno_nls.STATUS}","name":"STATUS","isKey": true,
"render":{"templates": [
{condition":"STATUS==0","content":"<span style=’background-color:green’>${Acceptable}</span>","variables":{"Acceptable":"@{dno_nls.Acceptable}"}
},{"condition":"STATUS==1","content":"<span style=’background-color:orange’>${Caution}</span>","variables":{"Caution":"@{dno_nls.Caution}"}
}]}},
{"label":"@{dno_nls.Location}","name":"LOCATION"}],"moreActions":[ { "label":"@{nls.HighlightOnMap}","func":"@{highlightOnMap.highlightOnMap}"} ]}
}
Map widget:
The administrator can configure the map controls that show on map for the user.
The administrator can what zoom and positing controls show on a map for theuser. The administrator can also configure multiple base layers with the controlparameters and attributes for each base layer.
ifef.widget.Map
The parameters for the mapwidget are:
controls:
The administrator can configure which map controls show on a map.v type: Possible values are "ol.control.Zoom", "ol.control.ZoomSlider",
"ol.control.FullScreen"," ol.control.MousePosition", ol.control.OverviewMap,"ol.control.Rotate", "ol.control.ScaleLine"
v parameters: each parameter has a shows a different type of mapping. See thetype and parameters mapping table bellow:
122 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Table 15. Settings for the control parameter
Type Parameters Description
ol.control.Zoom zoomInLabel: Text label usedfor the zoom in button.Default is +.
zoomOutLabel: Text label touse for the zoom out button.Default is -
zoomInTipLabel: Text label touse for the button tip.Default is Zoom in.zoomOutTipLabel: Text labelto use for the button tip.Default is Zoom out.
A control with 2 buttons, onefor zoom in and one forzoom out. This control is oneof the default controls of amap. default is show.
ol.control.ZoomSlider: nul A slider type of control forzooming in and out.
ol.control.FullScreen: label: Text label to use for thebutton. The default is anarrow.
tipLabel: Text label for thebutton tip. Default is Togglefull-screen.
ol.control.MousePosition: Acontrol to show the 2Dcoordinates of the mousecursor.
A button that when clickedfills the screen with the map.When in full screen mode, aclose button shows to exitfull screen mode.
ol.control.OverviewMap: collapsed: Whether thecontrol should start collapsedor expanded. Default to true.
collapseLabel: Text label touse for the expandedoverviewmap button. Defaultis «.
collapsible:Whether thecontrol can be collapsed ornot. Default to true.
label:Text label to use for thecollapsed overviewmapbutton. Default is ».
layers:Layers for theoverview map. tipLabel:Textlabel to use for the buttontip. Default is Overview map
Create a new control with amap acting as an overviewmap for an other definedmap
view
The administrator can configure the view portion of the map.v center: An array of numbers representing an xy coordinate [pointX, pointY].
This is the initial center for the view. The coordinate system for the center isEPSG:4326
Chapter 4. Using a standard configuration 123
v zoom: Only used if the resolution is not defined. The zoom level is used tocalculate the initial resolution for the view. The initial resolution isdetermined using the ol.View#constrainResolution method.
v extent: An array of numbers representing an extent: [minx, miny, maxx,maxy]. The extent constrains the center, the center cannot be set outside theextent. The default is undefined. The coordinate system for the extent isEPSG:4326.
v maxZoom: The maximum zoom level used to determine the resolutionconstraint. It is used together with minZoom (or maxResolution) andzoomFactor. Th default is 28.
Note: If minResolution is provided, it has precedence over maxZoom.v minZoom:The minimum zoom level used to determine the resolution
constraint. It is used together with maxZoom (or minResolution) andzoomFactor. Default is 0. Note that if maxResolution is also provided, it isgiven precedence over minZoom.
layers
The administrator can configure multiple base map layers.v visible: boolean type, the default is true.v title: The title of the layer, you can view it on the map control.v type: The possible values are ol.source.OSM, ol.source.MapQuest,
ol.source.stamen, ol.source.xyz, ol.source.BingMaps,ol.source.TileArcGISRest, ol.source.TileJSON, ol.source.TileWMS. Differentlayer types use different parameters.
v parameters: The object type, the parameters it is different according to thetype you select. Parameters is the same with openlayer3. See the type andparameters mapping table bellow.
Table 16. Type and parameter mapping
Type Description
ol.source.OSM Optional.. A URL template that includes {x},{y} or {-y}, and {z} placeholders. The defaultis http://{a-c}.tile.openstreetmap.org/{z}/{x}/{y}.png.
ol.source.
MapQuest
Layer. The possible values are: osm, sat, andhyb.
A URL template that includes {x}, {y} or {-y},and {z} placeholders.
A value for Layer is mandatory, the URL isoptional.
ol.source.stamen Layer. The possible values are watercolor,terrain-labels.
A URL template that includes {x}, {y} or {-y},and {z} placeholders.
A value for Layer is mandatory, the URL isoptional.
124 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Table 16. Type and parameter mapping (continued)
Type Description
ol.source.
BingMaps
The Bing map key is mandatory, an examplekey is:
Ak-dzM4wZjSqTlzveKz5u0d4IQ4bRz
VI309GxmkgSVr1ewS6iPSrOvOKhA-CJlm3
The options for the imagerySet: are: Road,Aerial, AerialWithLabels, collinsBart, andordnanceSurvey.
ol.source.xyz A URL template that includes {x}, {y} or {-y},and {z} placeholders.
ol.source.
TileArcGISRest
Call for an ArcGIS REST service URL for aMap Service or Image Service.
The url should include either /MapServer or/ImageServer.
ol.source.
TileJSON
The URL link to the address to the TileJSONfile.
ol.source.
TileWMS
WMS service URL.
serverType: The available server types are:'carmentaserver, geoserver, mapserver, qgis.
params: WMS request parameters.
A LAYERS parameter is mandatory.
STYLES is ' ' by default.
VERSION is 1.3.0 by default.
WIDTH, HEIGHT, BBOX and CRS (SRS forWMS version < 1.3.0) are set dynamically.
ol.source.WMTS url: A URL for the service. For KVPencoding, it is a normal URL. For theRESTful request encoding, this is a URLtemplate of the pattern {?-?}, for example:subdomain{a-f}.domain.com.
attributions:Attributions.
layer: Layer name as advertised in theWMTS capabilities. Mandatory.
matrixSet: Matrix set. Mandatory.
format: Image format. Default is image/jpeg.
projection: Projection. tileGrid: Tile grid. Setthe grid pattern for sources accessing WMTStiled-image servers.
Example
The example shows the use of a map widget.
Chapter 4. Using a standard configuration 125
{"id": "map","module": "ifef/widget/Map","container": "mapTab",
"parameters": {"controls":[
{"type":"ol.control.Zoom","parameters":{
"zoomInTipLabel":"@{nls.Map_Zoom_In_Tip_Label}","zoomOutTipLabel":"@{nls.Map_Zoom_Out_Tip_Label}"
}},{
"type":"ol.control.ZoomSlider","parameters":{}
},{
"type":"ol.control.ScaleLine","parameters":{
"minWidth":"64","units":"metric"
}},{
"type":"ol.control.FullScreen","parameters":{
"label":"\u2194","tipLabel":"@{nls.Map_Full_Screen_Tip_Label}"
}},{
"type":"ol.control.Rotate","parameters":{
"autoHide":false,"tipLabel":"@{nls.Map_Rotate_Tip_Label}"
}},{
"type":"ol.control.OverviewMap","parameters":{
"tipLabel":"@{nls.Map_Overview_Tip_Label}"}
},{
"type":"ol.control.MousePosition","parameters":{
"projection": "EPSG:4326"}
}],
"layers":[{
"type":"ol.source.OSM","visible":false,"title":"@{nls.Map_Layer_Title_OSM}","parameters":{}
},{
"type":"ol.source.MapQuest","visible":false,"title":"@{nls.Map_Layer_Title_MapQuest_Sat}","parameters":{
"layer": "sat"}
},{
126 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
"type":"ol.source.Stamen","visible":false,"title":"@{nls.Map_Layer_Title_Stamen}","parameters":{
"layer": "watercolor"}
},{
"type":"ol.source.XYZ","visible":true,"title":"@{nls.Map_Layer_Title_XYZ_ArcgisOnline}","parameters":{
"url":"http://server.arcgisonline.com/ArcGIS/rest/ services/World_Topo_Map/MapServer/tile/{z}/{y}/{x}"}
},{
"type":"ol.source.BingMaps","visible":false,"title":"@{nls.Map_Layer_Title_BingMaps}","parameters":{
"key":"Ak-dzM4wZjSqTlzveKz5u0d4IQ4bRzVI309GxmkgSVr1ewS6iPSrOvOKhA-CJlm3",
"imagerySet": "Road"}
},{
"type":"ol.source.TileArcGISRest","visible":false,"title":"@{nls.Map_Layer_Title_TileArcGISRest}","parameters":{
"url":"https://services.arcgisonline.com/arcgis/rest/services/ESRI_Imagery_World_2D/MapServer"
}},{
"type":"ol.source.TileJSON","visible":false,"title":"@{nls.Map_Layer_Title_TileJSON}","parameters":{
"url":"http://api.tiles.mapbox.com/v3/mapbox.geography-class.jsonp"
}},{
"type":"ol.source.TileWMS","visible":false,"title":"@{nls.Map_Layer_Title_TileWMS}","parameters":{
"url":"http://demo.boundlessgeo.com/geoserver/wms","params": {"LAYERS": "ne:ne"}
}},{
"type":"ol.source.WMTS","visible":false,"title":"@{nls.Map_Layer_Title_WMTS}","parameters":{
"url":"http://services.arcgisonline.com/arcgis/rest/services/Demographics/USA_Population_Density/MapServer/WMTS/",
"layer": "0","matrixSet": "EPSG:3857","format": "image/png","projection":"EPSG:3857","style":"default","wrapX": "true","tileGrid":{
Chapter 4. Using a standard configuration 127
"type":"ol.tilegrid.WMTS","parameters":{"origin":[-20037508.342789244,
20037508.342789244],"resolutions":[156543.03392804097,
78271.51696402048,39135.75848201024,19567.87924100512,9783.93962050256,4891.96981025128,2445.98490512564,1222.99245256282,611.49622628141,305.748113140705,152.8740565703525,76.43702828517625,38.21851414258813,19.109257071294063],
"matrixIds":[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,11, 12, 13]
}}
}}],
"view": {"zoom":5,"maxZoom": "4","center": [104.31,28.72],"extent":[-180,-80,180,80]"minZoom": "8"
}}
}
DataLayer widget:
The Datalayer widget is used to show a data layer on the map.
The administrator can configure additional data layers. The data can come from aREST service or another data file in standard format. The formats that are currentlysupported are: GeoJSON, TopoJSON, EsriJSON, IGC, Polyline, WKT, GML, GPX,KML, OSMXML.
You can specify the data type in the Datalayer widget with the formatTypeparameter.
You can specify the data link in the ifef/model/Model widget by the targetparameter.
You can configure the style for each data layer and set a condition for each style.Each data layer can be set for a custom range, fill, stroke and shape. You can alsoset text styles for each layer. The user can set the order of the layers.
Container
The container for the DataLayer must be a map.
Properties
StoreYou can retrieve stored data.
128 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
criteria
An object that describes the filter criteria, this property is changed when theuser click selects a check box or changes the more filter. If you bind thisproperty with a model and the model is bound to a filter, you can use thisproperties to control how a layer is displayed or not.
Selected
Indicates that a user has selected an asset in the data layer. An asset can alsobe selected by the settings the selected properties value.
Parameters for ifef.widget.DataLayer
map:The map ID that the data layer is dependent on. For example: @{map}.
index:The order of the data layers. The greater the value or the layer the higher thelayer.
formatType:
If data comes from a REST service, then this parameter setting is optional. Theformats that are supported are: GeoJSON, TopoJSON, EsriJSON, IGC, Polyline,WKT, GML, GPX, KML, and OSMXML. You can make a selection based onyour service type.
geometryName:The parameter is required when the data is from the REST service andgeometry field Name is not LOCATION. Default is “LOCATION”.
Styles:The user can configure multiple styles.v Condition - you can set the condition that uses the style.v Style:
– fill: Set the fill style for vector features.type: "ol.style.Fill"parameters: same as the openlayer "ol.style.Fill" class API.color: Colors can be defined as strings as rgb (r,g,b) or rgba (r,g,b,a)formats, or in hex #rrggbb or #rgb format. The color names, 'red', 'blue' or'green', can be used with the Canvas renderer. Default null; if null, theCanvas/renderer default black is used.
– stroke: Set the stroke style for vector features.type: "ol.style.Stroke"parameters: same as the openlayer "ol.style.Stroke" class API.
Table 17. Stroke parameters
Parameter Description
color: Colors can be defined as strings as rgb(r,g,b) or rgba (r,g,b,a) formats, or in hex#rrggbb or #rgb format. The color names,'red', 'blue' or 'green', can be used with theCanvas renderer. Default null; if null, theCanvas/renderer default black is used.
lineCap Line cap style: butt, round, or square.Default is round.
Chapter 4. Using a standard configuration 129
Table 17. Stroke parameters (continued)
Parameter Description
lineJoin: Line join style: bevel, round, or miter.Default is round.
lineDash: Line dash pattern. Default is undefined (nodash).
miterLimit: Miter limit. Default is 10.
width: Line width.
– image: - A circle, icon, or a RegularShape. See the openlayer API(http://openlayers.org/en/v3.14.2/apidoc/) for more information.type: "ol.style.Circle", "ol.style.Icon" , "ol.style.RegularShape",parameters: same as the openlayer's "ol.style.Circle","ol.style.Icon","ol.style.RegularShape" APIif the type is ol.style.Circle:
Table 18. Style is ol.style.Circle
Parameter Description
fill: Set fill style for vector features. (Object)Refer to openlayer API for moreinformation.
stroke: Set stroke style for vector features. (Object)Refer to the openlayer API for moreinformation.
radius: Radius of the circle.
if the type is ol.style.Icon:
Table 19. Style is ol.style.Icon
Parameter Description
fill: Set fill style for vector features. (Object)Refer to openlayer API for more information
stroke: Set stroke style for vector features. (Object)
anchor: Anchor. Default value is [0.5, 0.5] (iconcenter).
anchorOrigin: Origin of the anchor: bottom-left,bottom-right, top-left or top-right. Default istop-left.
offset: Offset, which, together with the size and theoffset origin, define the sub-rectangle to usefrom the original icon image. Default valueis [0, 0].
offsetOrigin: Origin of the offset: bottom-left,bottom-right, top-left or top-right. Default istop-left.
opacity: Sets the opacity of the icon. Default is 1.
scale: Scale
rotation: Sets the rotation in radians (positive rotationclockwise). Default is 0.
src: The URL of the image source.
130 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Table 19. Style is ol.style.Icon (continued)
Parameter Description
size: Icon size in pixel. Can be used together withoffset to define the sub-rectangle to use fromthe origin (sprite) icon image.
If the type is ol.style.IRegularShape: Then the resulting shape is a regularpolygon when radius is provided, or a star when radius1 and radius2 areprovided.
Table 20. Style is ol.style.IRegularShape
Parameter Description
fill: Set fill style for vector features.(Object)
stroke: Set stroke style for vector features. (Object)
points: Number of points for stars and regularpolygons. In the case of a polygon, thenumber of points is the number of sides.
radius: The circumradius of a regular polygon.
radius1: The inner radius of a star.
radius2: The outer radius of a star.
angle: The angle from the vertical of a shape inradians. A value of 0 will have one of theshape's point facing up. Default value is 0.
rotation: The angle of rotation in radians (positiverotation clockwise). Default is 0.
– text: - Sets the text style for vector features.if the type is "ol.style.Text"
Table 21. Style is ol.style.Text
Parameter Description
font: The font used as a CSS font value. .
offsetX: The horizontal text offset in pixels. Apositive value shifts the text to the right.Default is 0.
offsetY: The vertical text offset in pixels. A positiveshifts the text down. Default is 0.
scale: Scale
rotation: The angle of rotation in radians (positiverotation clockwise). Default is 0.
text: The text content.
textAlign: The text alignment. The values are: 'left','right', 'center', 'end' and 'start'. The defaultis 'start'..
textBaseline: Text base line. Possible values: 'bottom','top', 'middle', 'alphabetic', 'hanging','ideographic'. Default is 'alphabetic'.
fill: Set fill style for vector features. (Object).
stroke: The stroke style for vector features.
Chapter 4. Using a standard configuration 131
Example{"id": "overheadlineLayer",
"module": "ifef/widget/map/DataLayer","container": "map","properties": ["store", "creteria","selected"],"parameters":{
"index":2,"map":"@{map}","styles":[{
"condition": "STATUS==0","style": {
"stroke":{"type":"ol.style.Stroke",
"parameters": {"color": "#699037","width": 2
}}
}},{
"condition": "STATUS==1","style": {
"stroke":{"type":"ol.style.Stroke",
"parameters": {"color": "#FDBA1A","width": 2
}}
}},{
"condition": "STATUS==2","style": {
"stroke":{"type":"ol.style.Stroke",
"parameters": {"color": "#C32E14","width": 2
}}
}}]
}},{"id": "overheadlineModel",
"module": "ifef/model/Model","properties": ["store"],"parameters":{
"storeModule": "ifef/model/Store","target":"/ibm/ife/sample/dno/api/overheadline","idProperty": "ASSET_ID"
}},{"id": "bind1",
"module":"ifef/behavior/Bind","parameters":{
"bindings":[{"source": "@{overheadlineModel}","sourceProp": "store","target": "@{overheadlineLayer}","targetProp": "store"
132 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
}]
}},
Logical map widget:
The logical map shows the relationship between assets and between an asset and atype of measurement.
The user can query the logical map via a keyword of the instance. The logical mapcan be extended to show related items, and the user can analyze the impactbetween instances.
The framework of a logical map is in three parts:1. The logical map and its services. The data is queried from the model server via
services and the model server interface.2. The crawler and model server, The crawler generates the OWL file based on the
configuration.3. The user-defined part. This includes the data model and its service, and the
configuration for the crawler to generate the OWL file.
Here is sample data that is generated by the crawler. In this example the OWLdefines 2 kinds of instance types:v substation and asset.v Current_Risk a measurement type.
The OWL also defines two relationships:v Asset.hasMeasurement references the measurement belonging to the asset.v Measurement.associatedToAsset references the asset belonging to the
measurement.
The two relationships are an inverse of each other, therefore in the rdf file, onlyone relationship needs to be defined. After execution of inference.sh from theJena installation path the other relationship is automatically generated.<rdf:Description rdf:about="http://ontology#substation">
<rdf:type rdf:resource="http://www.w3.org/2002/07//owl#class"/><rdfs:lable xml:lang="en">Substation</rdfs:label><rdfs:subClassOf rdf:resource="http://ontology#asset"/>
</red:Description>
<rdf:Description rdf:about="http://ontology#Asset.hasMeasurement"><rdf:type rdf:resource="http://www.w3.org/2002/07/owl#ObjectProperty"/><rdfs:label xml:lang="en">Asset.hasMeasurement</rdfs#label><owl:inverseOf rdf:resource="http://ontology#Measurement.associatedToAsset"><rdfs:subClassOf rdf:resource="http://ontology#Relationship"/>
</rdf:Description>
<rdf:Description rdf:about="http://ontology#Current_Risk"><rdf:type rdf:resource="http://www.w3.org/2002/07/owl#Class"/><rdfs:label xml:lang="en">Current_Risk</rdfs#label><rdfs:subClassOf rdf:resource="http://ontology#Measurement"/><rdfs:comment>Measurement</rdfs:comment>
</rdf:Description>
<rdf:Description rdf:about="http://ontology#Measurement.associationToAsset"><rdf:type rdf:resource="http://www.w3.org/2002/07/owl#ObjectProperty"/>
Chapter 4. Using a standard configuration 133
<rdfs:label xml:lang="en">Measurement.associationToAsset</rdfs#label><owl:inverseOf rdf:resource="http://ontology#Asset.hasMeasurement"><rdfs:subClassOf rdf:resource="http://ontology#Relationship"/>
</rdf:Description>
The example rdf file defines that Current_Risk_944 is a measurementMeasurement.associatedToAsset of substation_2596. After execution of theinference.sh then substation_2596 has the relationship Asset.hasMeasurement andreferences Current_Risk_944.
The rdf file defines two instances:v substation_2596v Current_Risk_944
These two instance have the relationship Measurement.associatedToAsset. TheCurrent_Risk_944 is the measurement of the asset substation_2596.
Note: The rdf:resource should refer to an existing id defined in rdf:ID, e.g.rdf:resource of Current_Risk_944 refers to the rdf:ID of substation_2596.<otl:substation rdf:ID="substation_2596">
<otl:Object.name>Anytown_North</otl:Object.name><rdfs:label xml:lang="en">Anytown_North</rdfs:label><otl:Object.item.Url>ibm/ife/sample/dno/api/substation/2596</otl:Object.item.Url>
</otl:substation>
<otl:Current_Risk rdf:ID="Current_Risk_944"><otl:Object.name>Current Risk</otl:Object.name><rdfs:label xml:lang="en">Current Risk</rdfs:label><otl:Object_description>Current Risk</otl:Object.description><otl:Object.item.Url>ibm/ife/sample/dno/api/measurement/944</otl:Object.item.Url><otl:Measurement.accosicatedToAsset rdf:resource="#substation_2596"/>
</otl:Current_Risk>
The example rdf file has the crawler configuration necessary to generate the OWLand RDF files as follows:
Figure 16. Crawler configuration ID:substation
134 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Note: Explanatory notes:v The red rectangle ID:"substation" should be the same value as
itermsUrl.asset_type, otherwise the rdf:resource will refer to a none existingrdf:ID. The result in the logical map will not be correct.
v The values for id, value, subClassOf, owl_template, and rdf_template can all beedited.
v The value for itemsUrl is the service URL and is mandatory. It represents theresult returned from the service.
v The label is used to search and is mandatory.v The owl_template is the content of this type in the owl file.v The rdf_template is the content of a instance of this type in the rdf file.v The variable @{...} is changed to a real value.
The Service.properties file at the location: /opt/IBM/energy/crawler defines someof the properties used in the crawler.
Table 22. Type and parameter mapping
Property Description
serviceBaseURL=http://ip:port The service URL.
serviceUser=sysadmin Service username.
servicePassword=passw0rd Service password.
CLIENT_READ_TIMEOUT=0 Read_timeout.
CLIENT_CONNECT_TIMEOUT=0 Connect_timeout.
owlfile=d:/newfile.owl New OWL file.
Figure 17. Crawler configuration ID:Current_Risk
Figure 18. Crawler configuration ID:Measurement_associatedToAsset
Chapter 4. Using a standard configuration 135
Table 22. Type and parameter mapping (continued)
Property Description
rdffile=d:/newrdffile.rdf New rdf file.
ifef.widget.LogicalMap Property
The property for the logical map is:
layoutData:
The data that is used to draw in the logical map.
ifef.widget.LogicalMap Parameters
Th parameters for th logical map are:
keyFields:
Used to identify a record, json object, coming from a call of the model.
namespace:
The namespace of the data as an OWL/rdf file that is generated by thecrawler. The namespace is defined in the configuration file of the crawler.
knnDepth:
The depth for the KNN service, K-NearestNeighbor.
impactAnalysisDepth:
The depth of the impact analysis service. It can be temporarily changed by theconfiguration dialog of the logical map.
instCfg:
The configuration for the instance. It can be temporarily changed by theconfiguration dialog of the logical map. The user can add or delete items toadd or remove one kind of instance. The instType of newly added item heremust be generated in OWL files and already imported to model server.
For example: Add one instance type:{"instType":"undergroundline", "canBeOnMap":true, "checked":false, "label":"Underground
Line", "instStyle":"/ibm/ife/logicalmap/test/logicalmap/icon/undergroundline.png"}
The instance type is defined in the configuration file of crawler:
Figure 19. Configuration file of the crawler
136 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
v canBeOnMap - the instance can be displayed on map. If true, then there mustbe a “Highlight On Map” action for this instance.
v checked - Determines if this instance type is used to filter the search result.v instStyle - The icon used for this instance typev label - The text display in configuration dialog.
relationshipCfg:
The configuration for the relationship. It can be temporarily changed by theconfiguration dialog of logical map. The user can add or delete item here toadd or remove one kind of relationship. The relationship must be generated inthe OWL file and already be imported to the model server.
For example: Add one relationship.{"relationship":"http://ontology#Asset.NewRelationship", "checked":true, "label":"New Relationship", "relationshipStyle":"#ffa500"}
v relationship - the relationship defined in the OWL file.v checked - determines if this relationship is used to filter the search result.v relationsihpStyle - the color for this relationship. If the value is not in
range of ColorPalette, then black(#000000) is used.v label - the text displayed in the configuration dialog.
An sample configuration{
"id": "logicalMap","module": "lmap/widget/logicalmap/LogicalMap","container": "logicalMapTab","properties":["layoutData"],"parameters": {
"keyFields":["ASSET_TYPE","ASSET_ID"],"namespace":"http://ontology#","knnDepth":1,"impactAnalysisDepth":6,"instCfg":[{"instType":"substation","canBeOnMap":true, "checked":true,
"label":"@{nls.CfgDlgInstSubstation}","instStyle":"/ibm/ife/logicalmap/test/logicalmap/icon/substation.png"},
{"instType":"overheadline", "canBeOnMap":true, "checked":true,"label":"@{nls.CfgDlgInstOverheadline}","instStyle":"/ibm/ife/logicalmap/test/logicalmap/icon/overheadline.png"},
{"instType":"wind_farm", "canBeOnMap":true, "checked":false,"label":"@{nls.CfgDlgInstWindFarm}","instStyle":"/ibm/ife/logicalmap/test/logicalmap/icon/wind_farm.png"},
{"instType":"Measurement", "canBeOnMap":false, "checked":false,"label":"@{nls.CfgDlgInstMeasurement}","instStyle":"/ibm/ife/logicalmap/test/logicalmap/icon/measurement.png"},
{"instType":"Default", "instStyle":"/ibm/ife/logicalmap/test/logicalmap/icon/measurement.png"}],
"relationshipCfg":[{"relationship":"http://ontology#Asset.Connects", "checked":true, "label":"@{nls.CfgDlgRealConnects}","relationshipStyle":"#7fff00"}, {"relationship":"http://ontology#Asset.Connected","checked":true, "label":"@{nls.CfgDlgRealConnected}", "relationshipStyle":"#ffa500"},
{"relationship":"http://ontology#Asset.Contains","checked":false, "label":"@{nls.CfgDlgRealContains}", "relationshipStyle":"#6495ed"},
{"relationship":"http://ontology#Asset.Contained","checked":false, "label":"@{nls.CfgDlgRealContained}", "relationshipStyle":"#7b68ee"},
{"relationship":"http://ontology#Asset.hasMeasurement","checked":true, "label":"@{nls.CfgDlgRealHasMeasurement}", "relationshipStyle":"#f08080"},
{"relationship":"http://ontology#Measurement.associatedToAsset","checked":true, "label":"@{nls.CfgDlgRealAssociatedToAsset}","relationshipStyle":"#ff4500"},
{"relationship":"http://ontology#Asset.hasPrimaryMeasurement","checked":true, "label":"@{nls.CfgDlgRealHasPrimaryMeasurement}", "relationshipStyle":"#b22222"},
Chapter 4. Using a standard configuration 137
{"relationship":"http://ontology#Measurement.Is_Primary_Measurement_Of","checked":true, "label":"@{nls.CfgDlgRealIsPrimaryMeasurementOf}", "relationshipStyle":"#ffd700"},
{"relationship":"http://www.w3.org/2000/01/rdf-schema#subClassOf","checked":true, "label":"@{nls.CfgDlgRealSubClassOf}","relationshipStyle":"#ffe4c4"},
{"relationship":"http://www.w3.org/1999/02/22-rdf-syntax-ns#type","checked":true, "label":"@{nls.CfgDlgRealType}","relationshipStyle":"#da70d6"} ] }
}
Related configuration for the logical map
There are three other configurations to support the logical map:1. Logical map layouts - used to draw logical maps with different layouts.v Property -
rawLayoutData: the data used to draw the logical map.v Parameter -
The id of logical map.Configuration sample:{"id": "logicalMapLayouts","module": "lmap/behavior/LogicalMapLayouts","properties":["rawLayoutData"],"parameters": { "logicalMap":"@{logicalMap}" } }
2. Logical map previewcard helper - used as the helper class for more actions oflogical map previewcard.v Parameters:
– logicalMap: the ID of logical map.– highlightOnMap: the common highlight on the map support.Configuration sample:{
"id":"logicMapPreviewCardHelper","module":"lmap/widget/logicalmap/LogicMapPreviewCardHelper","parameters":{
"logicalMap":"@{logicalMap}","highlightOnmap":"@{highlightOnMap.highlightOnMap}"
}}
3. Logical map previewcard - Refer to “PreviewCard widget” on page 120 forinformation about the parameters.The property “NAME” is required to display the relationship or instanceinformation without an item URL, for example: Instance type:substation, in thepreviewcard. For example: {"label":"@{dno_nls.NAME}","name":"NAME","isKey": true}.A sample configuration is given:"id":"logicalMapPreviewCard",
"module": "ifef/widget/previewcard/PreviewCard","properties":["data"],"parameters": {
"titleProperty": "NAME","position": "_position","properties":[
{"label":"@{dno_nls.Measurement_ID}", "name":"MEASUREMENT_ID", "isKey": true},{"label":"@{dno_nls.Asset_ID}", "name":"ASSET_ID", "isKey": true},{"label":"@{dno_nls.FARM_ID}", "name":"FARM_ID", "isKey": true},{"label":"@{dno_nls.Measurement_Type}", "name":"MEASUREMENT_TYPE", "isKey": true},{"label":"@{dno_nls.ID}","name":"ID", "isKey": true}, {"label":"@{dno_nls.NAME}","name":"NAME", "isKey": true},
138 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
{"label":"@{dno_nls.Serial_Number}","name":"SERIAL_NUMBER", "isKey": true},{"label":"@{dno_nls.UNIT}","name":"UNIT", "isKey": true},{"label":"@{dno_nls.Description}","name":"DESCRIPTION", "isKey": true},{"label":"@{dno_nls.Create_Date}","name":"CREATE_DATE"},{"label":"@{dno_nls.Installation_Date}","name":"INSTALLATION_DATE"},{"label":"@{dno_nls.STATUS}",
"name":"STATUS","isKey": true,"render":{
"templates":[{
"condition":"STATUS==0","content":"<span
style=’background-color:green’>${Acceptable}</span>","variables":{
"Acceptable":"@{dno_nls.Acceptable}"}
},{
"condition":"STATUS==1","content":"<span
style=’background-color:orange’>${Caution}</span>","variables":{
"Caution":"@{dno_nls.Caution"}}
},{
"condition":"STATUS==2","content":"<span
style=’background-color:red’>${Critical}</span>","variables":{
"Critical":"@{dno_nls.Critical}"}
}]
}},{"label":"@{dno_nls.Location}","name":"LOCATION"},
]""moreActions":[
]}
}
List Widget:
The List widget is the wrapper for the idx gridx widget. It provides the capabilityfor a developer to create and configure list and column customizations.
ifef.widget.List Properties
store:
The data store that acts as the bridge to the REST service.
selected:
When a property is selected from a list, it is populated with the correspondingJSON object.
criteria:
A JSON object that describes the filter criteria. This property will be populatedonly if the keyFields parameter is specified (see below) and is updated whenthe selected property is changed.
Chapter 4. Using a standard configuration 139
ifef.widget.List Parameters
list level:
v pageSize: The initial size of the page, the number of the items that will bedisplayed on the initial page. For example: "pageSize": 10 will show 10items on the initial page.
v paginationBar: the pagination for the list. The quantity of items that showon each page. A value of 150 will display the next 150 items on that pageand also on subsequent pages. The last value 0 displays all the items in thedata store.
v baseSort: The sort sequence for the columns, ascend or descend. Specifydescending as true or false to determine the sort order of the column.Example:"baseSort": [
{"attribute": "ASSET_ID","descending": true
},{
"attribute": "NAME","descending": true
}]
v keyFields: The fields used to generate the criteria and selectors based onthe selected row in the list.
column level:
v field: The column field. The field that matches the field in the store that isqueried from the database.
v name: The name for the column that will be displayed in the list. Forexample "name": "ASSET_STATUS"
Note:
The user can use the strings in the nls file to support globalization , forexample: "name": "@{dno_nls.STATUS}”.
v sortable: Determines if the column can be sorted or not, true or false.For example: "sortable": true, mean that the column can be sorted.
v width: the width of the column in pixels. For example: "width": "80px".v formatter: the format of the cell data for time or date.
– type: specify the two data type that you want to format , ‘number’ or‘date’.number
When number, you must also specify the parameter "places", this is thenumber of fixed significant digits without specifying the dot as aplacement. For example:"formatter":{
"type": "number","places":2
}
dateWhen date, you must also specify the parameter "formatLength". Theavailable values are: long, short, medium and full. For example:
140 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
"formatter":{
"type": "date","formatLength":"short"
}
v style: the style for the cells. The value for this style can be a function thatreturns a style string, or simply be a style string for this column. Forexample:"style" :"background-color:#EE3D96;color:red" or "style" :"@{statusFormatter.style}".
v decorator: the function to decorate the raw data.
Configuration example{
"id": "measurementList","module": "ifef/widget/list/List","container": "measurementPane","properties": ["store", "selected", "criteria", "selector"],"parameters":{
"selectorFields" : ["MEASUREMENT_TYPE"],"keyFields" : ["MEASUREMENT_ID"],"pageSize": 10,"paginationBar":[10,50,100,0],"baseSort": [
{"attribute": "STATUS","descending": false
},{
"attribute": "NAME","descending": true
}],
"column": [{
"name": "@{dno_nls.STATUS}","field": "STATUS","sortable" : true,"style" : "@{statusFormatter.style}","decorator" : "@{statusFormatter.decorator}"
},{
"name": "@{dno_nls.Measurement_ID}","field": "MEASUREMENT_ID","sortable" : true
},{
"name": "@{dno_nls.NAME}","field": "NAME","sortable" : true
},{
"name": "@{dno_nls.UNIT}","field": "UNIT","sortable" : false
}]
}}
Chapter 4. Using a standard configuration 141
List Container Widget:
The user can place one list directly in one page. However, where there are multiplelists that can change based on the selection made by the user, it is better to put allthe lists in one List Container.
In the List Container widget you can specify the container for the lists. This isconfigured in a widget containment JSON file.
ifef.widget.ListContainer Parameters
selectLabel:
The label used for the drop down list.
style:The cascading style sheet (CSS) used to define the display style.
Configuration sample{
"id": "listContainer","module": "ifef/widget/list/ListContainer","container": "listTab","parameters": {
"selectLabel":"@{dno_nls.Select_Item}","style": "width:
100%; height: 100%;"}
},{
"id": "overheadlineList","module": "ifef/widget/list/List","container": "listContainer",
"properties": ["store"],"parameters": {
"keyFields":["ASSET_TYPE", "ASSET_ID"],"title": "@{overheadline_filter.label}","pageSize": 100,"paginationBar":[100,150,200,1000,0],"baseSort": [
{"attribute": "STATUS","descending": true}],
"column": [{"name": "@{dno_nls.STATUS}","field": "STATUS"},{"name": "@{dno_nls.NAME}","field": "NAME","sortable" : true}
]}
}
Line Chart Widget:
The LineChart widget is used to show changes to a series of values over time.
142 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
The Line Chart can be enlarged or made smaller by zooming in or out, and thetime period can be changed by dragging the chart to show different time periods.The line chart is used to show changes of one measurement reading over time fora specified asset.
ifef.widget.LineChart Parameters
title:
String, the title of the chart.
chartWidth:
Number, specifies the width of the chart.
chartHeight:
Number, specifies the height of the chart.
series:
Array, describes the number of lines and name for the specified series.v displayName: String, the display name for the specified series.v property: String, The field name for each of the series of the Y axis data.
The field name must be a number.
X_property:
String, The field name for each time period used for the X axis. The field namemust be a timestamp or period.
X_title:
The display name for the X axis.
Y_title:
The display name for the Y axis.
The properties for the Line Chart widget
store:
The data for line chart should be bound to the property store of the LineChartinstance. This property changes when the user selects different measurementcriteria.
Configuration sample
The configuration sample shows two series of data for the displayName VALUE1 andVALUE2.{
"id": "readingLineChart","module": "ifef/widget/chart/LineChart","container": "readingLineChartTab","properties": ["store"],"parameters": {
"title": "@{dno_nls.Reading_Line_Chart}","chartWidth":450,"chartHeight":200,"series": [{
"displayName": "@{dno_nls.VALUE1}","property": "VALUE1"
},{"displayName": "@{dno_nls.VALUE2}","property": "VALUE2"
Chapter 4. Using a standard configuration 143
}],"X_property": "TIME","X_title": "@{dno_nls.TIME}","Y_title": "@{dno_nls.VALUE}"
}}
The data for the Line Chart should be provided as a JSON Array that must have afield that contains the timestamp value. The other fields which contain numbervalue can be shown as a series of lines.[{
"id": 1,"TIME": "2013-01-01 08:58:00","VALUE": 4
},{"id": 2,"TIME": "2014-01-01 08:59:00","VALUE": 4
},{"id": 3,"TIME": "2015-01-01 09:00:00","VALUE": 5
}]
Bar Chart widget:
The BarChart widget is used to show a group of related values that can begrouped as a hierarchical relationship.
As a time-series value, a bar chart widget can be grouped to show year, Month,Day, Hour, or Minute.
As a population series a bar chart can be grouped to show population by Country,State, City, Town, or Region.
You can click on the bar chart to drill up and drill down the hierarchical levels.
The example bar chart is used to show measurements readings for maximum,minimum and average values for a specified asset. The bar chart is grouped byYear, Month, Day, Hour and Minute.
ifef.widget.LineChart Parameters
title:String, the title of the chart.
chartWidth:
Number, specifies the width of the chart.
chartHeight:
Number, specifies the height of the chart.
legends:
Array, specifies the number of bars for each of the groups.v displayName: String, the display name for the specified series of bars.v property: String, The field name for each series of bars of Y axis data. The
field name must be a number.
X_property:
144 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
String, The field name for each time period used for the X axis. The field namemust be a number.
X_title:
The display name for the X axis.
defaultLevelIndex:
Number, specifies the level of the hierarchy that shows when the bar chartopens.
levels:
Array, describes the number of levels of the bar chart can be drilled down orup, and also the number of hierarchy levels of the data in the chart.v index: String, the index number of the current level.v X_title: String, The display name of the X axis.v modelSelector: Widget instance, specifies which model selector instance is
used for the current level. Model Selector is a type of REST store map thatprovides the specified store for the widget by a key. The following figure isan example of a model selector instance.
v params: Array, the fields that describe the hierarchy relationship of eachlevel.– displayName: String, the display name for this field that shows as the drill
up title.– property: String, specifies the field name of the data that is used to drill
down or up and filter the data for Y axis.– value: Number, shows the default value for this field when the current
level is the default level.
ifef.widget.BarChart Properties
store:
The data for the bar chart that should bound to the property “store” of the barinstance. This property changes when the user selects different measurementcriteria.
Configuration sample{
"id": "readingBarChart","module": "ifef/widget/chart/BarChart",
Figure 20. Model Selector instance for the current level of hierarchy
Chapter 4. Using a standard configuration 145
"container": "statisticsBarChartTab","properties": ["store","chartListColumns","chartListData"],"parameters":
{"title": "@{dno_nls.Reading_Bar_Chart}","chartWidth":
450, "chartHeight":200, "legends":[{
"displayName": "@{nls.Chart_Label_MAX}","property": "MAX"
},{"displayName": "@{nls.Chart_Label_MIN}","property": "MIN"
},{"displayName": "@{nls.Chart_Label_AVG}","property": "AVG"
}],"X_property": "TIME","Y_title": "@{dno_nls.VALUE}","defaultLevelIndex":0,"levels": [{
"index": "0","X_title": "@{nls.Chart_Label_YEAR}","modelSelector": "@{readingByYearSelector}","params": []
},{"index": "1","X_title": "@{nls.Chart_Label_MONTH}","modelSelector": "@{readingByMonthSelector}","params": [{
"displayName": "@{nls.Chart_Label_YEAR}","property": "YEAR","value": "2013"
}]},{
"index": "2","X_title": "@{nls.Chart_Label_DAY}","modelSelector": "@{readingByDaySelector}","params": [{
"displayName": "@{nls.Chart_Label_YEAR}","property": "YEAR","value": "2013"
},{"displayName": "@{nls.Chart_Label_MONTH}","property": "MONTH","value": "1"
}]},{
"index": "3","X_title": "@{nls.Chart_Label_HOUR}","modelSelector": "@{readingByHourSelector}","params": [{
"displayName": "@{nls.Chart_Label_YEAR}","property": "YEAR","value": "2013"
},{"displayName": "@{nls.Chart_Label_MONTH}","property": "MONTH","value": "1"
},{"displayName": "@{nls.Chart_Label_DAY}","property": "DAY","value": "1"
}]},{
"index": "4",
146 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
"X_title": "@{nls.Chart_Label_MINUTE}","modelSelector": "@{readingByMinuteSelector}","params": [{
"displayName": "@{nls.Chart_Label_YEAR}","property": "YEAR","value": "2013"
},{"displayName": "@{nls.Chart_Label_MONTH}","property": "MONTH","value": "1"
},{"displayName": "@{nls.Chart_Label_DAY}","property": "DAY","value": "1"
},{"displayName": "@{nls.Chart_Label_HOUR}","property": "HOUR","value": "1"
}]}]
}}
Data sample
The data samples show a time-series value for year as the top level and month andday as subsequent levels.
Figure 21. Hierarchy level: By Year
Chapter 4. Using a standard configuration 147
Figure 22. Hierarchy level: By Month
148 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Header Button Widget:
The Header Button widget provides the ability to show a pop-up dialog box thatcontains other widgets.
The Header Button is placed on the header bar.
ifef.widget.HeaderButton Parameters
label:
String, the label of the button.
icon:
The customized icon for the button to be shown for the label.
Figure 23. Hierarchy level: By Day
Chapter 4. Using a standard configuration 149
content:
The widget instance, specifies the widget that show in the pop-up dialog boxwhen opened.
Properties
alertcount:
The alertcount is bound to the button, and shows as a number to the right ofthe label.
Configuration sample
In the configuration example, the icon can be customized, and the content changedto show the widgets that need to be included.{
"id": "notificationButton","module": "ifef/widget/header/HeaderButton","container": "header","properties": ["alertcount"],"parameters":{
"label": "Notification","style": "float: right;","buttonType": "info","icon":
"http://findicons.com/icon/download/175313/notification_warning/16/png","displayMode": "iconAndLabel","content": "@{notificationContent}"
}}
Ready-to-use application template:
An application template is a set of preconfigured configuration widgets thatprovide the basis of an application for the user to build upon. The template givesthe user a start in building the application.
The REST service frameworkThis section introduces the mechanism and tasks to help the user to developcustomized services. The REST service framework programming model providesan extension mechanism that lets the user to develop their own service quickly.These customized services can be used by the custom user interface (UI extension)for existing data.
The extension mechanism is a declarative programming model that lets the user toquickly create custom services. The services are shown in REST style and supportgeneral large-scale data handling. For example: pagination, filter by expression,and sorting.
The Sample ApplicationThe aim of the sample application is to help teach new developers how toincrementally develop the user interface based on UI framework provided by IFE.
There are two parts to the sample application:v filter panel.v corresponding map view.
The filter panel is used to control the data that is displayed in the map view. Byenabling or disabling the filters, the map view changes accordingly.
150 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Creating a UI Web project:
About this task
You create a Dynamic Web Project called ife_demo_web.
Procedure
1. Start Eclipse.2. Right-click the project explorer and select Dynamic Web Project.3. In the Project Name field, type ife_demo_web.4. In the Target runtime field, select WebSphere Application Server V8.5
Liberty Profile.5. In the Dynamic web module version field, select 3.0.6. In the Configuration field, select Default configuration for WebSphere
Application Server V8.5 Liberty Profile.7. Click Next.8. In the Context root field, type ife_demo_web.9. In the Content directory field, type WebContent and enable the option:
Generate web.xml deployment descriptor.10. Click Finish.
Creating the main configuration and bootstrap files:
You need to create the bootstrap file and place it into the WebContent directory ofthe project and create the configuration files to include different parts of theconfiguration items.
About this task
Different from traditional UI development, the UI Framework can parse JSONformat configuration files dynamically at the runtime. The JSON formatconfiguration contains the widget creation, containment, and the dependencyrelationship. The bootstrap file acts as the startup for the runtime.
Procedure
1. Create the bootstrap file index.html and save it to the WebContent directory forthe project.
2. Create the configuration files to include the different configuration items, andsave each one to the WebContent directory of the project.v config.json the entry configuration file.v layout.json the page layout configuration.v map.json the map view configuration.v model.json the model configuration.v bind.json the widget interaction configuration.
The example shows the structure of the directory.
Chapter 4. Using a standard configuration 151
3. Create the UIMessage.js message file in the nls folder for the supportedlocalization languages. The example message file contains the localizedlanguage settings for French, Chinese, traditional Chinese, Japanese, andBrazilian Portuguese.define({root : {Assets: "Assets",STATUS : "Status",NAME : "Name",UNIT : "Unit",...},"fr" : true,"zh" : true,"zh-tw" : true,"ja" : true,"pt-br" : true});
For each enabled locale, there is corresponding subdirectory. In this example,the message files under fr, zh, zh-tw, ja, and pt-br or nls is created.The resultis:
Deploying the web application to the Websphere Liberty server:
About this task
You need to deploy the ife_demo_web project to the Websphere Liberty server.
Figure 24. The structure of the directory
Figure 25. The nls directory structure
152 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Procedure
1. Open the Server view, and right-click Websphere Application Server V8.5Liberty from the local host and select Add and Remove.
2. Select ife_demo_web from the Available field and click Add.3. Click Finish.
Launching the page:
After you have deployed the sample application, you can launch the web page.
Procedure
1. Open your browser.2. Type the URL as follows: https://<your ip>:<port>/ife_demo_web/index.html
Where <your ip> and <port> are adjusted to your machine settings.
Chapter 4. Using a standard configuration 153
154 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Chapter 5. Using a big data configuration
This section contains information about using a big data configuration of theproduct.
Provisioning the productThe provisioning console enables you to manage instances, tenants and users.
When Maximo APM - Predictive Maintenance Insights On-Premises is installed toyour system, one instance, one tenant, and two users are created. You can findthem in the provisioning console user interface. If you need to add more users ortenants, you can add them by using the provisioning console.
Creating an instanceBefore using Maximo APM - Predictive Maintenance Insights On-Premises, youmust create an instance of the product. Only one instance of each product can becreated.
Procedure1. Log in to the provisioning console user interface by using the following URL:
http://hostname:port/where hostname is the provisioning console host and port is the port that isconfigured for the provisioning console.
2. Click Instances.3. If no Maximo APM - Predictive Maintenance Insights On-Premises instance
exists, create one:a. Click Add Instance.b. Select the IBM Maximo Asset Performance Management - Predictive
Maintenance Insights On-Premises application type.c. Specify the application URL as:
https://hostname:port/ibm/pm/where hostname is the Maximo APM -Predictive Maintenance Insights On-Premises host and port is the port that isconfigured for Maximo APM - Predictive Maintenance Insights On-Premises.
d. Add the instance.
Setting an API keyAfter you create an instance of Maximo APM - Predictive Maintenance InsightsOn-Premises, you must set an API key to enable the product to communicate withthe provisioning console.
Procedure1. Log in to the provisioning console user interface by using the following URL:
http://hostname:port/.2. Click Instances.3. Expand the Maximo APM - Predictive Maintenance Insights On-Premises
instance to view the instance details.4. Click API Keys. If no API key exists, click Add, then click OK.
155
Creating tenantsA tenant is a group of users that are granted access to instances of one or moreproducts. There is no limit to the number of users that can be assigned to a tenant.You can create one tenant for all your users, or you can create multiple tenants togroup users and control their access to product instances.
Procedure1. Log in to the provisioning console user interface by using the following URL:
http://hostname:port/.2. Click Tenants.3. Click Add Tenant.4. Enter an ID for the tenant. The ID must begin with a letter, the ID must
contain only letters and numbers, and letters must be capitalized.5. Enter an email address for the tenant. The tenant email address is used only
as an identifier for the tenant. No email is sent to this address.6. Enter a password for the tenant.7. For tenant type, specify internal.8. Leave the Note field blank.9. Select vi in the instance list, select Paid User, and input the expiration date.
10. Click Add.
Creating usersYou can add users to tenants. A user can be added to only one tenant. After a useris added, the user's username and password can be used to log in to the MaximoAPM - Predictive Maintenance Insights On-Premises user interface.
Procedure1. Log in to the provisioning console user interface by using the following URL:
http://hostname:port/.2. Click Users.3. Click Add User.4. Enter the username.5. Enter the user's email address.6. Enter a password for the user.7. Enter the user's full name.8. In the Metadata field, enter metadata in JSON format that indicates the
application the user is allowed to access. For Maximo APM - PredictiveMaintenance Insights On-Premises, enter the following metadata: {'pm':''}
9. Specify the tenant to which you want to add the user.10. Click Add.
Using the productYou can use Maximo APM - Predictive Maintenance Insights On-Premises toupload data. With the data, you can view and analyze the maintenancerequirements of equipment assets. You can also organize and track your equipmentassets.
156 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Logging onLog on to access Maximo APM - Predictive Maintenance Insights On-Premises.
Procedure1. Enter the URL into the address field of the browser.
Note: The fully qualified domain name is required in the URL, for example,https://web_hostname:port/ibm/pm/ where web_hostname is the host name ofthe web server. If you use the IP address instead of the registered fullyqualified domain name, some windows do not open correctly. The port is thenumber that you entered during the installation for liberty pm_serverhttpsPort. By default, the port is 9448.
2. At the log in page, enter your user name and password. The default user nameis demouser. The Maximo APM - Predictive Maintenance Insights On-Premiseshome page appears.
What to do next
On first use, you see a Welcome screen in which you can do the following things:v Get a tour of the main elements of the software.v View a tutorial video.v View the documentation.v Download sample data.v Load sample data.
After first use, you can click the User icon to access these functions.
Each time you close your browser window, you must enter your IBM ID andpassword to log in again.
Downloading the tutorial and sample dataMaximo APM - Predictive Maintenance Insights On-Premises includes a tutorialand sample data.
About this task
The topic shows how to download the tutorial and sample data.
Procedure1. Click the User icon and click Tutorial download to download the mp4 file for
the steps for a process engineer.2. Click Sample data download to download the sample data that is used for the
tutorial.
Getting startedWhen you first use the product, you need to upload entity property files and eventfiles to trigger the creation and training of models.
When you first use the product, complete the following tasks in the order shown.1. Optional: Configure model settings.2. Upload the first entity property file.
Chapter 5. Using a big data configuration 157
3. Upload the first event file. After the first event file is successfully uploaded, theproduct analyzes the data, creates a new model for each asset type, trains themodels, and then uses the models to do prediction. The last step is calledscoring.
4. After the model training and analysis are complete, you can view the analysisresults.
5. Optional: Upload more files. The new uploaded data is analyzed by existingmodels to make new predictions.
6. Optional: Retrain existing models.7. Optional: Reset user data.
Using data filesOn the home page, you can upload entity property files and event files. You canpreview, download, and delete uploaded files.
Data from multiple sourcesWhen data from different sources has the same timestamp, the data is mergedbefore training and scoring.
When values have conflicts, the following rules apply.v Values from Watson™ IoT Platform have lower priority than values from
Maximo® Asset Management and the Maximo APM - Predictive MaintenanceInsights On-Premises user interface. Values from Maximo Asset Managementand Maximo APM - Predictive Maintenance Insights On-Premises overwritevalues from Watson IoT Platform.
v If files from Maximo Asset Management and Maximo APM - PredictiveMaintenance Insights On-Premises have conflicts, the values from the mostrecently uploaded files overwrite the conflicting values from previous files.
Entity property filesEntity property files describe asset detail information and associate an asset withan asset type.
The following table describes important columns in the entity property file.
Table 23. Important columns in the entity property file
Column name Description
ASSET_ID A string that identifies each asset. The ASSET_ID columncannot contain empty or null values. This column isrequired.
ASSET_TYPE A string that describes the type of asset. Values in theASSET_TYPE column cannot contain spaces. Thiscolumn is required.
NEXT_PM The next planned maintenance date for an asset. Themargin value is the predicted failure date minusNEXT_PM. This column is required.
MF_DATE The manufacture date of an asset. This column isoptional.
158 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Table 23. Important columns in the entity property file (continued)
Column name Description
WELL_MAINTAIN A window in days. Maximo APM - PredictiveMaintenance Insights On-Premises uses this window todetermine if an asset is well-maintained,under-maintained or over-maintained.
v If the next planned maintenance date (NEXT_PM) isafter the predicted failure date (the margin is less than0), the asset is categorized as under-maintained.
v If the next planned maintenance date isWELL_MAINTAIN days before the predicted failuredate (the margin greater than WELL_MAINTAIN), theasset is categorized as over-maintained.
v If the margin value is greater than 0 and less thanWELL_MAINTAIN, the asset is well-maintained.
Margin = Predicted_Next_Failure_Date - NEXT_PM
This column is required.
Important:
v The file must not contain duplicate column names.v The MF_DATE column must use one of the following date formats consistently
within each file:– yyyy-MM-dd hh:mm:ss– dd/MM/yyyy HH:mm:ss– yyyy/MM/dd H:mm:ss– yyyy/M/d H:mm:ss– d/M/yyyy H:mm:ss– dd.MM.yyyy HH:mm:ss– MM-dd-yyyy HH:mm:ss tt, where tt = AM or PM
Event filesEvent files record failure events and asset operating data. Event data must be in acontinuous time series that is recorded at a second, minute, hourly, daily, weeklyor monthly level.
Important:
v The file must not contain duplicate column names.v Column names cannot contain spaces.v Column names cannot contain the following special characters: ' " < > + # . % * ;
: \ -.v The file must contain an asset_id column. The asset_id column cannot contain
empty or null values.v The file must record failure events.v The failure event, maintenance event, and repair event column values must be 0
or 1.v The file must contain a timestamp column. The timestamp column cannot
contain empty or null values.v The file must contain an is_fail column. is_fail is a keyword for a failure event
field in an event file. If you use is_fail as a column name for another field, the
Chapter 5. Using a big data configuration 159
column will be renamed as is_fail_renamed. In the analysis results, the failureevent field will be renamed as is_fail. The values in the is_fail column must be0 or 1.
v The nextMaintenance and manufacturedDate columns must use one of thefollowing date formats consistently within each file:– yyyy-MM-dd hh:mm:ss– dd/MM/yyyy HH:mm:ss– yyyy/MM/dd H:mm:ss– yyyy/M/d H:mm:ss– d/M/yyyy H:mm:ss– dd.MM.yyyy HH:mm:ss– MM-dd-yyyy HH:mm:ss tt, where tt = AM or PM
v When multiple event files are uploaded, when there are potential conflicts, thecolumn values from the newer file will overwrite the column values from theolder file.
Translation fileYou can use the translation file to map columns in your data files.
Uploaded files are automatically parsed to determine whether they are entityproperty files or event files. Columns in uploaded files are automatically read todetermine the type of data they contain. If you want to customize the way data inuploaded files is handled, you can edit the translation file.
The translation file contains the following JSON objects:
entityPropertyFileUsed to map columns in entity property files.
dataFileUsed to map columns in event files.
metaInputUsed to enable or disable fields in entity property files.
exclusionUsed to exclude fields in event files.
In the entityPropertyFile JSON object, assetType is the asset type,nextMaintenance is the next maintenance date, and manufactureDate is themanufactured date.
In the dataFile JSON object, failureEvent is the failure event flag,maintenanceEvent is the maintenance event flag, and repairReplaceEvent is therepair or replace event flag.
In the following example of the metaInput JSON object, IBM is the asset type, anddisable indicates that the non-required data fields for the IBM asset type from theentity property file are disabled."metaInput":{
"IBM":"disable"}
In the following example of the exclusion JSON object, IBM is the asset type, andindex and f4 are the fields to be excluded.
160 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
"exclusion":{
"IBM":"index,f4"}
Uploading data files and previewing the dataOn the home page, you can upload entity property files and event files. You canupload the files one at a time. Upload entity property files first, and then uploadevent files.
About this task
After an event file is uploaded, Maximo APM - Predictive Maintenance InsightsOn-Premises parses the uploaded data. If a model does not exist for the assets,Maximo APM - Predictive Maintenance Insights On-Premises builds the predictionmodel, predicts the next failure date, and gets the analysis results for each asset. Ifa model already exists, the product performs scoring and determines the new nextfailure date. You can manually retrain the model if necessary.
Procedure1. Select My Data > Files > Browse for file, select the file, and select Open.2. In the Progress pane, view the status of the upload.3. In the Uploaded Files section, view the files.4. To view the uploaded file variable type and dimension information, hover over
the tags in each file card.5. To preview the data in the file, click Preview. The first 10 rows of the data are
shown.
Downloading data filesOn the home page, you can download a data file that has been uploaded.
Procedure1. Select My Data > Files.2. In the Uploaded Files section, view the files.3. From the list of files, click the menu button of the file and click Download.
Deleting data filesOn the home page, you can delete a data file that has been uploaded.
About this task
When you delete a file, the operation does not delete the associated events in thedatabase, but only deletes the file from the system.
Procedure1. Select My Data > Files.2. In the Uploaded Files section, view the files.3. From the list of files, click the menu button of the file and click Delete.
Configuring training settingsYou can configure the training settings by configuring the data handling rules andmodel settings. Training settings affect how the data for each asset type isprocessed and how the model is trained. To access these settings, select the settingsicon.
Chapter 5. Using a big data configuration 161
You can configure training settings before you upload the first event data, orretrain existing models.
Resampling and data handling rulesYou can configure the resampling rule and data handling rules that are used by theproduct.
Resampling rule
Resampling rules affect the way data is aggregated. Two options are available forresampling data:
None No resampling technique is performed on the original data set.
DownsamplingData is downsampled. Downsampling rebalances the distribution betweenfailure events and non-failure events to increase the proportion of failureevents.
Data handling rules
Data handling rules specify the aggregation rule and missing value rule for eachcolumn in the event file. You can define data handling rules for individual fields.The options for aggregation rule and missing value rule depend on the type offield.
The following table describes the types of aggregation rules.
Table 24. Aggregation rules
Aggregation rule Description
T_IF_ANY_T True if any true. If one or more true valuesexist, then true is used.
F_IF_ANY_F False if any false. If one or more false valuesexist, then false is used.
mode The value that occurs most frequently isused.
first The value that occurs first is used.
last The value that occurs last is used.
sum The sum of all values is used.
mean The average of all values is used.
max The maximum value is used.
min The minimum value is used.
count The number of events in the time period isused.
The following table describes the types of missing value rules.
Table 25. Missing value rules
Missing value rule Description
false If the event does not have this value, false isused.
ffill The last available value is used.
162 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Table 25. Missing value rules (continued)
Missing value rule Description
bfill The first available value is used.
mean The average is used.
min The minimum value is used.
max The maximum value is used.
interpolate A linear interpolation is used.
Configuring model settingsThe product uses default model settings to preprocess data and train models.However, you can configure your model settings to train your model. You canchoose to automatically or manually configure the model settings. If youautomatically configure the model settings, the product uses default values formodel settings and data preprocessing. If you manually configure the modelsettings, you have more control of the values.
About this task
You can use the model settings function to set the configuration settings forcurrently selected asset type. You can switch asset types using the asset type menuon the asset panel.
When you upload your data, an initial training is automatically completed byusing the following parameters:v Number of Trees: 3v Maximum Depth of Tree: 3v Learning Rate: 0.3
For the Gradient Boosting Decision Tree (GBDT) regression model type, thefollowing parameters are available:v Number of Trees, range [2, 100], default 10v Maximum Depth of Tree, range [2, 10], default 4v Loss Function, default leastSquaresError, logLoss, and leastAbsoluteError
v Learning Rate, range [0.01, 0.3], default 0.1
During training, the settings icon and Retrain button are disabled.
Procedure1. Click the settings icon.2. On the Model Settings tab, select the analysis interval to define how you want
the data set to be aggregated before training. The default option for the analysisinterval is daily or you can select weekly, monthly, yearly, or the raw optionwhere no aggregation is done during training.
3. In the Define Model Settings box, do one of the following options:a. Add the parameter values.b. Select Automatically define model parameters to have the values be
automatically defined. If you select Automatically define modelparameters, the training speed is slow.
4. Optional: Select Automatically Retrain on Apply for the system toautomatically start a training that is based on the new values.
Chapter 5. Using a big data configuration 163
5. Select Apply.
Analysis resultsAfter you upload entity property files and event files, the product analyzes theinformation, trains the model based on the data that is uploaded, and thenprovides the analysis result. You can select an asset type to see the analyses for allequipment assets of that type.
On the asset pane, click the asset type menu and select an asset type.
Equipment assets are grouped by the following categories:
All AssetsAll equipment assets, or all equipment assets of the selected type.
Over MaintainedScheduled maintenance is long before the predicted failure of the asset.
Well MaintainedScheduled maintenance is close to the predicted failure of the asset.
Under MaintainedScheduled maintenance is long after the predicted failure of the asset.
Needs DataMore data is required to analyze the asset.
Each equipment asset appears on a separate card that provides importantindicators of asset health:
Top DriverTop driver is a sensitivity analysis that shows the strength of correlationbetween operating variables and failure for each equipment instance.Maximo APM - Predictive Maintenance Insights On-Premises ranks thedrivers, indicates the current value of each driver, and provides anestimate of the remaining value before failure in the driver unit. Forexample, the top failure for a pump might be the cubic feet of waterpumped since last repair. At the time of analysis, pump 2672 has pumped40000 cubic feet of water. Maximo APM - Predictive Maintenance InsightsOn-Premises estimates that it pump another 10000 cubic feet before it fails.This value is intended as an estimate. When this estimate is produced,Maximo APM - Predictive Maintenance Insights On-Premises assumes thatthe values of the other drivers remain constant. The actual number ofoperating hours is influenced by the changes in other variables.
MarginThe number of days' difference between the next scheduled maintenanceand the next predicted failure of the asset.
Attention: Negative margin means that the asset is predicted to failbefore the next scheduled maintenance.
Risk FactorsRisk factors are characteristics of equipment that make them more or lesssusceptible to failure. Unlike drivers, which are continuous numericvariables, risk factors are categorical characteristics of the equipment. Theyare useful in explaining why different equipment instances that are used ina similar way have different failure rates. For example, pump 2672 haspumped 40000 cubic feet of water since the last repair, and can pump
164 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
10000 more cubic feet before failure. However, pump 8251 has alsopumped 40000 cubic feet of water, but it can pump only 10 more cubicfeet. Pump 2672 is used in a clean environment. Pump 8251 is used in acorrosive environment. The environment is shown as a risk factor with aclean environment shown as a positive contributor for pump 2672 and acorrosive environment is shown as a negative contributor for pump 8251.
Graph The graph gives a concise visual reference of asset health:v The gray horizontal bar indicates the total top driver count before the
next predicted failure of the asset.v The dark portion of the horizontal bar indicates the current top driver
count.Attention: If the entire horizontal bar is dark, then the asset is alreadypast its next predicted failure.
v The vertical bar indicates the current average top driver count for thisasset type.
v The arrow at the end of the horizontal bar indicates whether the currenttop driver count is more than twice the average top driver count for thisasset type.
You can sort the cards based on Margin, or filter the cards based on Top Driver orAsset Property Type.
Click a card to open a window that shows more analysis results for the asset,including the following details:v The number of days until the next scheduled maintenance date.v All drivers (that is, variables that contribute to asset failure). A driver whose
name ends with _LTD is derived from an existing field by accumulating betweenfailure events.
v The maintenance history of the asset.v A histogram of all drivers or a particular driver.
Tip: Specify a time scale to view a particular period.
NotificationYou can receive system notifications in Maximo APM - Predictive MaintenanceInsights On-Premises. The notifications show system events such as file upload andmodel training.
The notification icon shows the number of notifications that you have received andshow in chronological order.
The notification types are:
File uploadedA system notification indicates the user has completed uploading a file.
File deletedA system notification indicates the user has deleted a file.
Analysis completeA system notification indicates an analysis of an asset is complete.
Asset addedA system notification shows that assets were added to the system.
Chapter 5. Using a big data configuration 165
Errors foundShows errors and the cause of each error. Errors may be caused by failuresduring file upload, failures during analysis of an asset, or other reasons.
Resetting the productYou can use the Factory Reset feature to reset the product. Selecting this optiondeletes all data, trained models, and configuration settings, returning the productto its original state.
About this task
To reset the product, complete the following steps.
Procedure1. Log in to the product.2. Click the user icon.3. Select the Factory Reset option.4. Click Continue. Data deletion begins.
Results
When the factory reset operation is complete, the message "Successfully deleteduser data" is displayed.
Integrating with other productsYou can integrate Maximo APM - Predictive Maintenance Insights On-Premiseswith other products to import and analyze maintenance data from those products.
Integration with Watson IoT PlatformMaximo APM - Predictive Maintenance Insights On-Premises integrates with IBMWatson® IoT Platform to make predictions about asset failure based on the currentstate of the asset.
Configure your organization in Watson IoT Platform
Before integrating Maximo APM - Predictive Maintenance Insights On-Premiseswith Watson IoT Platform, you must configure your organization in the platform.This guide does not explain how to create device types and device IDs.
You must add ASSET_ID in the Metadata field of a device ID. This metadata isused to determine with which asset ID this device associated. For example,{"ASSET_ID": "JK84-JAS-144"}
Next, send data to devices. Maximo APM - Predictive Maintenance InsightsOn-Premises supports receiving simple JSON data only. See the following example.The timestamp and asset ID are added automatically when generating files:{“is_fail”:”true”,“temperature_flag”:”true”,“event_count”:”3”}
166 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Add Integration
Before integrating with Watson IoT Platform, you need to create an integration inMaximo APM - Predictive Maintenance Insights On-Premises. You must enter theorganization ID, API key, and authentication token to connect to Watson IoTPlatform. After connecting to an organization, you can select the devices fromwhich to receive data.
In Maximo APM - Predictive Maintenance Insights On-Premises, in the IoT tab,click Add Integration. Enter the organization ID, API key, and authentication tokento connect to an organization. You can create only one integration for eachorganization.
Once connected to the organization, select the devices from which you want toreceive data. Select Add all data from all devices, or click SelectDevices/Types/Events to select specific devices.
Set Analysis Interval to Daily. The analysis interval is how often Maximo APM -Predictive Maintenance Insights On-Premises triggers IoT data analysis. Only theDaily interval is supported.
Analyze IoT data
After an integration with Watson IoT Platform is created, Maximo APM -Predictive Maintenance Insights On-Premises receives data from that integrationand starts analyzing daily, at midnight.
You can disconnect from the integration by clicking Disconnect. Maximo APM -Predictive Maintenance Insights On-Premises stops receiving data from thatintegration. You can reconnect to integration by clicking Connect.
You can pause analysis data from an integration by clicking Pause Analysis.Maximo APM - Predictive Maintenance Insights On-Premises stops analyzing datafrom that integration. You can continue analysis by clicking Continue Analysis.During a pause, Maximo APM - Predictive Maintenance Insights On-Premises canstill receive data from that integration.
Integration with Maximo Asset ManagementMaximo APM - Predictive Maintenance Insights On-Premises uses historicalmaintenance and metric data to make predictions about asset failure based on thecurrent state of the asset. IBM Maximo Asset Management is an application thatsupports device maintenance. It can be the source of some or all of the asset datathat is needed by Maximo APM - Predictive Maintenance Insights On-Premises.
Overview
Asset data from Maximo Asset Management may be provided to PM either as afile (csv) or through a http interface. The csv format may be most convenient for alarge historical data set while the http interface is convenient for ongoing updates.
Maximo Asset Management provides the capability to define and filter the data forexport to PM. In general, the exported data fields correspond to the columns of acsv file for upload to PM. Thus they include timestamp, asset id, failure,maintenance, and metric data.
Chapter 5. Using a big data configuration 167
Maximo Asset Management integration capabilities are defined using severalcomponents. Object Structures define the data fields. Publish Channels candetermine when the data is exported and can filter which data to include. EndPoints determine the export method (ex. File or HTTP). And External Systemscombine a Publish Channel with an End Point.
Work Orders
Maximo Asset Management work orders can be an import source of maintenancedata for the PM application. This includes asset failure, asset repair or replace, androutine maintenance. The following is a description of a set of Maximo AssetManagement external system artifacts that allow export of this work order data toMaximo APM - Predictive Maintenance Insights On-Premises.
Object Structure – PMEX_WORKORDER
The PMEX_WORKORDER Object Structure includes the following fields ofWORKORDER. The extended fields (PMEX_) are added as non-persistent attributesof WORKORDER.v ASSETNUMv SITEIDv WORKTYPEv FAILDATEv FAILURECODEv STATUSv STATUSDATEv PMEX_TIMESTAMPv PMEX_ASSET_IDv PMEX_IS_FAILv PMEX_IS_MAINTENANCEv PMEX_IS_REP_REPLACEv WELL_MAINTAIN
Maximo APM - Predictive Maintenance Insights On-Premises needs the values oftimestamp, asset_id, is_fail, is_maintenance, is_rep_replace. By default, MaximoAPM - Predictive Maintenance Insights On-Premises will infer these values.Asset_id is the combination of ASSETNUM+SITEID. If there is a FAILURECODEthen is_fail is TRUE and the timestamp is FAILDATE (otherwise timestamp isSTATUSDATE). If the WORKTYPE is CM or EM then is_rep_replace is TRUE andotherwise if it is PM then is_maintenance is TRUE.
This default mapping can be overridden by using a publish channel to explicitlyset the value of any of the fields beginning with PMEX_.
Meters
Maximo Asset Management meters can provide metric data that the PMapplication uses to train and score asset failure models.
168 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Object Structure – PMEX_METER
The PMEX_METER Object Structure includes the following fields of ASSETMETER.The extended fields (PMEX_) are added as non-persistent attributes ofASSETMETER.v SITEIDv METERNAMEv LASTREADINGv LASTREADINGDATEv PMEX_TIMESTAMPv PMEX_ASSET_IDv PMEX_METRIC_NAMEv PMEX_METRIC_VALUE
Maximo APM - Predictive Maintenance Insights On-Premises uses Maximo AssetManagement meters as metrics. It needs the values of timestamp and asset_id. Italso needs the metric name and value. By default, Maximo APM - PredictiveMaintenance Insights On-Premises will infer these values. Asset_id is thecombination of ASSETNUM+SITEID. Timestamp is LASTREADINGDATE. Themetric name is the METERNAME and the metric value is LASTREADING.
As with the work order, this default mapping can be overridden by using apublish channel to explicitly set the value of any of the fields beginning withPMEX_.
Endpoints
The object structures for Maximo APM - Predictive Maintenance InsightsOn-Premises can be exported using an HTTP or Flat File (csv) endpoint. A Flat Fileendpoint may be more appropriate for a large amount of historical data while anHTTP endpoint is ideal for automatically exporting new data.
The HTTP endpoint must be configured with the URL, username, and passwordfor Maximo APM - Predictive Maintenance Insights On-Premises. It must alsoinclude the header “content-type application/xml” and the http method “POST”.
Summary
Maximo Asset Management is an application with powerful capabilities to supportasset maintenance. Historical data in Maximo Asset Management can be used totrain and score predictive models in Maximo APM - Predictive MaintenanceInsights On-Premises. The resulting "days to failure" prediction in PrescriptiveMaintenance can provide a valuable insight to help optimize asset maintenanceand thus provide efficient and productive asset use.
Application programming interfaceThe application programming interface enables you to perform actions such asposting entity and event data, uploading a file, and retrieving a result.
Post entity data from Maximo Asset ManagementPosts entity data from IBM Maximo Asset Management.
URL
Chapter 5. Using a big data configuration 169
/ibm/pm/service/apiWrapper?apiName=maximo
MethodThe request type POST
URL parameters
Required
apiName="Maximo"
Username=demouser
type=property
Optional
None
Headers for API key authorization
Content-Type: text/html
APIKEY: API_Key
Sample body<?xml version="1.0" encoding="UTF-8"?><PublishMXPM_PM xmlns="http://www.ibm.com/maximo"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"creationDateTime="2017-03-14T13:37:20-04:00" transLanguage="EN"baseLanguage="EN" messageID="3456160.1489513040315874425"maximoVersion="7 6 $build$ V7608-46" event="1">
<MXPM_PMSet><ASSET action="Add">
<ASSETNUM>80901</ASSETNUM><PMEX_ASSET_ID> 80901vBEDFORD </PMEX_ASSET_ID><PMEX_ASSET_TYPE> AIRCRAFTBRAKES</PMEX_ASSET_TYPE><PMEX_MANUFACTURE_DATE>2016-03-01T00:00:00-05:00</PMEX_MANUFACTURE_DATE><PMEX_NEXT_MAINTENANCE>2017-03-01T00:00:00-05:00</PMEX_NEXT_MAINTENANCE><SITEID>BEDFORD</SITEID><WELL_MAINTAINED>14</WELL_MAINTAINED>
</ASSET></MXPM_PMSet>
</PublishMXPM_PM>
Success response
Code
200 OK
Content
{}
Error response
Code
403
Content
The server encountered an internal error and was unable to complete yourrequest. Please contact system administrator.
Sample callhttps://server_url/ibm/pm/service/apiWrapper?apiName=maximo&Username=user_name&type=property
170 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Notes This REST API call uses a user API key for authentication. User API keysare obtained from the provisioning console
Post event data from Maximo Asset ManagementPosts event data from IBM Maximo Asset Management.
URL
/ibm/pm/service/apiWrapper?apiName=maximo
MethodThe request type POST
URL parameters
Required
apiName=maximo
Username=demouser
type=data
Optional
None
Headers for API key authorization
Content-Type: text/html
APIKEY: API_Key
Sample Body<?xml version="1.0" encoding="UTF-8"?><PublishPMEX_WO_ANDMETERxmlns="http://www.ibm.com/maximo"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"creationDateTime="2016-10-18T12:11:29-04:00"transLanguage="EN" baseLanguage="EN" messageID="3114181.1476807089991377382"maximoVersion="7 6 20151202-1713 V7603-143" event="1">
<PMEX_WO_ANDMETERSet><WORKORDER action="Replace">
<ASSETNUM>811</ASSETNUM><FAILDATE xsi:nil="true" /><PMEX_ASSET_ID>811vBEDFORD</PMEX_ASSET_ID><PMEX_IS_FAIL>TRUE</PMEX_IS_FAIL><PMEX_IS_MAINTENANCE>TRUE</PMEX_IS_MAINTENANCE><PMEX_IS_REP_REPLACE>FALSE</PMEX_IS_REP_REPLACE><PMEX_TIMESTAMP>2016-12-05T12:11:25-04:00</PMEX_TIMESTAMP><SITEID>BEDFORD</SITEID><STATUS changed="1" maxvalue="COMP">COMP</STATUS><STATUSDATE changed="1">2016-12-05T12:11:25-04:00</STATUSDATE><WONUM>6011</WONUM><WORKTYPE>PM</WORKTYPE><PMEX_METER_READINGS>
<meterdata><metername>TEMP</metername><meterreading>200</meterreading>
</meterdata><meterdata>
<metername>PRESSURE</metername><meterreading>2.0</meterreading>
</meterdata><meterdata>
<metername>VIBRATION</metername><meterreading></meterreading>
Chapter 5. Using a big data configuration 171
</meterdata></PMEX_METER_READINGS><PMEX_OPTIONAL_FIELDS>
<optionalfield><fieldname>OptionalField1</fieldname><fieldvalue>TestValue</fieldvalue>
</optionalfield><optionalfield>
<fieldname>OptionalField2</fieldname><fieldvalue>TestValue</fieldvalue>
</optionalfield></PMEX_OPTIONAL_FIELDS>
</WORKORDER></PMEX_WO_ANDMETERSet>
</PublishPMEX_WO_ANDMETER>
Success response
Code
200 OK
Content
{}
Error response
Code
403
Content
The server encountered an internal error and was unable to complete yourrequest. Please contact system administrator.
Sample callhttps://server_url/ibm/pm/service/apiWrapper?apiName=maximo&Username=user_name&type=data
Notes This REST API call uses a user API key for authentication. User API keysare obtained from the provisioning console
Post entity data in JSON formatPosts entity data in JSON format.
URL
/ibm/pm/service/apiWrapper?apiName=json
MethodThe request type POST
URL parameters
Required
apiName="json"
Username=demouser
type=property
Optional
None
Headers for API key authorization
172 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Content-Type: application/json
APIKEY: API_Key
Sample body[{"ASSET_TYPE": " Aircraft ","ASSET_ID": "810vBEDFORD ","NEXT_PM": "2016-08-16 00:00:00","MF_DATE": "2015-05-01 00:00:00","LOCATION": "BEDFORD","MF": "IBM-US","WELL_MAINTAIN": 10,"MACHINE_LEVEL": 1}]
Success response
Code
200 OK
Content
{}
Error response
Code
403
Content
The server encountered an internal error and was unable to complete yourrequest. Please contact system administrator.
Sample callhttps://server_url/ibm/pm/service/apiWrapper?apiName=json&Username=user_name&type=property
Notes This REST API call uses a user API key for authentication. User API keysare obtained from the provisioning console
Post event data in JSON formatPosts event data in JSON format.
URL
/ibm/pm/service/apiWrapper?apiName=json
MethodThe request type POST
URL parameters
Required
apiName="json"
Username=demouser
type=data
Optional
None
Chapter 5. Using a big data configuration 173
Headers for API key authorization
Content-Type: application/json
APIKEY: API_Key
Sample body[{"ASSET_ID": "810vBEDFORD ","Timestamp": "2016-11-18 00:00:00","IS_FAIL":"TRUE","IS_MAINTENANCE": "FALSE","IS_REP_REPLACE": "TRUE","Speed": 15.383333,"Win_Angle": 180.665922,"Wind_Grade": "Soft","Power_Grade": "Large"}]
Success response
Code
200 OK
Content
{}
Error response
Code
403
Content
The server encountered an internal error and was unable to complete yourrequest. Please contact system administrator.
Sample callhttps://server_url/ibm/pm/service/apiWrapper?apiName=json&Username=user_name&type=data
Notes This REST API call uses a user API key for authentication. User API keysare obtained from the provisioning console
Upload a fileEnables users to upload a file.
URL
/ibm/pm/service/apiWrapper?apiName=file_upload
MethodThe request type POST
URL parameters
Required
apiName=file_upload
Username=demouser
Optional
None
174 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Headers for API key authenticationAPIKEY: API_Key
Body Attach a CSV file.
Success response
Code
200 OK
Content
{"result":[{"fileId":"file_id","fileName":"file_name"}]}
Error response
Code
200 OK
Content
"result":["error_message": appropriate_error_message]
Sample HTTP callhttps://server_url/ibm/pm/service/apiWrapper?apiName=file_upload&Username=user_name
Sample CURL call with API key authenticationcurl –k -X post -H "APIKEY:API_Key" --connect-timeout 600 -Ffile=@c:\inputdata_4_1M_part.csv "server_url/ibm/pm/service/apiWrapper?apiName=file_upload&Username=user_name"
Notes
CSV is the only file type that this REST API supports.
This REST API call uses a user API key for authentication. User API keysare obtained from the provisioning console.
Download dataDownloads the analysis result data for one asset.
URL
/ibm/pm/service/apiWrapper ?apiName=file_download
MethodThe request type POST
URL parameters
Required
apiName=file_download
Username=IBM_ID
Optional
Assetid=my_asset_ID
Assettype=my_asset_type
FutureOnly=true or false (default is false)
Headers for API key authenticationAPIKEY: API_Key
Chapter 5. Using a big data configuration 175
Success response
Code
200 OK
Content
Returns data in CSV format as part of the response.
Error response
Code
200 OK
Content
"result":["error_message": appropriate_error_message]
Sample HTTP calls
To download the file for a specific asset:
https://server_url/ibm/pm/service/apiWrapper?apiName=file_download&Assetid=my_asset_ID&Username=user_name
To download the file for a specific asset type (all assets included):
https://server_url/ibm/pm/service/apiWrapper?apiName=file_download&Assettype=my_asset_type&Username=user_name
To download the file with predictions for a specific AssetID:
https://server_url/ibm/pm/service/apiWrapper?apiName=file_download&Assetid=my_asset_ID&Username=user_name&FutureOnly=true
To download the file with predictions for a specific AssetType:
https://server_url/ibm/pm/service/apiWrapper?apiName=file_download&Assettype=AIRCRAFTBRAKES&Username=user_name&FutureOnly=true
Sample CURL calls with API key authentication
To download the file for a specific asset:
curl -X post -H "APIKEY:API_Key" -o filename.csv -v"https://server_url/ibm/pm/service/apiWrapper?apiName=file_download&Assetid=JK84-JAS-141&Username=user_name"
To download the file for a specific asset type (all assets included):
curl -X post -H "APIKEY:API_Key" -o filename.csv -v"https://server_url/ibm/pm/service/apiWrapper?apiName=file_download&Assettype=my_asset_type&Username=user_name"
To download the file with predictions for a specific AssetID:
curl -X post -H "APIKEY:API_Key" -o filename.csv -v"https://server_url/ibm/pm/service/apiWrapper?apiName=file_download&Assetid=my_assetID&Username=user_name&FutureOnly=true"
To download the file with predictions for a specific AssetType:
curl -X post -H "APIKEY:API_Key" -o filename.csv -v"https://server_url/ibm/pm/service/apiWrapper?apiName=file_download&Assettype=AIRCRAFTBRAKES&Username=user_name&FutureOnly=true"
Notes
176 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
The output response for this REST API call produces data in CSV format.
This REST API call uses a user API key for authentication. User API keysare obtained from the provisioning console.
Retrieve analysis resultsGets analysis result data in JSON format for a specific asset type or asset ID.
URL
/ibm/pm/service/apiWrapper?apiName=analysisResult
MethodThe request type POST
URL parameters
Required
apiName=analysisResult
Username=IBM_ID
Optional
Assetid=my_asset_ID
Assettype=my_asset_type
Headers for API key authenticationAPIKEY: API_Key
Success response
Code
200 OK
Content
Returns JSON data that contains analyzed results.
Error response
Code
403
Content
The server encountered an internal error and was unable to complete yourrequest. Please contact system administrator.
Sample HTTP calls
To retrieve analysis results for a specific asset:
https://server_url/ibm/pm/service/apiWrapper?apiName=analysisResult&Assetid=my_asset_ID&Username=user_name
To retrieve analysis results for a specific asset type, all assets included:
https://server_url/ibm/pm/service/apiWrapper?apiName=analysisResult&Assettype=my_asset_Type&Username=user_name
Sample CURL calls with API key authentication
To retrieve analysis results for a specific asset:
Chapter 5. Using a big data configuration 177
curl -X post -H "APIKEY:API_Key" --connect-timeout 600"https://server_url/ibm/pm/service/apiWrapper?apiName=analysisResult&Assetid=my_asset_ID&Username=user_name" --insecure
To retrieve analysis results for a specific asset type, all assets included:
curl -X post -H "APIKEY:API_Key" --connect-timeout 600"https://server_url/ibm/pm/service/apiWrapper?apiName=analysisResult&Assettype=my_asset_type&Username=user_name" --insecure
Sample response{
"rmse": "0.630609733315","asset_type": "AIR_COOLER","data": [
{"drivers": {
"driver": "normalcount,2.872262773722628,1.9,2.868065693430657,1.2234554290771484",
},"asset_id": "80901AIR","top_driver": "empty_col_cusum","missing_data": "0","risk_factor": {
"negative": "","positive": ""
},"failure_date": "2019-04-04","top_driver_avg": "2493.2096715328466","top_driver_current": "235.43868613138685","margin": "436","maintainence_status": "3","top_driver_prediction": "591.5"
}]
}
Notes This REST API call uses a user API key for authentication. User API keysare obtained from the provisioning console
Delete user dataDeletes all the data from the specified user's account. The account is not deleted.
URL
/ibm/pm/service/apiWrapper?apiName=deleteUserData
MethodThe request type POST
URL parameters
Required
apiName=deleteUserData
Username=IBM_ID
Optional
None
Headers for API key authorization
Content-Type: text/html
APIKEY: API_Key
178 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Success response
Code
200 OK
Content
{}
Error response
Code
403
Content
The server encountered an internal error and was unable to complete yourrequest. Please contact system administrator.
Sample HTTP call
To delete all data for a specific user:
https://server_url/ibm/pm/service/apiWrapper?apiName=deleteUserData&Username=user_name
Sample CURL call with API key authentication
To delete all data for a specific user:
curl -X post -H "APIKEY:API_Key" --connect-timeout 600"https://server_url/ibm/pm/service/apiWrapper?apiName=deleteUserData&Username=user_name" --insecure
Notes This REST API call uses a user API key for authentication. User API keysare obtained from the provisioning console
View analysis statusGets analysis status of a specific asset type.
URL
/ibm/pm/service/apiWrapper?apiName=analysisStatus
MethodThe request type POST
URL parameters
Required
apiName=analysisStatus
Assettype=my_asset_type
Username=IBM_ID
Optional
None
Headers for API key authorization
APIKEY: API_Key
Success response
Code
Chapter 5. Using a big data configuration 179
200 OK
Content
Returns JSON data that contains analysis status.
Sample HTTP call
To retrieve analysis results for a specific asset type, all assets included:
https://server_url/ibm/pm/service/apiWrapper?apiName=analysisStatus&Assettype=my_asset_Type&Username=user_name
Sample CURL call with API key authentication
To retrieve analysis results for a specific asset type, all assets included:
curl -X post -H "APIKEY:API_Key" --connect-timeout 600"https://server_url/ibm/pm/service/apiWrapper?apiName=analysisStatus&Assettype=my_asset_type&Username=user_name" insecure
Sample response{
"message": "NOT_TRAINED","status": "0"
}
Response items
NOT TRAINED: The asset type is not yet trained.
ANALYZING: The product is analyzing the asset type.
UNREAD: The asset type has been trained, but the user has not viewedthe result.
VIEWED: The asset type has been trained and the user has viewed theresult.
Notes This REST API call uses a user API key for authentication. User API keysare obtained from the provisioning console
TroubleshootingThis section contains troubleshooting information for Maximo APM - PredictiveMaintenance Insights On-Premises.
The following table shows possible error messages and corrective actions:
Table 26. Maximo APM - Predictive Maintenance Insights On-Premises error codes,messages, explanations, and corrective actions
Error code Error message Explanation Action
PM-W-0003 The file X uploadedsuccessfully
File uploadedsuccessfully to thedata lake and finishedparser.
PM-W-0004 The file X was deleted The file deletedsuccessfully from thedata lake and Hbase.
180 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Table 26. Maximo APM - Predictive Maintenance Insights On-Premises error codes,messages, explanations, and corrective actions (continued)
Error code Error message Explanation Action
PM-W-0005 The File X uploadfailed
Exception happenedduring file upload tothe data lake.
Check that the filecontains the correcttimestamp columnand other requiredfields. Event filesrequire failure event,timestamp, and assetid fields. Entityproperty files requireasset type, asset id.
PM-W-0021 There is no asset_idcolumn in the file X
ASSET_ID is arequired column inPrescriptiveMaintenance data. Butfile parser can notfind it from uploadedfile.
Add ASSET_IDcolumn in the filewhich report this errorand upload it again.
PM-W-0022 There is no timestampcolumn in the file X
Timestamp is arequired column inPrescriptiveMaintenance data. Butfile parser can notfind it from x file.
Add timestampcolumn in x file andupload it again.
PM-W-0023 There are repeatedcolumn names in thefile X
File parser foundduplicated columnnames in x file.
Remove or renameduplicated columnname in x file, andupload it again.
PM-W-0024 The type offailurEvent,maintenancEvent orrepairReplaceEventcolumn in the file X isnot correct
File parser usetranslation file toparse x file and findfailureEvent,maintenanceEvent orrepairReplaceEventdidn't contain flagvalue (True/False).
Edit translation filemap correct flag valuefields to thesespecified columns. Oredit x file to makethese columns containflag value(True/False).
PM-W-0025 The type ofnextMaintenance ormanufacturedDatecolumn in the file X isnot correct
File parser usetranslation file toparser the data findnextMaintenance ormanufacturedDatedidn't containtimestamp value.
Edit translation filemap correcttimestamp fields tothese specifiedcolumns. Or edit datato make thesecolumns containcorrect timestampdata(True/False)
PM-W-0026 There is no asset_typecolumn in the file.Choose a column asthe asset_type
File parser find userupload file is a entityproperty file. But thisfile didn't containASSET_TYPE column.
Add one more columnASSET_TYPE in thisfile or use translationfile to map onecolumn to asset_type.
Chapter 5. Using a big data configuration 181
Table 26. Maximo APM - Predictive Maintenance Insights On-Premises error codes,messages, explanations, and corrective actions (continued)
Error code Error message Explanation Action
PM-W-0027 None of the assets inthe file X have an assettype. Upload an entityproperty file andmanually trigger theanalysis
User didn’t uploadentity property filerelated with asset_idin event data.
Upload entityproperty file containasset_type informationfor asset_id in eventdata.
PM-W-0030 Successfullydisconnected from theIBM Watson IoTPlatform
Disconnected fromIoT platform.
PM-W-0031 You haven't connectedto this organization
User disconnect froma unconnected IoTorganization.
Refresh UI anddisconnect optiondisappear.
PM-W-0032 You already connectedto this organization
User try to connect toIoT organizationwhich has alreadybeen connected to.
Refresh UI andconnect optiondisappear.
PM-W-0033 Successfully connectedto the IBM Watson IoTPlatform
User connected to IoTplatform.
PM-W-0034 You must create aconnection to thisorganization beforeattempting to connect
User try to connect toan IoT platform whichconnection definitionhaven’t been createdyet.
Create a IoTconnection in IoT UIand then connect to it.
PM-W-0035 Successfully deletedconnection
User delete one IoTconnection.
PM-W-0036 An error occurredwhen deleting an IoTconnection
An exception happenwhen delete IoTconnection.
Disconnect to IoTplatform first thendelete this connectionagain.
PM-W-0039 An error occurredwhile analyzing file X
A timeout erroroccurred whenanalyzing file x
Rerun analyzing byclick retrain button onUI.
PM-W-0040 File X upload failedwith file parser
Error happen whensystem cannot parseFile x
Check file formatmatches withtranslation file andupload it again.
PM-W-0041 You already addedintegration toorganization X
User try to add a newintegration connectionwhich already existed.
User can edit old oneto make the change.IoT platform onsupport oneconnection from aclient.
PM-W-0043 An error occurredwhen saving thetranslation file
User uses invalidJSON file astranslation file.
Check translation fileis in correct JSONformat.
182 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Table 26. Maximo APM - Predictive Maintenance Insights On-Premises error codes,messages, explanations, and corrective actions (continued)
Error code Error message Explanation Action
PM-W-0044 The API Key orAuthentication Tokenis wrong
Failed to authenticatewith IoT platformwith input API keyand authenticationtoken.
Check API key andAuthentication tokeninput correctly.
PM-W-0045 You must disconnectfrom IoT platformbefore saving thisintegration
User try to saveintegration while itconnected.
Disconnect from IoTplatform and then editthe connection.
PM-W-0046 There is no dataFileobject in the translationfile
User may deletedataFile object intranslation file
dataFile object isrequired in translationfile. User need to addit back or fix incorrectspelling.
PM-W-0047 There is noentityPropertyFileobject in the translationfile
User may deleteentityPropertyFileobject in translationfile
entityPropertyFileobject is required intranslation file. Userneed to add it back orfix incorrect spelling.
PM-W-0048 The dataFile object isnot a valid json object
After user edittranslation filedataFile object is not avalid JSON object.
User need to fix theformat of dataFileobject in translationfile before save it orreplace it.
PM-W-0049 The entityPropertyFileobject is not a validjson object
After user edittranslation fileentityPropertyFileobject is not a validJSON object.
User need to fix theformat ofentityPropertyFileobject in translationfile before save it orreplace it.
PM-W-0050 You must providefailureEvent,maintenanceEvent andrepairReplaceEvent inthe dataFile object
After user edittranslation filefailureEvent,MaintenanceEvent orrepairReplaceEventcan not be found indataFile object.
User need to addfailureEvent,MaintenanceEventandrepairReplaceEvent indataFile object.
PM-W-0051 You must provideassetType,nextMaintainance,manufacturedDate andwellMaintainThresholdin theentityPropertyFileobject
After user edittranslation fileassetType,nextMaintainance,manufacturedDate orwellMaintainThresholdcan not be found inentityPropertyFileobject.
User need to addassetType,nextMaintainance,manufacturedDateandwellMaintainThresholdin dataFile object.
PM-W-0052 We found "key":"value"pairs in the translationfile that duplicatecolumn titles in the fileX. "key" must use adifferent name thancolumn titles
User use a columnname in file x as Keyin translation file.
Change either columnname in file x or Keyin translation file.
Chapter 5. Using a big data configuration 183
Table 26. Maximo APM - Predictive Maintenance Insights On-Premises error codes,messages, explanations, and corrective actions (continued)
Error code Error message Explanation Action
PM-W-0053 X rows contain anempty asset id in theuploaded file Y
Asset id is null in FileY
Provide a value forAsset id in File Y, andupload it again.
PM-W-0055 No asset type wasfound for X assets inevent file Y
System didn’t foundasset type related to xnumber of assets infile Y.
Upload an entityproperty file containrelation between assetand its asset type.
PM-W-0056 The schema in file Xdoes not match theprevious model, so wecannot score themodel. You mustmanually train a newmodel
Auto scoring processfound uploaded file xcolumns didn’t matchprevious trainedmodel.
Edit file x to makecolumns consistentwith previous model,or click retrain buttonto retrain a newmodel.
PM-W-0057 There is no failureevent in file X
Prescriptivemaintenance analysisrequire failure eventin event file, but file xdoesn’t have it. File xwill automaticallydelete from system.
Add failure event infile x then upload itagain.
PM-W-0058 The event data forasset type X is notsufficient to build amodel
To build analyticmodel it required atleast 10 record. Butdata for asset type xdoesn’t have enoughdata.
Upload more data forasset type x and clickretrain button toanalysis it.
PM-W-0059 The model is notaccurate for asset typeX
Analytic model isbuilt, but the modelaccuracy is very low.
Upload morehistorical event dataand click retrain toanalysis.
PM-W-0060 Event data for assettype X cannot fit amodel
Asset type x can’tbuild a model withcurrent event data
Upload morehistorical event dataand click retrain toanalysis.
PM-W-0061 The model builtsuccessfully, but theentity property file didnot contain the nextplanned maintenancedate. Margin cannot becalculated.
Entity property forthis model doesn’tcontained nextplanned maintenancedate. Model scorecannot completewithout that date.
Upload new entityproperty filecontained nextplanned maintenancedate. And click retainto analysis.
PM-W-0062 The asset type X wasanalyzed successfully
Asset type x hasfinished analysissuccessful.
PM-W-0063 The asset type X wasscored successfully
Asset type x hasfinished scoresuccessful.
184 IBM Maximo Asset Performance Management - Predictive Maintenance Insights On-Premises
Table 26. Maximo APM - Predictive Maintenance Insights On-Premises error codes,messages, explanations, and corrective actions (continued)
Error code Error message Explanation Action
PM-W-0064 The asset type Xanalysis failed
Asset type x fail toanalysis.
Click retrain toanalyze. If problemstill exist contactsupport, and provideevent data and entityproperty data forfurthertroubleshooting.
PM-W-0065 The asset type Xscoring failed
Asset type x fail toscore.
Make sure dataschema is consistentwith previous buildmodel. And clickretrain button. Ifproblem still existcontact support, andprovide event dataand entity propertydata for furthertroubleshooting.
PM-W-0066 The uploaded file X isnot a valid json file
User uploaded file xis doesn’t containedcorrect JSON format
Check file x and fixincorrect format.
PM-W-0067 The asset id X scoringfailed
Asset id x score failed Make sure the assetcontains event dataand that the dataschema is consistentwith the previousbuild model. Click theretrain button. Ifproblem still exists,contact support andprovide event dataand entity propertydata for furthertroubleshooting.
PM-W-0068 The asset id X wasscored successfully
Asset id x scoresuccessfully
Chapter 5. Using a big data configuration 185
Top Related