Вы находитесь на странице: 1из 56

Tivoli IBM Maximo for Oil and Gas

Version 7.1.1

Installation Guide

Note Before using this information and the product it supports, read the information in Notices on page 47.

This edition applies to version 7, release 1, modification 1 of IBM Maximo for Oil and Gas and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright International Business Machines Corporation 2008, 2009. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Contents
Chapter 1. Installation overview . . . . 1 Chapter 2. Updating environment data
Updating database properties. . . Updating installation properties . . Updating the WebSphere Application Deployment host name . . . . .

. 3

. . . . . . 3 . . . . . . 4 Server Network . . . . . . 4

Loading organizations to the external system . . Loading sites to the external system . . . . . Loading locations to the external system. . . . Loading assets to the external system. . . . . Loading location meters to the external system . Loading asset meters to the external system . . Disabling the external system for initial file loads.

. . . . . . .

27 27 28 28 29 29 30

Chapter 3. Software requirements

. . . 7 9

Chapter 13. Updates to integration data 31


Configuring the integration infrastructure for data updates. . . . . . . . . . . . . . . Retrieving the Web addresses for Web services . Configuring the end points for Web services . . Deploying Web services . . . . . . . . . Enabling the external systems for Web Services . . . . . . 31 31 32 32 33

Chapter 4. Preparing for the installation

Chapter 5. Installing Maximo for Oil and Gas . . . . . . . . . . . . . . . . 11 Chapter 6. Deploying the EAR files on Oracle WebLogic Server . . . . . . . 13 Chapter 7. Adding Map tabs to Maximo for Oil and Gas applications . . . . . 15 Chapter 8. Integration components provided with Maximo for Oil and Gas . 17 Chapter 9. Date formats . . . . . . . 19 Chapter 10. Maximo for Oil and Gas Web service handler . . . . . . . . . 21 Chapter 11. Configuring the integration infrastructure for initial file loads . . . 23
Adding MIMOSA enterprise identifiers in Maximo for Oil and Gas . . . . . . . . . . . . Updating system properties . . . . . . . . Enabling the publish channels for initial file loads Enabling the external system for initial file loads . Activating the integration cron task . . . . . . 23 . 24 24 . 25 . 25

Chapter 14. Maximo for Oil and Gas integration components . . . . . . . 35


Integration components for Maximo for Oil and Gas . Integration components for Maximo for Oil and Gas . data transfers from . . . . . . . data transfers to . . . . . . . . . . 35 . 35

Chapter 15. Web service operations . . 37 Chapter 16. Maximo for Oil and Gas integration mappings . . . . . . . . 39
Organization mapping. . . . . . . Site mapping . . . . . . . . . . Location mapping . . . . . . . . Asset mapping . . . . . . . . . Location meter mapping . . . . . . Asset meter mapping . . . . . . . Defect and incident mapping (locations) . Defect and incident mapping (assets) . . Work order mapping (locations) . . . Work order mapping (assets) . . . . Meter reading mapping (locations) . . Meter reading mapping (assets) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 39 40 40 41 42 43 43 44 45 45 46

Chapter 12. Initial loads of integration data . . . . . . . . . . . . . . . . 27

Notices . . . . . . . . . . . . . . 47
Trademarks . . . . . . . . . . . . . . 48

Copyright IBM Corp. 2008, 2009

iii

iv

IBM Maximo for Oil and Gas: Installation Guide

Chapter 1. Installation overview


Installing IBM Maximo for Oil and Gas involves installing the product, deploying the EAR files, and configuring the software. You can start the installation programs from the launchpad. To install Maximo for Oil and Gas, you complete the following tasks: 1. If you are upgrading from Maximo for Oil and Gas version 7.1, update your environment data. 2. Prepare to install. 3. Install Maximo for Oil and Gas. 4. For Oracle WebLogic Server environments only: Deploy the EAR files.

Copyright IBM Corp. 2008, 2009

IBM Maximo for Oil and Gas: Installation Guide

Chapter 2. Updating environment data


When you install a fix pack or upgrade an existing installation, the installation program uses values that are recorded from the previous deployment. If anything in your environment changed since the original deployment, you must record these changes in properties files before you can install Maximo for Oil and Gas.

About this task


If you made environmental changes to any of the systems in the original deployment, such as changing a host name or updating a password, the changes must be recorded in the install.properties and maximo.properties files on the administrative system. When the product installation program runs an upgrade task, it attempts to use values in the install.properties file and the maximo.properties file. During the upgrade process, if the user name or password for a system is not updated, the installation program uses the credentials in the properties files. If the installation program cannot log in to a system with the credentials found in the properties files, you are prompted to supply the correct information. Updated values are written to the appropriate property file. This method of updating credential information in property files has one exception; database connection and credential information must always be current before you attempt an upgrade operation. Database connection information and credential information are stored in the maximo.properties file. Any changes to this information from the time of the original deployment must be manually recorded in the maximo.properties file before you begin an upgrade from version 7.1 to version 7.1.1. When you change the value of the WebSphere Application Server Network Deployment host name (WAS.DeploymentManagerHostName), in addition to updating this property value in the install.properties file, you must also update a property for the WebSphere Application Server Network Deployment thin client in the thinwasadmin.bat file and then run that file.

Updating database properties


Before you can install Maximo for Oil and Gas, you must record any database changes that have been made in your environment since the original deployment. Update database properties in the maximo.properties file.

Procedure
1. Change to the product_home\maximo\applications\maximo\properties directory. The default location is C:\IBM\SMP\maximo\applications\maximo\ properties. 2. Back up the maximo.properties file. 3. 4. 5. 6. Delete the maximo.properties file. Change to the product_home\etc directory. Back up the maximo.properties_orig file. Save this backup copy permanently. Rename the unencrypted maximo.properties_orig file to maximo.properties.

