411 Mea Ora11i Sagv2

1

Release 4.1.1

Copyright 2002, MRO Software, Inc.

Integration Guide Oracle Financials 11i

This document and its publication do not constitute or create a contract. MRO Software, Inc., makes no warranties, express or implied, regarding the accuracy or completeness of this document or of the related program material. 2001 MRO Software, Inc. All rights reserved. Contains confidential and trade secret information of MRO Software, Inc. Use, transfer, disclosure, or copying without MRO Software, Inc.s express written permission is strictly forbidden. United States Patent No. 6,325,522 B2 Restricted Rights - Use, duplication, and disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 (OCT 1998). Trademarks: MAXIMO, INTERMAT, Struxure, MAXIMO Enterprise, MAXIMO Extended Enterprise, MAXIMO for Integrated Supply, MAXIMO Scheduler, MAXIMO Workflow, MAXIMO Analyzer, MAXIMO Buyer, MAXIMO Fleet Manager, MAXIMO Aviation Manager, MRO Online Commerce ServicesSM, MRO Software Operations CenterSM, Supplier e-Commerce Adapter, Illustrated Parts Catalog, Collego Catalog Manager, Standard Modifier Dictionary, and Autocon are trademarks of MRO Software, Inc. Other products and brand names are trademarks or registered trademarks of their respective companies; some are noted below. Third-Party Technology: Certain MRO Software, Inc., products contain technology provided under license from third parties, as noted below:

MRO Software Products

Third-Party Technology Information

MAXIMO Portions 2000 Brio Technology, Inc. Brio Report Builder provided by Brio Technology, Inc. Portions 1996 Centura Software Corporation. Portions 1995-2000 Actuate Corporation.

All Products Portions 1995-2000 BroadVision, Inc. BroadVision Business Commerce, BroadVision One-to-One Enterprise, BroadVision One-to-One Publishing, BroadVision Tools provided by BroadVision, Inc. Portions 2000 webMethods, Inc. webMethods B2B Integrator, webMethods B2B Integration Server provided by webMethods, Inc.

AutoVue Portions 1989-1998 Cimmetry Systems, Inc. AutoVue, AutoVue Professional provided by Cimmetry Systems, Inc.

MAXIMO Workflow

Portions 1998, 1999 NETRONIC Software GmbH.

Illustrated Parts Catalog

Portions 1999-2001 Snowbound Software Corporation. RasterMaser provided by Snowbound Software Corporation.

Online Commerce Services

Portions TAXWARE International, Inc. TAXWARE VERAZIP Sales/User, STEP provided by TAXWARE International, Inc.

3

CONTENTS

CHAPTER 1: INTRODUCTION....................................................................................9

Overview...................................................................................................................10 Related Documentation.............................................................................................11 Integration Overview ................................................................................................13

CHAPTER 2: IMPLEMENTING THE SOFTWARE INTEGRATION...................17 Reconfiguring MAXIMO Table Columns ................................................................18

Modifying Integration API Control Codes............................................................19 Oracle Financials Control Codes ..........................................................................35

Customizing Integration Procedures .........................................................................47 CHAPTER 3: USING THE INTEGRATION MODULE ...........................................49

Inventory Ownership.................................................................................................50 Determining Inventory Ownership .......................................................................50 Viewing Inventory Ownership..............................................................................51 Changing Inventory Ownership ............................................................................51

Inventory Balance Transactions................................................................................52 APICTLs for Inventory Balance Transactions......................................................53 Importing and Exporting Inventory Balance Data ................................................56 Summary of Item Balance Transactions Using Default Settings of the APIs .......56 Recommended API Settings for Exchanging Item Balances ................................58

Purchasing Transactions ...........................................................................................61 Purchase Order Ownership ...................................................................................61

APICTLs for PO Ownership ......................................................................................62 Viewing PO Ownership..............................................................................................63 Changing PO Ownership............................................................................................63

Contents

4

Purchasing Configurations....................................................................................64 Comparison of APICTLs for the Configurations........................................................65 Configuration 1 ..........................................................................................................67 APICTL Control Values for Configuration 1 .............................................................68 Configuration 2 ..........................................................................................................69 APICTL Control Values for Configuration 2 .............................................................70 Configuration 3 ..........................................................................................................71 APICTL Control Values for Configuration 3 .............................................................72 Configuration 4 ..........................................................................................................73 APICTL Control Values for Configuration 4 .............................................................74 Configuration 5 ..........................................................................................................75 APICTL Control Values for Configuration 5 .............................................................76 Other Configurations..................................................................................................77

User Exit Procedures.................................................................................................78 External Procedures ..............................................................................................79 API Integration Points, Default Processes, and the UTRANSTYPE Control.......79

API Processing of Shared Information......................................................................80 Purchasing Data Transfers ....................................................................................80

Transferring Purchase Requisitions from MAXIMO to Oracle Financials ................80 Import errors...............................................................................................................82 Transferring Purchase Requisition Change of Status from Oracle Financials to MAXIMO...................................................................................................................83 Transferring Purchase Orders from Oracle Financials to MAXIMO .........................84 Transferring Purchase Order Change of Status from Oracle Financials to MAXIMO85 Transferring Receipts from Oracle Financials to MAXIMO......................................86 Transferring Purchase Orders from MAXIMO to Oracle Financials..........................87 Transferring Receipts from MAXIMO to Oracle Financials......................................90 Inventory Ownership for Material Receipts Sent to Oracle Financials ......................91 Impact of Inventory Ownership on Material Receipts Imported into MAXIMO .......92 Loaded Costs for Material Receipts that are Imported into MAXIMO ......................92 Loaded Costs in MAXIMO........................................................................................92 Loaded Cost in the APIs.............................................................................................93

Item Data Exchanges ............................................................................................94 Transferring Item Data from MAXIMO to Oracle Financials....................................94 Transferring Item Data from Oracle Financials to MAXIMO....................................96 Transferring Material Reservations/ Demands to Oracle Financials ..........................98 Inventory Ownership for Material Reservations Sent to Your System.......................99 Transferring Material Issues from Oracle Financials to MAXIMO .........................100 Inventory Ownership for Material Issues Sent to MAXIMO ...................................100 Transferring Item Balance Data from Oracle Financials to MAXIMO ....................101

Contents

5

Transferring Item Confirmations to MAXIMO........................................................103 Inventory Ownership with Item Confirmations Sent to MAXIMO..........................103

Vendors...............................................................................................................104 Transferring Vendor Data from Oracle Financials to MAXIMO .............................105

Accounts Payable Data Transfers .......................................................................106 Transferring Invoices from MAXIMO to Oracle Financials ....................................106 Transferring Invoices from Oracle Financials to MAXIMO ....................................107

General Ledger Data Exchanges.........................................................................109 Transferring Journal Entries from MAXIMO to Oracle Financials..........................110 Transferring Entries from INVTRANS to Oracle Financials ...................................112 Transferring Journal Entries from MATRECTRANS to Oracle Financials .............112 Transferring Journal Entries from MATUSETRANS to Oracle Financials .............114 Transferring Entries from SERVRECTRANS to Oracle Financials ........................115 Transferring Entries from LABTRANS to Oracle Financials ..................................116 Transferring Entries from TOOLTRANS to Oracle Financials................................117 Transferring Entries from INVOICETRANS to Oracle Financials ..........................118 Transferring Chart of Accounts Data from Oracle Financials to MAXIMO ............119 GL Synchronization Transformations ......................................................................120 Transferring Accounts from MAXIMO to Oracle Financials...................................120 Transferring Accounts from Oracle Financials to MAXIMO...................................121 MAXIMO Support for the Transformation of the GL Accounts..............................121 Cases Requiring Transformation of GL Accounts....................................................121

MAXIMO Interface Tables.....................................................................................125 Data Columns......................................................................................................125 User Columns......................................................................................................126 Batch Control Columns.......................................................................................126 The User Control Column...................................................................................126 Interface Control Columns..................................................................................127 Status Columns ...................................................................................................128

Error Messages........................................................................................................129 Purchasing Interface Tables ....................................................................................130

MOUT_PR_INTERFACE Table ........................................................................130 MAX_PRX_INTERFACE Table........................................................................142 MAX_PO_INTERFACE Table ..........................................................................152 MAX_POX_INTERFACE Table .......................................................................161 MAX_RCV_INTERFACE Table .......................................................................163 MOUT_PO_INTERFACE Table........................................................................175 MOUT_RCV_INTERFACE Table.....................................................................186

