ibm® watson iot · 2020. 10. 19. · 1. the client must be on maximo 7.6.0.5 or higher release 2....

IBM® Watson IoT Maximo Asset Management – Version 7.6 Release

Maximo 76 Cognos Analytics 11 Release 7 Installation Guide LDAP/Active Directory Security Authentication only December 2017

CONTENTS

Revision History iii

Overview 4

Feature Considerations 5

Integration Installation Steps 7

Prerequisite Steps 8

1 Create namespace in Cognos Configuration 9

2 Configure Maximo System Properties For Cognos 11

3 Create A Data Source in Cognos Administration 13

4 Cognos Analytics Web Based Modeling 20

5 Verify Integration Configuration 21

Security Access Troubleshooting 23

Logging and Troubleshooting Information 25

Reference Materials 26

© Copyright International Business Machines Corporation 2017 US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Maximo Cognos Analytics Integration Installation

iii

REVISION HISTORY

Date Version Revised By Comments

December 2017 PD Initial Release

OVERVIEW

Starting with Maximo 7.6.0.5, a certified integration to IBM Cognos ® Analytics release 7 is available. This integration extends the data analysis capabilities into the self-service reporting and dashboard features provided by Cognos Analytics. This certified integration is applicable with the following conditions 1. You must have your own licenses of Cognos Analytics Release 7 2. You must use LDAP or Active Directory for Security Authentication Additionally, this certification enables your users to access the Cognos Analytics environment from Maximo only. It does not include the publishing of Cognos packages from Maximo’s Integration Framework. For more details on this certified integration, see the section below titled ‘Integration Considerations’

Due to the complexity of this integration, it is highly recommended that you first review all features of this guide – along with the Cognos Analytics installation - before proceeding. Details on this document, along with other Maximo BI documentation, can be found in the Reference Materials section at the end of this guide. Please note that the user performing the Integration Installation must be very experienced and knowledgeable with both the Maximo Architecture, and the Cognos Analytic products. The integration installation requires in depth knowledge of Maximo, as well as in depth knowledge in Cognos Administration Functionality, including defining data sources and creating namespaces.


5

FEATURE CONSIDERATIONS

The Maximo 7.6.0.5 and above Cognos 11 Release 7 integration is applicable only under the following conditions 1. The client must be on Maximo 7.6.0.5 or higher release 2. The client must have their own Cognos 11 Release 7 license 3. The client must use either an LDAP or Active Directory security authentication model The Maximo 7.6.0.x Cognos 11 Release 7 does not include support for 1. Maximo Custom Security Provider – or MXCSP – security authentication for the integration between Maximo 7.6 and Cognos 11. 2. Publishing of Cognos 11 packages from Maximo’s 7.6 Integration framework application. Note: Any previously published Cognos packages created from a Maximo 7.6 Cognos 10.2.1.1 upgrade should upgrade to your new Cognos 11 environment. 3. Any Maximo 7.6 delivered reports, packages or workspaces are not enabled for a Cognos 11 environment. This content in the directory path shown below are intended for Cognos 10.2.1.1 environments only. <maximo76>\reports\cognos\Packages 4. Multi-tenant environments

Additionally, please note that depending on your configuration, you may see a variety of sign-on pages in Cognos. Items that impact what you see include: 1. If you have multiple Cognos namespaces, your users will be prompted to first select a namespace.

2. If you have LDAP – but do not have SSO configured – your users will be prompted to enter their username and password as shown here.


7

INTEGRATION INSTALLATION STEPS

The integration installation is for Maximo 7.6.0.5 and future releases with Cognos Analytics Release 7. Cognos Analytics Release 7 is also referred to as Cognos 11 R7, and the terms will be used interchangeably in this guide. Due to the variety of tasks being performed, the integration steps below must be carefully performed. Prerequisite Tasks Install Cognos Analytics Release 7 and Cognos Framework Manager Integration Installation Tasks 1. Create Namespace in Cognos Configuration 2. Configure Maximo System Properties for Cognos 3. Create a Data Source in Cognos Administration 4. Verify Integration Configuration

PREREQUISITE STEPS