Copyright IBM Corp. 2008, 2009

7. Copy the maximo.properties file to the product_home\maximo\applications\ maximo\properties\ directory. 8. Edit the maximo.properties file and update the credential or connection information for the database server. 9. Save the file. 10. Run the encryptproperties.bat file in the product_home\maximo\tools\ maximo\ directory on the file to encrypt it.

What to do next
Update the installation properties in the install.properties file.

Updating installation properties


Before you can install Maximo for Oil and Gas, you must record any installation program properties changes that have been made in your environment since the original deployment. Update installation properties in the install.properties file.

Before you begin


Update the database properties in the maximo.properties file.

Procedure
1. Change to the product_home\etc directory. 2. Edit the install.properties file and make updates. Do not change encrypted properties, which are prefixed by [enc]. You are prompted for updated values during the update operation. These values are written to the install.properties file. 3. Save the file.

What to do next
Update the WebSphere Application Server Network Deployment host name.

Updating the WebSphere Application Server Network Deployment host name


Before you can install Maximo for Oil and Gas, you must update the WebSphere Application Server Network Deployment host name that was used in the previous deployment.

Before you begin


Update the installation properties in the install.properties file.

Procedure
1. Update the WebSphere Application Server Network Deployment host name that was used in the previous deployment. 2. Update the WAS.DeploymentManagerHostName value in the install.properties file. 3. Edit the C:\IBM\SMP\WASClient\thinwasadmin.bat file.

IBM Maximo for Oil and Gas: Installation Guide

4. Update the following line of the file with the new, fully qualified, host name of the WebSphere Application Server Network Deployment server. set wsadminHost=-Dcom.ibm.ws.scripting.host=fully-qualified host name. 5. Run the thinwasadmin.bat file with these values: thinwsadmin.bat -domain manager user name -password. 6. When prompted, indicate that you do want to download the truststore file.

Results
After completing these updates, you can upgrade, install a fix pack, or install a product by using the corrected values.

Chapter 2. Updating environment data

IBM Maximo for Oil and Gas: Installation Guide

Chapter 3. Software requirements


Ensure that you meet the software requirements before you install IBM Maximo for Oil and Gas 7.1.1. You install Maximo for Oil and Gas on a Microsoft Windows administrative workstation. The Maximo for Oil and Gas EAR files are built on the Windows workstation and later deployed to the application server.

Base requirements
Ensure that IBM Maximo Asset Management 7.1 is installed on the same Windows administrative workstation where you plan to install Maximo for Oil and Gas 7.1.1, and in the same language as Maximo for Oil and Gas 7.1.1. Ensure that Maximo Asset Management has the 7.1.1.6 or later fix pack installed.

Copyright IBM Corp. 2008, 2009

IBM Maximo for Oil and Gas: Installation Guide

Chapter 4. Preparing for the installation


When you install Maximo for Oil and Gas, you modify the configuration and content of your application servers, database server, and directory server. These servers are referred to as the middleware servers. Before you install Maximo for Oil and Gas, you must complete tasks on these middleware servers and your administrative workstation.

Procedure
1. Gather login information for the middleware servers. The installation program requires access to the middleware servers that are installed with Maximo Asset Management to complete the installation. You need the administrative user IDs and passwords for the middleware servers. 2. Back up the middleware servers and administrative workstation. 3. Prepare the application server:
Application server WebSphere Application Server What to do Ensure that the middleware servers are started. The installation program connects to the middleware servers by using the middleware login information that you specify during the product installation. Ensure that the application server (MAXIMOSERVER) is stopped. If the application server is running, stop the server and wait a few minutes before you start the installation program. If the application server is not stopped, the installation process stops.

WebLogic Server

4. If you run the installation program in a double-byte language or an eastern European language, set the workstation regional settings to that language. You can reset your regional settings after you complete the installation.

Copyright IBM Corp. 2008, 2009

10

IBM Maximo for Oil and Gas: Installation Guide

Chapter 5. Installing Maximo for Oil and Gas


Use the launchpad to install Maximo for Oil and Gas.

Procedure
1. Start the launchpad. The launchpad is automatically started when you run the product DVD. If the Windows autorun feature is disabled, you can start the launchpad by running the launchpad.exe program from the root directory of the product DVD. If you cannot start the launchpad, navigate to the product_home\bin directory and double-click the solutionInstallerGUI.bat file. 2. 3. 4. 5. Click Install the Product. Click IBM Maximo for Oil and Gas 7.1.1. Select a language for your installation, and click OK. If you started the installation program from the solutionInstallerGUI.bat file, select OilAndGas711.zip from launchpad_root\Install\OILINSTALL. 6. Follow the steps in the installation program. 7. On the additional language support features panel, select the option box to specify whether you want the installation program to install additional languages.

8. If you use WebSphere Application Server, in the package options panel that shows the deployment options, ensure that the Package Options check box is cleared to redeploy the EAR files and to update the Maximo database. 9. Follow the steps in the installation program. 10. When the installation is complete, from the Package Successfully Deployed window, click Done.

What to do next
If you want to check the results of the language package installation, review the language package installation log file, TDToolkitdate-time.log, in the product_home\maximo\tools\maximo\log directory. If you use WebLogic Server, manually redeploy the EAR files. If you use WebSphere Application Server, the installation is complete. Add Map tabs to Maximo for Oil and Gas, if applicable, or configure the integration infrastructure for initial file loads.

Copyright IBM Corp. 2008, 2009

11

12