Contents

6

Item Interface Tables ..............................................................................................198 MAX_ITM_INTERFACE..................................................................................198 MOUT_RSV_INTERFACE Table .....................................................................211

Inventory Confirmation Tables ...............................................................................220 MAX_ICF_INTERFACE Table .........................................................................220

Issues Data Tables...................................................................................................229 MAX_ISU_INTERFACE Table.........................................................................229

Vendor Interface Tables..........................................................................................235 MAX_COM_INTERFACE ................................................................................235

Accounts Payable Interface Tables .........................................................................242 MOUT_AP_INTERFACE..................................................................................242 MAX_AP_INTERFACE ....................................................................................252

General Ledger Interface Tables .............................................................................262 MOUT_GL_INTERFACE Table........................................................................262 MAX_COA_INTERFACE Table.......................................................................319 MAX_COAX_INTERFACE Table ....................................................................323

General Ledger Code Combinations from Oracle Financials .................................328 General Ledger Components from Oracle Financials .............................................331 Invoices from Oracle Financials .............................................................................335 Items from Oracle Financials ..................................................................................342 Issues from Oracle Financials .................................................................................349 Balances from Oracle Financials ............................................................................353 Reservations from MAXIMO .................................................................................366 Purchase Orders from Oracle Financials.................................................................375 Receipts from Oracle Financials .............................................................................382 Vendors from Oracle Financials .............................................................................386 Journal Transactions from MAXIMO.....................................................................390 Items from MAXIMO.............................................................................................395 Purchase Orders from MAXIMO with the CAI PO Interface Tables .....................404 Purchase Orders from MAXIMO to the Oracle Standard Purchasing Documents Open Interface Tables .............................................................................................427 Receipt Transfer from MAXIMO to Oracle Financials ..........................................443 Purchase Requisition from MAXIMO ....................................................................450 Invoices from MAXIMO ........................................................................................460

Contents

7

CHAPTER 4: SYSTEM MAINTENANCE................................................................465 Configuring the Database........................................................................................465 Customizing the Integration APIS ..........................................................................466

Using UTRANSTYPE Values with User Exit Procedures .................................467 Using Extra Tables in User Exits ........................................................................467

Using Batch Routines..............................................................................................468 The Batch Routine Process .................................................................................472 Maintaining the Batch Files ................................................................................473

Maintaining the Interface Tables ............................................................................474 Purging the Interface Tables ...............................................................................474 Running Reports .................................................................................................475

Troubleshooting ......................................................................................................476 General Troubleshooting Procedures ..................................................................476 MAXIMO Interface Log.....................................................................................477 Checking Status Columns ...................................................................................478 Debugging Errors Using MAXIMO Interface Flow ...........................................478 Error Messages....................................................................................................480

Transferring Purchase Requisition Changes into MAXIMO....................................480 Transferring Purchase Orders into MAXIMO..........................................................480 Transferring Purchase Order Changes into MAXIMO.............................................481 Transferring Receipts into MAXIMO ......................................................................481

Transferring Invoices into MAXIMO.................................................................482 Oracle Errors.......................................................................................................485

Contents

8

9

CHAPTER 1

INTRODUCTION

This manual provides information about the MAXIMO financial application integration module. Use this integration module to exchange information between Oracle Financials and MAXIMO.

This manual is intended for the following audience:

System administrators Implementation team members MAXIMO users

MAXIMO and Oracle Financials users include people having many types of jobs, including:

Project manager Maintenance manager Accountant Industrial engineer Inventory manager Purchasing manager MIS specialist

Chapter 1

10

Overview The information in this manual is presented in four sections, described below:

Chapter Description

1. Introduction Provides an overview of the MAXIMO financial application integration module.

2. Implementing the Software Integration Describes the system changes you need to make in order to integrate MAXIMOand Oracle Financials.

3. Using the Integration Module Explains how to use the integration APIs in an integrated system, describes the interface tables, and provides the mappings between MAXIMO database tables and the integration module interface tables.

4. System Maintenance Describes how to maintain the interface tables, run batch routines, and troubleshoot the system. Details error messages and error resolutions.

There is a separate installation manual that provides information on your system requirements, preparatory procedures for a successful installation, and installation instructions.

Introduction

11

Related Documentation For a list of verification procedures to follow after you install the integration module, see the file GENVERIF.DOC in the APIDOC directory.

For more information about using MAXIMO, refer to the following sources:

The MAXIMO Users Manual describes how to use the MAXIMO maintenance system features. It provides a thorough overview of MAXIMO features and relationships among modules.

The online Help system provided with MAXIMO provides conceptual and task-oriented information on using MAXIMO.

The MAXIMO System Administrators Guide provides instructions on system administrator functions such as managing the database and customizing the system and the utilities that come with MAXIMO. It also gives instructions for setting up general ledger accounting features within MAXIMO.

The MAXIMO Finance Managers Guide describes both the GL accounts used by MAXIMO as well as the processes involved in creating and using the GL account fields. Processes and transactions are described from both a user perspective and a database management perspective.

You will also need the relevant manuals for Oracle Financials.

By using the MAXIMO Oracle Financials integration module, you can create an integrated system in which MAXIMO interfaces with Oracle Financials. Through its application programming interfaces (APIs), this integration module facilitates access to MAXIMO data and application functions. Therefore, the APIs improve the efficiency of specific business functions performed by MAXIMO customers.

The standard MAXIMO APIs are transparent to users and designed for flexibility. You can mix and match the documented integration points within the limitations of Oracle Financials. However, please note that the standard

Chapter 1

12

MAXIMO APIs provide only the documented integration points, and not unlimited integration points.

The integration module tracks events that cause data to be transferred between systems, as well as the location of the data in each system. The integration module manages the MAXIMO internal functions to ensure that transfers occur smoothly and consistently.

Although a copy of the information is stored in both applications, you maintain it in only one application. By eliminating duplicate functions and processes, the integration module ensures users maximum efficiency.

The integration module processes are modeled after those in MAXIMO. Thus, the module is synchronized with MAXIMO when MAXIMO is updated.

Introduction

13

Integration Overview As shown below, there are five components in an integration between MAXIMO and Oracle Financials.

The MAXIMO application

The MAXIMO APIs, a set of stored Oracle PL/SQL procedures which extract data from MAXIMO and import data into MAXIMO from the related financial system

The integration portion, which passes and validates the data between the two APIs

Oracle Financials APIs, which extract data from the financial system and import data into the financial system from MAXIMO

Oracle Financials

The Oracle Financials integration API is an extension of the standard MAXIMO API and is developed and supported jointly by MRO Software, Inc. and Oracle. MRO Software is responsible for the MAXIMO API and integration components while Oracle is responsible for support and changes to the external system API Installation and upgrade of the Oracle Financials API will still require integration work. Business practices will vary from site to site as will the complexity of the integration. The APIs will, however, reduce the integration development life cycle for the customer as well as expedite future MAXIMO upgrades.

Using the MAXIMO integration APIs, you can both coordinate processes and exchange information between MAXIMO and Oracle Financials. Furthermore, the APIs work behind the scenes, so that MAXIMO and Oracle Financials work together seamlessly. The integration module keeps track of events that will

MAXIMO Integration Oracle Applications

MAXIMO API

Oracle Applications

API

Chapter 1

14

cause data to be transferred between systems and where data is located in the systems. It also manages the MAXIMO internal functions to ensure that transfers occur smoothly and consistently.

The MAXIMO integration APIs transfer inbound and outbound data between applications. The integration APIs move data from the source application to the destination application by way of interface tables, which store the data and any related processing information. MAXIMO provides the interface tables.

As a destination application, MAXIMO receives data from the source application, Oracle Financials, for further processing, storage, or both. The data usually has completed its processing in Oracle Financials before being passed to the destination.

As a source application, MAXIMO sends processed data to the destination application, Oracle Financials, for processing, storage, or both.

For example, you can coordinate the purchasing process between MAXIMO and Oracle Financials. You can send an approved purchase requisition from MAXIMO to Oracle Financials so that a purchase order can be generated in Oracle Financials. The purchase requisition information is placed in an interface table. An integration API sends the information from the interface table to Oracle Financials. The purchase order is generated in Oracle Financials. When the purchase order is approved, the information can be sent to MAXIMO via an interface table. When Oracle Financials receives the item, it generates a receipt record. The receipt information, for the item originally requested in MAXIMO, can be sent back to MAXIMO using another interface table.

Introduction

15