Install Cognos Analytics Release 7 Before beginning this integration installation, the Cognos 11 R7 Analytics Server must be installed per the Cognos Installation process. Notes: 1. It is HIGHLY recommended that you do not install the default Cognos Content Database as it is a small Derby database intended for small development/test environments only. It is not intended to be used for Production Environments. 2. Unlike the Maximo Cognos 10 installation, with Cognos 11, there is no need to install and configure a HTTP server. Cognos 11 comes with an embedded WebSphere Application server.

After installing the Cognos Analytics, you may want to install Cognos Framework Manager (FM). FM is a windows-only installation. For more details, access https://ibm.co/2xhzN4B Reference Materials Cognos Analytics Installation documentation https://ibm.co/2fMtfov2.


9

1 CREATE NAMESPACE IN COGNOS CONFIGURATION

The Cognos namespace contains the Cognos Objects, such as groups, roles, data sources and contacts. In the Maximo Cognos Integration, this namespace is used for Security Group authorization.

Note: If you have an LDAP namespace already configured for Cognos, you can use it for the Maximo Integration. Be sure to note its details, and skip the rest of this section.

If you do not have an LDAP namespace configured, follow the steps below. Be sure to have all the details of your LDAP configuration before proceeding.

1A. Access Cognos Configuration. (Select Cognos – Cognos Configuration from your Program Menu) In the Explorer View , navigate to Security – Authentication

1B. Click on New Resource – Namespace.

1C. Enter your applicable values. An example of a LDAP Namespace is shown below

Note: 1. Namespace changes If you modify the namespace at any time, be sure to fully exit out of Cognos Configuration. Then, restart the Cognos services for the new namespace to take effect. 2. For additional information on configuring namespaces with Cognos 11, access the link below https://ibm.co/2xYSpda


11

2 CONFIGURE MAXIMO SYSTEM PROPERTIES FOR COGNOS

Property values are required to enable Maximo to pass the correct information to Cognos. View the information below to set each property value. 2A. Log into Maximo as the System Administrator. Go to the System Properties application. 2B. Locate the Cognos Property Values by selecting filter, and in the property name field, enter Cognos. 2C. Define each of the values as described below, and the perform a ‘Live Refresh’ in the application. Additional details on the property values are provided in the chart and the text below.

Property Name Description Used For 1 mxe.report.cognos.serverURL Cognos Dispatcher/Gateway URI. Used

for Maximo to access the Cognos Application.

Cognos access

2 mxe.report.cognos.namespace Cognos Namespace which holds information on Users, Security Groups and Roles.

Cognos access

3 mxe.report.cognos.datasource Connects to the Maximo database for report development and execution.

Dashboards and reports

4 mxe.report.cognos.db.schemaName Maximo database schema name Dashboards and reports

5 mxe.report.cognos.db.type Maximo database type Dashboards and reports

6 mxe.report.cognos.db.sql.name For clients using a SQL Server Database, this is the catalogue name associated with the database

Dashboards and reports

7 mxe.report.cognos.maxappurl Maximo Web Application URL for Cognos User Authentication

Access to Cognos outside of Maximo

mxe.report.cognos.serverURL - The path to the Cognos Dispatcher. This is used by Maximo to access the Cognos applications. Because client configurations may vary, review your configuration carefully so the correct value from Cognos Configuration is used. An example of the Cognos Server url is: http://9.11.222.33:9000/bi/v1/disp Note: 1. If you are upgrading from Maximo 76 with Cognos 10.2.1.1, the mxe.report.cognos.serverURL for Cognos 11 will be different.

mxe.report.cognos.namespace - This is the Cognos Namespace ID value. This is the LDAP namespace ID you created in Step 1. PLEASE NOTE: This value is case sensitive.