IBM Maximo for Oil and Gas: Installation Guide

Chapter 6. Deploying the EAR files on Oracle WebLogic Server


If you use Oracle WebLogic Server, after you install IBM Maximo for Oil and Gas, you must deploy the EAR files from the WebLogic console. Deploying the EAR files starts the application server.

Before you begin


v The EAR files must be deployed after the updatedb command is run. The updatedb command is run as part of the installation process. However, if you manually run the updatedb command, make sure that you do so before you deploy the EAR files. v On a Windows operating system, if the MAXIMOSERVER server is not running, start it from a command prompt. v On a UNIX operating system, ensure that the WebLogic Server daemon is running. To view the WebLogic console, you must have a Java virtual machine installed.

Procedure
1. Change to the mydomain directory.
Platform Windows Location From a command prompt, change the path to: drive:\BEA_installation_location\ user_projects\domain\mydomain Open a terminal window, or if you are using Telnet to connect from a Windows computer, open a command prompt, and change the path to: /home/mxadmin/bea/ user_projects/domains/mydomain

UNIX

2. Start the WebLogic Server.


Platform Windows UNIX Command to enter startWebLogic.cmd ./startWebLogic.sh

3. Start the MAXIMOSERVER administration console by typing the following URL in the address bar of your browser: http://hostname:7001/console. Press Enter. 4. Follow the instructions in the WebLogic console help to deploy the maximo.ear file and the maximohelp.ear file.

Results
The installation is complete.

Copyright IBM Corp. 2008, 2009

13

What to do next
Add Map tabs to Maximo for Oil and Gas applications, if applicable, or configure the integration infrastructure for initial file loads.

14

IBM Maximo for Oil and Gas: Installation Guide

Chapter 7. Adding Map tabs to Maximo for Oil and Gas applications
If you have installed and enabled a license for IBM Maximo Spatial Asset Management, you can add Map tabs to several Maximo for Oil and Gas applications when you install Maximo for Oil and Gas.

About this task


You can enable Map tabs in the following applications: v Assets (Oil) v Locations (Oil) v Service Requests (Oil) v Work Order Tracking (Oil)

Procedure
1. In the product_home\maximo\applications\maximo\properties\product directory, open the oilandgas.xml file. 2. Search for the following <extendpresentation> elements and remove the comment tags (<!-- and -->)) from each element: v <extendpresentation app=PLUSGWO baseapp=WOTRACK product=spatial> v <extendpresentation app=PLUSGSR baseapp=SR product=spatial> v <extendpresentation app=PLUSGASS baseapp=ASSET product=spatial> v <extendpresentation app=PLUSGLOC baseapp=LOCATION product=spatial> 3. Save the file. 4. Run the updatedb command again. 5. Regenerate the EAR files. 6. Redeploy the EAR files.

What to do next
Configure the integration infrastructure for initial file loads.

Copyright IBM Corp. 2008, 2009

15

16

IBM Maximo for Oil and Gas: Installation Guide

Chapter 8. Integration components provided with Maximo for Oil and Gas
The integration process transfers data between IBM Maximo for Oil and Gas and the IBM Chemical and Petroleum Integrated Information Framework and other MIMOSA OSA-EAI V3.2.1-based systems (external systems). The product includes integration components to transfer new and updated records of the following types from Maximo for Oil and Gas to the external system: v v v v v v Organizations Sites Locations Assets Meter readings for locations Meter readings for assets

The product includes integration components to transfer new records of the following types from the external system to Maximo for Oil and Gas. These records can be associated with assets or locations: v Defects v Incidents v Work orders v Asset meter readings v Location meter readings Validation is based on the MIMOSA schema [OSA-EAI-CRIS-XSD-V032]CRIS_complete_V3-2-1_[31-Dec-2008].xsd.

Copyright IBM Corp. 2008, 2009

17

18

IBM Maximo for Oil and Gas: Installation Guide

Chapter 9. Date formats


All dates exchanged by Maximo for Oil and Gas and a MIMOSA OSA-EAI V3.2.1-based external system must have the same format. Dates exchanged between the systems must be in the format yyyy-MMddTHH:mm:ssZ
Date element yyyy MM dd T HH mm ss Z Description Year Month Day Indicates that the following numbers represent a time Hour (00 - 23) Minute (00 - 59) Second (00 - 59) UTC zero offset indicator

Copyright IBM Corp. 2008, 2009

19

20

IBM Maximo for Oil and Gas: Installation Guide

Chapter 10. Maximo for Oil and Gas Web service handler
A system administrator must regularly monitor Maximo for Oil and Gas and the external system for data transfer errors. The PLUSGWEBSERVICE handler processes responses from the external system and can overwrite the Web service end point SOAP action. Each transaction that is used in the integration has a specific SOAP operation. The Web service handler processes responses as follows: v If the response is a success, the handler finishes processing the message. A success is indicated by a TRUE value for the success attribute on the <status> element of the response. v If the response is a failure, the handler marks the message for reprocessing. A failure is indicated by a FALSE value for the success attribute on the <status> element of the response. To reprocess the message, you use the Message Reprocessing application in the Integration module. This table displays the error responses that the external system sends to Maximo for Oil and Gas, and the mapping to the Maximo message.
message_code STAT_ERR_INPUT Message group plusgwebservice Message key inputError Message text The external system could not proceed with the operation because the message sent is incorrect. A technical error occurred in the external system.

STAT_ERR_TECH

plusgwebservice

techError

Copyright IBM Corp. 2008, 2009

21

22

IBM Maximo for Oil and Gas: Installation Guide