The following diagram illustrates this exchange of purchasing information.

MOUT_PR_INTERFACETable

PO_REQUISITIONS_INTERFACETable

ApprovedRequisition

MAXIMO MOUT_PO_INTERFACETable

MOUT_RCV_INTERFACETable

OracleFinancials

MAXIMO Oracle Financials

Approved Purchase Order

Receipt

For more information about transferring data between applications and the interface tables, see Chapter 3, Using the Integration Module.

MAXIMO and Oracle Financials can share several types of information. In the integrated system, you can:

transfer purchase requisitions from MAXIMO to Oracle Financials transfer purchase orders from Oracle Financials to MAXIMO transfer receipts from Oracle Financials to MAXIMO transfer invoices between applications share item data share vendor data transfer MAXIMO general ledger journal entries to Oracle Financials update the MAXIMO Chart of Accounts application with data from Oracle

Financials

For details about how to use the integration module, see Chapter 3, Using the Integration Module.

Chapter 1

16

17

CHAPTER 2

IMPLEMENTING THE SOFTWARE INTEGRATION

This section describes the system changes necessary to integrate MAXIMO and Oracle Financials. You should make these changes after installing the integration APIs.

The integration team should include individuals that have an understanding of the technical and functional capabilities of both MAXIMO and Oracle Financials. At least one member of the team should be familiar with your organizations business processes, especially those that affect multiple departments. The system or database administrator should also be part of the team.

Implementing the integration of MAXIMO and Oracle Financials consists of evaluating your integration requirements in each of several areas shared between the products, and choosing the implementation method that best suits your needs. Your choices affect how the two applications will share certain information.

You must decide how to match the following information shared by the two applications:

financial calendars currencies tax rates units of measure user names

You do not have to match these settings if you are going to maintain the data separately in the two applications. In this case, you will manually add the information to each application.

Chapter 2

18

If the two applications will share data, you must decide how to make the settings compatible. For example, if Oracle Financials defines currency in terms of the British pound and MAXIMO is configured to use the U.S. dollar, you must decide which currency definition to use and make it the consistent definition for both applications.

The integration does not include a method for matching settings.

Reconfiguring MAXIMO Table Columns You must reconfigure MAXIMO columns to be compatible with Oracle Financials. You may reconfigure the columns either before or after data transactions have occurred, depending on whether you process transactions in real time or in batches.

If you will be using the software integration in real-time (data transactions will occur in real-time, not in batch routines), table and column mapping must be synchronized first. Otherwise, the transactions will fail. If you will be using the software integration via batch routines, and you do not reconfigure the table columns, then you can later use an external process to transform the data to a compatible format.

Compare the MAXIMO tables to the tables in Oracle Financials. Any columns containing data shared between MAXIMO and the financial application must be compatible with respect to these attributes: column length, data type, nulls setting.

You can look in the oramaxcf.sql file to see the fields that the adapter configures during installation. For example, the following statement in that file sets the COMPANY column in the COMPANIES record to a length of 46 characters.

start &&md.maxconf COMPANIES COMPANY 46

If the installation has decreased the length of any of your MAXIMO table columns, use the MAXIMO Database Configuration application to reconfigure the length. Do this before selecting Configure Changes from the Actions option of the Database Configuration Application.

Implementing the Software Integration

19

Modifying Integration API Control Codes

You can modify the integration API control codes and the Oracle Financials control codes to configure the integration module for your system needs. The control code settings regulate data transfers between MAXIMO and Oracle Financials.

Most of the API control codes switch the API on or off. For example, if you do not want to synchronize item data between MAXIMO and Oracle Financials, set the ITMIN or ITMOUT controls to N. If the control code for ITMIN is Y and if a new item is inserted into Oracle Financials, the item data is entered into MAXIMO. To stop that transfer, set the code to N. To stop the transfer of item data from MAXIMO to Oracle Financials, set the control code for ITMOUT to N.

You can further modify some integration APIs with the API controls. For example, you can do more than turn invoice transfers on or off with APIN and/or APOUT. If invoice data is being transferred in, the following control codes will further qualify the incoming data:

APINADJINV Adjusts inventory cost if there is variance.

APINADJDIRECT Adjusts direct cost if there is variance.

APINUPDTVND Updates vendors unit price.

APINAUTORCV Allows invoicing of services not yet received by automatically recording receipt during invoicing.

Not all API control codes are on/off switches. Use the GLDELIMITER control code to specify the general ledger account segment delimiter used in Oracle Financials. The delimiter is a hyphen (-) by default. Use PROLDSTAT and PRNEWSTAT control codes to specify the status of purchase requisitions pending transfers. PROLDSTAT indicates the status that a purchase requisition must be in prior to changing status. PRNEWSTAT indicates the purchase requisition status that triggers the data transfer, providing that the prior status is PROLDSTAT.

Refer to the following table for a complete list of external API control codes that are installed with Oracle Financials API. As discussed at the beginning of Chapter 3, there are two purchasing Configurations:

Chapter 2

20

Configuration 1 and Configuration 2. For some controls, the control value in Configuration 2 must be the opposite of the default control value in Configuration 1. For example, for APICTL, the value for APIN is Y under Configuration 1, but N under Configuration 2. Thus, the cell in the Control Value column reads Y for Configuration 1, N for Configuration 2.

The default values column shows the values as they are when the external APIs are installed. The middle column in the following table indicates whether the APICTL for that row has any impact on Oracle Financials. For example, COMOUT is set to N, since Oracle Financials will not accept updates for companies/vendors from MAXIMO.

API Control Group

Control Applicable for the Oracle Financials API?

Control Value Default

Description

APICTL COA Y Y Receive chart of accounts and account segment data from Oracle Financials to MAXIMO.

APICTL GLDELIMITER Y - GL account segment delimiter for GL data coming from an Oracle Financials. This GL delimiter is used as a placeholder identifier for GL processing (and replaced with the GL delimiter specified in MAXIMO if the delimiter is to be stored in the database).


21

API Control Group



Description

APICTL COMIN Y Y Receive companies data from Oracle Financials to MAXIMO.

APICTL COMOUT N Y Send companies data from MAXIMO to Oracle Financials.

APICTL ITMCATIN Y Y Receive item catalog data from Oracle Financials to MAXIMO.

APICTL ITMCATOUT Y Y Send item catalog data from MAXIMO to Oracle Financials. Global switch.

APICTL ITMNOSTORE Y Y Send item without storeroom information from MAXIMO to Oracle Financials.

APICTL STOCKITEM Y Y Send stocked item from MAXIMO to Oracle Financials.

APICTL NONSTOCKITEM Y Y Send non-stocked item from MAXIMO to Oracle Financials.

APICTL SPITEM Y Y Send special order item from MAXIMO to Oracle Financials.

Chapter 2

22

API Control Group



Description

APICTL ITMSTOREIN Y Y Receive item store data from Oracle Financials to MAXIMO.

APICTL ITMSTOREOUT Y Y Send item store data from MAXIMO to Oracle Financials.

APICTL ITMMFGIN N Y Receive item manufacturer data from Oracle Financials to MAXIMO.

APICTL ITMMFGOUT N Y Send item manufacturer data from MAXIMO to Oracle Financials.

APICTL ITMVNDIN Y Y Receive item vendor data from Oracle Financials to MAXIMO.

APICTL ITMVNDOUT N Y Send item vendor data from MAXIMO to Oracle Financials.

APICTL ITMBALXFROUT N N When Y, send item balance data from MAXIMO to Oracle Financials for MAXIMO-owned inventory only.


23

API Control Group



Description

APICTL ITMBALXFRIN Y N When Y, receive item balance data from Oracle Financials to MAXIMO for externally-owned inventory only.

APICTL EXTRCVOUT Y N When Y, allow receipts for externally-owned inventory to be sent to Oracle Financials.

APICTL EXTISSOUT N N When Y, allow issues for externally-owned inventory to be sent to Oracle Financials.

APICTL MAXRCVIN Y N When Y, allow receipts for MAXIMO-owned inventory to be received into MAXIMO.

APICTL MAXISSIN Y N When Y, allow Issues for MAXIMO-owned inventory to be received into MAXIMO.

Chapter 2

24

API Control Group



Description

APICTL RCVIBUPD Y Y When N, bypass the inventory balance and cost updates associated with a receipt transaction for externally owned inventory coming into MAXIMO. When Y, all updates occur.