mxe.report.cognos.datasource - The Cognos Data Source connects to the Maximo database for report development and execution. This will be created in the next step. - This datasource name must be upper case. mxe.report.cognos.db.type - This property can have 1 of the 3 Values below "DB2" for DB2 "OR" for ORACLE "SS" for SQL-Server mxe.report.cognos.db.sql.name - Required system value for SQL Server databases only. It identifies the catalogue name associated with the database. mxe.report.cognos.db.schemaName - Defines the database schema name from which the metadata will be extracted. *NOTE: This value may have to be entered in Uppercase depending on your database type (ex. This is a requirement for Oracle and DB2) mxe.report.cognos.maxappurl - This is needed for user authentication against the maximo web app url. If your Maximo URL for example is: http://maximoserver1:9998/maximo then this value would be http://maximoserver1:9998/maximo


13

3 CREATE A DATA SOURCE IN COGNOS ADMINISTRATION

The Cognos Data Source connects to the Maximo database for report development and execution. This can be your production database, or a replicated copy of your Maximo database for reporting. Prerequisites: Database Client: 1. If Cognos is installed on a machine that IS NOT YOUR database server, confirm that you have installed the specific database client on the Cognos 11 Server. Specific Database Items to Note: 1. If you are using SQL Server, confirm you have an ODBC connection from Cognos to the Sql Server database. 2. If you are using DB2, you must catalog your database. 3. If you are using Oracle, confirm that the TNS name is defined on the Cognos server. To create the Data Source, first access and confirm your integration from Maximo to Cognos. 3A. Confirm that the Cognos services are started and the Cognos Server is available. 3B. Log into Maximo as a user with administration privileges to access Cognos, for example maxadmin. 3C. in Maximo’s Report Administration application, select ‘Launch Cognos Administration’ This will take bring up a separate browser session where Cognos Administration is displayed.

3D. To verify the Maximo Users and Security Groups are available in Cognos, click on the Security Tab. Your configured namespace of LDAP should display as shown below.

3E. Select the namespace, and your users should appear.

3F. Begin to create your data source. Click on the Configuration tab and highlight Data Source Connections


15

3G. Click on the new Data Source Icon .

3H. Enter the name of your database used in mxe.report.cognos.datasource in UPPERCASE.

Click Next.

3I. Select a Database Type. In this example, the database type is Oracle. Disable the ‘Configure JDBC Connection’ check box. Click Next.

3J. Enter any specific values for your data base type.

(See section below for more details on Oracle and Sql Server databases)

Navigate to the bottom of the page and check password under the Sign On Section. Enter the database User ID and Password. This user needs to be able to read data from all Maximo tables

3K. Scroll down and click Test the connection...

3L. A message will display that the test was completed successfully. Click Close and then Finish.

Your Data Source is now configured.


17

Considerations for creating Oracle and Sql Server Data sources 1. If you are using an Oracle database, you will be prompted during to enter a SQL* Net connect string during the configuration. This string should match the service name you configured in Oracle TNS Names file as shown in the examples below.

2. If you are using a Sql Server database, set the database type to SQL 2008 Native Client (SQL Server Native Client) as shown below. If you do not specify the native SQL Server driver, you may run into issues when executing Cognos reports with certain date types.


19

Data Source Troubleshooting 1. If the data source does not connect successfully and you see "DPR-ERR-2002" error or "DPR-DPR-1035" in cogserver.log, restart your cognos server. 2. Missing dll Error If you are using a native database driver - not a JDBC connection - and you receive a message that dll's are missing while testing the connection, follow the steps below For Oracle: Copy the oci.dll from the client install of Oracle to <Cognos>\c11\bin For DB2: Copy all dll’s from the client install of DB2 to <Cognos>\c11\bin Reference Material Link For additional information on configuring data sources, access the link below https://ibm.co/2yINP07

4 COGNOS ANALYTICS WEB BASED MODELING

A number of new features are available with the Cognos Analytics release, including Web based modeling. Web based modeling enables you to select and join specific database objects in a simplified, visualized user interface. These web based models can then be used for report or dashboard development.

Web based modeling supplements the Cognos meta data models created from Cognos Framework Manager.

If you will be using Web based modeling,

4A. Copy the database JDBC drivers to the <cognos install directory>/drivers folder.

4B. Restart the Cognos server

4C. Configure your data source for web-based modeling by

1. Accessing Cognos Analytics. Go to Manage > Administration console.