Chapter 11. Configuring the integration infrastructure for initial file loads
Maximo for Oil and Gas records are initially loaded to the external system through XML file transfers. Before you can load these files to the external system, you must perform several activities.

Before you begin


v Log on as a user in the MAXADMIN group. v Ensure that no users are logged on to Maximo for Oil and Gas. Do not enable any oil-and-gas-specific components in the Integration module until you obtain MIMOSA enterprise identifiers and associate them with Maximo for Oil and Gas organizations. Important: The names of the oil-and-gas-specific integration components (for example, object structures and external systems) begin with the prefix PLUSG. If you created any integration components that begin with PLUSG, the integration can fail.

Procedure
1. Obtain a MIMOSA enterprise_id for every active and inactive organization in Maximo for Oil and Gas. 2. Associate the MIMOSA enterprise identifiers with the Maximo for Oil and Gas organizations. 3. Update the system properties. Configure the JMS queues as described in the Integration Guide. Enable the publish channels for the initial file loads. Enable the external system for the initial file loads. Activate the integration cron task. Load organization, site, location, asset, location meter, and asset meter records to the external system. 9. Disable the external system for the initial file loads. 4. 5. 6. 7. 8.

Adding MIMOSA enterprise identifiers in Maximo for Oil and Gas


MIMOSA enterprise identifiers provide a common identifier in Maximo for Oil and Gas and in the external system. You must associate a MIMOSA enterprise identifier with every active and inactive organization in Maximo for Oil and Gas. If you do not associate a MIMOSA enterprise identifier with an organization, the organization record is ignored.

Before you begin


Obtain a MIMOSA enterprise identifier for every active and inactive organization in Maximo for Oil and Gas.

Copyright IBM Corp. 2008, 2009

23

Procedure
1. In the Organizations (Oil) application, display the organization record that you want to update. 2. On the Organization tab, in the Open Unique Identifier field, specify the MIMOSA enterprise identifier that corresponds to the organization. 3. Save the record.

What to do next
Update the system properties.

Updating system properties


You might need to update the mxe.int.globaldir and mxe.int.webappurl system properties. The mxe.int.globaldir property identifies the base directory for the files that are generated by the integration, for example, errors and output XML. The mxe.int.webappurl property identifies the IP address and port where Maximo for Oil and Gas is deployed.

Before you begin


Associate MIMOSA enterprise identifiers with Maximo for Oil and Gas organizations.

Procedure
1. In the System Properties application, select the mxe.int.globaldir property. Update fields as needed, and then save the record. 2. If you update the mxe.int.globaldir property, select the corresponding Select Record check box, and then select Live Refresh from the Select Action menu. 3. Select the mxe.int.webappurl property. Update fields as needed, and then save the record. Specify the server host as follows: http://<IP>:<port>/meaweb. 4. If you update the mxe.int.webappurl property, select the corresponding Select Record check box, and then select Live Refresh from the Select Action menu.

What to do next
1. Configure the JMS queues as described in the Integration Guide. 2. Enable the publish channels for the initial file loads.

Enabling the publish channels for initial file loads


Before you can transfer data to the external system, you must enable the publish channels for the record types to be transferred.

Before you begin


v Update the system properties. v Configure the JMS queues as described in the Integration Guide.

Procedure
1. In the Publish Channels application, on the List tab, select all the Maximo for Oil and Gas publish channels. a. In the Publish Channel field, type PLUSG, and then press Enter. b. Select the Select Records check box that is below the last row in the list.

24

IBM Maximo for Oil and Gas: Installation Guide

c. Select the Select All Records check box that is in the table header. 2. From the Select Action menu, select Enable Event Listener, and then verify that the Enable Listener check box is selected for every PLUSG publish channel.

What to do next
Enable the external system for the initial file loads.

Enabling the external system for initial file loads


The external system that is associated with the initial file loads is configured to process XML files. You must enable this external system before you can transfer any records.

Before you begin


Enable the publish channels for the initial file loads.

Procedure
1. In the External Systems application, select the PLUSGMIMDF external system. 2. On the System tab, select the Enabled check box, and then save the record. 3. On the Publish Channels tab, select every Enabled check box, and then save the record.

What to do next
Activate the integration cron task.

Activating the integration cron task


Before you can use the integration, you must activate the cron task that manages the integration.

Before you begin


Enable the external system for the initial file loads.

Procedure
1. In the Cron Task Setup application, select the JMSQSEQCONSUMER cron task. 2. On the Cron Task tab, in the Cron Task instances table window, select all the Active check boxes. 3. Save the record. 4. From the Select Action menu, select Reload Request. 5. In the Reload Request window, select the Select Row check boxes that correspond to the SEQQIN and SEQQOUT instance names. 6. Click OK, and then save the record.

What to do next
Load organizations to the external system.

Chapter 11. Configuring the integration infrastructure for initial file loads

25

26

IBM Maximo for Oil and Gas: Installation Guide

Chapter 12. Initial loads of integration data


The initial file loads ensure that the organization, site, asset, location, and meter data in IBM Maximo for Oil and Gas is available on the external system. You must load the data in the following sequence: 1. Organizations 2. Sites 3. 4. 5. 6. Locations Assets Location meters Asset meters

You also must import the files to the external system in the same sequence. If you do not, errors will occur.

Loading organizations to the external system


You load Maximo for Oil and Gas organization data to the external system to synchronize the organizations in the two systems. The application loads active and inactive organizations.

Before you begin


Activate the integration cron task.

Procedure
1. In the External Systems application, select the PLUSGMIMDF external system. 2. On the Publish Channels tab, select the PLUSGORGInterface publish channel. 3. Click Data Export. In the Data Export window, do not specify an export condition. 4. Click OK.