APICTL ISSIBUPD Y Y When N, bypass the inventory balance and cost updates associated with an issue transaction for externally owned inventory coming into MAXIMO.When Y, all updates occur.

APICTL ISUIN Y Y Receive material issue data from Oracle Financials to MAXIMO.

APICTL JESERVREC Y Y Send service receipt journal data from MAXIMO to Oracle Financials.

APICTL JEMATUSE Y Y Send item usage journal data from MAXIMO to Oracle Financials.


25

API Control Group



Description

APICTL JELABOR Y Y Send labor journal data from MAXIMO to Oracle Financials.

APICTL JEMATREC Y Y Send item receipt journal data from MAXIMO to Oracle Financials for a receipt against a MAXIMO-owned PO.

APICTL EJEMATREC Y Y Send item receipt journal data from MAXIMO to Oracle Financials for a receipt against an Oracle-owned PO.

APICTL JETOOL Y Y Send tool journal data from MAXIMO to Oracle Financials.

APICTL JEINVOICE Y Y Send invoice journal data from MAXIMO to Oracle Financials.

APICTL JEINVENTORY Y Y Send inventory journal data from MAXIMO to Oracle Financials.

Chapter 2

26

API Control Group



Description

APICTL APIN Y Y for Config 1

N for Config 2

Receive invoice data from Oracle Financials to MAXIMO (invoice details with variance pre-calculated. Global switch

APICTL APINADJINV Y Y Adjust inventory cost (when required) for invoice data received by MAXIMO from Oracle Financials.

APICTL APINADJDIRECT Y Y Adjust direct cost (when required) for invoice data received by MAXIMO from Oracle Financials.

APICTL APINCLOSEPO N Y Close PO on full invoice (when required) for invoice data received by MAXIMO from Oracle Financials.

APICTL APINUPDTVND Y Y Update vendor last cost (when required) for invoice data received by MAXIMO from Oracle Financials.


27

API Control Group



Description

APICTL APINAUTORCV N Y Auto receipt on invoice (when required) for invoice data received by MAXIMO from Oracle Financials. Auto receipt is for service receipt only (as in the MAXIMO application).

APICTL APOUT Y N for Config 1 Y for Config 2

Send invoice data from MAXIMO to Oracle Financials.

APICTL APDETAILS Y Y Send invoice detail data from MAXIMO to Oracle Financials. When set to N, only invoice summary information will be sent.

APICTL APSTART Y APPR If invoice status is equal or greater than control value and not previously sent, invoice will be sent to Oracle Financials.

APICTL PROUT Y Y for Config 1 N for Config 2

Send PR data from MAXIMO to Oracle Financials. Global switch.

Chapter 2

28

API Control Group



Description

APICTL PRINT Y N Send internal PR data from MAXIMO to Oracle Financials.

APICTL PRSERV Y N Send service PR data from MAXIMO to Oracle Financials.

APICTL PRXIN Y Y for Config 1 N for Config 2

Receive PR status updates from Oracle Financials to MAXIMO.

APICTL POIN Y Y for Config 1 N for Config 2

Receive PO data from Oracle Financials to MAXIMO.

APICTL POOUT Y N Send PO data from MAXIMO to Oracle Financials.

APICTL RCVIN Y Y for Config 1

N for Config 2

Receive receipt data from Oracle Financials to MAXIMO.

APICTL RCVINADJINV N (Y) Regardless of control value, adjust inventory cost (when required) for receipt data received by MAXIMO, from Oracle Financials.


29

API Control Group



Description

APICTL RCVINADJDIRECT

N (Y) Regardless of control value, adjust direct cost (when required) for receipt data received by MAXIMO, from Oracle Financials.

APICTL RCVINCLOSEPO Y (Y) Regardless of control value, close PO on full receipt (when required) for receipt data received by MAXIMO, from Oracle Financials.

APICTL RCVINUPDTVND N (Y) Regardless of control value, update vendor last cost (when required) for receipt data received by MAXIMO, from Oracle Financials.

APICTL RCVOUT Y Y for Config 1

N for Config 2

Send receipt data from MAXIMO to Oracle Financials.

APICTL PRGENITEM Y N Replace MAXIMO item number with MAXITEM, the MAXIMO generic value for requisitioned items.

Chapter 2

30

API Control Group



Description

APICTL RCVSVCAPPR Y Y Update Service Receipts on a PO to be approved at the time of receipt.

APICTL PAYONRCPT Y N When set to N, this prevents the Pay On Receipt update from occurring (regardless of the setting on the PO). To allow payment on receipt to occur, set the control to Y.

APICTL WOOUT N N When Y, send work order data to Oracle Financials.

APICTL WOSTART N APPR When work order status is equal to or beyond the status in the control value, work order data is sent from MAXIMO to Oracle Financials.

APICTL WOXIN N N When Y, receive work order status updates from Oracle Financials to MAXIMO.


31

API Control Group



Description

APICTL WOUNAPPACTUALS

N Y When N, a change to the work order status in MAXIMO to Unapprove (WAPPR) will not be allowed when work order actuals exists.

APICTL RSVOUT Y N When Y, send material reservations for externally owned inventory to Oracle Financials from MAXIMO.

APICTL SRVIN N N When Y, receive work order service receipts from Oracle Financials to MAXIMO.

APICTL LPYOUT N N When Y, send work order labor pay data to Oracle Financials from MAXIMO.

APICTL ICFIN Y N When Y, receive reservation confirmation/update from Oracle Financials to MAXIMO.

Chapter 2

32

API Control Group



Description

APICTL RSVONLIN Y N When Y, accept issues only when they have an associated reservation. When N, accept issues regardless of an association to a reservation.

APICTL LOCATIONOUT N N When Y, send locations from MAXIMO to Oracle Financials.

APICTL LOCATIONIN N N When Y, receive locations from Oracle Financials to MAXIMO.

APICTL EJESERVREC Y Y Send service receipt journal data from MAXIMO to Oracle Financials for a receipt against an Oracle-owned PO.

APICTL POSTART Y APPR If PO status is equal or greater than control value, the PO will be sent to Oracle Financials.

APICTL PRSTART Y APPR If PR status is equal or greater than control value and not previously sent, the PR will be sent to Oracle Financials.


33

API Control Group



Description

APICTL ERCVOUT Y Y When Y, send receipts from MAXIMO to Oracle for a receipt against an Oracle-owned PO.

APICTL ISUOUT N Y Send Material Issues from MAXIMO to Oracle Financials.

APICTL WOIN N N When Y, accept work orders from Oracle Financials to MAXIMO.

APICTL LPYIN N Y When Y, accept Labor Pay transactions from Oracle Financials into MAXIMO.

APICTL PRIN N N When Y, accept Purchase Requisitions from Oracle Financials into MAXIMO.

APICTL GLUPDATE N Y When Y, allow online changes to the WO GL account after the WO has been sent to the external system (WOOUT = Y).

APICTL SYSTEMOUT N N When Y, send systems from MAXIMO to Oracle Financials.

Chapter 2

34

API Control Group



Description

APICTL SYSTEMIN N N When Y, receive systems from Oracle Financials to MAXIMO.

APICTL APITRANS N N When Y, insert to MAX_API_TRANS for outbound interface transactions defined in the API.

APICTL RCVINGL Y Y Journal Receipt

APICTL RCVINGLINV Y Y Journal Inventory Adjustment

APICTL RCVINGLDIRECT Y Y Journal Direct Adjustment

APICTL APINGL Y N

APICTL APINVARGL Y N

APICTL APINGLINV Y Y

APICTL APINGLDIRECT Y N

APICTL JESPLITDBCR Y Y

API Control Group

Control Applicable to Oracle Projects?

ControlValue Default

Description

APICTL FCIN Y Y Financial Control to MAXIMO

APICTL PROJECTOUT Y Y Projects from MAXIMO

APICTL TASKOUT Y Y Tasks from MAXIMO


35

APICTL ACTUALSOUT Y Y Project Actuals from MAXIMO

APICTL LCIN Y Y Labor to MAXIMO

APICTL BUDGETOUT Y Y Budget from MAXIMO

Use MAXIMO Application Setup to change the control code values. Choose APICTL from the value list to access the control codes. For more information about using the MAXIMO Application Setup application, refer to the MAXIMO System Administrators Guide.

For more information about how the data is transferred, see Chapter 3, Using the Integration Module.

Oracle Financials Control Codes

The Oracle Financials control codes modify the integration APIs between MAXIMO and Oracle Financials. Many of the Oracle Financials control codes either further control the behavior of the APIs or provide defaults specific to Oracle Financials that are not available in MAXIMO. Some Oracle Financials control codes may turn the APIs on or off based upon qualifiers that are unique to Oracle Financials.

The MAXIMO Chart of Accounts application supports only one Chart of Accounts ID from Oracle Financials. The APIs filter code combination values coming from Oracle Financials to MAXIMO according to the value set in the value list OFCTL.GLCOAID. However, MAXIMO accepts code combinations for multiple sets of books, if each set of books has the same Chart of Accounts ID.

In contrast, data passing from MAXIMO to Oracle Financials may need a unique ID for each set of books, but MAXIMO only supports one set of books. Thus, by default, for journal transactions to the GL_INTERFACE table, and for invoices transferred to the tables AP_EXPENSE_REPORT_HEADERS and AP_EXPENSE_REPORT_LINES, the Set of Books ID is the value in OFCTL.GLSOBID. However, you can write your own user exits in OGLX.SP and OAPX.SP to support multiple sets of books. Replace the

Chapter 2

36

value automatically written to Set of Books ID with your derived Set of Books ID.

The controls GLSOBID, GLCOAID and GLRCVECUMBID require Oracle Financials internal identifiers (keys). These keys are not visible to you on the application screens. Ask your database administrator or Oracle consultant to obtain these keys by querying the tables directly.

GLSOBID and GLCOAID values can be obtained from the ORG_ORGANIZATION_DEFINITIONS table. You must obtain your organization code, then view this table for the SET_OF_BOOKS_ID and CHART_OF_ACCOUNTS_ID column values.

The MAXIMO Purchasing applications support a second base currency that can be used to track transactions in a second currency, allowing for Euro currency reporting. Likewise, Oracle Financials uses Multiple Reporting Currencies (MRC) functionality to provide similar support. The main difference between the two is that MAXIMO has a limit of one additional currency, whereas Oracle allows for multiple reporting currencies for a single base (primary) currency.

The APIs support this multi-currency functionality in the following manner. All transactions sent to Oracle Financials will have their reporting currency calculated upon entry with the conversion rates stored in Oracle Financials. Transactions sent to MAXIMO will retrieve the Oracle Financials conversion rates which will then be used to calculate the MAXIMO second currency amount. Therefore, all transactions sent between the two systems will use the conversion rates that are held in Oracle Financials.

The GLSOBID2 control needs to be set to the code for the reporting set of books in Oracle. The currency for that reporting set of books should match the MAXIMO second currency code.

The GLRCVECUMBID value can be obtained for the GL_ENCUMBRANCE_TYPES table. You can only have one encumbrance type in MAXIMO, i.e., on a receipt against a purchase order. The likely encumbrance value will be the one used for purchasing in Oracle Financials. You need to set up the encumbrance value only if you plan to do receiving in MAXIMO and not update Oracle Financials with the receipts. (Refer to Purchasing Configuration 2 in Chapter 4).


37

Note that currently there is no integration API for transferring receipts from MAXIMO to Oracle Financials. Oracle is planning to provide this functionality at a later date. However, if this functionality is implemented through a consultant or a third party, then the encumbrance type ID is required.

The GENUSR and GENSTORE flags provide mechanisms to substitute the MAXIMO user and storeroom information. When GENUSR is enabled, the API replaces the MAXIMO user with the user MAXIMO. This provides a way to not add all MAXIMO users in Oracle Financials. Since you can enforce security within MAXIMO, if you have only a generic user defined in Oracle Financials with appropriate responsibilities, it is easier to manage users across systems. If this is not acceptable to you, and Oracle Financials must validate the user, then the GENUSR flag should be set to N. GENSTORE is similar to GENUSR, as it allows storerooms being transferred to be generalized. When GENSTORE is set to Y; it acts as a filter for data coming into MAXIMO. Only information for one organization, i.e., the master organization defined in ITMORG, is allowed to pass through.

For data going out of MAXIMO, the storeroom code is replaced with the value in ITMORG. As well, for PO receipt transactions, the subinventory code is populated with the value in ITMSUB, instead of the Bin Number from MAXIMO. Thus, when GENSTORE is set to Y, storeroom and organizational/bin and subinventory information need not be in sync in both systems. When GENSTORE is set to N, the MAXIMO storeroom code is transferred to the Oracle Financials organization code for all item data being transferred from MAXIMO.

For data coming from Oracle Financials, the organization code is validated against the MAXIMO storeroom location. If the code exists, the item is inserted/updated for that storeroom location. When Genstore is N, the bin and subinventory codes are transferred to each other for PO receipt transactions going in both directions.

NOTE: The Current APIs support full storeroom synchronization, i.e., synchronization of balances, issues and reservations for Oracle owned inventory. This is not supported for MAXIMO-owned inventory. Item synchronization for MAXIMO-owned inventory primarily supports purchasing.

Chapter 2

38

Vendor APIs between MAXIMO and Oracle Financials implement additional logic to compensate for differences between the two systems. The Vendor code in MAXIMO is a concatenated value consisting of VENDOR_SEGMENT1 and VENDOR_SITE_CODE. Similarly, purchase order line numbers in MAXIMO are also made on concatenated values. In Oracle Financials, any release PO has a different identifier than the originating blanket PO. Thus, for release purchase orders sent from Oracle Financials to MAXIMO, the identifier (PONUM in MAXIMO) consists of the blanket PO number concatenated with the release number. Refer to the mapping for further details.

Refer to the following table for a list of the integration API control codes, their descriptions, and default settings.

Oracle Financials Control Group

Control Control Value Description

OFCTL GLSOBID 0 Set of Books ID

OFCTL GLSOBID2 0 Reporting Set of Books ID

OFCTL GLCOAID 0 Chart of Accounts ID

OFCTL GLCURNCY USD Default currency code

OFCTL GLCURNCYTYPE User Currency conversion type

OFCTL GLRCVECUMBID 0 Receipt encumbrance type ID. This is the internal ID for the encumbrance type code used for purchase order encumbrance


39



OFCTL PRSTOCK INVENTORY

Oracle Financials destination type code for inventory items

OFCTL PRDIRECT EXPENSE Oracle Financials destination type code for direct issue items

OFCTL PRSERVLINETYPE SERVICE Requisition line type for services. All other MAXIMO PR lines use the default requisition line type as defined in Oracle Financials

OFCTL ITEMCATID X Purchasing category for non-service PR lines without a valid item ID (e.g., materials and SP items)

OFCTL SERVCATID X Purchasing category for service PR line type

OFCTL USEPRNUM N Use PRNUM for requisition number.

OFCTL ITMORG XXX Inventory master organization

Chapter 2

40



OFCTL ITMINV Y Inventory item flag used when a new item is added in MAXIMO and transferred to Oracle Financials

OFCTL ITMINT Y Internal order enable flag used when a new item is added in MAXIMO and transferred to Oracle Financials

OFCTL GENSTORE N Mask MAXIMO storeroom

OFCTL JEITMREC MAXIMO1 Journal category for item receipts (commitment/ encumbrance)

OFCTL JEITMRECINVC MAXIMO1 Journal category for invoice adjustment/auto for receipts

OFCTL JEITMRECRET MAXIMO1 Journal category for item receipt returns

OFCTL JEITMRECTRANS MAXIMO1 Journal category for receipts (transfers)

OFCTL JEITMISS MAXIMO1 Journal category for item usage

OFCTL JEITMISSINVC MAXIMO1 Journal category for invoice adjustment for usage


41



OFCTL JEITMISSRET MAXIMO1 Journal category for item usage returns

OFCTL JEITMISSTRANS MAXIMO1 Journal category for item usage (transfers)

OFCTL JEITMAVGADJ MAXIMO1 Journal category for inventory average cost adjustments

OFCTL JEITMCAPADJ MAXIMO1 Journal category for inventory capital cost adjustments

OFCTL JEITMBALADJ MAXIMO1 Journal category for inventory current balance adjustments

OFCTL JEITMSTDADJ MAXIMO1 Journal category for inventory standard cost adjustments

OFCTL JEITMRECADJ MAXIMO1 Journal category for inventory standard receipt adjustments

OFCTL JELABWORK MAXIMO1 Journal category for labor (work) reporting

OFCTL JELABNWORK MAXIMO1 Journal category for labor (non-work) reporting

Chapter 2

42



OFCTL JESERVREC MAXIMO1 Journal category for service receipts (commitment/ encumbrance)

OFCTL JEINVCCVAR MAXIMO1 Journal category for invoice currency variances

OFCTL JEINVCIVAR MAXIMO1 Journal category for invoice variances

OFCTL JEINVCTAX1 MAXIMO1 Journal category for invoice TAX 1 type transactions





OFCTL JEINVOICE MAXIMO1 Journal category for invoice payables


43



OFCTL JETOOL MAXIMO1 Journal category for tool usage

OFCTL POLINETYPE Goods PO line type for non-service PO lines

OFCTL OPERUNITID 0 Default Operating Unit ID

OFCTL SUBLOCDEL - Delimiter to separate the Oracle Subinventory code and Locator ID when populating the MAXIMO BIN

OFCTL PAYTERMSID 0 Default Payment Terms used for sending POs to Oracle

OFCTL GLVALIDATE Y Validate the GL accounts prior to sending to Oracle

OFCTL DMDSRCTYPE MAXIMO1 Demand Source Type used for Reservations being sent to Oracle

OFCTL APLINETYPE MAXIMO1 Invoice line type

OFCTL GENUSR N Mask MAXIMO user

OFCTL ITMSUB STORES MAXIMO Inv default subinv

Chapter 2

44

Oracle Projects Control Group


OFCTL EXPENDTOOL Tools Expenditure Type for Tools

OFCTL EXPENDITEM Materials Expenditure Type for Materials

OFCTL EXPENDLABOR MAX-Labor-L Expenditure Type for Labor

OFCTL RESLEVELTOOL 1 Resource Level for Tools

OFCTL RESLEVELITEM 1 Resource Level for Materials

OFCTL RESLEVELLABOR 1 Resource Level for Labor

OFCTL PAORG 204 Project Organization

OFCTL PAUSER MAXIMO Project Accounting User

OFCTL PAVERSIONID 1 Project Acct Version

OFCTL PAPRODCODE MAXIMO Project Acct Product Code

OFCTL CHARGEORG Consulting-West

Charging Organization

OFCTL NLRORG Consulting-West

NLR Owning Organization

OFCTL BUDGETTYPE Approved Cost Budget

Default Budget Type Code

OFCTL SRCUSE MAXIMO-U Trans Source for Usages

OFCTL SRCEXP MAXIMO-E Trans Source for Expenses

OFCTL LABORCOSTED N Labor Codes sent as Costed


45



OFCTL CRAFTCOSTED N Craft Codes sent as Costed

OFCTL SRCTIM-NC MAXIMO-T Trans Src - Non-Costed

OFCTL SRCTIM-C MAXIMO-T-C

Trans Src - Costed

OFCTL RESLIST MAXIMO 'Default Resource List

OFCTL JETOOLAPI N Send Non-Project Tool JE to Oracle GL

OFCTL JETOOLAPIPR N Send Project Tool JE to Oracle GL

OFCTL JELABORAPI N Send Non-Project Labor JE to Oracle GL

OFCTL JELABORAPIPR N Send Project Labor JE to Oracle GL

OFCTL JEMATUSEAPI N Send Non-Project Matl Usage JE to Oracle GL

OFCTL JEMATUSEAPIPR N Send Project Matl Usage JE to Oracle GL

OFCTL JEMATRECAPI N Send Non-Project Receipt to Oracle GL

OFCTL JEMATRECAPIPR N Send Project Receipt to Oracle GL

OFCTL PROJPAY No Use Projects Pay Rate

Chapter 2

46



OFCTL CONVHRS 2080 Annual Converted to Hourly Rate

OFCTL PROJAPPR APPROVED Proj Status for WO Appr

OFCTL PROJCOMP PENDING_CLOSE

Proj Status for WO COMP

OFCTL PROJCLOS CLOSED Proj Status for WO CLOSE

OFCTL PROJPR No Send Projects Data on PR

OFCTL PROJPO No Send Projects Data on PO

OFCTL PROJAP No Send Projects Data on AP

OFCTL WOHEIRVAL No Validate FC/WO Heirarchies

Use the MAXIMO Application Setup application to change the control code values. Choose OFCTL from the value list to access the control codes. For more information about using the MAXIMO Application Setup application, refer to the MAXIMO System Administrators Guide.

For more information about how the data is transferred, see Chapter 3, Using the Integration Module.


47

Customizing Integration Procedures The MAXIMO integration module transfers data between MAXIMO and the MAXIMO interface tables. However, you must customize the external integration procedures to transfer the data between the MAXIMO interface tables and Oracle Financials.

MRO Software provides interface tables as integration points for all outbound transfers. These interface tables insulate your data from the internal processing in MAXIMO. They also assure you of a consistent view of the data during MAXIMO upgrades. You should connect to these integration points and provide the means to integrate to these points.

After the MAXIMO integration API writes to the interface table, the API calls an external integration procedure, which acts as a template for your custom procedure. All of the MAXIMO external integration procedures include sample code to guide you in the development of integration procedures to Oracle Financials. Note that these integration procedures are for real-time routines. In a batch environment, you need not use these procedures.

WARNING: The Oracle Financials integration module includes vendor-supported external integration procedures provided by MRO Software and Oracle. While Oracle Financials users can customize the user exit procedures, they should not customize the external integration procedures.

There are many file types in the integration module. Files containing triggers have the filename extension .TRG; files containing packages have the filename extensions .PSP and .PKG; files containing stored procedures have the filename extension .SP; and files containing user exit procedures have the filename extension .USP. You should modify only .USP (user exits) and e*.SP (external integration procedures) files.

Chapter 2

48

49

CHAPTER 3

USING THE INTEGRATION MODULE

Use the MAXIMO financial application integration module to transfer and process data between MAXIMO and Oracle Financials. The integration module does not change the basic functions of either application.

Most of the integration APIs in the module involve purchasing processes and the general ledger.

The APIs provide the interface tables as integration points for inventory location and balance updates. The interface tables accept storeroom locations from your Oracle inventory system so that MAXIMO can create them in its applications, and send storeroom information from MAXIMO to your Oracle system. The inventory balance interface synchronizes item balance and cost information between the two applications by overlaying the existing item balance and cost data, in MAXIMO, with values sent from your Oracle Inventory system.

NOTE: The current integration for Oracle Financials does not support sending balance and cost information from MAXIMO to Oracle Inventory. The MAXIMO integration gateway can be set up to send balances from MAXIMO to the MAX_ITM_INTERFACE table. However, there is no method of moving that data from the interface table into the Oracle Inventory tables. Any mention of sending balances and costs from MAXIMO is there only to help describe functionality.

The inventory balance API uses the MAX_ITM_INTERFACE table to contain data for transactions coming into MAXIMO from your Oracle Inventory system.

Chapter 3

50

NOTE: If a storeroom location in MAXIMO is created by an API (rather than by MAXIMO), MAXIMO does not automatically grant user access to that storeroom. The system administrator must set user-level security for anyone who needs to process transactions for that storeroom in MAXIMO. This security is set in the usual manner in theMAXIMO Signature Security application.

Inventory Ownership The inventory ownership, which is defined by the combination of an item and its location, determines the direction of the data flow for inventory balance and cost transactions.

MAXIMO owned inventory is inventory that is created in MAXIMO by a MAXIMO application.

Oracle owned inventory is created in MAXIMO by the Integration Gateway.

Determining Inventory Ownership

The APIs determine the inventory ownership by identifying how the inventory was created in MAXIMO. As explained above, inventory created via the integration module is owned by your Oracle Financials system and inventory created by a MAXIMO table in MAXIMO contains the column INVOWNER. The value in the INVOWNER column is set to E (external) for an inventory record that the integration module creates. If the value is anything other than E, the inventory is treated in all transactions as though it is MAXIMO owned.

WARNING: The integration module treats all inventory records that were created in versions of MAXIMO before Release 4.0 as MAXIMO owned.

Using the Integration Module

51

Viewing Inventory Ownership

To view the owners of your inventory data, perform the following query using SQL*Plus or any other SQL language:

Select INVOWNER from INVENTORY where ITEMNUM = your item number and LOCATION = your storeroom location;

Query results:

Items with INVOWNER = E are treated as Oracle owned inventory by the APIs.

Items with INVOWNER E are treated as MAXIMO owned inventory by the APIs. When INVOWNER is set to any value other than E, including NULL values and spaces, the APIs treat the associated item number as MAXIMO owned.

Changing Inventory Ownership

To change the owner of the inventory, enter the following SQL statement:

Update INVENTORY Set INVOWNER = E (for Oracle owned; use any other value for MAXIMO owned) Where ITEMNUM = your item number and LOCATION = your storeroom location;

Commit;

Chapter 3

52

Inventory Balance Transactions The APIs do not allow an update of inventory balances in both directions for any single combination of an item and its location. The integration currently supports receiving balance transactions from the Oracle Inventory system to update MAXIMO inventory tables.

Direction of Inventory Balance Updates:

MAXIMOowned

Inventory

Oracleowned

Inventory

MAXIMOowned

Inventory

Oracleowned

Inventory

MAXIMO Oracle InventorySystem

No

No

No

Yes


53

APICTLs for Inventory Balance Transactions

Usually, the application that is the owner of the inventory performs all transactions (including receipts and issues) that affect the balances of that inventory. However, the APIs provide capabilities for receipt and issue transactions on the system that does not own the inventory. The table below shows the default settings for the API controls associated with inventory transactions.

Value Default Description

ITMSTOREIN Y Adds item to a location in MAXIMO. Also creates the location in MAXIMO if it doesnt exist.

ITMSTOREOUT Y Exports item and storeroom location updates to the Oracle Financials system.

ITMBALXFRIN N Allows MAXIMO to import item balances for Oracle owned inventory.

If set to Y, it imports item balances and cost updates for Oracle owned inventory, when the inventory balances are updated in Oracle.

Chapter 3

54


ITMBALXFROUT N NOTE: This transaction is not supported by the current integration between MAXIMO and Oracle Inventory. When the value is set to Y, data will update the MAX_ITM_INTERFACE table, but it will NOT update the Oracle Inventory tables.

Allows item balances of MAXIMO owned inventory to be exported from MAXIMO.

If set to Y, it exports item balance and inventory cost updates from MAXIMO for MAXIMO owned inventory.

All cost adjustments (both standard and average), balance adjustments, and physical count adjustments performed by MAXIMO for Oracle owned inventory cause an API error that you see on the user screen in MAXIMO and cause a database rollback.

All receipt and issue transactions performed by MAXIMO for Oracle owned inventory cause a database rollback and an API error that you see on the user screen in MAXIMO. You can override this condition by setting the EXTRCVOUT and EXTISSOUT switches to Y. If you set these switches to Y, MAXIMO completes the transactions and sends them to your Oracle Financials system. However, MAXIMO does not send the inventory balance update that occurs as part of the transaction to your Oracle Financials system, since the inventory is not MAXIMO owned.

EXTRCVOUT N If set to Y when RCVOUT = Y, allows item receipts for Oracle owned inventory to be exported.


55


EXTISSOUT N Note: This transaction is not supported by the current integration between MAXIMO and Oracle Inventory. When the value is set to Y, data will update the MOUT_ISU_INTERFACE table, but it will NOT update the Oracle Inventory tables.

If set to Y when ISSOUT = Y, allows item issues for Oracle owned inventory to be exported.

MAXRCVIN Y If set to Y when RCVIN = Y, allows item receipts for MAXIMO owned inventory to be imported.

MAXISSIN Y If set to Y when ISUIN = Y, allows item issues for MAXIMO owned inventory to be imported.

RCVIBUPD N When set to Y, performs the inventory balance updates for Oracle owned inventory as part of the receipt transaction when the receipt is imported into MAXIMO.

ISSIBUPD N When set to Y, performs the inventory balance updates for Oracle owned inventory as part of the issue transaction when the issue transaction is imported into MAXIMO.

Chapter 3

56

Importing and Exporting Inventory Balance Data

Importing MAXIMO can import balance data only for Oracle owned inventory and only when the ITMBALXFRIN and ITMSTOREIN controls are set to Y.

Exporting Note: Sending balance transactions from MAXIMO to Oracle Inventory is not supported by the current integration.

MAXIMO can export balance data only for MAXIMO owned inventory and only when the ITMBALXFROUT and ITMSTOREOUT controls are set to Y.

Summary of Item Balance Transactions Using Default Settings of the APIs

The information below summarizes how the APIs transfer item balance data when the default API settings are in place.

Using the Default API settings:

Item storeroom information is exchanged between MAXIMO and your financial system. MAXIMO creates locations in its applications if they dont already exist. You can modify this activity by using the ITMSTOREIN and ITMSTOREOUT controls.

You cannot transfer item balances. You can modify this activity by using the ITMBALXFROUT(not currently supported) and ITMBALXFRIN controls.

You cannot perform item balance and cost adjustments on Oracle owned inventory in any MAXIMO application. The APIs prevent MAXIMO from completing these transactions and display an error message on the relevant MAXIMO screen. You also cannot import into MAXIMO any item balance and cost adjustments performed on MAXIMO owned inventory. The APIs hold these transactions in the MAX_ITM_INTERFACE table and display an error in that tables IMPORTSTATUS column.


57

You cannot modify this activity by using a control switchthese processes are based strictly on inventory ownership. See Inventory Ownership on page 50 for information on modifying inventory ownership.

You cannot perform item receipt and issue transactions against Oracle owned inventory in any MAXIMO application. The APIs prevent MAXIMO from completing these transactions and display an error message on the relevant MAXIMO screen. You can modify this activity by using the EXTRCVOUT and EXTISSOUT controls.

You cannot import item receipt and issue transactions on MAXIMO owned inventory. The APIs hold these transactions in the MAX_RCV_INTERFACE and MAX_ISU_INTERFACE tables and display an error in the IMPORTSTATUS column. You can modify this activity by using the MAXRCVIN and MAXISSIN controls.

Inventory balance updates are performed as part of the item receipt and issue transactions that you import into MAXIMO for MAXIMO owned inventory.

These updates are not performed as part of the item receipt and issue transactions you import into MAXIMO for Oracle owned inventory. However, you can allow balance updates for Oracle owned inventory by using the RCVIBUPD and ISSIBUPD settings. When you set these controls to Yes, MAXIMO creates the receipt and updates the inventory balance to reflect the receipt. When you set these controls to No, MAXIMO creates the receipt but does not update the inventory balance.

There is an override switch for these controls that you can set on a per-transaction basis. This override switch is a column called IBUPD, found in the MAX_RCV_INTERFACE and MAX_ISU_INTERFACE tables. If you set this override switch to N for a specific transaction, the APIs do not perform inventory balance updates with that transaction, even if the control switches RCVIBUPD and ISSIBUPD are set to Y.

NOTE: You cannot set this switch to Y to override the RCVIBUPD and ISSIBUPD switches being set to N.

Chapter 3

58

We make this feature available because balance transfers to MAXIMO of Oracle owned items usually follow receipt and issue transactions and overwrite the inventory balances in MAXIMO.

Recommended API Settings for Exchanging Item Balances

We recommend the following settings for the APICTL control switches when you want to exchange item balance information between MAXIMO and your Oracle Financials system.

NOTE: You can choose to send information one way only, i.e., send only Oracle owned inventory to MAXIMO or send only MAXIMO owned inventory to your Oracle Financials system.

APICTL Applicable to:

(B) MAXIMO

(O) Oracle Financials

(B/O) Both

MAXIMO-owned

Not in Oracle Financials System

MAXIMO-owned

In Oracle Financials System

Oracle-owned

View is in MAXIMO

ITMCATIN B/O Y (Optional for standardized or centralized part numbers.)

Y (For standardized or centralized part numbers.)

Y

ITMCATOUT B/O N Y (For Spot Buys)

N/A

ISUIN B/O N N Y

ISUOUT B N/A N/A N/A

JEINVENTORY B/O N Y N

JEMATUSE B/O Y Y N


59

APICTL Applicable to:

(B) MAXIMO

(O) Oracle Financials

(B/O) Both

MAXIMO-owned

Not in Oracle Financials System

MAXIMO-owned

In Oracle Financials System

Oracle-owned

View is in MAXIMO

ITMBALXFROUT B N/A N/A N/A

ITMSTOREOUT B N Y (For centralized inventory visibility.)

N/A

ICFIN E N/A N/A Y

RSVOUT E N/A N/A Y

ITMBALXFRIN E N/A N/A Y

ITMSTOREIN E N/A N/A Y

With these settings, the APIs will work as follows:

You can transfer item storeroom information between MAXIMO and your Oracle Financials system. The integration module creates locations in MAXIMO if the locations do not already exist. You can modify this activity with the ITMSTOREIN and ITMSTOREOUT controls.

The APIs will import the item balances of Oracle owned inventory into MAXIMO after your Oracle Financials system inserts them into the MAX_ITM_INTERFACE table. You can control this activity with the ITMBALXFRIN control.

You cannot use MAXIMO to perform item balance and cost adjustments on Oracle owned inventory. The APIs prevent these transactions from being completed and display an error message on the relevant MAXIMO screen. MAXIMO does not import item balance and cost adjustments on MAXIMO

Chapter 3

60

owned inventory. This data is stopped in the MAX_ITM_INTERFACE table; the table displays an error in the IMPORTSTATUS column. You cannot control these processes with control switches; this activity is based on inventory ownership. See Inventory Ownership on page 50 for information on modifying inventory ownership.

If needed, you can use MAXIMO to perform item receipt transactions on Oracle owned inventory; the APIs send updates to your Oracle Financials system. You can control this with the EXTRCVOUT control.

If needed, you can import item receipt and issue transactions for MAXIMO owned inventory. You can control this activity with the MAXRCVIN and MAXISSIN controls.

If you are using the standard integration control settings, the integration module does not do the usual inventory balance update as part of the item receipt and issue transaction for Oracle owned inventory that is imported into MAXIMO. If you want to modify this activity, see the information on the API settings RCVIBUPD and ISSIBUPD, which control updates to inventory balances (APICTLs for Inventory Balance Transactions on page 53).

NOTE: Externally owned inventory costs in MAXIMO may not match costs in Oracle if processes in Oracle Financials affect the costs without sending the transaction information to MAXIMO via the API.


61

Purchasing Transactions The APIs provide the interface tables as integration points for purchasing transactions. Using the APIs, you can exchange purchase requisition data, purchase order data, and receipt data between the systems. Several interface tables are used for these transactions. See Purchasing Interface Tables on page 130 for more information on these transactions.

Purchase Order Ownership

As of Release 4.0.3 of the integration module, purchase orders are considered to be owned by the application that creates them:

Oracle owned purchase orders were created in MAXIMO by the Integration Gateway.

MAXIMO owned purchase orders were created in MAXIMO by a MAXIMO application.

Since the integration module can both send and receive purchase orders, there can be both MAXIMO and Oracle owned POs in the MAXIMO system at one time. We provide several APICTLs that allow you to control the POs for which you send receipts, material receipt journal entries, and service receipt journal entries.

Chapter 3

62

APICTLs for PO Ownership

RCVOUT Controls sending receipts for MAXIMO owned POs.

RECEIPTS

ERCVOUT Controls sending receipts for Oracle owned POs.

JEMATREC Controls sending material receipt journal entries for MAXIMO owned POs. MATERIAL RECEIPT JOURNAL ENTRIES EJMATREC Controls sending material receipt journal entries for Oracle owned POs.

JESERVREC Controls sending service receipt journal entries for MAXIMO owned POs. SERVICE RECEIPT JOURNAL ENTRIES EJSERVREC Controls sending service receipt journal entries for Oracle owned POs.

See Chapter 2, Implementing the Software Integration, for more information on these controls.

WARNING: The integration module treats all PO records that were created in versions of MAXIMO before Release 4.0.3 as MAXIMO owned.


63

Viewing PO Ownership

To view the owners of your purchase order data, perform the following query using SQL*Plus or any other SQL language:

Select OWNERSYSID from PO where PONUM = your purchase order number;

Query results:

POs with OWNERSYSID = Null are treated as MAXIMO owned POs by the APIs.

POs with OWNERSYSID = OA are treated as Oracle owned POs by the APIs.

Changing PO Ownership

To change the owner of the purchase order, enter the following SQL statement:

Update PO Set OWNERSYSID = OA (OA for Oracle owned; use Null for MAXIMO owned) Where PONUM = your PO number;

Commit;

Chapter 3

64

Purchasing Configurations

Purchasing data transactions are supported by five configurations in the Integration Gateway. You should evaluate which configuration is the best model of your purchasing management practices, then implement the APIs for it. You can choose not to implement specific processes in the configuration you use, but you cannot change any of the processes in a configuration.

The configuration processes are supported by a set of API controls. Each discussion of the configurations lists the primary API control settings for that configuration. To implement a specific configuration, you must match your control settings to those listed.

NOTE: Chapter 2 includes a list of all APICTLs and their default settings. You should review all the APICTLs and their settings, as they may affect other processes you use.

Common purchasing transactions supported by configurations in the integration module are summarized in the following table. Most of the transactions are labeled to specify the configuration to which they apply. Several of the transactions apply to more than one configuration. Each configuration is explained in more detail in the sections following this table.

Purchasing Transaction Related Configuration(s)

Create purchase requisitions in MAXIMO. All

Send purchase requisitions from MAXIMO to your financial system.

Configuration 1

Send approved purchase orders from your financial system to MAXIMO.

Configuration 1

Send approved purchase orders from MAXIMO to your financial system.

Configurations 2, 4, and 5

Process receipts in MAXIMO and transfer the receipt data to your financial system.

Configurations 4 and 5


65

Purchasing Transaction Related Configuration(s)

Process receipts in your financial system and transfer the receipt data to MAXIMO.


Exchange vendor information. All

Generate invoices in the Oracle Financials financial system and transfer the invoice data to MAXIMO.

Configurations 1, 2, and 4

Generate invoices in MAXIMO and transfer the invoice data to your financial system.


Send invoice variances from the Oracle Financials system to MAXIMO.

All

Transfer chart of accounts data from your financial system to the MAXIMO Chart of Accounts application.

All

Transfer purchasing-related general ledger journal entries from MAXIMO to your financial system.

Configuration 3

Comparison of APICTLs for the Configurations

The table below compares some of the most important APICTL settings for each configuration. Note that there are additional APICTL values that affect how the two systems exchange information. See Chapter 2, Implementing the Software Integration, for a list of all APICTLs and their default values.

Setting for Configuration: API Control

1 2 3 4 5

APIN Y Y N Y N

APOUT N N Y N Y

PROUT Y N N N N

Chapter 3

66

Setting for Configuration: API Control

1 2 3 4 5

POIN Y N N N N

POOUT N Y N Y Y

RCVIN Y Y N N N

RCVOUT N N N Y Y

JEMATREC N N Y N N

JESERVREC N N Y N N

JEINVOICE N N Y N N

APDETAILS N N Y/N N N

APINADJINV Y Y Y Y Y

APINADJDIRECT Y Y Y Y Y


67

Configuration 1

Configuration 1 supports distributed (decentralized) requisitioning, centralized purchasing, receiving, and invoicing activities.

In the first configuration:

Create purchase requisitions with MAXIMO at the decentralized location and send them to your financial system.

Generate purchase orders at a central location with your purchasing system and send them to MAXIMO.

Use your purchasing system if you receive items at a central location.

Receive invoices and process them at a central location using your accounts payable system.

Send details, including variances, of approved/matched invoices from your accounts payable system to MAXIMO for further processing. MAXIMO will use this data to update inventory and direct costs at the decentralized location.


Exchange vendor information.

Chapter 3

68

APICTL Control Values for Configuration 1

If your processes are the same as those described for Configuration 1, you should set your APICTL control code values as shown below. Use Application Setup in MAXIMO to view or change these codes.

The controls listed below are the primary controls for this configuration. However, you should review all the control codes listed in chapter 2 and set them according to the configuration that you implement.

Control Control Value

APIN Y

APOUT N

PROUT Y

POIN Y

POOUT N

RCVIN Y

RCVOUT N

JEMATREC N

JESERVREC N

JEINVOICE N

APDETAILS N

APINADJINV Y

APINADJDIRECT Y


69

Configuration 2

Configuration 2 supports distributed requisitioning and purchasing in MAXIMO; and centralized receiving, invoicing, and accounts payable activities.

In the second configuration:

Create and process purchase requisitions in MAXIMO.

Create purchase orders in MAXIMO send them to the Oracle Financials system.

Process receipts at a centralized location.

Receive invoices and process them at the centralized location.

Send the invoice summary or detail to MAXIMO after accounts payable processing by the Oracle Financials system.


Transfer purchasing-related general ledger journal entries from MAXIMO to your financial system.

Exchange vendor information.

Chapter 3

70

APICTL Control Values for Configuration 2

If your processes are the same as those described for Configuration 2, you should set your APICTL control code values as shown below. Use Application Setup in

411 Mea Ora11i Sagv2

Documents

trademarks of mro software

software integration

certain mro software

maximo enterprise

maximo workflow portions

maximo scheduler

maximo analyzer

maximo buyer