Copying files from Maximo Manage to report development environment

Copy script files, database drivers, database JAR files, and property files from an existing or locally set up Maximo Manage instance to the BIRT directory structure.

Before you begin

  • Install the rsync utility tool, which you can use to transfer files from Maximo Manage to your development environment. For more information see, Transferring Files In and Out of Containers in OpenShift®.
  • If you want to set up a local Maximo Manage instance, install a container engine such as Docker.

About this task

The following files and folders must be copied from a Maximo Manage instance to your local report development environment:
libraries
The libraries directory contains library, resource, and property files that are required to support the report design files.
reports
The reports directory contains content for the standard reports that are delivered with Maximo Manage.
scriptlibrary
The scriptlibrary directory contains script library classes and the mxreportdatasources.properties file that the BIRT Designer tool uses to connect to databases.
Note: If you modify the mxreportdatasources.properties file at any point, you must restart Eclipse.
templates
Twelve template files are used as a starting point in creating report design files. When you create a report, you must start with one of the templates because they contain the required scripted data source and library files that are needed for the integration.
JAR file
The JAR file for the JDBC driver of your database stores class files for reports.

Procedure

  1. Get the required access token for Maximo Manage.
    1. Log in to the Red Hat® OpenShift web console as an administrator.
    2. From the account menu, select Copy login command.
    3. Click Display Token.
    4. In the Log in with this token field, copy the oc command.
  2. In a Linux® shell in your BIRT development environment, run the oc command that you copied from the Log in with this token field.
  3. Open the Maximo Manage project by running following command in the Linux shell:
    oc project <Name of the Maximo Manage project>
    For example,
    oc project mas-build-manage
  4. To find the name of your Maximo Manage admin pod, open a Linux shell and run the following command:
    oc get pods
    The admin pod is the pod that includes maxinst in the name. Take a note of the full pod name to use in the next step.
  5. If you do not have administrator access to an existing Maximo Manage instance:
    1. Deploy a local instance of Maximo Manage.
    2. Configure Maximo Manage to store images in an external registry. For more information, see Storing images in an external registry.
    3. Retrieve the administrative image and instantiate it in a container engine, such as Docker. For more information, see Retrieving administrative images.
  6. Copy the following files and folders from the Maximo Manage instance to your local report development environment.
    1. For the script library, copy the folder that contains the script classes from any temporary download location to Eclipse, as shown in the following example.
      Copy the classes folder from:
      <temporary_directory>/reports/birt/scriptlibrary/classes
      to
      <birt_version>/eclipse/plugins/org.eclipse.birt.report.viewer_<version>/birt/WEB-INF/
    2. For the database driver, copy the database driver file from any temporary download location to the following location in Eclipse:
      <birt_version>/eclipse/plugins/org.eclipse.birt.report.viewer_<version>/birt/WEB-INF/lib
    3. Open the database JAR file that you copied and extract the contents of the JAR file to a location that is similar to the following example:
      <birt_version>/eclipse/plugins/org.eclipse.birt.report.viewer_<version>/birt/WEB- INF/classes
    4. Update the mxreportdatasources.properties file, which defines the connection from the BIRT designer to the Maximo Manage database, from the <birt_version>/eclipse/plugins/org.eclipse.birt.report.viewer_<version>/birt/WEB-INF/classes location, with the following parameters for your database:
      • Database URL
      • Database driver
      • Database username
      • Password schema owner
  7. Restart the BIRT development environment.

Example

The following example is configured with sample values for a Db2® database:
#<DataSourceName>.<propertyName>=value
# driver for ORACLE
# oracle.jdbc.OracleDriver
# sample url for ORACLE
# jdbc:oracle:thin:@<HOST>:<PORT>:<SID>
# sample schemaowner for ORACLE
# maximo
# driver for SQLServer
# com.microsoft.sqlserver.jdbc.SQLServerDriver
# sample url for SQLServer
# jdbc:sqlserver://hostname:port;databaseName=dbname;integratedSecurity=false;
# sample schemaowner for SQLServer
# dbo
# driver for DB2
# com.ibm.db2.jcc.DB2Driver
# sample url for DB2
# jdbc:db2://localhost:50000/dbalias
# sample schemaowner for DB2
# maximo
maximoDataSource.url= jdbc:db2://IBM-A5:50000/DB2A maximoDataSource.driver=com.ibm.db2.jcc.DB2Driver
maximoDataSource.username=henryl
maximoDataSource.password=henryl
maximoDataSource.schemaowner=maximo