What to do next
1. Fix any errors that occurred. 2. Import the organization records into the external system. 3. Load the site records to the external system.

Loading sites to the external system


You load Maximo for Oil and Gas site data to the external system to synchronize the sites in the two systems. The application loads active and inactive sites.

Before you begin


Load organizations to the external system.

Copyright IBM Corp. 2008, 2009

27

Procedure
1. In the External Systems application, select the PLUSGMIMDF external system. 2. On the Publish Channels tab, select the PLUSGSITEInterface publish channel. 3. Click Data Export. In the Data Export window, do not specify an export condition. 4. Click OK.

What to do next
1. Fix any errors that occurred. 2. Import the site records into the external system. 3. Load the location records to the external system.

Loading locations to the external system


You load Maximo for Oil and Gas location data to the external system to synchronize the locations in the two systems.

Before you begin


Load sites to the external system.

Procedure
1. In the External Systems application, select the PLUSGMIMDF external system. 2. On the Publish Channels tab, select the PLUSGOPERLOCInterface publish channel. 3. Click Data Export. In the Data Export window, do not specify an export condition. 4. Click OK.

What to do next
1. Fix any errors that occurred. 2. Import the location records into the external system. 3. Load the asset records to the external system.

Loading assets to the external system


You load Maximo for Oil and Gas asset data to the external system to synchronize the assets in the two systems.

Before you begin


Load locations to the external system.

Procedure
1. In the External Systems application, select the PLUSGMIMDF external system. 2. On the Publish Channels tab, select the PLUSGASSETInterface publish channel. 3. Click Data Export. In the Data Export window, do not specify an export condition. 4. Click OK.

28

IBM Maximo for Oil and Gas: Installation Guide

What to do next
1. Fix any errors that occurred. 2. Import the asset records into the external system. 3. Load the location meter records to the external system.

Loading location meters to the external system


You load Maximo for Oil and Gas location meter data to the external system to synchronize the location meters in the two systems. The application loads all location meters, irrespective of their status.

Before you begin


Load assets to the external system.

Procedure
1. In the External Systems application, select the PLUSGMIMDF external system. 2. On the Publish Channels tab, select the PLUSGLOCMETERInterface publish channel. 3. Click Data Export. In the Data Export window, do not specify an export condition. 4. Click OK.

What to do next
1. Fix any errors that occurred. 2. Import the location meter records into the external system. 3. Load the asset meter records to the external system.

Loading asset meters to the external system


You load Maximo for Oil and Gas asset meter data to the external system to synchronize the asset meters in the two systems. The application loads all asset meters, irrespective of their status.

Before you begin


Load location meters to the external system.

Procedure
1. In the External Systems application, select the PLUSGMIMDF external system. 2. On the Publish Channels tab, select the PLUSGASSMETERInterface publish channel. 3. Click Data Export. In the Data Export window, do not specify an export condition. 4. Click OK.

What to do next
1. Fix any errors that occurred. 2. Import the asset meter records into the external system. 3. Disable the external system for initial file loads.

Chapter 12. Initial loads of integration data

29

Disabling the external system for initial file loads


The external system that is associated with initial file loads is configured to process XML files. Web services are used for subsequent updates. You must disable the current external system before you enable Web services, because parallel operation of file transfer and Web services can cause errors.

Before you begin


Load all data to the external system.

Procedure
1. In the External Systems application, select the PLUSGMIMDF external system. 2. On the System tab, clear the Enabled check box, and then save the record.

What to do next
Configure the integration infrastructure for data updates.

30

IBM Maximo for Oil and Gas: Installation Guide

Chapter 13. Updates to integration data


After you perform some configuration activities, the integration will automatically transfer new and updated records between Maximo for Oil and Gas and the external system. The integration process captures changes to active and inactive organizations and sites, and to locations, assets, and meters. An updated record is a record in which any field on the outgoing messages changes. You must associate a MIMOSA enterprise identifier with a new organization, or the organization record is not transferred to the external system. Note: Make changes to asset locations in Maximo for Oil and Gas, not in the external system. When a record is deleted in Maximo for Oil and Gas, the rstat_type_code attribute in the outgoing message contains a 3. The external system must recognize this code as a deletion and remove the record from its database. The rtype_stat_code attribute and the lcinfo attribute are used to indicate status. To see which fields and values are used for a record, see the integration mapping for that record type.

Configuring the integration infrastructure for data updates


You initially load data from Maximo for Oil and Gas to the external system using XML files. For subsequent updates, you use Web services.

Procedure
1. Retrieve the Web service URL for RegistryManagementServices and for TrendManagementServices. 2. Configure the end points for Web services. 3. Deploy Web services. 4. Enable the external systems for Web services.

Retrieving the Web addresses for Web services


Before you can configure the end points for Web services, you must know the Web addresses for RegistryManagementServices and TrendManagementServices. If you do not know the Web addresses, you can retrieve them from a WSDL file.

Before you begin


Disable the external system for initial file loads.

Procedure
1. Open the Web service wsdl file. 2. Locate the service element. One of the children of the element has a location attribute, which defines the Web address.

Copyright IBM Corp. 2008, 2009

31

What to do next
Configure the end points for Web services.

Configuring the end points for Web services


You configure end points to identify the Web service that processes outgoing data.

Before you begin


Obtain the Web addresses for RegistryManagementServices and for TrendManagementServices.

Procedure
1. In the End Points application, on the List tab, select the PLUSGMIMWSREG end point. 2. On the End Point tab, select the ENDPOINTURL property. 3. In the Value field, specify the Web service URL for RegistryManagementServices. 4. 5. 6. 7. 8. Select the SERVICENAME property, and update its value. Save the record. On the List tab, select the PLUSGMIMWSTREND end point. On the End Point tab, select the ENDPOINTURL property. In the Value field, specify the Web service URL for TrendManagementServices.

