Author
santukom
View
232
Download
0
Embed Size (px)
7/31/2019 Oil711 Install Guide
1/56
Tivoli IBM Maximo for Oil and Gas
Installation Guide
Version 7.1.1
7/31/2019 Oil711 Install Guide
2/56
NoteBefore 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 subsequentreleases 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 Contractwith IBM Corp.
7/31/2019 Oil711 Install Guide
3/56
Contents
Chapter 1. Installation overview . . . . 1
Chapter 2. Updating environment data . 3Updating database properties . . . . . . . . . 3Updating installation properties . . . . . . . . 4Updating the WebSphere Application Server NetworkDeployment host name . . . . . . . . . . . 4
Chapter 3. Software requirements . . . 7
Chapter 4. Preparing for the installation 9
Chapter 5. Installing Maximo for Oil andGas . . . . . . . . . . . . . . . . 11
Chapter 6. Deploying the EAR files onOracle WebLogic Server . . . . . . . 13
Chapter 7. Adding Map tabs to Maximofor Oil and Gas applications . . . . . 15
Chapter 8. Integration componentsprovided 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 integrationinfrastructure for initial file loads . . . 23Adding MIMOSA enterprise identifiers in Maximofor Oil and Gas . . . . . . . . . . . . . 23Updating system properties . . . . . . . . . 24Enabling the publish channels for initial file loads 24Enabling the external system for initial file loads . . 25Activating the integration cron task . . . . . . 25
Chapter 12. Initial loads of integrationdata . . . . . . . . . . . . . . . . 27
Loading organizations to the external system . . . 27Loading sites to the external system . . . . . . 27
Loading locations to the external system. . . . . 28Loading assets to the external system. . . . . . 28Loading location meters to the external system . . 29Loading asset meters to the external system . . . 29Disabling the external system for initial file loads. . 30
Chapter 13. Updates to integration data 31Configuring the integration infrastructure for dataupdates. . . . . . . . . . . . . . . . 31Retrieving the Web addresses for Web services . . 31Configuring the end points for Web services . . . 32Deploying Web services . . . . . . . . . . 32Enabling the external systems for Web Services . . 33
Chapter 14. Maximo for Oil and Gasintegration components . . . . . . . 35Integration components for data transfers fromMaximo for Oil and Gas . . . . . . . . . . 35Integration components for data transfers toMaximo for Oil and Gas . . . . . . . . . . 35
Chapter 15. Web service operations . . 37
Chapter 16. Maximo for Oil and Gasintegration mappings . . . . . . . . 39Organization mapping. . . . . . . . . . . 39Site mapping . . . . . . . . . . . . . . 39Location mapping . . . . . . . . . . . . 40Asset mapping . . . . . . . . . . . . . 40Location meter mapping . . . . . . . . . . 41Asset meter mapping . . . . . . . . . . . 42Defect and incident mapping (locations) . . . . . 43Defect and incident mapping (assets). . . . . . 43Work order mapping (locations) . . . . . . . 44Work order mapping (assets) . . . . . . . . 45Meter reading mapping (locations) . . . . . . 45Meter reading mapping (assets) . . . . . . . 46
Notices . . . . . . . . . . . . . . 47Trademarks . . . . . . . . . . . . . . 48
Copyright IBM Corp. 2008, 2009 iii
7/31/2019 Oil711 Install Guide
4/56
iv IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
5/56
7/31/2019 Oil711 Install Guide
6/56
2 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
7/56
Chapter 2. Updating environment data
When you install a fix pack or upgrade an existing installation, the installationprogram uses values that are recorded from the previous deployment. If anything
in your environment changed since the original deployment, you must recordthese 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 originaldeployment, such as changing a host name or updating a password, the changesmust be recorded in the install.properties and maximo.properties files on theadministrative system.
When the product installation program runs an upgrade task, it attempts to usevalues in the install.properties file and the maximo.properties file. During theupgrade process, if the user name or password for a system is not updated, theinstallation program uses the credentials in the properties files. If the installationprogram cannot log in to a system with the credentials found in the propertiesfiles, you are prompted to supply the correct information. Updated values arewritten 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 youattempt an upgrade operation. Database connection information and credentialinformation are stored in the maximo.properties file. Any changes to thisinformation from the time of the original deployment must be manually recordedin the maximo.properties file before you begin an upgrade from version 7.1 toversion 7.1.1.
When you change the value of the WebSphere Application Server NetworkDeployment host name (WAS.DeploymentManagerHostName), in addition toupdating this property value in the install.properties file, you must also updatea property for the WebSphere Application Server Network Deployment thin clientin 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 databasechanges that have been made in your environment since the original deployment.Update database properties in the maximo.properties file.
Procedure1. 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. Delete the maximo.properties file.
4. Change to the product_home\etc directory.
5. Back up the maximo.properties_orig file. Save this backup copy permanently.
6. Rename the unencrypted maximo.properties_orig file to maximo.properties.
Copyright IBM Corp. 2008, 2009 3
7/31/2019 Oil711 Install Guide
8/56
7/31/2019 Oil711 Install Guide
9/56
4. Update the following line of the file with the new, fully qualified, host name ofthe WebSphere Application Server Network Deployment server. setwsadminHost=-Dcom.ibm.ws.scripting.host=fully-qualified host name.
5. Run the thinwasadmin.bat file with these values: thinwsadmin.bat -domainmanager 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 aproduct by using the corrected values.
Chapter 2. Updating environment data 5
7/31/2019 Oil711 Install Guide
10/56
6 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
11/56
Chapter 3. Software requirements
Ensure that you meet the software requirements before you install IBM Maximo forOil 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 theWindows workstation and later deployed to the application server.
Base requirements
Ensure that IBM Maximo Asset Management 7.1 is installed on the same Windowsadministrative 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 7
7/31/2019 Oil711 Install Guide
12/56
8 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
13/56
Chapter 4. Preparing for the installation
When you install Maximo for Oil and Gas, you modify the configuration andcontent of your application servers, database server, and directory server. These
servers are referred to as the middleware servers. Before you install Maximo for Oiland Gas, you must complete tasks on these middleware servers and youradministrative workstation.
Procedure
1. Gather login information for the middleware servers. The installation programrequires access to the middleware servers that are installed with Maximo AssetManagement to complete the installation. You need the administrative user IDsand passwords for the middleware servers.
2. Back up the middleware servers and administrative workstation.
3. Prepare the application server:
Application server What to do
WebSphere Application Server Ensure that the middleware servers arestarted. The installation program connectsto the middleware servers by using themiddleware login information that youspecify during the product installation.
WebLogic Server Ensure that the application server(MAXIMOSERVER) is stopped. If theapplication server is running, stop theserver and wait a few minutes before youstart the installation program. If theapplication server is not stopped, theinstallation process stops.
4. If you run the installation program in a double-byte language or an easternEuropean language, set the workstation regional settings to that language. Youcan reset your regional settings after you complete the installation.
Copyright IBM Corp. 2008, 2009 9
7/31/2019 Oil711 Install Guide
14/56
10 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
15/56
Chapter 5. Installing Maximo for Oil and Gas
Use the launchpad to install Maximo for Oil and Gas.
Procedure1. Start the launchpad. The launchpad is automatically started when you run the
product DVD. If the Windows autorun feature is disabled, you can start thelaunchpad by running the launchpad.exe program from the root directory ofthe product DVD. If you cannot start the launchpad, navigate to the
product_home\bin directory and double-click the solutionInstallerGUI.batfile.
2. Click Install the Product.
3. Click IBM Maximo for Oil and Gas 7.1.1.
4. Select a language for your installation, and click OK.
5. 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 tospecify whether you want the installation program to install additionallanguages.
8. If you use WebSphere Application Server, in the package options panel thatshows the deployment options, ensure that the Package Options check box iscleared 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 Deployedwindow, click Done.
What to do next
If you want to check the results of the language package installation, review thelanguage 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 Maptabs to Maximo for Oil and Gas, if applicable, or configure the integrationinfrastructure for initial file loads.
Copyright IBM Corp. 2008, 2009 11
7/31/2019 Oil711 Install Guide
16/56
12 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
17/56
Chapter 6. Deploying the EAR files on Oracle WebLogicServer
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 EARfiles starts the application server.
Before you begin
v The EAR files must be deployed after the updatedb command is run. Theupdatedb command is run as part of the installation process. However, if youmanually run the updatedb command, make sure that you do so before youdeploy 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 Location
Windows From a command prompt, change the pathto: drive:\BEA_installation_location\user_projects\domain\mydomain
UNIX Open a terminal window, or if you areusing Telnet to connect from a Windows
computer, open a command prompt, andchange the path to: /home/mxadmin/bea/user_projects/domains/mydomain
2. Start the WebLogic Server.
Platform Command to enter
Windows startWebLogic.cmd
UNIX ./startWebLogic.sh
3. Start the MAXIMOSERVER administration console by typing the followingURL 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
7/31/2019 Oil711 Install Guide
18/56
What to do next
Add Map tabs to Maximo for Oil and Gas applications, if applicable, or configurethe integration infrastructure for initial file loads.
14 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
19/56
Chapter 7. Adding Map tabs to Maximo for Oil and Gasapplications
If you have installed and enabled a license for IBM Maximo Spatial AssetManagement, you can add Map tabs to several Maximo for Oil and Gasapplications 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)
Procedure1. In the product_home\maximo\applications\maximo\properties\product
directory, open the oilandgas.xml file.
2. Search for the following elements and remove thecomment tags ()) from each element:
v
v
v
v
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
7/31/2019 Oil711 Install Guide
20/56
16 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
21/56
Chapter 8. Integration components provided with Maximo forOil and Gas
The integration process transfers data between IBM Maximo for Oil and Gas andthe IBM Chemical and Petroleum Integrated Information Framework and otherMIMOSA OSA-EAI V3.2.1-based systems (external systems).
The product includes integration components to transfer new and updated recordsof the following types from Maximo for Oil and Gas to the external system:
v Organizations
v Sites
v Locations
v Assets
v Meter readings for locations
v Meter readings for assets
The product includes integration components to transfer new records of thefollowing types from the external system to Maximo for Oil and Gas. Theserecords 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-V03-
2]CRIS_complete_V3-2-1_[31-Dec-2008].xsd.
Copyright IBM Corp. 2008, 2009 17
7/31/2019 Oil711 Install Guide
22/56
7/31/2019 Oil711 Install Guide
23/56
Chapter 9. Date formats
All dates exchanged by Maximo for Oil and Gas and a MIMOSA OSA-EAIV3.2.1-based external system must have the same format.
Dates exchanged between the systems must be in the format yyyy-MM-ddTHH:mm:ssZ
Date element Description
yyyy Year
MM Month
dd Day
T Indicates that the following numbersrepresent a time
HH Hour (00 - 23)
mm Minute (00 - 59)
ss Second (00 - 59)
Z UTC zero offset indicator
Copyright IBM Corp. 2008, 2009 19
7/31/2019 Oil711 Install Guide
24/56
20 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
25/56
Chapter 10. Maximo for Oil and Gas Web service handler
A system administrator must regularly monitor Maximo for Oil and Gas and theexternal system for data transfer errors. The PLUSGWEBSERVICE handler
processes responses from the external system and can overwrite the Web serviceend point SOAP action. Each transaction that is used in the integration has aspecific SOAP operation.
The Web service handler processes responses as follows:
v If the response is a success, the handler finishes processing the message. Asuccess is indicated by a TRUE value for the success attribute on the element of the response.
v If the response is a failure, the handler marks the message for reprocessing. Afailure is indicated by a FALSE value for the success attribute on the element of the response. To reprocess the message, you use the MessageReprocessing application in the Integration module.
This table displays the error responses that the external system sends to Maximofor Oil and Gas, and the mapping to the Maximo message.
message_code Message group Message key Message text
STAT_ERR_INPUT plusgwebservice inputError The external systemcould not proceedwith the operationbecause the messagesent is incorrect.
STAT_ERR_TECH plusgwebservice techError A technical erroroccurred in theexternal system.
Copyright IBM Corp. 2008, 2009 21
7/31/2019 Oil711 Install Guide
26/56
22 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
27/56
Chapter 11. Configuring the integration infrastructure forinitial file loads
Maximo for Oil and Gas records are initially loaded to the external system throughXML file transfers. Before you can load these files to the external system, you mustperform 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 untilyou obtain MIMOSA enterprise identifiers and associate them with Maximo for Oiland Gas organizations.
Important: The names of the oil-and-gas-specific integration components (forexample, object structures and external systems) begin with the prefix PLUSG. Ifyou created any integration components that begin with PLUSG, the integrationcan fail.
Procedure
1. Obtain a MIMOSA enterprise_id for every active and inactive organization inMaximo for Oil and Gas.
2. Associate the MIMOSA enterprise identifiers with the Maximo for Oil and Gasorganizations.
3. Update the system properties.
4. Configure the JMS queues as described in the Integration Guide.
5. Enable the publish channels for the initial file loads.6. Enable the external system for the initial file loads.
7. Activate the integration cron task.
8. Load organization, site, location, asset, location meter, and asset meter recordsto the external system.
9. Disable the external system for the initial file loads.
Adding MIMOSA enterprise identifiers in Maximo for Oil and Gas
MIMOSA enterprise identifiers provide a common identifier in Maximo for Oil andGas and in the external system. You must associate a MIMOSA enterprise identifierwith every active and inactive organization in Maximo for Oil and Gas. If you do
not associate a MIMOSA enterprise identifier with an organization, theorganization record is ignored.
Before you begin
Obtain a MIMOSA enterprise identifier for every active and inactive organizationin Maximo for Oil and Gas.
Copyright IBM Corp. 2008, 2009 23
7/31/2019 Oil711 Install Guide
28/56
Procedure
1. In the Organizations (Oil) application, display the organization record that youwant to update.
2. On the Organization tab, in the Open Unique Identifier field, specify theMIMOSA 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 systemproperties. The mxe.int.globaldir property identifies the base directory for the filesthat are generated by the integration, for example, errors and output XML. Themxe.int.webappurl property identifies the IP address and port where Maximo forOil and Gas is deployed.
Before you begin
Associate MIMOSA enterprise identifiers with Maximo for Oil and Gasorganizations.
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 SelectRecord 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 savethe record. Specify the server host as follows: http://:/meaweb.
4. If you update the mxe.int.webappurl property, select the corresponding SelectRecord 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 publishchannels for the record types to be transferred.
Before you beginv 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 forOil 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
7/31/2019 Oil711 Install Guide
29/56
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 verifythat the Enable Listener check box is selected for every PLUSG publishchannel.
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 toprocess XML files. You must enable this external system before you can transferany records.
Before you begin
Enable the publish channels for the initial file loads.
Procedure1. 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 savethe 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 managesthe 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 theActive 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
7/31/2019 Oil711 Install Guide
30/56
26 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
31/56
Chapter 12. Initial loads of integration data
The initial file loads ensure that the organization, site, asset, location, and meterdata 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. Locations
4. Assets
5. Location meters
6. Asset meters
You also must import the files to the external system in the same sequence. If youdo not, errors will occur.
Loading organizations to the external system
You load Maximo for Oil and Gas organization data to the external system tosynchronize the organizations in the two systems. The application loads active andinactive 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 exportcondition.
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 systemYou load Maximo for Oil and Gas site data to the external system to synchronizethe 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
7/31/2019 Oil711 Install Guide
32/56
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 exportcondition.
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 tosynchronize 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 publishchannel.
3. Click Data Export. In the Data Export window, do not specify an exportcondition.
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 synchronizethe 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 publishchannel.
3. Click Data Export. In the Data Export window, do not specify an exportcondition.
4. Click OK.
28 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
33/56
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 tosynchronize the location meters in the two systems. The application loads alllocation 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 tosynchronize the asset meters in the two systems. The application loads all assetmeters, 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 publishchannel.
3. Click Data Export. In the Data Export window, do not specify an exportcondition.
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
7/31/2019 Oil711 Install Guide
34/56
Disabling the external system for initial file loads
The external system that is associated with initial file loads is configured to processXML files. Web services are used for subsequent updates. You must disable thecurrent external system before you enable Web services, because parallel operationof 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
7/31/2019 Oil711 Install Guide
35/56
Chapter 13. Updates to integration data
After you perform some configuration activities, the integration will automaticallytransfer new and updated records between Maximo for Oil and Gas and the
external system.
The integration process captures changes to active and inactive organizations andsites, and to locations, assets, and meters. An updated record is a record in whichany field on the outgoing messages changes.
You must associate a MIMOSA enterprise identifier with a new organization, or theorganization record is not transferred to the external system.
Note: Make changes to asset locations in Maximo for Oil and Gas, not in theexternal system.
When a record is deleted in Maximo for Oil and Gas, the rstat_type_code attributein the outgoing message contains a 3. The external system must recognize thiscode as a deletion and remove the record from its database.
The rtype_stat_code attribute and the lcinfo attribute are used to indicate status. Tosee which fields and values are used for a record, see the integration mapping forthat record type.
Configuring the integration infrastructure for data updates
You initially load data from Maximo for Oil and Gas to the external system usingXML files. For subsequent updates, you use Web services.
Procedure1. 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 Webaddresses for RegistryManagementServices and TrendManagementServices. If youdo 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 locationattribute, which defines the Web address.
Copyright IBM Corp. 2008, 2009 31
7/31/2019 Oil711 Install Guide
36/56
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 forTrendManagementServices.
Procedure
1. In the End Points application, on the List tab, select the PLUSGMIMWSREGend point.
2. On the End Point tab, select the ENDPOINTURL property.
3. In the Value field, specify the Web service URL forRegistryManagementServices.
4. Select the SERVICENAME property, and update its value.
5. Save the record.
6. On the List tab, select the PLUSGMIMWSTREND end point.
7. On the End Point tab, select the ENDPOINTURL property.
8. 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 betransferred 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 thelist.
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 IsDeployed check box that corresponds to each PLUSG Web service is selected.
32 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
37/56
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 recordtypes to be exchanged.
Before you begin
Deploy Web services.
Procedure
1. In the External Systems application, select the PLUSGMIMWSREG externalsystem.
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 theexternal system.
Chapter 13. Updates to integration data 33
7/31/2019 Oil711 Install Guide
38/56
34 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
39/56
Chapter 14. Maximo for Oil and Gas integration components
Maximo for Oil and Gas provides predefined components for integrating with theIBM 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 datafrom Maximo for Oil and Gas to an external system.
Object structure Publish channel
Organization PLUSGORG PLUSGORGInterface
Site PLUSGSITE PLUSGSITEInterface
Location PLUSGOPERLOC PLUSGOPERLOCInterfaceAsset PLUSGASSET PLUSGASSETInterface
Location meter PLUSGLOCMETER PLUSGLOCMETERInterface
Asset meter PLUSGASSMETER PLUSGASSMETERInterface
Integration components for data transfers to Maximo for Oil and Gas
This table shows the integration components that are used to send integration datafrom an external system to Maximo for Oil and Gas.
Object structure Enterprise service Web service
Defect ticket(location)
PLUSGDEFECT
PLUSGDEFSMIMCInterface
PLUSGMIMWSREG_PLUSGDEFSMIMCInterface
Incident ticket(location)
PLUSGINCIDENT
PLUSGINCSMIMCInterface
PLUSGMIMWSREG_PLUSGINCSMIMCInterface
Defect ticket(asset)
PLUSGDEFECT
PLUSGDEFAMIMCInterface
PLUSGMIMWSREG_PLUSGDEFAMIMCInterface
Incident ticket(asset)
PLUSGINCIDENT
PLUSGINCAMIMCInterface
PLUSGMIMWSREG_PLUSGINCAMIMCInterface
Work order(location)
PLUSGWO PLUSGWOSMIMCInterface
PLUSGMIMWSREG_PLUSGWOSMIMCInterface
Work order(asset)
PLUSGWO PLUSGWOAMIMCInterface
PLUSGMIMWSREG_PLUSGWOAMIMCInterface
Meter reading(location)
PLUSGLOCATIONMETER
PLUSGMETERSMIMUInterface
PLUSGMIMWSTREND_PLUSGMETERSMIMUInterface
Meter reading(asset)
PLUSGASSETMETER
PLUSGMETERAMIMUInterface
PLUSGMIMWSTREND_PLUSGMETERAMIMUInterface
Copyright IBM Corp. 2008, 2009 35
7/31/2019 Oil711 Install Guide
40/56
36 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
41/56
Chapter 15. Web service operations
Maximo for Oil and Gas and XSD schemas for the enterprise services are stored inthe directory that is defined in the mxe.int.globaldir system property. The
MIMOSA WSDLs are defined in the RegistryManagement.wsdl and theTrendManagement.wsdl. The XSD schema is based on the definitions inV3-2TechXML.xsd.
WSDLoperation Input element Output element
Defect ticket CreatePLUSGDEFECT
CreatePLUSGDEFECT
CreatePLUSGDEFECTResponse
Incidentticket
CreatePLUSGINCIDENT
CreatePLUSGINCIDENT
CreatePLUSGINCIDENTResponse
Work order CreatePLUSGWO
CreatePLUSGWO CreatePLUSGWOResponse
Meter reading(location)
UpdatePLUSGLOCATIONMETER
UpdatePLUSGLOCATIONMETER
UpdatePLUSGLOCATIONMETERResponse
Meter reading(asset)
UpdatePLUSGASSETMETER
UpdatePLUSGASSETMETER
UpdatePLUSGASSETMETERResponse
Copyright IBM Corp. 2008, 2009 37
7/31/2019 Oil711 Install Guide
42/56
7/31/2019 Oil711 Install Guide
43/56
Chapter 16. Maximo for Oil and Gas integration mappings
Mappings identify the content that is transferred between Maximo for Oil and Gasand 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 fromMaximo for Oil and Gas to the external system.
Maximo for Oil and Gastable.column
MIMOSA attributeenterpriseTYPE MIMOSA interface reference
ORGANIZATION.ORGID user_tag_ident V3-2-5036-01CreateEnterprise.xsd
ORGANIZATION.DESCRIPTION
name
ORGANIZATION.ACTIVE rstat_type_code
ORGANIZATION.PLUSGOPENOMUID
enterprise_id
The following attributes are sent with values set to undefined.
Attribute Undefined value
ent_db_id 0
ent_db_site 00000000
ent_type_code 0
Site mapping
You use the site mapping to send site data from Maximo for Oil and Gas to theexternal system.
Maximo for Oil and Gastable.column
MIMOSA attributesiteTYPE
MIMOSA interfacereference
SITE.SITEID user_tag_ident V3-2-5037-01CreateSite.xsd
SITE.DESCRIPTION name
SITE.ACTIVE rstat_type_code
SITE.PLUSGOPENOMUID site_id
ORGANIZATION.PLUSGOPENOMUID
enterprise_id
ORGANIZATION.PLUSGOPENOMUID(hexadecimal format) +SITE.PLUSGOPENOMUID(hexadecimal format)
site_code
Copyright IBM Corp. 2008, 2009 39
7/31/2019 Oil711 Install Guide
44/56
The following attributes are sent with values set to undefined.
Attribute Undefined value
st_db_id 0
st_type_code 0
Location mapping
You use the location mapping to send location data from Maximo for Oil and Gasto the external system.
Maximo for Oil and Gastable.column
MIMOSA attributesegmentTYPE
MIMOSA interfacereference
LOCATIONS.LOCATION user_tag_identv V3-2-5038-01CreateSg.xsd
v V3-2-5042-01UpdateSg.xsdLOCATIONS.DESCRIPTION name
LOCATIONS.STATUS lcinfo
attr_name: status
value:
1: operating
2: not ready
3: decommissioned
rstat_type_code
value:
0: not ready ordecommissioned
1: operating
SITE.PLUSGOPENOMUID(hexidecimal format)
segment_site
LOCATIONS.PLUSGOPENOMUID(look up fromLOCATIONS.LOCATION)
segment_id
The following attributes are sent with values set to undefined.
Attribute Undefined value
sg_db_id 0
segment_group_yn N
sg_type_code 0
Asset mapping
You use the asset mapping to send asset data from Maximo for Oil and Gas to theexternal system.
40 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
45/56
Maximo for Oil and Gastable.column
MIMOSA attributeassetTYPE
MIMOSA interfacereference
ASSET.ASSETNUM user_tag_identv V3-2-5043-01UpdateAs.xsd
v V3-2-5042-01UpdateSg.xsdASSET.DESCRIPTION name
SITE.PLUSGOPENOMUID(look up from ASSET.SITE)
asset_org_site
ASSET.PLUSGOPENOMUID(look up fromASSET.LOCATION)
segment_id
ASSET.PLUSGOPENOMUID(look up fromASSET.ASSETNUM)
asset_id
LOCATIONS.STATUS lcinfo
attr_name: status
value:
1: operating
2: not ready
3: decommissioned
rstat_type_code
value:
0: not ready ordecommissioned
1: operating
The following attributes are sent with values set to undefined.
Attribute Undefined value
as_db_id 0
as_type_code 0
Location meter mapping
Yo use the location meter mapping to send location meter data from Maximo forOil and Gas to the external system.
Chapter 16. Maximo for Oil and Gas integration mappings 41
7/31/2019 Oil711 Install Guide
46/56
Maximo for Oil and Gastable.column
MIMOSA attributemeas_locationTYPE
MIMOSA interfacereference
LOCATIONS.PLUSGOPENOMUID(look up fromLOCATIONMETER.LOCATION)
segment_id V3-2-1018-01CreateMLoc.xsd
LOCATIONMETER.METERNAME
user_tag_ident
LOCATIONMETER.LOCATIONMETERID
meas_loc_id
LOCATIONMETER.PLUSGOPENOMUID(look up fromLOCATIONMETER.SITEID)
meas_loc_site
LOCATIONMETER.ACTIVE rstat_type_code
S (constant value) segment_or_asset
The following attributes are sent with values set to undefined.
Attribute Undefined value
ml_db_id 0
ml_type_code 0
Asset meter mapping
You use the asset meter mapping to send asset meter data from Maximo for Oiland Gas to the external system.
Maximo for Oil and Gastable.column
MIMOSA attributemeas_locationTYPE
MIMOSA interfacereference
ASSET.PLUSGOPENOMUID(look up fromASSETMETER.ASSETNUM)
asset_id V3-2-1018-01CreateMLoc.xsd
ASSETMETER.METERNAME
user_tag_ident
ASSETMETER.ASSETMETERID
meas_loc_id
ASSETMETER.PLUSGOPENOMUID(look up from
ASSETMETER.SITEID)
meas_loc_site
ASSETMETER.ACTIVE rstat_type_code
A (constant value) segment_or_asset
The following attributes are sent with values set to undefined.
Attribute Undefined value
ml_db_id 0
42 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
47/56
Attribute Undefined value
ml_type_code 0
Defect and incident mapping (locations)
You use the defect and incident mapping to send location defect and incident datafrom the external system to Maximo for Oil and Gas.
Maximo for Oil and Gastable.column
MIMOSA attributesegment_eventTYPE
MIMOSA interfacereference
INCIDENT.REPORTEDBY MAXINTADMIN V3-2-8058-01CreateSgEvent.xsd
INCIDENT.LOCATION segment_id
ORGANIZATION.PLUSGOPENOMUID(hexadecimal format) +SITE.PLUSGOPENOMUID(hexadecimal format)
segment_site
INCIDENT.DESCRIPTION user_tag_identINCIDENT.PLUSGEXTINCREF
(prefix = EVCODE)
event_type_code
INCIDENT.AFFECTEDDATE gmt_event_start
INCIDENT.CLASS lcinfo
attr_name = event_type
value = DEFECT orINCIDENT, depending onmessage type
INCIDENT.PLUSGOPENOMUID
lcinfo
attr_name = open_uid
value = Integer
The following response is sent from Maximo for Oil and Gas to the externalsystem.
Maximo for Oil and Gas table.columnMIMOSA attributesegment_eventTYPE
INCIDENT.TICKETID event_id
Defect and incident mapping (assets)
You use the defect and incident mapping to send asset defect and incident datafrom the external system to Maximo for Oil and Gas.
Chapter 16. Maximo for Oil and Gas integration mappings 43
7/31/2019 Oil711 Install Guide
48/56
Maximo for Oil and Gastable.column
MIMOSA attributeasset_eventTYPE
MIMOSA interfacereference
INCIDENT.REPORTEDBY MAXINTADMIN V3-2-8059-01CreateAsEvent.xsd
INCIDENT.ASSETNUM asset_id
ORGANIZATION.PLUSGOPENOMUID
(hexadecimal format) +SITE.PLUSGOPENOMUID(hexadecimal format)
asset_org_site
INCIDENT.DESCRIPTION user_tag_ident
INCIDENT.PLUSGEXTINCREF
(prefix = EVCODE)
event_type_code
INCIDENT.AFFECTEDDATE gmt_event_start
INCIDENT.CLASS lcinfo
attr_name = event_type
value = DEFECT orINCIDENT, depending onmessage type
INCIDENT.PLUSGOPENOMUID
lcinfo
attr_name = open_uid
value = Integer
The following response is sent from Maximo for Oil and Gas to the externalsystem.
Maximo for Oil and Gas table.columnMIMOSA attributesegment_eventTYPE
INCIDENT.TICKETID event_id
Work order mapping (locations)
You use the work order mapping to send location work order data from theexternal system to Maximo for Oil and Gas.
Maximo for Oil and Gastable.column
MIMOSA attributesg_req_for_workTYPE
MIMOSA interfacereference
LOCATIONS.
PLUSGOPENOMUID(look up fromWORKORDER.LOCATION)
segment_id V3-2-8057-01
CreateSgRFWandWO.xsd
SITE.PLUSGOPENOMUID(look up fromWORKORDER.SITEID)
segment_site
WORKORDER.DESCRIPTION name
WORKORDER.PLUSGOPENOMUID
work_req_id
44 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
49/56
7/31/2019 Oil711 Install Guide
50/56
Meter reading mapping (assets)
You use the meter reading mapping to send meter readings for assets from theexternal system to Maximo for Oil and Gas.
Maximo for Oil and Gas
table.column
MIMOSA attributemevent_num_dataTYPE
meas_eventTYPE MIMOSA interface referenceASSETMETER.ASSETNUM asset_id V3-2-1008-03
CreateScalarDataAndAlarms.xsdASSETMETER.ASSETMETERNAME
meas_loc_id
ASSETMETER.SITEID asset_org_site
ASSETMETER.NEWREADING
mevent_num_data.data_value
ASSETMETER.NEWREADINGDATE
mevent_num_data.gmt_event
46 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
51/56
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 inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, 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 theoperation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:
IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.
For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:
Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan, Ltd.
1623-14, Shimotsuruma, Yamato-shiKanagawa 242-8502 Japan
The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION AS IS WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not applyto you.
This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.
Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.
Copyright IBM Corp. 2008, 2009 47
7/31/2019 Oil711 Install Guide
52/56
IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:
U.S.A. IBM Corporation2Z4A/10111400 Burnet RoadAustin, 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 materialavailable 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 ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.
All statements regarding IBMs future direction or intent are subject to change orwithdrawal 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 thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.
If you are viewing this information softcopy, the photographs and colorillustrations may not appear.
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks ofInternational 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 andtrademark information at www.ibm.com/legal/copytrade.shtml.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks ofMicrosoft 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 othercountries.
48 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
53/56
Other company, product, and service names may be trademarks or service marksof others.
Notices 49
7/31/2019 Oil711 Install Guide
54/56
50 IBM Maximo for Oil and Gas: Installation Guide
7/31/2019 Oil711 Install Guide
55/56
7/31/2019 Oil711 Install Guide
56/56
Printed in USA