2. In the Configuration tab, select Data source connections.

3. Locate the data source, and click its Set properties action.

4. On the Connection tab, enable ‘Allow web-based modeling’ check box.

5. Save.


21

5 VERIFY INTEGRATION CONFIGURATION

To test that your integration has been completed properly, confirm that you can launch to Cognos via the following access points 1. Maximo Report Administration A. Log into Maximo as an administration with access to Report Administration. B. From the action menu, select ‘Cognos Administration’ C. A separate browser window will appear. D. The administrator is then brought over to the Cognos Administration page.

2. Maximo Start Center A. Log into Maximo as a user with security privileges to the Cognos application B. From the menu, select ‘Analytics – Cognos Reporting’ C. A separate browser window will appear. D. The user is then brought to the home Cognos Analytics page.

3. Within a Maximo Application A. Log into Maximo as a user with security privileges to the Cognos Reporting action within a Maximo application B. Within the action menu of the application, select ‘Reporting’ C. A separate browser window will appear. D. The user is then brought to the home Cognos Analytics page.

4. Direct sign on to Cognos – without going thru Maximo A. Locate the system property titled mxe.report.cognos.serverURL B. Copy/paste the value for this url into a browser C. The Cognos sign in page appears D. After logging in, you are brought to the home page of Cognos.


23

SECURITY ACCESS TROUBLESHOOTING

If you are unable to access Cognos from within the Maximo environment because you do not see the launch points detailed above, confirm security access has been granted. 1. To launch to Cognos administration from Maximo Report Administration A. Go to Maximo’s Security group application B. Filter on ‘report administration’ C. Enable ‘Launch Cognos Administration’ Additionally, enable the other options below if needed D. Enable ‘Cognos reporting’ if you want to launch to the Cognos home page from Maximo’s Report Administration E. Enable ‘Display the Cognos Package information if Report Type = Cognos’ If you want to see the Cognos package information for registered Cognos reports in Maximo F. Save

2. To launch to Cognos from the Maximo Start Center or menu A. Go to Maximo’s Security group application B. Filter on ‘cognos’ C. Enable ‘Cognos Reporting Application’ D. Save.

To launch to Cognos from within a Maximo application A. Go to Maximo’s Security group application B. Filter on the specific application. In this example, it is ‘assets’ C. Under the Options section, Enable ‘Cognos Reporting’ D. Save.


25

LOGGING AND TROUBLESHOOTING INFORMATION

1. Log Files If you have issues enabling the Maximo Cognos Integration, review the information in either the Maximo, Cognos or database logs 2. Cognos Logging Utilize this Cognos log file for more details on troubleshooting the integration: cogserver.log located in <Cognos>\c11\logs 3. Database Logging If reports not executing as expected, utilize the database log files for more details If you are using DB2 Navigate to <Cognos>\c11\bin and locate cogdmd2.ini. Open the file, and locate the [TRACE] section. Uncomment the lines: ;[TRACE] ;Output=<my trace file> ;Timer=yes Next, specify the output file (and path) where you want to save the file in place of <my trace file>. Restart the Cognos Server. If you are using Oracle Navigate to <Cognos>\c11\bin and locate cogdmor.ini. Open that file, and locate the [TRACE] section. Uncomment the lines: ;[TRACE] ;Output=<my trace file> ;Timer=yes Next, specify the output file (and path) where you want to save the file in place of <my trace file>. Restart the Cognos Server.

REFERENCE MATERIALS

Additional information can be found at the sites below

Maximo Report Reference materials http://ibm.co/1osSHAb Maximo Supported product matrix http://ibm.co/M4et40

Cognos Analytics installation documentation https://ibm.co/2fMtfov Cognos Analytics supported matrix http://www-01.ibm.com/support/docview.wss?uid=swg27047186 Cognos Analytics community https://www.ibm.com/communities/analytics/cognos-analytics/


27

Notices This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A.

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at “Copyright and trademark information” at www.ibm.com/legal/copytrade.shtml. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both

ibm® watson iot · 2020. 10. 19. · 1. the client must be on maximo 7.6.0.5 or higher release 2....

Documents