9. Select the SERVICENAME property, and update its value. 10. Save the record.

What to do next
Deploy Web services.

Deploying Web services


You must deploy Web services before new and updated information can be transferred between Maximo for Oil and Gas and the external system.

Before you begin


Configure the end points for Web services.

Procedure
1. In the Web Services Library application, on the List tab, select all the Maximo for Oil and Gas Web services. a. In the Name field, type PLUSG, and then press Enter. b. Select the Select Records check box that appears below the last row in the list. c. Select the Select All Records check box that is in the table header. 2. From the Select Action menu, select Deploy Web Service. Verify that the Is Deployed check box that corresponds to each PLUSG Web service is selected.

32

IBM Maximo for Oil and Gas: Installation Guide

What to do next
Enable the external systems for Web services.

Enabling the external systems for Web Services


To transfer updates between Maximo for Oil and Gas and the external system, you enable the enterprise services and publish channels that correspond to the record types to be exchanged.

Before you begin


Deploy Web services.

Procedure
1. In the External Systems application, select the PLUSGMIMWSREG external system. 2. On the System tab, select the Enabled check box. 3. On the Publish Channels tab, select every Enabled check box. 4. On the Enterprise Services tab, select every Enabled check box. 5. Save the record. 6. Select the PLUSGMIMWSTREND external system. 7. On the System tab, select the Enabled check box. 8. On the Publish Channels tab, select every Enabled check box. 9. On the Enterprise Services tab, select every Enabled check box. 10. Save the record.

Results
The configuration for the integration process is complete. New and updated records will be transferred automatically between Maximo for Oil and Gas and the external system.

Chapter 13. Updates to integration data

33

34

IBM Maximo for Oil and Gas: Installation Guide

Chapter 14. Maximo for Oil and Gas integration components


Maximo for Oil and Gas provides predefined components for integrating with the IBM Chemical and Petroleum Integrated Information Framework and other MIMOSA OSA-EAI V3.2.1-based systems (external systems).

Integration components for data transfers from Maximo for Oil and Gas
This table shows the integration components that are used to send integration data from Maximo for Oil and Gas to an external system.
Object structure Organization Site Location Asset Location meter Asset meter PLUSGORG PLUSGSITE PLUSGOPERLOC PLUSGASSET PLUSGLOCMETER PLUSGASSMETER Publish channel PLUSGORGInterface PLUSGSITEInterface PLUSGOPERLOCInterface PLUSGASSETInterface PLUSGLOCMETERInterface PLUSGASSMETERInterface

Integration components for data transfers to Maximo for Oil and Gas
This table shows the integration components that are used to send integration data from an external system to Maximo for Oil and Gas.
Object structure Defect ticket (location) Incident ticket (location) Defect ticket (asset) Incident ticket (asset) Work order (location) Work order (asset) Meter reading (location) Meter reading (asset) PLUSG DEFECT PLUSG INCIDENT PLUSG DEFECT PLUSG INCIDENT PLUSGWO PLUSGWO Enterprise service PLUSGDEF SMIMCInterface PLUSGINC SMIMCInterface PLUSGDEF AMIMCInterface PLUSGINC AMIMCInterface PLUSGWO SMIMCInterface PLUSGWO AMIMCInterface Web service PLUSGMIMWSREG_ PLUSGDEFSMIMCInterface PLUSGMIMWSREG_ PLUSGINCSMIMCInterface PLUSGMIMWSREG_ PLUSGDEFAMIMCInterface PLUSGMIMWSREG_ PLUSGINCAMIMCInterface PLUSGMIMWSREG_ PLUSGWOSMIMCInterface PLUSGMIMWSREG_ PLUSGWOAMIMCInterface PLUSGMIMWSTREND_ PLUSGMETERSMIMUInterface PLUSGMIMWSTREND_ PLUSGMETERAMIMUInterface

PLUSGLOCATION PLUSGMETER METER SMIMUInterface PLUSGASSET METER PLUSGMETER AMIMUInterface

Copyright IBM Corp. 2008, 2009

35

36

IBM Maximo for Oil and Gas: Installation Guide

Chapter 15. Web service operations


Maximo for Oil and Gas and XSD schemas for the enterprise services are stored in the directory that is defined in the mxe.int.globaldir system property. The MIMOSA WSDLs are defined in the RegistryManagement.wsdl and the TrendManagement.wsdl. The XSD schema is based on the definitions in V3-2TechXML.xsd.
WSDL operation Defect ticket Incident ticket Work order CreatePLUSG DEFECT CreatePLUSG INCIDENT CreatePLUSG WO Input element CreatePLUSG DEFECT CreatePLUSG INCIDENT CreatePLUSGWO Output element CreatePLUSGDEFECT Response CreatePLUSGINCIDENT Response CreatePLUSGWO Response

Meter reading UpdatePLUSG (location) LOCATION METER Meter reading UpdatePLUSG (asset) ASSETMETER

UpdatePLUSG UpdatePLUSGLOCATIONMETER LOCATIONMETER Response UpdatePLUSG ASSETMETER UpdatePLUSGASSETMETER Response

Copyright IBM Corp. 2008, 2009

37

38

IBM Maximo for Oil and Gas: Installation Guide

Chapter 16. Maximo for Oil and Gas integration mappings


Mappings identify the content that is transferred between Maximo for Oil and Gas and the IBM Chemical and Petroleum Integrated Information Framework or other MIMOSA OSA-EAI V3.2.1-based systems (external systems).

Organization mapping
You use the organization mapping to send organization (enterprise) data from Maximo for Oil and Gas to the external system.
Maximo for Oil and Gas table.column ORGANIZATION.ORGID ORGANIZATION. DESCRIPTION ORGANIZATION.ACTIVE ORGANIZATION. PLUSGOPENOMUID MIMOSA attribute enterpriseTYPE user_tag_ident name rstat_type_code enterprise_id MIMOSA interface reference V3-2-5036-01CreateEnterprise.xsd

The following attributes are sent with values set to undefined.


Attribute ent_db_id ent_db_site ent_type_code Undefined value 0 00000000 0

Site mapping
You use the site mapping to send site data from Maximo for Oil and Gas to the external system.
Maximo for Oil and Gas table.column SITE.SITEID SITE.DESCRIPTION SITE.ACTIVE SITE.PLUSGOPENOMUID ORGANIZATION. PLUSGOPENOMUID ORGANIZATION. PLUSGOPENOMUID (hexadecimal format) + SITE.PLUSGOPENOMUID (hexadecimal format) MIMOSA attribute siteTYPE user_tag_ident name rstat_type_code site_id enterprise_id site_code MIMOSA interface reference V3-2-5037-01CreateSite.xsd

Copyright IBM Corp. 2008, 2009

39

The following attributes are sent with values set to undefined.


Attribute st_db_id st_type_code Undefined value 0 0

Location mapping
You use the location mapping to send location data from Maximo for Oil and Gas to the external system.
Maximo for Oil and Gas table.column LOCATIONS.LOCATION LOCATIONS.DESCRIPTION LOCATIONS.STATUS MIMOSA attribute segmentTYPE user_tag_ident name lcinfo attr_name: status value: 1: operating 2: not ready 3: decommissioned rstat_type_code value: 0: not ready or decommissioned 1: operating SITE.PLUSGOPENOMUID (hexidecimal format) LOCATIONS. PLUSGOPENOMUID (look up from LOCATIONS.LOCATION) segment_site segment_id MIMOSA interface reference v V3-2-5038-01CreateSg.xsd v V3-2-5042-01UpdateSg.xsd

The following attributes are sent with values set to undefined.


Attribute sg_db_id segment_group_yn sg_type_code Undefined value 0 N 0

Asset mapping
You use the asset mapping to send asset data from Maximo for Oil and Gas to the external system.

40

IBM Maximo for Oil and Gas: Installation Guide

Maximo for Oil and Gas table.column ASSET.ASSETNUM ASSET.DESCRIPTION SITE.PLUSGOPENOMUID (look up from ASSET.SITE) ASSET.PLUSGOPENOMUID (look up from ASSET.LOCATION) ASSET.PLUSGOPENOMUID (look up from ASSET.ASSETNUM) LOCATIONS.STATUS

MIMOSA attribute assetTYPE user_tag_ident name asset_org_site segment_id

MIMOSA interface reference v V3-2-5043-01UpdateAs.xsd v V3-2-5042-01UpdateSg.xsd

asset_id

lcinfo attr_name: status value: 1: operating 2: not ready 3: decommissioned rstat_type_code value: 0: not ready or decommissioned 1: operating

The following attributes are sent with values set to undefined.


Attribute as_db_id as_type_code Undefined value 0 0

Location meter mapping


Yo use the location meter mapping to send location meter data from Maximo for Oil and Gas to the external system.

Chapter 16. Maximo for Oil and Gas integration mappings

41

Maximo for Oil and Gas table.column LOCATIONS. PLUSGOPENOMUID (look up from LOCATIONMETER. LOCATION) LOCATIONMETER. METERNAME LOCATIONMETER. LOCATIONMETERID LOCATIONMETER. PLUSGOPENOMUID (look up from LOCATIONMETER.SITEID) LOCATIONMETER.ACTIVE S (constant value)

MIMOSA attribute meas_locationTYPE segment_id

MIMOSA interface reference V3-2-1018-01CreateMLoc.xsd

user_tag_ident meas_loc_id meas_loc_site

rstat_type_code segment_or_asset

The following attributes are sent with values set to undefined.


Attribute ml_db_id ml_type_code Undefined value 0 0

Asset meter mapping


You use the asset meter mapping to send asset meter data from Maximo for Oil and Gas to the external system.
Maximo for Oil and Gas table.column ASSET.PLUSGOPENOMUID (look up from ASSETMETER.ASSETNUM) ASSETMETER. METERNAME ASSETMETER. ASSETMETERID ASSETMETER. PLUSGOPENOMUID (look up from ASSETMETER.SITEID) ASSETMETER.ACTIVE A (constant value) MIMOSA attribute meas_locationTYPE asset_id MIMOSA interface reference V3-2-1018-01 CreateMLoc.xsd

user_tag_ident meas_loc_id meas_loc_site

rstat_type_code segment_or_asset

The following attributes are sent with values set to undefined.


Attribute ml_db_id Undefined value 0

42

IBM Maximo for Oil and Gas: Installation Guide

Attribute ml_type_code

Undefined value 0

Defect and incident mapping (locations)


You use the defect and incident mapping to send location defect and incident data from the external system to Maximo for Oil and Gas.
Maximo for Oil and Gas table.column INCIDENT.REPORTEDBY INCIDENT.LOCATION ORGANIZATION. PLUSGOPENOMUID (hexadecimal format) + SITE.PLUSGOPENOMUID (hexadecimal format) INCIDENT.DESCRIPTION INCIDENT. PLUSGEXTINCREF (prefix = EVCODE) INCIDENT.AFFECTEDDATE gmt_event_start INCIDENT.CLASS lcinfo attr_name = event_type value = DEFECT or INCIDENT, depending on message type INCIDENT. PLUSGOPENOMUID lcinfo attr_name = open_uid value = Integer MIMOSA attribute segment_eventTYPE MAXINTADMIN segment_id segment_site MIMOSA interface reference V3-2-8058-01 CreateSgEvent.xsd

user_tag_ident event_type_code

The following response is sent from Maximo for Oil and Gas to the external system.
Maximo for Oil and Gas table.column INCIDENT.TICKETID MIMOSA attribute segment_eventTYPE event_id

Defect and incident mapping (assets)


You use the defect and incident mapping to send asset defect and incident data from the external system to Maximo for Oil and Gas.

Chapter 16. Maximo for Oil and Gas integration mappings

43

Maximo for Oil and Gas table.column INCIDENT.REPORTEDBY INCIDENT.ASSETNUM ORGANIZATION. PLUSGOPENOMUID (hexadecimal format) + SITE.PLUSGOPENOMUID (hexadecimal format) INCIDENT.DESCRIPTION INCIDENT. PLUSGEXTINCREF (prefix = EVCODE)

MIMOSA attribute asset_eventTYPE MAXINTADMIN asset_id asset_org_site

MIMOSA interface reference V3-2-8059-01 CreateAsEvent.xsd

user_tag_ident event_type_code

INCIDENT.AFFECTEDDATE gmt_event_start INCIDENT.CLASS lcinfo attr_name = event_type value = DEFECT or INCIDENT, depending on message type INCIDENT. PLUSGOPENOMUID lcinfo attr_name = open_uid value = Integer

The following response is sent from Maximo for Oil and Gas to the external system.
Maximo for Oil and Gas table.column INCIDENT.TICKETID MIMOSA attribute segment_eventTYPE event_id

Work order mapping (locations)


You use the work order mapping to send location work order data from the external system to Maximo for Oil and Gas.
Maximo for Oil and Gas table.column LOCATIONS. PLUSGOPENOMUID (look up from WORKORDER.LOCATION) SITE.PLUSGOPENOMUID (look up from WORKORDER.SITEID) WORKORDER.DESCRIPTION WORKORDER. PLUSGOPENOMUID MIMOSA attribute sg_req_for_workTYPE segment_id MIMOSA interface reference V3-2-8057-01 CreateSgRFWandWO.xsd

segment_site

name work_req_id

44

IBM Maximo for Oil and Gas: Installation Guide

The following mapping is used to send the ticket identifier from Maximo for Oil and Gas to the external system.
Maximo for Oil and Gas table.column WORKORDER.WONUM MIMOSA attribute work_order_for_TYPE work_order_id

Work order mapping (assets)


You use the work order mapping to send asset work order data from the external system to Maximo for Oil and Gas.
Maximo for Oil and Gas table.column ASSET.PLUSGOPENOMUID (look up from WORKORDER.ASSETNUM) SITE.PLUSGOPENOMUID (look up from WORKORDER.SITEID) MIMOSA attribute as_req_for_workTYPE asset_id MIMOSA interface reference V3-2-8055-01 CreateAsRFWandWO.xsd

asset_org_site

WORKORDER.DESCRIPTION name WORKORDER. PLUSGOPENOMUID work_req_id

The following response is sent from Maximo for Oil and Gas to the external system.
Maximo for Oil and Gastable.column WORKORDER.WONUM MIMOSA attribute work_order_for_TYPE work_order_id

Meter reading mapping (locations)


You use the meter reading mapping to send meter readings for locations from the external system to Maximo for Oil and Gas.
Maximo for Oil and Gas table.column LOCATIONMETER. LOCATION LOCATIONMETER. LOCATIONMETERNAME MIMOSA attribute mevent_num_dataTYPE meas_eventTYPE segment_id meas_loc_id

MIMOSA interface reference V3-2-1008-03 CreateScalarDataAndAlarms.xsd

LOCATIONMETER.SITEID segment_site LOCATIONMETER. NEWREADING LOCATIONMETER. NEWREADINGDATE mevent_num_data. data_value mevent_num_data. gmt_event

Chapter 16. Maximo for Oil and Gas integration mappings

45

Meter reading mapping (assets)


You use the meter reading mapping to send meter readings for assets from the external system to Maximo for Oil and Gas.
Maximo for Oil and Gas table.column MIMOSA attribute mevent_num_dataTYPE meas_eventTYPE MIMOSA interface reference V3-2-1008-03 CreateScalarDataAndAlarms.xsd

ASSETMETER.ASSETNUM asset_id ASSETMETER. ASSETMETERNAME ASSETMETER.SITEID ASSETMETER. NEWREADING ASSETMETER. NEWREADINGDATE meas_loc_id asset_org_site mevent_num_data. data_value mevent_num_data. gmt_event

46

IBM Maximo for Oil and Gas: Installation Guide

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 users 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. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan, Ltd. 1623-14, Shimotsuruma, Yamato-shi Kanagawa 242-8502 Japan 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.

Copyright IBM Corp. 2008, 2009

47

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: U.S.A. IBM Corporation 2Z4A/101 11400 Burnet Road Austin, TX 78758 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this information and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, or any equivalent agreement between us. 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. All statements regarding IBMs future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. 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. If you are viewing this information softcopy, the photographs and color illustrations may not appear.

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. Java and all Java-based trademarks and logos are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries.

48

IBM Maximo for Oil and Gas: Installation Guide

Other company, product, and service names may be trademarks or service marks of others.

Notices

49

50

IBM Maximo for Oil and Gas: Installation Guide

Printed in USA