IvaraEXPIntegration Oracle

Ivara EXP Integration
Guide for OracleeAM

Copyright 2012 Ivara Corporation. All rights reserved.
Information in this document is subject to change without notice.
The software described in this document is provided under license agree-

ment or non-disclosure agreement. The software may be used in accor-
dance with the terms of those agreements.
Oracle and Java are registered trademarks of Oracle and/or its affiliates.
Microsoft and Windows are registered trademarks of Microsoft Corpora-
tion. Other brands and their products are trademarks or registered
trademarks of their respective holders and should be noted as such.
No part of this document may be reproduced, stored in a retrieval system

or transmitted in any form or any means electronic or mechanical,
including photocopying for any purpose other than the purchasers use as
agreed in the license or non-disclosure without permission of Ivara Cor-
poration.
Ivara Corporation
5046 Mainway
Burlington, Ontario
Canada. L7L 5Z1
Tel: 905-632-8000
Fax: 905-632-5129
www.ivara.com
Ivara EXP Integration Guide for Oracle eAM
Published February 2012
Document identification code: IV-IO
Document version code: 1.6
2 Ivara EXP Integration Guide for Oracle eAM

Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1. Integration Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Integration Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Ivara EXP-Oracle eAM Integration Objects . . . . . . . . . . . . . . . . . . 19
Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Asset Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Standard Tasks, Activities, and Activity Assets . . . . . . . . . . . . . 23
Standard Jobs and PM Schedules . . . . . . . . . . . . . . . . . . . . . . . . . 27
Work Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Work Orders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Viewing Integration Information and Activities. . . . . . . . . . . . . . . . 40
2. Setting up the Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Installation and Configuration Notes . . . . . . . . . . . . . . . . . . . . . . . . 42
Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Manually Running Inbound and Outbound Processes . . . . . . . . . 43
Changing the Chunk Size for Processing Inbound Messages. . . . 43
Case-Sensitivity With an Oracle Database . . . . . . . . . . . . . . . . . . 44
How Users are Identified on Ivara EXP Objects . . . . . . . . . . . . . . 45
Overview of Integration Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Setting up the Integration in Oracle eAM . . . . . . . . . . . . . . . . . . . . 47
Setup Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Set up the Export Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Modify Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Modify and Run the Permissions and Synonyms Script . . . . . . . 52
Run the Install Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Set up Concurrent Programs for Exports to Ivara EXP . . . . . . . 53
Set up the Flexfield Attributes for Work Order and Request . . . 67
Setting up the Integration in Ivara EXP . . . . . . . . . . . . . . . . . . . . . 70
Create an External System in Ivara EXP . . . . . . . . . . . . . . . . . . . 71
Review Integration Information in Ivara EXP . . . . . . . . . . . . . . . 75
Set Options for Synchronizing Asset Hierarchies . . . . . . . . . . . . 76
Select Options for Standard Tasks and Jobs . . . . . . . . . . . . . . . . 78
Set Oracle eAM Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Generate CMMS Integration Information . . . . . . . . . . . . . . . . . . 82
Map Ivara EXP Settings to Oracle eAM Settings . . . . . . . . . . . . 87
Set the Default Completion Status for Work Orders . . . . . . . . . . 99
Ivara EXP Integration Guide for Oracle eAM 3

Contents
Testing the Integration Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Importing Test Assets from Oracle eAM . . . . . . . . . . . . . . . . . . 101
Creating and Sending Test Documents . . . . . . . . . . . . . . . . . . . 102
Updating Oracle eAM Documents . . . . . . . . . . . . . . . . . . . . . . . . 104
Viewing Integration Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Retrying and Manually Resolving Events . . . . . . . . . . . . . . . . . 110
Troubleshooting Event Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Modifying an Event Instruction . . . . . . . . . . . . . . . . . . . . . . . . . 111
Setting up Scheduled Actions for the Integration . . . . . . . . . . . . . 114
Securing Integration Functionality . . . . . . . . . . . . . . . . . . . . . . . . 115
3. Working with the Integration . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Importing Oracle eAM Assets into Ivara EXP . . . . . . . . . . . . . . 122
Showing Assets in the Sites Physical Hierarchy . . . . . . . . . . . . 122
Modifying Assets in Oracle eAM . . . . . . . . . . . . . . . . . . . . . . . . . 123
Modifying Assets in Ivara EXP . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Changing an Assets CMMS Information in Ivara EXP . . . . . . 124
Deleting Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Updating an Assets Consequence Priority . . . . . . . . . . . . . . . . . 125
Viewing Integration Information About Assets . . . . . . . . . . . . . 126
Standard Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Exporting Standard Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Removing the Ready to Send Status from a Task . . . . . . . . . . 129
Creating and Modifying Activities in Oracle eAM . . . . . . . . . . . 130
Modifying and Resending Standard Tasks in Ivara EXP . . . . . 130
Changing a Standard Tasks CMMS Information in Ivara EXP 131
Deleting Activities and Standard Tasks . . . . . . . . . . . . . . . . . . . 131
Viewing Integration Information About Standard Tasks . . . . . 132
Standard Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Marking Generated Work Orders as Ready to Send . . . . . . . . 134
Exporting Standard Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Removing the Ready to Send Status from a Job . . . . . . . . . . . . 135
Creating and Modifying PM Schedules in Oracle eAM . . . . . . . 136
Modifying and Resending Standard Jobs in Ivara EXP . . . . . . 136
Changing a Standard Jobs CMMS Information in Ivara EXP . 137
Deleting PM Schedules and Standard Jobs . . . . . . . . . . . . . . . . 137
Viewing Integration Information About Standard Jobs . . . . . . 138
Work Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Exporting Work Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Removing the Ready to Send Status from a Work Request . . 141
Updating Work Request Status in Oracle eAM . . . . . . . . . . . . . 141
Resending a Work Request to Oracle eAM . . . . . . . . . . . . . . . . . 142
Changing a Work Requests CMMS Information in Ivara EXP 142
Viewing Integration Information About a Work Request . . . . . 143

Contents
Work Orders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Exporting Work Orders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Removing the Ready to Send Status from a Work Order . . . . 145
Resending a Work Order to Oracle eAM . . . . . . . . . . . . . . . . . . 146
Changing a Work Orders CMMS Information in Ivara EXP . . 146
Updating Work Order Status in Oracle eAM . . . . . . . . . . . . . . . 147
Viewing Integration Information About Work Orders . . . . . . . . 147
Acknowledging Indicator Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Viewing CMMS Information for the Enterprise . . . . . . . . . . . . . . 154
Turning Off the Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
4. Customizing the Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Adding Properties to Existing Interface Classes . . . . . . . . . . . . . . 158
Creating a Custom Interface Class . . . . . . . . . . . . . . . . . . . . . . . 159
Modifying a Transform for an Interface Class . . . . . . . . . . . . . . 163
Adding Integration Objects Using New Interface Classes . . . . . . 165
Creating an Interface Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Generating an XML Document . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Adding a Transform to the Integration Package . . . . . . . . . . . . 170
Adding Class Mappings to the Ivara EXP External System . . . 171
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Contents

Preface
The Ivara EXP Integration Guide for Oracle eAM provides information
about setting up the Ivara EXP CMMS Integration functionality to
exchange information about assets, work requests, work orders, standard
tasks, and standard jobs with Oracle Enterprise Asset Management
software.
Contents
About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Glossary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Preface
About This Guide

This guide is designed as a self-contained document that you can print
and use independently of the Ivara software. For information about
related Ivara functions, refer to Ivara EXP Help. You can access the Help
by clicking in the toolbar while you are logged in to Ivara EXP.
This guide contains the following sections:
1. Integration Overview on page 15

This chapter explains what information is exchanged between the
two systems and how the communication works.
2. Setting up the Integration on page 41
This chapter explains how to set up the Oracle eAM integration inter-
faces, set up the integration in Ivara EXP, test the integration, set up
scheduled actions, and secure integration objects.
3. Working with the Integration on page 121
This chapter explains how to work with integrated objects and view
integration information in Ivara EXP, and safely turn off the integra-
tion.
4. Customizing the Integration on page 157
This chapter explains how to add new properties or objects to the

integration.

Preface
Related Documentation
See the following documents for more information about installing Ivara,
using its work management functions, and troubleshooting integration
errors.
See this document ... For information on ... Where to find it

Ivara EXP Installa- Hardware and soft- [IvaraInstall-
tion Prerequisites ware requirements Folder]\Docs\
for installing English\
Ivara EXP and set- Technical_Guides
ting up the integra-
tion
Ivara EXP Installa- Installing Ivara EXP, [IvaraInstall-
tion Guide defining services, and Folder]\Docs\
setting up scheduled English\
actions Technical_Guides
Ivara EXP Upgrade Upgrading Ivara EXP [IvaraInstall-
Guide software, databases, Folder]\Docs\
and integration English\
plugins Technical_Guides
Ivara EXP Help Assets, work manage- Click when logged
ment, and other in to Ivara EXP
related Ivara features
Troubleshooting Solving common inte- [IvaraInstall-
Ivara EXP CMMS gration problems Folder]\Docs\
Integration English\
Integration_Guides

Preface
Glossary
This section provides definitions of terminology used in this guide. For a
complete list of terms, see the Glossary topic in Help.
Term Definition
Activity Identifies a maintenance activity for an asset. An oil
change is an Activity for a car. An Activity is often
pre-planned and can be used repetitively to create
Work Orders that require similar maintenance on
Assets.
Ivara EXP standard tasks are sent to Oracle eAM,

where activities are created and maintained. Simi-
larly, activities can be sent to Ivara EXP.
Asset An asset is a physical piece of equipment or a collec-
tion of equipment (system) that you need to main-
tain.
In Ivara EXP, you can also create asset records for

organizational areas, such as plants or depart-
ments.
Asset group In Oracle eAM, asset groups represent the classifi-
cations of equipment. Examples include Trucks,
Pumps, Towers, Buildings, Storage Tanks, and Tur-
bines. Assets that have similar physical configura-
tions and maintenance requirements typically
belong to a single Asset Group.
Asset hierarchy The asset hierarchy is a representation of all the
assets that contribute to the goals of your organiza-
tion and how the assets relate to one another.
Asset number In Oracle eAM, a unique number represents an
asset or piece of equipment on which maintenance
will be performed. An example of an asset number
would be a Pump-101, or Toyota Truck 01.

Preface
Term Definition
Asset Priority As performed using Ivara EXP, Asset Prioritization
Analysis Analysis is a systematic, quantitative basis for
deciding the importance of an asset to an organiza-
tion based on factors such as safety, environment,
operating cost, quality, customer service, and
throughput. The outcome of the analysis is the con-
sequence priority number and the relative risk.
Also see Consequence priority number.

Base interval In Oracle eAM, a base interval is the minimum
period of time (90 days) or meter reading (7,500
miles) between when PM activities included in one
PM schedule should be performed. It can be consid-
ered a common denominator among the multiple
activities included in one PM Schedule that share a
common base interval.
CMMS (com- A computerized system to assist with the efficient
puterized main- management of maintenance activities through the
tenance application of computer technology. It often includes
management a computerized work order system, as well as facili-
system) ties for scheduling routine maintenance tasks and
recording and storing work orders, materials, and
parts lists.
Consequence An assets consequence priority ranking is the result
priority number of an asset prioritization analysis, which identifies
which assets present the biggest risk to your organi-
zations success. The consequence priority number is
determined by comparing an assets failure conse-
quence scores to a set of rules.
When the priority analysis is complete, analysis

assets are assigned consequence priority numbers.
This information is added to the assets criticality
code in Oracle eAM. See Criticality code.
Criticality code In Oracle eAM, criticality codes suggest the impor-
tance of an asset to an organization, for example,
High and Low. An asset that has a direct impact on
production or that is difficult to replace may be con-
sidered a critical asset. Asset criticality codes help
you to determine the urgency of requested work.
When Oracle eAM and Ivara EXP are synchronized,

the assets criticality code is provided by the
Ivara EXP assets consquence priority number.

Preface
Term Definition
Indicator An indicator is an Ivara EXP object that lets you
record something that you can measure on your
equipment. Using indicators, you can monitor
equipment performance or condition. For example,
typical indicators on a car include the engine tem-
perature gauge, the odometer, the brake system
warning light, and tire condition.
PM schedule In Oracle eAM, a PM schedule is a plan to perform
periodic work on an asset or on a group of assets
that are listed on a route.
In Ivara EXP, PM schedules are synchronized with

standard jobs. See also Standard job.
Standard job In Ivara EXP, a standard job is a collection of stan-
dard tasks for one or more assets. For example, you
might create a standard job for a vehicle that
includes standard tasks such as changing the oil,
inspecting the brakes, and rotating the tires. A stan-
dard job can also include rules that determine when
the tasks are converted to work order tasks.
In Oracle eAM, Ivara EXP standard jobs are syn-

chronized with PM schedules. See PM schedule.
Standard task In Ivara EXP, a standard task is a plan for a work
order task that is done repeatedly for a specific
asset. For example, you can create standard tasks
for a vehicle such as changing the oil or inspecting
the brakes.
In Oracle eAM, Ivara EXP standard tasks are syn-

chronized with activities.
Work identifi- Work identification analysis is a methodology for
cation analysis identifying assets, defining functional failures,
determining how failures occur (failure mode), and
preventing failures or mitigating their conse-
quences. The types of work identification analysis
used in Ivara EXP are:
Reliability Centered Maintenance (RCM2)

Maintenance Task Analysis
The results of work identification analysis are new
or enhanced indicators, procedures, standard tasks,
standard jobs, and PM routes.

Preface
Term Definition
Work order In Ivara EXP, a work order task is a single unit of
task work that can be performed on an asset. For exam-
ple, you can create a work order task to inspect a
piece of equipment or to collect indicator readings on
an asset. A work order task must be part of a work
order.
Work order Work orders are the main documents used to man-
age work. In Ivara EXP, a work order summarizes
one or more work order tasks.
When the integration is active, an Oracle eAM work

order is created for each Ivara EXP work order
marked as ready to be sent to the CMMS. This
includes work orders created to acknowledge an
anomalous indicator reading, work orders created
from a triggered standard job, and those created
from scratch.
Work request A work request is a document that allows people
outside of the maintenance group to submit a
request to repair an asset. For example, anyone in a
plant could submit a work request if they see a
safety guard missing from a piece of equipment.
Work requests can be turned into work orders. They
are automatically marked as work completed
when the work order is closed.

Preface

Chapter 1 Integration Overview
Using the Computerized Maintenance Management System (CMMS)

Integration functionality in Ivara EXP, you can exchange information
about assets, work requests, work orders, standard tasks, and standard
jobs with Oracle eAM software.
Note: The CMMS Integration functionality does not work with

sites where the EAM module is enabled.
This chapter provides an overview of the integration framework, the

standard integration points, how information flows between Oracle eAM
and Ivara EXP, and how to view integration activities.
Contents
Integration Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Ivara EXP-Oracle eAM Integration Objects . . . . . . . . . . . . . . . . . . . . . . 19
Viewing Integration Information and Activities. . . . . . . . . . . . . . . . . . . 40

Integration Framework
Ivara EXP communicates with Oracle eAM at scheduled intervals (usu-
ally daily) using the Action Scheduler service provider. You can also run
actions manually to test the integration. The Ivara EXP Integration
Adapter for Oracle eAM moves data directly into Oracle eAM, using ODP
to make stored procedure calls.
The Ivara stored procedures also create XML files for processing in
Ivara EXP. Moving data from Oracle eAM to Ivara EXP is triggered by
an Oracle Concurrent Request. The files are placed in a configurable
folder accessible to both Oracle eAM and Ivara. The XML files are then
processed to import data into Ivara EXP. The files are deleted only after
all records have been successfully imported. (Optionally, the files can be
backed up to a sub-folder.) The user that the Ivara process runs as needs
full access to the configurable folder that stores the XML files.
The following diagram shows how data is moved between systems.

The following diagram shows what happens when a work order is

marked as Ready to Send and the CMMS outbound processing action
is run:
Once the work order is created in Oracle eAM, it is planned, scheduled,

and executed there. When the work orders status changes, an XML docu-
ment is generated and queued. At scheduled intervals, the CMMS
inbound processing action starts the Oracle eAM integration adapter,
which checks for XML documents and updates the corresponding work
orders in Ivara EXP. The following diagram shows this process:


Ivara EXP-Oracle eAM Integration Objects

Integration objects define the data content needed for the execution of a
particular business activity. This section describes the Ivara EXP-Oracle
eAM integration objects, including the work flow and the properties that
are synchronized. The integration objects are defined for these business
objects:
Assets on page 19
Asset Hierarchy on page 22
Standard Tasks, Activities, and Activity Assets on page 23
Standard Jobs and PM Schedules on page 27
Work Requests on page 30
Work Orders on page 34
Assets
In a fully integrated environment, Oracle eAM is the master system for
assets. This means that all assets created in Oracle eAM are copied to
Ivara EXP. Any modifications, including status changes, to an Oracle
eAM asset are applied to the Ivara EXP asset.
Asset properties that are synchronized to an Oracle eAM asset property

should not be changed in Ivara EXP because this could result in inconsis-
tent data being presented for the same asset in the two systems. To
ensure that changes are not made, the synchronized properties are pre-
sented in a read-only state.
Note: You can also create and maintain some assets in Ivara EXP
only, if necessary. These assets are not synchronized with Oracle
eAM; however, they must have default CMMS information so that
they can be referenced on work orders and standard tasks that
will be sent to Oracle eAM. Ivara EXP takes the information for
an asset from its first ancestor with a CMMS identification num-
ber.
All Ivara EXP assets created from Oracle eAM assets are assigned the
asset classification maintainable asset. Oracle eAM assets are synchro-
nized with Ivara EXP assets.
When an asset is disassociated from its parent in Oracle eAM, the

Ivara EXP assets parent is set to Null and the asset is removed from the
physical hierarchy. If the asset is associated with another parent in Ora-
cle eAM, the Ivara EXP assets parent is updated and the asset is shown
in the hierarchy.

If an asset is deleted in Oracle eAM, and you wish to delete the

Ivara EXP asset, you must do so manually.
When the asset hierarchy is built in Ivara EXP, the Oracle eAM assets
parent asset is used in the hierarchy.
The following diagram shows the flow of asset information between

Ivara EXP and Oracle eAM:
Asset Properties that are Synchronized

The following properties are updated in Ivara EXP when an asset is cre-
ated or modified in Oracle eAM.
Ivara EXP Asset Oracle eAM Asset Notes

Property Source
eAM asset inven- Asset inventory item
tory item ID ID
eAM asset serial Asset serial number
number
Asset number Asset instance num-
ber
Asset description Asset description

Ivara EXP Asset Oracle eAM Asset Notes

Property Source
Asset classification Set to maintainable
asset
Maintenance group Owning department
Parent asset Parent asset
Asset status Asset status
eAM asset instance Asset instance ID
ID
Asset type Asset group
Site Organization ID
Asset Consequence Priority

An assets consequence priority is set when an Ivara EXP asset prioriti-
zation analysis is completed. When the analysis is complete and the
results are applied to the assets, Oracle eAM assets are updated with
new consequence priority codes. At the same time, the Oracle eAM asset
information is updated in Ivara EXP.
The following property is updated in Oracle eAM when an asset conse-

quence priority is modified in Ivara EXP.
Ivara Asset Property Oracle eAM Asset

Consequence priority (priority ranking Asset criticality code
number) - CMMS Priority property

Ivara Asset Property Oracle eAM Asset

CMMS eAM inventory item ID Inventory item ID
CMMS eAM serial number Serial number
CMMS site ID Organization
Manual Synchronization
For asset synchronization, the following Ivara EXP properties must be
manually mapped to Oracle eAM properties.
Ivara EXP Property Ivara EXP Value List Oracle eAM Value List
Asset type Asset Type Asset Group
Asset status Asset Status Asset Status
CMMS Priority Consequence Priority Priority values (inte-
gers) entered on the
Oracle eAM critical-
ity codes
Asset Hierarchy
Oracle eAM is the master system for the asset hierarchy in a synchro-
nized environment. The initial hierarchy position for an asset is defined
when the asset is created in Oracle eAM. The Ivara EXP asset created
from the Oracle eAM asset uses the Oracle eAM parent to position itself
in the Ivara EXP hierarchy. Subsequent modifications to the Oracle eAM
asset hierarchy are applied to the Ivara EXP asset hierarchy.
All Oracle eAM asset hierarchy information is synchronized to

Ivara EXP.
There are several options for synchronizing Ivara EXP asset hierarchies
with the asset hierarchy in Oracle eAM. For example, you can synchro-
nize one or two Ivara EXP asset hierarchies with the Oracle eAM hierar-
chy. For hierarchy 1, an alternate hierarchy, or both, you can choose from
four options:
Always synchronized. All changes to the Oracle eAM hierarchy are

made to the Ivara EXP hierarchy. Ivara EXP assets created from a
Oracle eAM asset use the Oracle eAM parent to create the Ivara EXP
hierarchy.
Note: To prevent users from changing the Ivara EXP asset hierar-
chy from the sites Assets view or the assets Hierarchies view,
you must set users security profiles to make the views read-only.

For more information, see Securing Integration Functionality on

page 115.
New assets only. When an asset is created in Oracle eAM and

assigned a parent that also exists in Ivara EXP, the asset is added to
the physical hierarchy in Ivara EXP as well. However, if you later
change the assets parent in Oracle eAM, the change does not affect
the Ivara EXP hierarchy. You can manually change an assets parent
in Ivara EXP.
Not synchronized. Changes in the Oracle eAM hierarchy are not
made to the Ivara EXP hierarchy. The asset hierarchy is maintained
manually in Ivara EXP.
Custom. A customized integration is used, so changes in the Oracle
eAM hierarchy are not made to the Ivara EXP hierarchy.
When Asset Hierarchies are Synchronized

When the Ivara EXP asset hierarchy is always synchronized, the hierar-
chy is updated in Ivara EXP whenever the Asset: Change parent asset
action occurs in Oracle eAM.
The following diagram illustrates the flow of asset hierarchy information

between Ivara EXP and Oracle eAM:
When only new assets are synchronized, the asset hierarchy is updated
in Ivara EXP only when the asset is added in Oracle eAM.
Standard Tasks, Activities, and Activity Assets

Ivara EXP standard tasks are synchronized with Oracle eAM activities.
Standard tasks defined in Ivara EXP are typically the output of the work
identification process and can include inspection and corrective standard
tasks. When an Ivara EXP standard task is marked as Ready to Send
to the CMMS, the integration process creates an Oracle eAM activity and
activity asset. Once the activity is created, Oracle eAM becomes the mas-
ter system for the standard tasks synchronized properties. Changes to

these properties and additional planning activities are performed in Ora-

cle eAM and communicated to Ivara EXP, where the standard task is
updated.
Activities that are manually created in Oracle eAM are exported to

Ivara EXP, where the standard task is created. This allows the task to be
included on the resulting work order when the Ivara EXP standard job is
triggered. Oracle eAM is the master system for these tasks.
While Oracle eAM supports multiple assets on an activity, Ivara EXP

supports a single asset per standard task. Consequently, one standard
task is created for each asset on an activity. Changes to the activity defi-
nition are applied to all of the standard tasks created from the activity.
Modifications to the standard tasks route assets, dynamic route rules,

static indicators, and other non-synchronized properties can be per-
formed in Ivara EXP. These changes are not communicated to Oracle
eAM, but they are reflected on the subsequent work order tasks created
from the standard task.
Note: When an activity is deleted in Oracle eAM, the link to the

standard task is removed and the CMMS information is updated
accordingly. However, the standard task must be manually
deleted in Ivara EXP.
Task Templates
Ivara EXP task templates can be used to create and maintain standard
tasks in Ivara EXP. However, for standard tasks that are linked to a tem-
plate and synchronized to a Oracle eAM activity, task template changes
to any of the synchronized properties are not applied to the linked stan-
dard tasks. These properties are controlled only by the Oracle eAM activ-
ity. Standard task properties that are not mastered in Oracle eAM are
updated when task template changes are applied.
Information Flow
The following diagram shows the flow of standard task-activity informa-
tion between Ivara EXP and Oracle eAM:


Standard Task Properties that are Synchronized

The following standard task/activity properties are synchronized
between Ivara EXP and Oracle eAM. Once an Oracle eAM activity is cre-
ated, the standard tasks synchronized properties are made read-only in
Ivara EXP.
Ivara EXP Task Prop- Oracle eAM Activity Notes

erty Property
Task number Activity name
Asset number Asset number A work asset is added
to the activity for
standard tasks
Title Description
Long description Activity long descrip-
tion

Ivara EXP Task Prop- Oracle eAM Activity Notes

erty Property
Priority Priority Mapped based on the
CMMS priority num-
ber on the Ivara EXP
work priority
Maintenance group Department
For standard task synchronization, the following Ivara EXP properties
must be manually mapped to Oracle eAM properties.
Maintenance group Maintenance group Department
Work priority Work priority Work Order Priority
Site Site Site
Standard Jobs and PM Schedules

Ivara EXP standard jobs are synchronized with Oracle eAM PM sched-
ules. Standard jobs defined in Ivara EXP are typically outputs of the
work identification process and can include PM inspection routes (stan-
dard jobs) and corrective standard jobs. When an Ivara EXP standard job
is marked as Ready to Send to the CMMS, the integration process cre-
ates an Oracle eAM PM schedule.
Once the PM schedule is created, Oracle eAM becomes the master system
for the standard jobs synchronized properties. Changes to these proper-
ties and additional planning activities are performed in Oracle eAM and
communicated to Ivara EXP, where the standard job is updated.
A description of the jobs triggering rule is included as part of the job

description in the information exported to the Oracle eAM PM schedule.
The triggering rule description is text only; a triggering frequency is not
created on the Oracle eAM PM schedule.
A PM schedule manually created in Oracle eAM is exported to

Ivara EXP, where a standard job is created. This allows the job to be trig-
gered in Ivara EXP and the resulting work order to be exported to Oracle
eAM.
Job templates are not integrated with Oracle eAM, but they can still be
used in Ivara EXP to create standard jobs.

Note: When a PM schedule is deleted in Oracle eAM, the link to

the standard job is removed and the CMMS information is
updated accordingly. However, the standard job must be manu-
ally deleted in Ivara EXP.
Information Flow
The following diagrams show the flow of standard job/PM schedule infor-
mation between Ivara EXP and Oracle eAM:

Standard Job and PM Schedule Properties that are Synchronized

The following standard job/PM schedule properties are synchronized
between Ivara EXP and Oracle eAM. Once an Oracle eAM PM schedule
is created, the standard jobs synchronized properties are made read-only
in Ivara EXP.
Default PM values can be defined on the work type. The values defined
are used to populate the Oracle eAM PM schedule properties when an
Ivara EXP standard job is exported to Oracle eAM.
Ivara EXP Job Property Oracle eAM PM Sched- Notes

ule Property
Standard job number PM name
eAM set name Set name eAM set name is
defined on the work
type in Ivara EXP
Triggering rule Long description Appended to the long
expression description
eAM schedule type Schedule type eAM schedule type is
defined on the work
type in Ivara EXP
eAM PM scheduling Use last service eAM PM scheduling
use use is defined on the
work type in
Ivara EXP

Ivara EXP Job Property Oracle eAM PM Sched- Notes

ule Property
eAM PM next service Next service eAM PM next service
is set on the work
type in Ivara EXP
eAM PM multiple Multiple rules eAM PM multiple
rules rules is set on the
work type in
Ivara EXP
Work order status Work order status The property is a
string in Ivara EXP.
Oracle eAM statuses
are Draft, Active,
and Inactive.
Title Comments
eAM PM first trigger- Date rules effective
ing date from
eAM PM default Base interval in days
interval
Standard task num- Activity name Activities that corre-
ber spond to the jobs
standard tasks must
exist in Oracle eAM
before the standard
job is exported.
For standard job synchronization, the following Ivara EXP properties
must be manually mapped to Oracle eAM properties.
Work type Work type Work order type
Work Requests
When the integration is active, an Oracle eAM work request is created
for each Ivara EXP work request marked as Ready to Send to the
CMMS. This includes work requests created to acknowledge an anoma-
lous indicator reading, follow-up requests, and those created from
scratch. The Ivara EXP work request number is updated with the num-
ber assigned to it in by Oracle eAM.

Once the work request exists in Oracle eAM, it is maintained there. Only
status changes performed in Oracle eAM are synchronized to Ivara EXP.
Changes to other properties are not sent to Ivara EXP.
It is not necessary that all Ivara EXP work requests be sent to Oracle
eAM. It is possible to create the work request directly in Ivara EXP and
send the resulting work order to Oracle eAM. The work request is never
sent to Oracle eAM. However, because Oracle eAM is the planning and
work execution system, it is highly recommended that all Ivara EXP
work requests be sent to Oracle eAM.
To prevent users from changing an integrated work requests status in

Ivara EXP, you must set users security profiles to make the methods
that affect statuses read-only. For more information, see Securing Inte-
gration Functionality on page 106.
Information Flow
The following diagram illustrates the flow of work request information
between Ivara EXP and Oracle eAM when a work request is created in
Oracle eAM:
Work Request Properties that are Synchronized

The following work request properties are sent from Ivara EXP to Oracle
eAM.

Ivara EXP Work Oracle eAM Work Notes

Request Property Request Property
Work request number Work request number The Ivara EXP work
request number is
updated with the
Oracle eAM work
request number
Asset number Asset number
Work request status Work request status When the status
changes in Oracle
eAM, the Ivara EXP
work request is
updated with the
appropriate mapped
status
Long description Long description The following infor-
mation is appended
for work requests cre-
ated to acknowledge
an alarm:
Asset and indica-

tor in alarm
Reading value
Employee who
took the reading
Date and time of
the reading
Collectors note
Acknowledged by
(employee name)
Acknowledge-
ment date and
time
Acknowledge-
ment note
Work priority Priority

Ivara EXP Work Oracle eAM Work Notes

Request Property Request Property
Enterprise - Oracle Work request type
eAM Work request
type
Work Request Type

The Oracle eAM work request type is populated with the value defined in
the enterprise Integration Settings. This allows all work requests that
originate in Ivara EXP to be flagged as such in Oracle eAM.
For work request synchronization, the following Ivara EXP property
must be manually mapped to the Oracle eAM property.
Work Request Statuses

Work request status changes performed in Oracle eAM are synchronized
with Ivara EXP work requests. The Ivara EXP work request status is
updated to reflect the change in Oracle eAM. If the changed Oracle eAM
status is mapped to an Ivara EXP status, the status is set on the work
request. If the status is not mapped in Ivara EXP, the work request
CMMS status is updated only.
The following table shows the standard statuses that are automatically
mapped between Oracle eAM and Ivara EXP.
Oracle eAM Task Status Ivara EXP Task Status

Open New

Oracle eAM Task Status Ivara EXP Task Status

On work order Work order created
Rejected Cancelled
Complete Work completed
The work request status mappings can be changed in the Integration Set-
tings window in Ivara EXP. For more information, see Mapping Work
Order and Work Request Statuses on page 84.
Work Orders
When the integration is active, an Oracle eAM work order is created for
each Ivara EXP work order marked as Ready to Send to the CMMS.
This includes work orders created to acknowledge anomalous indicator
readings, work orders created from a triggered standard job, and those
created from scratch. The Ivara EXP work order number is updated with
the number assigned to it by Oracle eAM.
The integration is based on work orders, rather than work order tasks.
The Oracle eAM work order contains a list of operations corresponding to
the tasks on the Ivara EXP work order.
It is possible for a work order to be created and completed in Ivara EXP

without a corresponding work order being created in Oracle eAM. How-
ever, because Oracle eAM is the planning and work execution system, it
is highly recommended that all Ivara EXP work orders be sent to Oracle
eAM. Failure to do this can result in a number of problems, such as:
Asset work history in Oracle eAM is incomplete.

Tasks that are not in Oracle eAM might be overlooked and not sched-
uled.
The cost of the work executed only in Ivara EXP will not be reflected
in the Oracle eAM maintenance costs.
Once a work order exists in Oracle eAM, it is maintained there. Only
work order status changes performed in Oracle eAM are synchronized to
Ivara EXP. Changes to other properties are not sent to Ivara EXP.
When the work orders status changes to Closed, the integration closes
the Ivara EXP work order. Only work orders that originated in
Ivara EXP are updated.
To prevent users from changing an integrated work orders status in

Ivara EXP, you must set users security profiles to make the methods
that affect statuses read-only. For more information, see Securing Inte-
gration Functionality on page 115.

Information Flow
The following diagram shows the flow of work order information between
Ivara EXP and Oracle eAM:
The Oracle eAM activity is used to fill out the Oracle eAM work orders
planning information. Ivara EXP work order tasks reference the stan-
dard task or task template from which the task was created. The stan-
dard task or task template knows the Oracle eAM activity linked to it.
When the Ivara EXP work order task is sent to Oracle eAM, one of the
properties copied is the Activity. Setting the activity on the Oracle eAM
work order triggers the Oracle eAM logic that copies the planning infor-
mation (requirements, safety, and so on) to the work order.

Work Order Properties that are Synchronized

The following work order properties are sent from Ivara EXP to Oracle
eAM.
Ivara EXP Work Order Oracle eAM Work Notes

Property Order Property
Work order number Work order number The Ivara EXP work
order number is
updated with the
Oracle eAM work
order number
Title Description
Work order status Status When the status
changes in Oracle
eAM, the Ivara EXP
work order is
updated with the
appropriate mapped
status

Ivara EXP Work Order Oracle eAM Work Notes

Property Order Property
Primary task - Asset Asset number
number
Primary task - eAM Asset group
inventory item ID
Primary task - Stan- Activity number
dard task number
Primary task - Work Work order type The work type defini-
type tion in Ivara EXP
specifies the Oracle
eAM equivalent
Primary task - Main- Owning department
tenance group
Primary task - Work Priority
priority
Planned completion Due date
date
Planned start date Submission date
Work Order Task Properties That are Synchronized

Ivara EXP work order tasks are synchronized with Oracle eAM opera-
tions. The following properties are synchronized.
Ivara EXP Work Order Task Property Oracle eAM Operation Property
Task counter Operation sequence number
Task title Operation description
Task planned start date Start date
Task planned completion date Completion date

Ivara EXP Work Order Task Property Oracle eAM Operation Property
Task long description Operation long description
The following information is

appended for work orders created
to acknowledge an alarm:
Asset and indicator in alarm

Reading value
Employee who took the read-
ing
Date and time of the reading
Collectors note
Acknowledged by (employee
name)
Acknowledgement date and
time
Acknowledgement note
Task Multiplier
Work order task numbers are converted to Oracle eAM-friendly operation
numbers using the task multiplier. This allows new operations to be
added in the appropriate sequence to the Oracle eAM work order.
The operation number is calculated by multiplying the task number by

the task multiplier. For example, an Ivara EXP work order with three
tasks results in an Oracle eAM work order with three operations num-
bered as follows, depending on the task multiplier:
Ivara EXP task Operation Operation Operation

number number number number
Multiplier = 10 Multiplier = 5 Multiplier = 1
1 10 5 1
2 20 10 2
3 30 15 3
The task multiplier is defined in enterprise integration settings.

For work order synchronization, the following Ivara EXP properties must
be manually mapped to Oracle eAM properties.
Work type Work type Work Order Type
Maintenance group Maintenance group Department
Work Order Statuses

Work order status changes performed in Oracle eAM are synchronized
with Ivara EXP work order tasks, which are updated to reflect changes to
Oracle eAM statuses. If the new Oracle eAM status is mapped to an
Ivara EXP status, the status is set on the work order task. If the status is
not mapped in Ivara EXP, the work order CMMS status only is updated.
The following table shows the standard statuses that are automatically
mapped between Oracle eAM and Ivara EXP.
Oracle eAM Work Order Status Ivara EXP Task Status

Cancelled Cancelled
Released Planned
Unreleased In Planning
Completed Completed
Closed Closed
The task status mappings can be created and changed in the Integration
Settings window in Ivara EXP. For more information, see Map Work
Order and Work Request Statuses on page 95.

Viewing Integration Information and Activities

You can monitor integration activities for the enterprise in Ivara EXP.
For more information, see Viewing Integration Events on page 104.
You can view the integration status of assets, standard tasks, standard
jobs, work requests, and work orders. Each objects window contains
CMMS and Integration Events tabs. You can also view lists eAM activ-
ities for standard tasks and standard jobs. On a sites Reliability Pro-
gram view, select the eAM Activities tab to see a list of activities.

Chapter 2 Setting up the Integration
This chapter explains in detail how to set up the integration in Oracle

eAM and in Ivara EXP. Instructions on mapping Oracle eAM and
Ivara EXP settings, testing the integration, setting up scheduled actions,
and securing the integration in Ivara EXP are also provided.
Contents
Installation and Configuration Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Overview of Integration Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Setting up the Integration in Oracle eAM . . . . . . . . . . . . . . . . . . . . . . . 47
Setting up the Integration in Ivara EXP. . . . . . . . . . . . . . . . . . . . . . . . . 70
Testing the Integration Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Setting up Scheduled Actions for the Integration . . . . . . . . . . . . . . . . 114
Securing Integration Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Installation and Configuration Notes

Before you can set up the Ivara EXP-Oracle eAM integration, you must
have installed Ivara EXP on the computer where integration activities
will take place. For information about installing the software, see the
Ivara EXP Installation Guide.
This section provides:
Information about software requirements

Requirements for executing outbound and inbound processes manu-
ally
Instructions for adjusting the performance of inbound message pro-
cessing
Considerations for Oracle databases
A tip for identifying actions performed by the Action Scheduler user
Software Requirements
Before installing or upgrading Ivara EXP, make sure that Oracle E-
Business Suite is installed and configured correctly. The integration solu-
tion is designed to work with the Enterprise Asset Management (eAM)
application.
The Ivara EXP application server computer requires:
Oracle 11.2.0.2 Client components:

SQL *Plus
Oracle Net
Oracle Data Provider for .NET
Oracle Providers for ASP .NET
Note: If the 64-bit version of Ivara EXP is installed, be sure to

install the 64-bit version of the Oracle client components.
The Oracle 11.2.0.2 client components must reside on the computer

where the Oracle integration adapter is installed, typically, where the
Ivara EXP integration server is installed.
These components can be downloaded from the Oracle web site.
The plugin has been verified to work with Oracle E-Business Suite 12.0.6
and 11.5.10. Ivara will make reasonable efforts to support later Oracle E-
Business Suite service packs.

Manually Running Inbound and Outbound Processes

In order to run the inbound and outbound processes manually for testing
purposes, you must be running Ivara EXP as a thick-client (local server)
instance.
You can then open the Tools menu on the site, click Application Inte-
grations, and then click either Process Inbound Messages or Pro-
cess Outbound Messages. These commands triggers inbound or
outbound processing for all Oracle eAM documents assigned to the cur-
rent site.
For information about configuring a thick-client (local server), see

Installing Ivara EXP and Setting up the Database in Ivara EXP Instal-
lation Guide.
Changing the Chunk Size for Processing Inbound Messages

Inbound messages from Oracle eAM are processed in chunks in the form
of XML files. This minimizes memory consumption when large numbers
of XML files are generated because the chunk is committed as one trans-
action. The default chunk size is 200.
To Adjust the Chunk Size:

1. Stop the Ivara EXP application server.
2. Open the Settings Editor for the server.
3. In the File menu, click Show Advanced Settings.
4. In the Settings tab, select the Runtime node. Look for the Integra-
tion settings.

5. Click in the Oracle eAM Inbound Chunk Size box and enter the
new value.
6. Click the File menu and then Save. Exit the Settings Editor.
7. Restart the server to have the change take effect.
Case-Sensitivity With an Oracle Database

When running Ivara EXP with an Oracle database, all of the Ivara EXP
data will be case-sensitive. This might cause integration events to fail if
integrated alphanumeric properties are defined in Ivara EXP using a dif-
ferent case than Oracle eAM uses. For a list of these properties, see Map
Ivara EXP Settings to Oracle eAM Settings on page 87.
There are two ways to handle case-sensitivity:
Enter all integrated properties in the case used in Oracle eAM.

Configure the Ivara EXP database to be case-insensitive by following

the instructions in Case-Insensitive Searches in Oracle in the
Ivara EXP Installation Guide.
How Users are Identified on Ivara EXP Objects

When an object is updated in Oracle eAM, the corresponding object is
updated in Ivara EXP. If you run the CMMS inbound processing action
manually, the audit trail on the object displays your Ivara EXP employee
name. For example, when a work order is closed, the work orders Closed
by field displays the employee name linked to the Ivara EXP user ID on
the computer where the action is run. If the action is performed by the
Action Scheduler, the object is shown as having been updated by the
Action Schedulers Ivara EXP employee name, for example, IvaraAS.
To identify objects that are updated or closed by scheduled actions, you

can set up the Action Scheduler service provider with an Ivara EXP user
ID and employee name such as IvaraOracle eAM on the computer
where integration actions are run. For information about setting up an
Action Scheduler user, see Setting up Action Scheduling in Ivara EXP
Installation Guide.

Overview of Integration Setup

The main steps for setting up an Ivara EXP-Oracle eAM integration are
described in the following sections:
1. Setting up the Integration in Oracle eAM on page 47
This step involves creating a database schema, preparing scripts, and

running them, and setting up concurrent programs in Oracle eAM.
2. Setting up the Integration in Ivara EXP on page 70
This step involves creating an external system in Ivara EXP, review-

ing integration settings, setting asset hierarchy and other options,
generating CMMS information for objects, and mapping Ivara EXP
values.
3. Testing the Integration Setup on page 101
You can create test standard tasks, standard jobs, work requests, and
work orders and manually run actions to ensure that your CMMS
information is set up correctly on each site in Ivara EXP.
4. Setting up Scheduled Actions for the Integration on page 114
You can schedule actions to send documents to Oracle eAM and

retrieve information from Oracle eAM.
5. Securing Integration Functionality on page 115
Adjust security profiles to ensure that Ivara EXP users have access to
only the integration objects and information that they need. For
example, secure the close, cancel, and reopen methods for the work
request, work order, and work order task classes to prevent users
from inadvertently interfering with integration events.

Setting up the Integration in Oracle eAM

The Ivara EXP Integration Adapter moves data directly into Oracle eAM,
using ODP to make stored procedure calls. Moving data from Oracle eAM
to Ivara EXP is triggered by an Oracle concurrent request. Then Ivara
stored procedures create XML files to be processed in Ivara EXP. The
files must be placed in a configurable folder accessible to both Oracle
eAM and Ivara.
Setting up the integration on the Oracle eAM side involves creating the
export directory, installing stored procedures, setting up concurrent pro-
grams, and more. This section explains the steps.
Setup Steps
You will need to perform the following steps:
1. Create the database schema. The database administrator must create

a schema called Ivara in the Oracle E-Business Suite database.
2. Set up the Export Directory on page 48
Provide a Windows folder that is accessible to both the Oracle

instance and the Ivara server computer.
3. Modify Tables on page 48
Before running the scripts provided by Ivara, review and revise four
tables, as needed.
4. Modify and Run the Permissions and Synonyms Script on page 52
This script grants permissions and creates synonyms in the Oracle

eAM database.
5. Run the Install Script on page 53
This script installs the stored procedures in the Oracle eAM database.
6. Set up Concurrent Programs for Exports to Ivara EXP on page 53
In Oracle eAM, set up concurrent programs for exporting data for
each of the types of objects.
7. Set up the Flexfield Attributes for Work Order and Request on page
67
Follow the steps in this section for both work order and work request.

Set up the Export Directory

You are responsible for providing a Windows folder that is accessible to
both the Oracle instance and the Ivara server computer. This export
directory is used by Ivara to move data out of Oracle eAM. The default
directory name is /ivara_export.
If Oracle eAM is installed in an environment other than Microsoft Win-

dows, you must have the XML files transferred to a Windows folder. In a
Linux environment, we recommend setting up a mounted drive. Then
run Services for NFS in the Windows environment to monitor the
mounted drive and transfer the files to the Windows folder. The com-
mand syntax for running the service is:
mount -t nfs <machinename>:<cnfssharename> /ivara_export
Note: The Ivara EXP user, typically the action scheduler user,
must have administrator privileges to the export directory in
order to delete the XML files after processing.
There are other methods to move files from Unix to Windows, such as
SFTP and Samba.
Next, add the export directory to the UTL_FILE_DIR system parameter:
UTL_FILE_DIR = /ivara_export
Modify Tables
Before running the install script, review and revise the following tables,
as needed.
xxivara_interface_control.tbl
xxivara_org_id_filter.tbl
xxivara_attribute_filter.tbl
xxivara_error_control.tbl
Tip: You can modify the control tables after the installation and
deployment steps are completed by using your tool of choice (for
example, SQL Plus) to update tables with the desired values.
This section explains how to modify tables.

Modify the Interface Control Table

For each of the export interfaces (asset, activity, work order, work
request, and PM schedule), this table provides the name of the export
directory and the number of days back to look for modifications to be
exported to Ivara EXP.
To Modify the Interface Control Table

1. Locate the table in the Ivara EXP install directory:
<IvaraInstallDirectory>\bin\Integration\Oracle eAM\Deploy-
ment\xxivara_interface_control.tbl
2. Open the file with an editor of your choice. Here is an excerpt from
the table:
DROP TABLE xxivara_interface_control
/
CREATE TABLE xxivara_interface_control
(interface_name VARCHAR2(50)
,export_dir VARCHAR2(50)
,num_of_days NUMBER)
TABLESPACE ivara;
GRANT ALL ON ivara.xxivara_interface_control TO apps WITH

GRANT OPTION;
INSERT INTO xxivara_interface_control VALUES

('ORA_EXP_ASSET'
,'/ivara_export'
,1)
/
3. Replace /ivara_export with the path to the export directory

wherever it appears.
4. By default, the number of days is set to 1. If required, change this

value for each of the interfaces.
5. Save and close the file.
Modify the Organization ID Filter Table

This table flags the Oracle eAM organizations that are to be synchro-
nized with Ivara EXP sites. Add the organizations to this table and flag
them to be included (or excluded). The process only exports objects (work
orders, work requests, activities, and PM schedules) that belong to the
departments included in this table.

To Modify the Organization ID Filter Table

ment\xxivara_org_id_filter.tbl
the table:
DROP TABLE xxivara_org_id_filter
/
CREATE TABLE xxivara_org_id_filter
(organization_id NUMBER
,enable_flag VARCHAR2(1)
,description VARCHAR2(240))
TABLESPACE ivara;
GRANT ALL ON ivara.xxivara_org_id_filter TO apps WITH GRANT

OPTION;
INSERT INTO xxivara_org_id_filter

(SELECT organization_id
,'N'
,organization_code
FROM mtl_parameters)
/
UPDATE xxivara_org_id_filter
SET enable_flag = 'Y'
WHERE description = 'VEL'
/
COMMIT;
3. Copy and paste the code block for each organization:

UPDATE xxivara_org_id_filter
SET enable_flag = 'Y'
WHERE description = 'VEL'
4. For each organization, replace VEL with the organizations descrip-

tion.
5. Set the enable flag to Y to include the organization or to N to
exclude it from synchronization.
Modify the Attribute Filter Table

Ivara EXP work order and work request numbers are stored in attribute
15. You need only change this table if this attribute is used for another
purpose in the Oracle eAM database.

To Modify the Attribute Filter Table

ment\xxivara_attribute_filter.tbl
2. Open the file with an editor of your choice.
DROP TABLE xxivara_attribute_filter
/
CREATE TABLE xxivara_attribute_filter
(interface VARCHAR2(30)
,attribute_name VARCHAR2(30))
TABLESPACE ivara;
GRANT ALL ON ivara.xxivara_attribute_filter TO apps WITH

GRANT OPTION;
INSERT INTO xxivara_attribute_filter VALUES

('WORKORDER'
,'ATTRIBUTE15')
/
INSERT INTO xxivara_attribute_filter VALUES
('WORKREQUEST'
,'ATTRIBUTE15')
/
COMMIT
/
3. Replace 'ATTRIBUTE15' with another attribute wherever it is used.
Modify the Error Logging Control Table

For each of the import and export interfaces (asset, activity, work order,
work request, and PM schedule), this table enables or disables error log-
ging and specifies the severity level.
For export interfaces, logging is enabled by default and the severity level
is 3 (Error). For import interfaces, logging is disabled by default because
errors are captured in Ivara EXP. However, you might wish to turn on
logging for testing and troubleshooting imports.
Severity levels are Debug = 0, Info = 1, Warn =2, Error = 3, Fatal =4.
To view errors, use the xxivara_error_log, located in the Ivara EXP\bin

folder.

To Modify the Error Control Table

ment\xxivara_error_control.tbl
the table:
DROP TABLE xxivara_error_control
/
CREATE TABLE xxivara_error_control
(interface VARCHAR2(30)
,enabled_flag VARCHAR2(1)
,severity NUMBER)
TABLESPACE ivara;
GRANT ALL ON ivara.xxivara_error_control TO apps WITH GRANT

OPTION;
INSERT INTO xxivara_error_control VALUES

('ORA_EXP_ACTIVITY'
,'Y'
,3)
/
ORA_EXP_* indicates an export interface from Oracle eAM to

Ivara EXP. EXP_ORA_* indicates an import interface from EXP to
Oracle eAM.
3. When you have finished modifying logging, save and close the file.
Modify and Run the Permissions and Synonyms Script

Modify and then run grants_and_syns.sql, which grants permissions and
creates synonyms in the database.
To Modify and Run the Script

1. Locate the script in the Ivara EXP install directory:
ment\grants_and_syns.sql
2. Open the file with an editor of your choice.
--

**********************************************************
-- General Information:
-- The user name and password provided as an example only.
-- Replace the apps/test1@tsa1 and ivara/test1@tsa1 with
-- your own credentials and SID
--********************************************************
connect apps/test1@tsa1
grant select on EAM_PM_ACTIVITYGROUP_V to ivara;
grant select on eam_pm_schedulings_v to ivara;
grant select on eam_meters to ivara;
grant select on eam_pm_scheduling_rules to ivara;
connect ivara/test1@tsa1
create synonym EAM_PM_ACTIVITYGROUP_V for
apps.EAM_PM_ACTIVITYGROUP_V;
create synonym eam_pm_schedulings_v for
apps.eam_pm_schedulings_v;
create synonym eam_meters for eam.eam_meters;
create synonym eam_pm_scheduling_rules for
eam.eam_pm_scheduling_rules;
3. Replace apps/test1@tsa1 and ivara/test1@tsa1 with your own

credentials and SID.
5. Run the script on the Oracle eAM database using SQL Plus.
Run the Install Script

This script installs the stored procedures in the Oracle eAM database.
1. Run the script on the Oracle eAM database using SQL Plus.
2. When prompted, enter and confirm the following:
Oracle Database Name: (dbserver:1541/sid)

Ivara username for above database: (ivara)
Ivara username for synonym: (ivara)
Ivara Password for above database:
APPS Password for above database:
Installation directory: (c:\ivara\oraclescripts)
Set up Concurrent Programs for Exports to Ivara EXP

Set up concurrent programs for exporting data from Oracle eAM to
Ivara EXP. In Oracle eAM, set up concurrent programs for each of the
following:

Activity
Asset
PM schedule
Work order
Work request
Note: Log on to Oracle eAM as System Administrator.
Activity Export
1. Navigate to Concurrent:Program:Executable and enter data, as
shown:
2. Navigate to Concurrent:Program:Define and enter data, as shown:

3. Navigate to Security:Responsibility:Request. Query the application

Enterprise Asset Management. Create an entry, as shown:
4. This activity export report is now available by logging on using the

Enterprise Asset Management responsibility, navigating to Reports,
and selecting Ivara Activity Export:

5. Click Submit to run the report immediately. To run the report as a

repeating function, click Schedule and set the options. The following
example shows it running at the last second of every day:

Asset Export
shown:


4. This activity export report is now available by logging on using the

and selecting Ivara Asset Export:


PM Schedule Export
shown.

2. Navigate to Concurrent:Program:Define and enter data, as shown

below:
3. Navigate to Security:Responsibility:Request. Query for the applica-

tion Enterprise Asset Management. Then create an entry, as shown
below:

4. This PM export report is now available by logging on using the Enter-

prise Asset Management responsibility, navigating to Reports, and
selecting Ivara PM Export:


Work Order Export

shown:



4. This work order export report is now available by logging on using the
and selecting Ivara Work Order Export:


Work Request Export

shown:


4. This work request export report is now available by logging on using

the Enterprise Asset Management responsibility, navigating to
Reports, and selecting Ivara Work Request Export:

example shows it running as soon as possible:

Set up the Flexfield Attributes for Work Order and Request

Follow the steps in this section for both work order and work request.
Illustrations are shown for work request, but they apply to work order as
well.
1. Log on to the application and choose the Enterprise Asset Manage-

ment responsibility.
2. Navigate to Setup:Flexfields:Descriptive:Segments. Query for Work
Request or Work Order information.
3. Click Freeze Flexfield Definition to clear the option.

4. Click Global Data Elements to select it.

5. Click Segments. Add a segment called Ivara Work Request or

Ivara Work Order and assign it to ATTRIBUTE15. If you do not
want it to appear in Oracle eAM, clear the Displayed option.
6. Click Open. In the Segments window, clear the Required option.
7. Change the Display Size to 25. Click Value Set.

8. Close the Segments window and the Segments Summary window.
9. On the Descriptive Flexfield Segments window, click Freeze Flex-

field Definition. Click Save.

Setting up the Integration in Ivara EXP

Setting up and activating the CMMS integration in Ivara EXP involves
these steps:
1. Create an External System in Ivara EXP on page 71
Create the external system in Ivara EXP. This involves naming it,
setting the location for inbound XML files, and information for access-
ing the Oracle eAM database.
2. Review Integration Information in Ivara EXP on page 75
When you create an external system in Ivara EXP, the Oracle eAM
integration is automatically activated. You can review the type of sys-
tem and the work order integration level.
3. Set Options for Synchronizing Asset Hierarchies on page 76
You can choose from several options for synchronizing Ivara EXP
asset hierarchies with Oracle eAM.
4. Select Options for Standard Tasks and Jobs on page 78
You can have Ivara EXP check that a standard jobs tasks have been
sent to Oracle eAM before sending the job. You can specify the status
that tasks must have before they can be synchronized. You can also
specify how tasks and jobs are numbered.
5. Set Oracle eAM Options on page 81
You can set the default asset type, work request type, number multi-
plier for work order tasks, and PM schedule defaults.
6. Generate CMMS Integration Information on page 82
Next, tell Ivara EXP to generate CMMS integration information for

sites, assets, work order tasks, work requests, standard tasks, and
standard jobs in one or more sites in your Ivara EXP database.
Note: Generating CMMS integration information can take several

minutes or hours, depending on the number of records in your
Ivara EXP database. If you are setting up a new Ivara EXP imple-
mentation, you might wish to perform this step before populating
the database with the bulk of your data. After this step is per-
formed, CMMS information is automatically generated whenever
a new asset, standard task, standard job, work request, or work
order task is added to the system.
7. Map Ivara EXP Settings to Oracle eAM Settings on page 87

You must map Ivara EXP and Oracle eAM work statuses and types.
Other Ivara EXP settings, such as site names, must be entered to
match Oracle eAM settings.
8. Set the Default Completion Status for Work Orders on page 99
A default completion status must be selected for closing work orders.

Otherwise, when work orders are closed in Oracle eAM, an error will
occur when the information is processed in Ivara EXP.
Create an External System in Ivara EXP

The external system provides the Ivara EXP integration manager with
the inbound and outbound parameters it needs to transfer data. Adding
an external system also activates the integration functionality in
Ivara EXP.
Note: To create or modify an external system, you must log on to

Ivara EXP with an Administrator license.
1. Open the Enterprise window and select the Integrations view.
2. Select the External Systems tab and click New. The New External
System dialog appears.
3. Give the external system a descriptive name.
4. The integration type must be EXP/CMMS.
5. Select the standard integration type: Oracle eAM.
6. Select the version of Oracle eAM.
The Assembly name box is populated by default with the file name
of the integration .dll file. For Oracle eAM, the file name is Oracle
eAMIntegrationAdapter.dll.
Tip: Integration .dll files are located in the <IvaraInstallDirec-

tory>\bin\Integration folder.
The New External System dialog will look similar to this:

7. Click OK. The External system window appears.
8. Modify the general settings, if necessary.
Note: If you change the supported direction from Both to

Inbound or Outbound, you cannot add new parameters, class
mappings, or (if Inbound is selected) classes for the other direc-
tion. For example, if the selected direction is Inbound, New but-
tons are only available for inbound parameters and class
mappings. However, the existing objects for the excluded direction
are still available. You can delete or mark them inactive, if
required. Right-click the parameter, mapping, or class and click
Delete or Mark as Inactive.

The Parameters table lists the inbound and outbound parameters

for the Oracle eAM integration adapter and their statuses. These
standard parameters are supplied by Ivara EXP to communicate with
Oracle eAM. They can be either inbound (to Ivara EXP) or outbound
(from Ivara EXP) and can be defined at either the adapter or class
level. Adapter level parameters apply to all integrated classes. Class
level parameters apply to individual class integration.
Note: The URL outbound parameter does not apply to Oracle

eAM.
9. If you are integrating with E-Business Suite version 11.5.10, add a

parameter and set the version value:
Click New. The Parameter Key dialog appears.

Set the Parameter level to Adapter level.
Set the Direction to Outbound and the Key to eAMVersion.
Click OK.
Select the Outbound tab and the Parameter Values tab.
Double-click eAMVersion to open the Parameter Value dialog.
In the Value box, enter 11.5.
Click OK. The Outbound tab will look similar to this:

10. Select the Inbound tab. On the Parameter Values tab, double-click
the XML Directory inbound parameter. The Parameter Value dialog
appears.
11. In the Value box, enter the directory where the server stores the
inbound XML files and click OK. For example:
\\<ComputerName>\IvaraInboundMsgs
12. To archive copies of inbound XML files, double-click the XML
Inbound Backup Folder parameter to open the Parameter Value dia-
log.
13. In the Value box, enter the directory where copies of the inbound
XML files will be archived. Setting this parameter activates
archiving. Click OK.
14. Select the Outbound tab. On the Parameter Values tab, open the
Database Source Name parameter.
15. In the Value box, enter the name of the data source required to con-
nect to the Oracle eAM database. Click OK.
16. Open the Password and Username outbound parameters and provide
the password and user name required to connect to the Oracle eAM
data source.
Note: By default, the Password keys Mask values setting is

turned on. This prevents any user signed on with an end-user
license from seeing the password in the Parameter Values tab.
The password is shown as a series of vertical bars (for example,
|||||), and the value is not visible in the Parameter Value dialog.
17. Close the External System window.

Making Objects Active or Inactive

The Outbound tab, Processor tab lists the standard integration
objects: Asset, Standard Job, Standard Task, Work Orders, and Work
Requests. These are the classes that the outbound processor scans for
instances to be sent to Oracle eAM. Instances of these classes are placed
in the outbound processors queue when they are marked as Ready to
send.
Do not modify this list unless you want to exclude one of the classes in
the integration. In that case, right-click the class and click Mark as
Inactive. To extend the standard integration to include additional
classes, see Customizing the Integration on page 157.
You can mark external systems, parameters, class mappings, and out-
bound processing classes as inactive or active. For example, for testing
purposes, you might want to create two or more classes and alternate
using them in the integration. To toggle an object to inactive or active,
right-click it and select Mark as Inactive or Mark as Active, as appro-
priate. The Active Status column in tables indicates whether the object
is active or inactive.
Review Integration Information in Ivara EXP

When you create an external system in Ivara EXP, the Oracle eAM inte-
gration is automatically activated. You can review the type of system and
the work order integration level.
To Review Integration Information

1. Open the Enterprise window.
2. Click the Administration menu and then Integration Settings.

The Integration Settings dialog appears.
On the General tab, Ivaras CMMS integration is active is

selected. In the Type of system list, Oracle eAM is selected and the
version of Oracle eAM.

Note: If you are integrating with version 11.5, the system version
shown in Integration Settings should be Oracle eAM 12.0.
The Work order integration level is set to the appropriate option

for the CMMS you are integrating with. For example, when a work
orders status changes in Oracle eAM, the work orders status is
updated in Ivara EXP.
Note: Do not change the default selection unless you intend to

customize the integration components in Ivara EXP and Oracle
eAM.
Set Options for Synchronizing Asset Hierarchies

There are several options for synchronizing Ivara EXP asset hierarchies
with the asset hierarchy in Oracle eAM. You can synchronize one or two
Ivara EXP asset hierarchies with Oracle eAM. For hierarchy 1, an alter-
nate hierarchy, or both, you can choose from four options.
Note: To prevent users from changing the Ivara EXP asset hierar-
chy from the sites Assets view or the assets Hierarchies view,
you must set users security profiles to make the views read-only.
For more information, see Securing Integration Functionality on
page 115.
To Set Up Asset Hierarchy Synchronization

1. On the Integration Settings dialog, select the Asset Hierarchy tab.
2. Select an option for asset hierarchy 1 in Ivara EXP:

Asset hierarchy 1 Select one of the following options for synchro-

synchronization to nizing asset hierarchy 1. You can choose:
the CMMS hierarchy
Always synchronized. All changes to the
CMMS hierarchy are made to the Ivara EXP
hierarchy. Ivara EXP assets created from a
CMMS asset use the CMMS parent to create
the Ivara EXP hierarchy. When this option
is selected, you cannot change an assets par-
ent. This is the most commonly used option.
New assets only. Only additions to the
CMMS hierarchy are synchronized to the
Ivara EXP hierarchy. Hierarchy changes to
existing assets are not reflected in the
Ivara EXP hierarchy. This option is selected
in cases where your implementation team
has decided that the CMMS hierarchy pro-
vides a good initial definition for Ivara EXP,
but changes are required. You can manually
change an assets parent in Ivara EXP.
Not synchronized. The CMMS and
Ivara EXP hierarchies are not synchronized.
This option is selected in cases where your
implementation team has decided that the
CMMS hierarchy is not appropriate for the
purposes of Ivara EXP. The Ivara EXP hier-
archy is defined within Ivara EXP itself.
Custom. A customized integration is used,
so changes in the CMMS hierarchy are not
made to the Ivara EXP hierarchy.
3. If another asset hierarchy is to be synchronized to Oracle eAM

instead of or in addition to hierarchy 1, select one of the following
options:

Alternate hierarchy To synchronize another hierarchy instead of or

to synchronize to in addition to hierarchy 1, select the appropriate
the CMMS hierarchy option. Choose:
Always synchronized. All changes to the

CMMS hierarchy are made to the Ivara EXP
hierarchy. Ivara EXP assets created from a
CMMS asset use the CMMS parent to create
the Ivara EXP hierarchy. When this option
is selected, you cannot change an assets par-
ent using the Parent Assets tab.
New assets only. Changes to the CMMS
hierarchy are made to the Ivara EXP hierar-
chy. Ivara EXP assets created from a CMMS
asset use the CMMS parent to create the
Ivara EXP hierarchy. You can manually
change an assets parent in Ivara EXP.
Not synchronized. Changes in the CMMS
hierarchy are not made to the Ivara EXP
hierarchy. You can maintain the asset hier-
archy manually in Ivara EXP.
Custom. A customized integration is used,
so changes in the CMMS hierarchy are not
made to the Ivara EXP hierarchy.
Select the hierarchy to synchronize from the list.
Next, you can select options for handling standard tasks and jobs.
Select Options for Standard Tasks and Jobs

Ivara EXP can check that the standard tasks referenced on a standard
job have corresponding activities in Oracle eAM before exporting the job.
You can specify the status that tasks must have before they can be syn-
chronized. You can also specify how standard tasks and jobs are num-
bered in Ivara EXP.

To Select Standard Task and Job Options

1. On the Integration Settings dialog, select the Options tab and the
General tab.
2. Enter the appropriate settings:
Setting Name Description
Check that the jobs A standard job typically contains a list of stan-
tasks have been dard tasks. The tasks must have corresponding
successfully inte- activities in Oracle eAM before the job is sent.
grated when the job
is marked as ready For Oracle eAM, ensure that this option is
to send selected. Ivara EXP checks whether the stan-
dard jobs tasks exist in the CMMS before the
standard job can be marked as Ready to Send.
Clearing this option results in errors in the inte-

gration if the referenced tasks activities do not
exist in Oracle eAM when the job is sent.

Standard job num- Use these options to control how standard job
bers numbers are constructed. Choose from:
Use EXP number the Ivara EXP number

is used as entered for standard jobs created
in Ivara EXP.
Note: For jobs that originate from an

Oracle eAM activity, the PM schedule
number is used.
Use EXP number plus site ID the sites

ID is appended to the standard job number.
Task status You can enter a task status to indicate that all
standard tasks on a job are available for use in
the CMMS. Enter the appropriate CMMS task
status in the box.
Note: This status is specific to your

CMMS and does not relate to any status
used in Ivara EXP.
As well, if a work order is based on a standard

task, the standard tasks CMMS task number is
included in the outbound message if the stan-
dard task has the specified status.
Standard task num- Use these options to control how standard task
bers numbers are constructed. Choose from:
Use EXP number - the Ivara EXP number

is used as entered for standard tasks created
in Ivara EXP.
Note: For tasks that originate from an

Oracle eAM activity, the activity number
is used.
Use EXP number plus site ID - the sites

ID is appended to the standard task number.
Note: For Oracle eAM integration, it is

recommended that this option be selected
because activity numbers are not unique
by organization.

Note: Because Oracle eAM supports long descriptions, do not

select Break long descriptions into separate line. This option
does not apply in Oracle eAM.
Set Oracle eAM Options

You can set options for assets, work requests, work order tasks, and PM
schedule defaults.
To Set Oracle eAM Options

1. On the Integration Settings dialog, select the Options tab and the
eAM tab.
2. In the Default asset type list, select an asset type. If the Oracle
eAM asset has not been assigned an asset category, this asset type is
assigned to the asset when it is imported into Ivara EXP.
3. Enter a work request type to be assigned to all Oracle eAM work

requests created from Ivara EXP work requests. This must be a valid
work request type in Oracle eAM, for example, EXP - IVARA.
4. Enter the task multiplier. This number (for example, 10) is used to
convert work order task numbers to operation numbers suitable for
Oracle eAM. For more information about how this works, see Task

Multiplier on page 38.
5. Enter the PM schedule defaults:

Base triggering interval default triggering interval, in days,
for all standard jobs with a rule based schedule type
Time until first trigger date number of days used to calculate
the initial trigger date for all standard jobs with a list dates
schedule type
Generate CMMS Integration Information

When the integration is activated, CMMS and integration event informa-
tion is added to the views for the following objects:
Site
Asset
Standard task
Task template
Standard job
Standard job task
Work order task
Work request
The CMMS tabs display information about the objects synchronized
properties and the exchanges between the systems.
You can generate default integration information for objects that already
exist in Ivara EXP. You can perform this action for an individual site or
all sites in the enterprise at the same time. If you are setting up a new
Ivara EXP implementation, you might wish to perform this step before
populating the database with the bulk of your data. After this step is per-
formed, CMMS information is automatically generated whenever a new
asset, standard task, standard job, work order task, or work request is
added to the system.
Note: Generating CMMS integration information can take several

minutes or hours, depending on the number of records in your
Ivara EXP database.
You can also set options that determine how assets, standard tasks, and
standard jobs currently in Ivara EXP are numbered on their CMMS Info
tabs. For example, you can specify that asset identifiers consist of only
numbers and the length of the identifiers. The identifiers are then auto-
matically padded with zeros (to the right of the number) to achieve the
specified length.

Before generating CMMS integration information, you must also specify

which work requests are to be integrated according to work type.
Tip: If incorrect options were selected when the CMMS integra-

tion information was originally generated, you can regenerate the
information. On the Options tab of the Generate CMMS Informa-
tion dialog, select the appropriate options for regenerating infor-
mation for assets, standard tasks, standard jobs, or a combination
of them. Any information that was added to the objects CMMS
tabs after the original generation are replaced with default val-
ues.
Note: To generate or regenerate CMMS integration information,

you must log on to Ivara EXP with an Administrator license.
This section explains how to generate CMMS information and how to
regenerate it.
To Generate CMMS Integration Information

1. On the Integration Settings dialog, click Setup. The Generate CMMS
Integration Info dialog appears. This dialog allows you to control how
the CMMS information is generated.

2. Enter the following settings, as appropriate.
Sites To generate CMMS information for an individ-

ual site only, click Site and select the site from
the list. If All sites is selected, CMMS informa-
tion is generated for all sites in the enterprise.
A CMMS object Select this option if your Ivara EXP database

already exists... contains assets that have matching assets or
locations in the CMMS and the same identifica-
tion numbers are used in both systems. After the
CMMS integration information is generated, the
setting on each existing assets CMMS tab will
be An equivalent asset exists in the CMMS.
Clear this option if most of your Ivara EXP

assets do not correspond to assets in the CMMS.
If only a few assets will be linked to CMMS
assets, you can manually identify the CMMS
number for those assets.
The majority of the Select the type of asset to which Ivara EXP
CMMS assets are assets will most often be linked. This will be the
default setting on the assets CMMS tabs. You
can change this setting on individual assets
later, if necessary.
Asset types Select the asset types for which assets do not
typically exist in the CMMS. When the CMMS
information is generated for each Ivara EXP
asset, the assets type is checked against this
list. If the asset type is marked to be excluded,
the asset is designated as not having an equiva-
lent in the CMMS. Ivara EXP then gets the
assets CMMS information from the first ances-
tor that has a CMMS identification number.
3. Select the Tasks and Jobs tab.

4. Review and clear the following, if necessary.
Standard tasks Select A CMMS object already exists... if

your Ivara EXP database contains standard
tasks that have matching objects in the CMMS
and the same identification numbers are used in
both systems. When the CMMS integration
information is generated, An equivalent task
exists in the CMMS is selected on each stan-
dard tasks CMMS tab.
Clear this option if most of your Ivara EXP tasks

do not correspond to objects in the CMMS. If
only a few tasks will be linked to CMMS objects,
you can manually identify the CMMS number
for those tasks.
Standard jobs Select A CMMS object already exists... if

your Ivara EXP database contains standard jobs
that have matching objects in the CMMS and
the same identification numbers are used in
both systems. When CMMS integration informa-
tion is generated, An equivalent job exists in
the CMMS is selected on each standard jobs
CMMS tab and the job number is copied to the
CMMS identification number.
Clear this option if most of your Ivara EXP jobs

do not correspond to objects in the CMMS. If
only a few jobs will be linked to CMMS objects,
you can manually identify the CMMS number
for those jobs.
5. Select the Work Requests tab.
6. Select the work types for which you want to activate integration.

7. Click OK to start the generation process. In the confirmation dialog

that appears, click Yes.
If the process fails to complete successfully, a message window

appears, showing the cause of the problem. You can restart the pro-
cess once the problem has been resolved. The process picks up pro-
cessing where it left off. Objects that were successfully updated are
not reprocessed.
When the process is complete, default mappings for Oracle eAM and
Ivara EXP task statuses are listed in the Integration Settings dialog,
General tab, in the Work status mapping table. For more informa-
tion about changing these defaults, see Map Work Order and Work
Request Statuses on page 95.
8. Click Close to close the Integration Settings dialog.
To Regenerate CMMS Integration Information

1. On the Integration Settings dialog, click Setup. The Generate CMMS
Integration Info dialog appears. If CMMS information was generated
previously, the Options tab is available.
2. Click the Options tab.

3. Select the appropriate options. These settings are only available if

CMMS information has already been generated for the objects.
Regenerate the Select this option if you want existing CMMS

existing asset information to be regenerated for assets. Any
CMMS information information entered on assets CMMS tabs will
be replaced by default values. The CMMS infor-
mation should only be regenerated if incorrect
options were selected when the CMMS informa-
tion was originally generated.

existing standard information to be regenerated for standard
task CMMS informa- tasks. Any information entered on standard
tion tasks CMMS tabs will be replaced by default
values. The CMMS information should only be
regenerated if incorrect options were selected
when the CMMS information was originally
generated.

existing standard information to be regenerated for standard jobs.
job CMMS informa- Any information entered on standard jobs
tion CMMS tabs will be replaced by default values.
The CMMS information should only be regener-
ated if incorrect options were selected when the
CMMS information was originally generated.
4. Click OK to start the generation process. In the confirmation dialog

that appears, click Yes.
5. Click Close to close the Integration Settings dialog.
Map Ivara EXP Settings to Oracle eAM Settings

When you are integrating Ivara EXP with Oracle eAM, the following set-
tings must match in both systems:
Ivara EXP Setting Oracle eAM Notes

Setting
Asset status Asset status Map the asset statuses between
systems. See Map Asset Status
Codes on page 88.

Ivara EXP Setting Oracle eAM Notes

Setting
Asset type Asset group Add the matching Oracle eAM
asset groups to Ivara EXP asset
types. See Map Asset Types on
page 89.
Consequence Asset priority Enter the matching Oracle eAM
priority number code priority code on each Ivara EXP
consequence priority. See Map
Consequence Priority Numbers
on page 91.
Maintenance Department Add each Oracle eAM depart-
group ment to the corresponding
Ivara EXP maintenance group.
Each maintenance groups abbre-
viation must match the corre-
sponding department exactly.
See Map Maintenance Group
Abbreviations on page 92.
Site Organization The matching site and organiza-
ID tion IDs must be entered in the
properties for each site. See Map
Site Names on page 93.
Work priority Work order pri- You can map Ivara EXP work
ority priorities CMMS priority num-
bers to the corresponding work
order priority codes in Oracle
eAM. See Map Work Priorities
on page 94.
Work order and Status Map matching statuses in
request status Ivara EXP. See Map Work Order
and Work Request Statuses on
page 95.
Work type Work order Map matching types in
type Ivara EXP. See Map Work
Types on page 97.
Map Asset Status Codes

Asset status represents the operational state of an asset, and whether or
not it is available for use. The name of the Ivara EXP status must match
the Oracle eAM status. This section explains how to modify an existing
asset status code.

To Map Asset Status Codes

1. From the Site window, select the Assets view, Settings tab. Select
the Assets tab and the Asset management settings node in the
tree.
Tip: You can also click the Administration menu, Maintenance

Settings, and then Asset Management. The Asset Management
Settings dialog appears.
2. Select the Asset Statuses tab. This tab shows a list of the current
asset statuses.
3. Double-click an asset status. The Asset Status dialog appears. Click

Edit.
4. Revise the status name to match the corresponding status in Oracle

eAM.
5. Click OK to save the status and close the dialog.
Map Asset Types

The mapping between Ivara EXP asset types and Oracle eAM asset
groups is defined on each asset type. When an Ivara EXP asset is being
created or updated from an Oracle eAM asset, the asset group is used to
determine the asset type to use. If no asset type can be mapped to the
asset group, the enterprises default asset type (defined in Integration
Settings) is used.

See Setting up Asset Types in Help for detailed information about asset
type properties. The following procedure explains features that are spe-
cific to CMMS integration. You must perform the following steps for each
site in your Ivara EXP system.
To Map Asset Types

1. In Ivara EXP, open a site.
2. From the Administration menu, select Maintenance Settings and

Asset Management. The Asset Management Settings dialog
appears.
3. On the Asset Types tab, double-click an asset type to open it. The
Asset Type window appears. Click Edit.
4. Select the General tab and ensure that Assets of this type typi-
cally exist in your CMMS is selected.
5. Select the eAM tab.

6. Enter the Oracle eAM asset group that corresponds to the asset type
in Ivara EXP, for example GEN.AGI. When an asset is created or
updated in Ivara EXP, the asset group is used to determine the asset
type to use.
Note: If no asset type is mapped to the asset group, the enter-

prises default asset type is used.
7. Click OK.
8. When you are finished updating asset types, click OK.
Map Consequence Priority Numbers

For each consequence priority in Ivara EXP, enter the corresponding pri-
ority values to be entered on the Oracle eAM criticality codes.
To Map Consequence Priority Numbers

2. From the Administration menu, select Work Identification Set-

tings and then Asset Prioritization. The Asset Prioritization Set-
tings dialog appears.
3. Select the Consequence Priorities tab. This tab lists all of your
Ivara EXP consequence priorities.
4. Open a priority by double-clicking it. The Consequence Priority dialog

appears. Click Edit.

5. In the CMMS Information area, enter the matching Oracle eAM

priority lookup code.
6. Click OK.
7. Repeat steps 4 to 6 for each priority that you need to map.
8. Click OK to close the settings dialog.
Map Maintenance Group Abbreviations

Each maintenance groups abbreviation must match the corresponding
Oracle eAM department exactly. See Setting up Maintenance Groups in
Help for detailed information about maintenance groups. The following
procedure explains features that are specific to CMMS integration. You
must perform the following steps for each site in your Ivara EXP system.
To Map Maintenance Group Abbreviations

1. In Ivara EXP, open the site.
2. Select the Personnel view, Maintenance Groups tab.
3. Double-click a maintenance group to open it.
4. Select the Properties view, General tab.
5. Make sure that editing is enabled.

6. In the Abbreviation box, enter the Oracle eAM department.
7. Save and close the maintenance group.

Repeat this procedure for the other maintenance groups you wish to inte-
grate.
Map Site Names

Site and organization names in Oracle eAM and Ivara EXP must match
exactly.
To Map Site Names

2. From the Site menu, select Properties. The Properties dialog

appears.
3. On the General tab, enter the code for the matching Oracle eAM
Organization ID in the Site name box.
4. Select the CMMS Info tab.

5. In the Site ID box, enter the Organization ID. Leave the Organiza-
tion box blank; it does not apply to Oracle eAM.
6. Click OK.
Map Work Priorities

You can map Ivara EXP work priorities CMMS priority numbers to the
corresponding work order priority codes in Oracle eAM.
To Map Work Priorities

2. From the Administration menu, select Maintenance Settings and

then Work Management. The Work Management Settings dialog
appears.
3. Select the Priorities tab. Double-click a priority to open it. The Work
Priority dialog appears. Click Edit.

4. In the CMMS priority box, enter the unique, corresponding Oracle

eAM work order priority code.
5. Click OK.
Repeat this procedure for the other work priorities.
Map Work Order and Work Request Statuses

Ivara EXP work orders or work requests receive status updates when
users change the status of Oracle eAM work orders or requests. The sta-
tus that is shown in Ivara EXP is determined by the work status map-
pings set up in the Ivara EXP Integration Settings dialog. Default
mappings are added to Ivara EXP when you generate CMMS integration
information.
This section explains how to map an Oracle eAM status code to an

Ivara EXP status. For example, to have Ivara EXP work requests show
the status Work completed when an Oracle eAM work request is com-
pleted, Complete must be the matching status. The case of the CMMS
task status must match the case of the status in Oracle eAM.
To Map Statuses for Work Orders and Work Requests

1. In Ivara EXP, open the Enterprise window.
2. From the Administration menu, select Integration Settings. The

Integration Settings dialog appears.
3. On the General tab, you will see the Work status mapping table.

4. To edit an existing status mapping, double-click it. The CMMS Work

Order and Task Status Mapping dialog appears. Click Edit.
5. If appropriate, select Maps to an EXP task status.

When an Oracle eAM status is not mapped to an Ivara EXP status,

the Ivara EXP work order tasks status is not changed when that sta-
tus is selected in Oracle eAM. However, the Oracle eAM status is dis-
played in the work orders CMMS information.
6. In the EXP task status list, select the status that maps to the Oracle
eAM work status.
7. If appropriate, select Maps to EXP work request status.
When an Oracle eAM status is not mapped to an Ivara EXP status,

the Ivara EXP work requests status is not changed when that status
is selected in Oracle eAM. However, the Oracle eAM status is dis-
played in the work requests CMMS information.
8. In the EXP work request status list, select the status that maps to
the CMMS work request status.
9. If appropriate, enter a comment.
10. Click OK.
Map Work Types

Your Ivara EXP work types must be mapped to corresponding Oracle
eAM work order types before you begin working with the integration. If
they are not mapped, you will not be able to mark standard tasks as
Ready to Send.
When mapping work types, you can define default PM scheduling

options, which are used to populate the PM schedule properties when a
standard job is exported to Oracle eAM.
This section explains how to set options that pertain to Oracle eAM inte-
gration. For detailed information about creating work types, see Setting
up Work Types in Help.
To Map Work Types

1. In Ivara EXP, open a site. Select the Work Management view and
the Settings tab.
2. On the Work Management tab, select the Work Types tab. This
tab lists all of the Ivara EXP work types.
3. Open a work type by double-clicking it. In the Work Type Properties

dialog, General tab, select the CMMS tab. Click Edit.

4. Fill in the values as follows:
Document type Oracle eAM lookup code for the work order type
that corresponds to this work type. The code
must be unique across work types.
Work requests are When a work request is created with this work
integrated type, it can be sent to the CMMS.
5. Select the eAM tab to provide the default values for PM scheduling.
6. Fill in the settings as follows:

Set name The value entered here must exactly match the
corresponding set name in Oracle eAM.
Use Select the option that the PM Scheduler process

uses to calculate work order dates.
Next service based If the schedule type is rule-based, the start date
on is calculated. If the schedule type is list dates,
you can select start date or end date.
Multiple rules date Indicate how the predicted due dates are deter-
to use mined for multiple rules:
First date the due date is set to the first due

date of all rules
Last date the due date is set to the last due

date of all rules
Schedule type The schedule type can be rule-based or date list-

based.
7. Click OK.
8. Repeat steps 3 to 7 for each work type that needs mapping.

9. When you are finished, click OK.
Set the Default Completion Status for Work Orders

Ensure that a default completion status is selected for closing work
orders in the Ivara EXP work management settings. Otherwise, when
work orders are closed in Oracle eAM, inbound processing in Ivara EXP
will fail because the work order will not have a completion status.
To Set the Default Completion Status for Work Orders

1. In Ivara EXP, open a site. Select the Work Management view and
the Settings tab.
2. On the Work Management tab, select the Completion Statuses

tab. Click Edit.

3. In the For work order closing list, select Complete.
4. Click Save.

Testing the Integration Setup

When you have added CMMS integration information to Ivara EXP
objects, you can test the integration before setting up scheduled actions
to automate integration events.
Ivara EXP provides tools to help you test the connection and your inte-
gration information. You can:
Manually import one or more assets from Oracle eAM.

Create test work orders and manually send the information to Oracle
eAM, where work orders are created. Similarly, you can manually
run the action that retrieves information about completed Oracle
eAM work orders and closes the Ivara EXP work order tasks.
View the status of integration events.
Troubleshoot errors and flag events to be retried.
Note: In order to run the inbound and outbound processes manu-

ally for testing purposes, you must be running Ivara EXP as a
thick-client (local server) instance. For information about config-
uring a thick-client, see Installing Ivara EXP and Setting up the
Database in Ivara EXP Installation Guide.
Importing Test Assets from Oracle eAM

You will need to have at least one synchronized asset in Ivara EXP before
you can send a work order, work request, or standard task to Oracle
eAM.
To Import Assets from Oracle eAM

1. Update one or more assets in Oracle eAM and save your changes. For
example, change their descriptions. Then, manually trigger the report
request for an asset in Oracle eAM.
2. Check the XML directory to ensure that the XML files were gener-
ated.
Note: When inbound messages are processed, they are deleted

from the export directory. If you designated an XML inbound
backup folder when setting up the external system, copies of the
inbound XML files are stored there. See Create an External Sys-
tem in Ivara EXP on page 71.

3. In the Ivara EXP site window, open the Tools menu, select Applica-
tion Integrations, and Process Inbound Messages. This com-
mand triggers inbound processing for all Oracle eAM documents
assigned to the current site.
4. In the Ivara EXP Enterprise window, select the Integrations view

and the Events tab. Select the Integration events configuration to
view messages about integration events. If an error occurs, you can
review it here.
5. When the integration event is successful, you can open the site and
select the Assets view, Listing tab. The CMMS Asset Exists and
CMMS Identification Number columns indicate the assets that
you changed and imported.
Creating and Sending Test Documents

To check that the integration is working correctly, you can create one or
more test documents in Ivara EXP and send them to Oracle eAM. You
might wish to test each type of document that you will be using (that is,
work orders, work requests, standard tasks, or standard jobs).
To Create and Send a Test Document

1. For testing purposes, create a work order and save it.
2. Mark the document as Ready to Send. Select the Tools menu,

CMMS, and then Mark as Ready to Send. In the confirmation dia-
log that appears, click Yes.
Tip: To view the integration status, open a work order task, select
the Planning view and the CMMS tab. The document has the
integration status Ready to send and is shown as waiting for
outbound processing. For example:

3. On the site window, click the Tools menu, Application Integra-

tions and then Process Outbound Messages. This command sends
information about the document to Oracle eAM, where a matching
document is created. The Process Outbound Messages command trig-
gers processing for all documents marked Ready to Send on the site.
When the process is successful, the CMMS tab is updated. For exam-
ple:

4. In the Work Order Task window, CMMS tab, select the Work Order
Events tab. The event for the work order export is listed. You can
double-click the event to open it.
Updating Oracle eAM Documents

To test inbound (Oracle eAM to Ivara EXP) processing, update one or
more of the Oracle eAM documents that are integrated with Ivara EXP.
For example, close a work order. Then manually trigger the report
request for Work Order in Oracle eAM.
Check the XML directory to ensure that the XML files were generated.
Then, in the Ivara EXP site window, click the Tools menu, Application
Integrations, and Process Inbound Messages. This command trig-
gers inbound processing for all Oracle eAM documents assigned to the
current site.
View the Ivara EXP documents. They should reflect the changed status
or information.
Viewing Integration Events

You can view the status of inbound and outbound integration events. You
can also view a table of integration messages.
To View Integration Events

2. Select the Events tab. To see all integration events, select the Inte-
gration events configuration. In the list, you will see the event that
you just launched and its results. For example:

3. Double-click an event to view more information. The Integration

Event dialog appears.
4. Select the Current Message tab. For example:

This dialog displays the following information:
Event tab
Event number Ivara EXP automatically numbers each event.

Status The status of the event can be one of:
Waiting to be processed for outbound mes-

sages, the data has been extracted from the
object and is waiting to be sent to the
CMMS. For inbound messages, the message
has been obtained from the external system
and is waiting to be processed in Ivara.
Waiting to be retried an error prevented
the event from being processed, and it has
been flagged to be retried.
Processed the event completed success-
fully.
Error an error prevented the event from
being processed.
Manually resolved the problem that put
the event in error was resolved outside of the
integration. To change an Error status to
Manually resolved, right-click the Event cell
and select Manually resolved.
Informational the message is for informa-
tion purposes only.
Event ID The identification number for the event.
Event type The type of integration event, for example,

Asset, AWBProject, WorkOrders, Standard-
Task, and so on.
Application class The name of the Ivara application class at which

the event is directed. For example, Asset, AWB-
Project, StandardTask, WorkOrder, and so on.
Instance object ID The object ID of the Ivara application object that

is being modified or that generated the event.
For example, if the event is an inbound update
to an Ivara standard task, this is the object ID of
the standard task that is being updated.

Direction Indicates whether the event is inbound (from

the external application to Ivara) or outbound
(from Ivara to the external application).
Instruction tab
The Instruction tab displays the XML instructions used to send the
message between the two systems.
Current Message tab

The current message indicates either the success or failure of the
integration event.
Details tab
Created Date and time when the event was created.
Processed Date and time at which the integration event

was processed.
Created by The user who created the integration event.
Messages tab
The Messages tab displays a list of all of the messages generated for
the event. You can use the messages provided to troubleshoot errors,
if necessary.
5. Close the Integration Event window.
6. Select the Messages tab. This tab provides configurations for view-
ing, filtering, searching, and sorting errors, all integration messages,
manually resolved messages, and messages for events waiting to be
retried.
7. Double-click a message to open it. The Integration Event Message

window appears. For example:

This window contains the following information:
Processed on Date and time that the message was created.
Message type The types of integration messages are:
Message obtained
Processed successfully
Warning
Information
Error
Error - retried
Error - manually resolved
Application mes- Description of the integration error, if applica-

sage ble. Information about the application that cre-
ated the message, the class, object ID, adapter,
and adapter parameters.
Full message The complete integration event message.

8. When you are finished, close the window.
Retrying and Manually Resolving Events

In the Enterprise window, Integrations view, Events tab, you can
right-click an inbound or outbound event and perform the following
actions:
Modify Instruction Open the Modify Instruction dialog enabled

for editing.
Retry Retry an event with the status Error or Processed to have it
sent again the next time that the CMMS processing action is exe-
cuted.
Mark as Manually Resolved You can change an events status
from Error to Manually Resolved, for example, if you have solved the
problem outside of the integration.
Undo Mark as Manually Resolved An events status can be
changed from Manually Resolved to Error, for example, if you wish to
retry the event.
Troubleshooting Event Errors

This section provides suggestions for handling event errors.
Tip: By setting the XMLInboundBackupFolder parameter in the

external system, you can save inbound XML messages from Ora-
cle eAM. For more information, see Create an External System in
Ivara EXP on page 71.
For more information about solving integration problems, see Trouble-
shooting Ivara EXP CMMS Integration. You can find this document in:
<IvaraInstallDirectory>\Docs\English\Integration_Guides
Cannot find the specified application object of class WorkPriority

This type of message can occur when sending objects from Oracle eAM to
Ivara EXP for which a property has not been mapped. For example, by
default Ivara EXP, uses five work priorities, with sequence numbers
from one to five:
Emergency (1)
Urgent (2)
Normal (3)
Programmed (4)
Fill In (5)

If you enter a priority of six or higher on an Oracle eAM work order, you
will get the error listed above. You can correct this problem using one of
the following methods:
Change the priority on the Oracle eAM work order to one that is used
in Ivara EXP
Modify the failed event to change the work priority number to one
that is used in Ivara EXP and re-try processing the event. See Modi-
fying an Event Instruction, next.
Add a work priority in Ivara that uses sequence number six
You might see similar error messages when sending other objects for
which properties have not been mapped. For a list of required property
mappings, see Map Ivara EXP Settings to Oracle eAM Settings on page
87.
Modifying an Event Instruction

If an event cannot be processed due to an error, you can modify the XML
code for the event and try to process it again. For example, if you are
attempting to send a work request to Oracle eAM with an incorrect
department, you could change the department number in the event
instruction and then re-process the event. You would also change the
maintenance groups abbreviation to match the correct department so
that future exports will be successful.
To Modify an Event Instruction

2. On the Events tab, select the With an error configuration.

3. Right-click the event that has the error and click Modify Instruc-
tion. The Modify Instruction dialog appears. For example:

The text in the Instruction box is editable and selected.
Tip: You can copy the instruction text to your favorite XML editor,
search for and modify text, and copy the text back into the Modify
Instruction dialog.
4. Edit the XML code.
For example, to change the Department number, search for the fol-
lowing text:
I_ASSIGNED_DEPARTMENT>7</I_ASSIGNED_DEPARTMENT&gt
Change the number to that of the valid department. For example:

I_ASSIGNED_DEPARTMENT>4</I_ASSIGNED_DEPARTMENT&gt
5. Click OK.

6. Right-click the event and click Retry. The event status changes to
Waiting to be retried.
The next time the CMMS Outbound Processing action is run, the
event will be processed.

Setting up Scheduled Actions for the Integration

You should schedule the following two actions to perform integration
activities at regular intervals:
The Process Outbound Messages action polls Ivara EXP for integra-
tion events that are waiting to be processed or retried. The informa-
tion is communicated to Oracle eAM. If Oracle eAM is not available
when the event is processed, the integration event is failed.
The Process Inbound Messages action checks the Oracle eAM XML
folder for XML files that contain incoming events, such as closed work
orders or updated standard tasks or standard jobs.
Note: If your Ivara EXP setup includes one or more sites that are
not integrated with a CMMS, be sure to restrict scheduled actions
to the integrated sites. Otherwise, event processing will consume
unnecessary system resources as it updates the non-integrated
sites.
For complete instructions on creating scheduled actions, see Setting up

Action Scheduling in Ivara EXP Installation Guide.

Securing Integration Functionality

It is important to adjust security profiles to ensure that users have access
to only the integration functionality they require. In particular, you
should secure the following class elements:
CMMS EXP Integration Active attribute of the Enterprise class

The administrator who is setting up the integration needs full access
to the Ivaras CMMS Integration is active option in the Enter-
prises Integration Settings dialog. This option and related properties
are controlled by the CMMS EXP Integration Active attribute of the
Enterprise class.
Turn Off CMMS Integration action of the Enterprise class
You might also wish to prevent the integration from being acciden-
tally shut down by securing access to the Enterprise class Turn Off
CMMS Integration action.
CMMS Outbound Processing and CMMS Inbound Processing meth-
ods of the Site class
Secure these methods so that only users who are setting up and test-
ing integration events have access to them.
Close, cancel, and reopen methods of the Work order and Work order
task classes, as well as the Close task attribute and work completion
status relationship on the Activity report class.
To prevent some users from inadvertently interfering with integra-
tion events, adjust their security profiles to secure the close, cancel,
and reopen actions for the Work order and Work order task, and
Work request classes. Leave the close methods unsecured for other
users so that they can manually close a work order or work request if
the two systems get out of sync.
Resend method for Standard Tasks, Standard Jobs, Work Orders,
and Work Requests
These objects should only be resent to the CMMS when a new CMMS
database is introduced or when an object has been deleted in error
and must be recreated.
For asset hierarchies that are always synchronized, be sure to secure
the hierarchy pages on the sites Assets view, as well as the assets
Hierarchies view to prevent users from changing asset hierarchies.
Note: For detailed information about creating security profiles,

see the Security topics in Help.

The following table shows some of the classes and their elements that are
related to CMMS integration.
Class Element Type Description

Enterprise CMMS Alter- Attribute Identifies the alternate
nate hierar- asset hierarchy that is
chy for synchronized with the
synchroniza- CMMS instead of, or in
tion addition to, hierarchy 1.
CMMS Alter- Attribute Indicates one of the fol-
nate hierar- lowing settings:
chy
synchroniza- Hierarchies are syn-
tion rule chronized
Synchronized on
new only
Not synchronized
Custom
CMMS eAM Attribute
work request
type
CMMS EXP Attribute Controls whether or not
integration Ivara EXP is integrated
active to a CMMS
CMMS Hier- Attribute Indicates one of the fol-
archy 1 syn- lowing settings:
chronization
rule Hierarchies are syn-
chronized
Synchronized on
new only
Not synchronized
Custom
CMMS identi- Attribute
fier
CMMS stan- Attribute Integration option
dard job check
tasks inter-
faced


CMMS stan- Attribute Integration option
dard task sta-
tus to check
CMMS sys- Attribute Identifies the type of
tem CMMS system
CMMS user Attribute
tag identifier
CMMS work Attribute Indicates whether the
order integra- integration is task-cen-
tion level tric or work order-cen-
tric
CMMS inte- Relation- List of work order sta-
gration work ship tuses that are mapped
order status to CMMS statuses
mapping
Generate Method Initializes your EXP
CMMS Inte- objects for CMMS inte-
gration Info gration
Turn Off Method Turns off the integra-
CMMS Inte- tion to your CMMS sys-
gration tem
CMMS Asset All elements
Info
CMMS eAM All elements
activity
CMMS eAM All elements
activity asset
CMMS inte- All elements
gration work
order status
mapping
CMMS stan- All elements
dard job info
dard job task
info


dard task info
CMMS work All elements
order info
order task
info
request info
type info
Integration Created Attribute Date and time that the
event instance was created
Event ID Attribute Uniquely identifies the
event
Event type Attribute Identifies the type of
event: work order to
CMMS, work order
close, other
Instruction Attribute Command to be pro-
cessed
Instruction Attribute String representation of
abbreviation the HTML instruction;
used in tables
Processed Attribute Date and time when the
instance was processed
Status Attribute Status can be Waiting
to be processed, Waiting
to be retried, Processed,
Error, Manually
resolved, or Informa-
tional.
Site CMMS Method Processes incoming
inbound pro- integration events from
cessing the CMMS


CMMS out- Method Processes outgoing inte-
bound pro- gration events being
cessing sent to the CMMS


Chapter 3 Working with the Integration
This chapter describes how to work with integrated objects in Ivara EXP
and in Oracle eAM.
Contents
Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Standard Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Standard Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Work Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Work Orders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Acknowledging Indicator Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Viewing CMMS Information for the Enterprise . . . . . . . . . . . . . . . . . . 154
Turning Off the Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Assets
This section describes how to import assets from Oracle eAM to
Ivara EXP, add assets to the Ivara EXP physical hierarchy, and make
changes to assets in both Oracle eAM and Ivara EXP. For detailed infor-
mation on how asset integration works, see Assets on page 19.
Importing Oracle eAM Assets into Ivara EXP

Assets that have already been created in Oracle eAM can be added to the
Ivara EXP database in two ways:
Open the Oracle eAM asset and modify one of the integrated proper-
ties. This creates an event that causes the asset to be imported to
Ivara EXP. For a list of the standard properties integrated for assets,
see Assets on page 19.
Assets can be imported as a batch. Contact Ivara Technical Services
for more information.
When an asset is imported into the Ivara EXP database, it is not auto-
matically included in the asset hierarchy unless its parent asset is
already in the hierarchy. When you import a parent and its child assets,
you can add the parent to the site hierarchy. The child assets are then
displayed in the hierarchy.
You can view the imported assets and locations on the sites Assets view,
Listing tab. The default configuration is Asset listing, by asset num-
ber. This configurations contains the CMMS Asset Exists and CMMS
Identification Number columns, which display information about inte-
grated assets.
Showing Assets in the Sites Physical Hierarchy

When you are setting up the physical hierarchy in Ivara EXP with assets
from Oracle eAM, you can add the top-level parent assets to the site so
that they appear in the Physical Hierarchy tab. For example, in Oracle
eAM you might have an asset that is a parent to several other assets.
When the assets are brought into Ivara EXP, the parent information is
preserved. In this example, you would need to manually set the site Bed-
ford as the parent asset to Asset 10001:

If your integration settings specify that the asset hierarchy is always

synchronized with the Oracle eAM hierarchy, you will have to temporar-
ily allow changes to the asset.
To Enter a Parent Asset in Ivara EXP

1. Open the child asset.
3. On the Properties view, General tab, select the Location tab.
4. If the integration settings specify that the asset hierarchy is always

synchronized with the Oracle eAM hierarchy, the Browse button is
not available. On the Tools menu, click CMMS Information and
then Allow Changes. A confirmation window appears. Click OK.
The Browse button is now available.
5. Click Browse, select the site or other parent asset in the Asset Selec-
tor dialog, and click OK.
6. If you allowed changes (Step 4), click the Tools menu, CMMS Infor-
mation, and Disallow Changes.
7. Save and close the asset.
8. On the Site window, select the Assets view, Physical Hierarchy

tab.
9. On the View menu, click Refresh. The asset and its children now
appear in the hierarchy.
Modifying Assets in Oracle eAM

Once an asset has been imported from Oracle eAM, the synchronized
properties must be maintained there. When one of the synchronized
properties is modified in Oracle eAM, an update is sent to Ivara EXP. For
a list of the standard properties integrated for assets, see Assets on
page 19.

Modifying Assets in Ivara EXP

When an Ivara EXP asset is linked to an Oracle eAM asset, the inte-
grated properties are locked and cannot be edited in Ivara EXP. Ideally,
any changes made to synchronized properties in Oracle eAM are made to
the asset in Ivara EXP. However, if an asset gets out of sync and you
need to change a property, you can temporarily unlock the asset for edit-
ing.
Note: Changes to synchronized properties made in Ivara EXP are

overwritten the next time the asset is updated in Oracle eAM and
inbound processing occurs.
To Modify an Integrated Asset

1. Open the asset in Ivara EXP.
3. From the Tools menu, select CMMS Information and then Allow
Changes. A confirmation message appears. Click Yes. The assets
integrated properties can now be edited.
4. Make your changes and save the asset.
5. From the Tools menu, select CMMS Information and then Disal-
low Changes. The synchronized properties are re-locked.
Changing an Assets CMMS Information in Ivara EXP

CMMS information is provided during the integration process when an
asset is imported into Ivara EXP or updated in Oracle eAM. However, a
problem with the integration process can result in the CMMS informa-
tion becoming out of sync with Oracle eAM. You can manually correct the
information. The next time that the asset is updated in Oracle eAM and
inbound processing occurs, the information might be overwritten.
Note: Clearing An equivalent asset exists in the CMMS on the

assets CMMS tab is not advisable. If the equivalent object is
updated in Oracle eAM, an integration error will occur when
inbound messages are processed in Ivara EXP. The error message
will indicate that the asset already exists and that the name or
number must be unique. If the error occurs, you can select the
option again to re-establish the link, or you can renumber the
asset in Ivara EXP.

To Change an Assets CMMS Information in Ivara EXP

1. Open the asset in Ivara EXP.
2. On the Properties view, select the CMMS tab.
4. Click Change. The Change CMMS Information dialog appears.
5. Change the CMMS information as required and click OK. The infor-
mation is changed in the CMMS tab.
Deleting Assets
Oracle eAM assets are synchronized with Ivara EXP assets. However,
when these objects are deactivated in Oracle eAM, they must be manu-
ally deleted in Ivara EXP or have their CMMS information reset.
Updating an Assets Consequence Priority

Typically, the consequence priority for an asset is set during an asset pri-
oritization analysis. Once the analysis is completed, you can apply the
results of the analysis to the analysis assets. This update creates an
event that causes the criticality code of Oracle eAM assets to also be
updated. For more information on creating and working with prioritiza-
tion analyses in Ivara EXP, see the Ivara EXP Help.

Note: You can also manually change the consequence priority of

an asset on the assets Properties view, General tab. This
update is sent to the linked Oracle eAM asset the next time that
outbound messages are processed.
To Apply Analysis Results to Assets

1. Open the prioritization analysis in Ivara EXP.
3. From the Analysis menu, select Apply Analysis Results. A confir-

mation message appears. Click Yes.
The consequence priority is updated on all analysis assets. Linked
assets are marked as waiting for outbound processing. The Oracle
eAM assets are updated the next time that the CMMS Outbound Pro-
cessing action is run.
Viewing Integration Information About Assets

You can view the asset identification and integration events for individ-
ual assets.
To View Integration Information About Assets

1. Select the Assets view and the Listing tab. The Asset listing, by
asset number configuration is shown by default.
2. Scroll to the right to see the CMMS Asset Exists and CMMS Iden-
tification Number columns.
3. To view information about a specific asset, select the asset in the
table and click the form icon . The information that you would see
in the Asset window, Properties view is shown.
4. Select the CMMS tab.

This tab contains the following information:
An equivalent asset Indicates whether or not a corresponding asset

exists in the CMMS exists in the CMMS.
Master system The system that controls the objects informa-

tion.
Waiting for out- If selected, this option indicates that the object
bound processing has been marked as Ready to Send. The next
time that outbound messages are processed, the
objects information is sent to the CMMS.
Type The type of asset in the CMMS, for example,

asset in Oracle eAM, or equipment or functional
location in SAP.

Identification num- The identification number that is used to map

ber the Ivara EXP asset to the equivalent asset in
the CMMS.
CMMS status The status of the matching document in the

CMMS.
Related CMMS asset The assets parent in the CMMS.
Parent asset The number of the assets parent in Ivara EXP.
The eAM tab contains the following information:
Instance ID The asset instance ID in Oracle eAM.
Asset group ID The assets Inventory Item ID in Oracle eAM.
Asset group Description of the asset group.
Serial number The assets serial number in Oracle eAM.
5. Select the Integration Events tab. This tab lists all of the integra-
tion events, their directions, messages, and statuses.
You can double-click an event to view the Integration Event dialog.

Standard Tasks
This section explains how to send standard tasks from Ivara EXP to Ora-
cle eAM, import activities from Oracle eAM, and view information about
the integration in Ivara EXP. For detailed information on how standard
task/activity integration works, see Standard Tasks, Activities, and
Activity Assets on page 23.
Note: An integrated standard task must have a CMMS status of

Active before work orders can be created from it.
Exporting Standard Tasks

Once a standard task has been completed in Ivara EXP, you can mark it
as Ready to Send. When the CMMS Outbound Processing action is run,
the standard task is sent to Oracle eAM, where an activity and activity
asset are created.
For a list of integrated standard task properties, see Standard Tasks,

Activities, and Activity Assets on page 23.
To Export a Standard Task to Oracle eAM

1. Create the standard task in Ivara EXP.
2. From the tasks Tools menu, select CMMS and then Mark as
Ready to Send. A confirmation message appears. Click Yes.
The tasks Properties view, CMMS tab displays the integration sta-
tus of Ready to Send. Waiting for outbound processing is
selected.
When the CMMS Outbound Processing action is run, a matching
activity becomes available in Oracle eAM.
Removing the Ready to Send Status from a Task

If you have marked a standard task as Ready to Send but you need to
make changes, you can unmark the task as long as it has not yet been
sent to Oracle eAM.
To Remove the Ready to Send Status from a Task

1. Open the standard task.
2. From the Tools menu, select CMMS and then Unmark as Ready to
Send. A confirmation message appears.
3. Click Yes. The tasks integration status changes to Not ready to

send, and you can check out the task and make changes.

4. When you have finished making changes you can again mark the task
as Ready to Send.
Creating and Modifying Activities in Oracle eAM

When you create an activity for an integrated asset in Oracle eAM, a
matching standard task is created in Ivara EXP. If the activity includes
more than one integrated asset, a standard task is created for each asset.
If you modify an existing activity for an integrated asset, the integrated
properties are updated on the Ivara EXP standard task.
The work type for the standard task is taken from the assets defaults. If
the assets defaults do not include work type, Ivara EXP takes it from the
closest ancestor that has a work type.
Modifying and Resending Standard Tasks in Ivara EXP

Once a standard task is linked to an Oracle eAM activity, the integrated
properties are locked and cannot be edited in Ivara EXP. However, a task
might become out of sync if, for example, the integration is synchronized
with the wrong Oracle eAM database or the Oracle eAM object was
deleted in error. As long as an activity with the same identifier does not
exist in Oracle eAM, you can change properties in Ivara EXP and resend
the standard task to Oracle eAM. To revise the standard task, you can
temporarily unlock it for editing. Then you can mark the task as Ready to
Resend. When the CMMS Outbound Processing action is run, the task is
re-sent to Oracle eAM.
Note: Changes to synchronized properties made in Ivara EXP will

be overwritten the next time the activity is updated in Oracle
eAM.
For a list of integrated standard task properties, see Standard Tasks,
Activities, and Activity Assets on page 23.
To Modify and Resend an Integrated Standard Task

1. Open the standard task in Ivara EXP.
2. From the Tools menu, select CMMS and then Allow Changes. A
confirmation message appears. Click Yes.
4. Make your changes and save the task.
5. When you are ready to send the task, click the Tools menu, CMMS,
and then Mark as Ready to Resend. A confirmation message
appears. Click Yes.

The standard task is saved and re-locked. The integration status now
shows Ready to Send. Once the CMMS Outbound Processing action
has been run, the activity is created in Oracle eAM.
Changing a Standard Tasks CMMS Information in Ivara EXP

CMMS information is provided during the integration process when a
standard task is linked to an activity in Oracle eAM. However, a problem
with the integration process can result in the CMMS information becom-
ing out of sync with Oracle eAM. You can manually correct the informa-
tion. The next time that the standard task is updated in Oracle eAM and
inbound processing occurs, the information is overwritten.
To Change a Standard Tasks CMMS Information in Ivara EXP

1. Open the standard task in Ivara EXP.
4. Change the information as required and click OK. The information is

changed in the CMMS tab.
Deleting Activities and Standard Tasks

If you delete an Oracle eAM activity, you must manually delete the
matching Ivara EXP standard task.

To Delete an Ivara EXP Standard Task

1. From the site, select the Reliability Program view.
2. On the Tasks tab, right-click the task that you want to delete and
select Delete. A confirmation message appears.
3. Click Yes. The standard task is deleted.
Viewing Integration Information About Standard Tasks

You can view the document number, integration status, and integration
events for individual standard tasks. You can also view integration infor-
mation about all standard tasks.
To View CMMS Information About Standard Tasks

1. Select the sites Reliability Program view and select the Tasks tab.
Scroll to the right to view the CMMS Identification Number col-
umn.
2. To view integration information about an individual standard task,
open it and select the Properties view and the CMMS tab.

Integration status Not ready to send The document has been

created but has not been marked as Ready
to Send.
Ready to send The document has been
marked as Ready to Send to the CMMS.
Exists in CMMS An integration event has
been created to send the document to the
CMMS.

tion.
An equivalent exists Indicates whether this object is mapped to a

in the CMMS matching document in the CMMS.
Identification\Doc- The identification number of the equivalent doc-

ument number ument in the CMMS.

CMMS.
The eAM Info tab contains the following information:
Activity number The identifier of the Oracle eAM activity.
Asset number The identifier of the Oracle eAM activity asset

for this standard task.
Note: For tasks that originate in Oracle eAM, the CMMS informa-
tion is automatically filled in by the integration process and can-
not be manually changed.

3. Select the Events tab. This tab lists all of the integration events,
their directions, messages, and statuses.
You can double-click an event to view detailed information in the

Integration Event dialog.
Standard Jobs
This section explains how to send standard jobs from Ivara EXP to Ora-
cle eAM and make changes to standard jobs in Ivara EXP and PM sched-
ules in Oracle eAM. It also explains how to ensure that work orders
triggered from a standard job are automatically marked as Ready to
Send. For detailed information on how standard job/PM schedule inte-
gration works, see Standard Jobs and PM Schedules on page 27.
Note: An integrated standard job must have the CMMS status

Active before work orders can be created from it.
Marking Generated Work Orders as Ready to Send

When you create a standard job in Ivara EXP, it is assigned a default
option to automatically mark work orders as Ready to Send when they
are generated from a triggered standard job. The next time that out-
bound processing takes place, the work orders are sent to Oracle eAM.
You can clear this option, if you wish.
Note: Work orders that are created manually from a standard job
are not automatically marked as Ready to Send. This allows you
to plan the work order before sending it to Oracle eAM.

To View the Mark as Ready to Send Option

1. Open the standard job.
2. Select the CMMS tab.
3. Work orders generated when this job is triggered are auto-

matically marked as ready to be sent to the CMMS is selected
by default.
Exporting Standard Jobs

To add standard job tasks to a standard job, you can select existing stan-
dard tasks or task templates. If you select a task template, you must also
specify the asset to use when a task is created.
Once a standard job has been completed in Ivara EXP, you can mark it as
Ready to Send. When the CMMS Outbound Processing action is run,
the standard job is sent to Oracle eAM, where a PM schedule is created.
Note: The standard tasks referenced on the job must have been
sent to Oracle eAM before you send the job. You will not be able to
mark the job as Ready to Send if corresponding activities do not
exist in Oracle eAM.
For a list of integrated standard job properties, see Standard Jobs and
PM Schedules on page 27.
To Export a Standard Job to Oracle eAM

1. Create the standard job in Ivara EXP.
2. From the jobs Tools menu, select CMMS and then Mark as Ready
to Send. A confirmation message appears. Click Yes.
The jobs Properties view, CMMS tab displays the integration sta-
tus of Ready to Send. Waiting for outbound processing is
selected.
When the CMMS Outbound Processing action is run, a matching PM
schedule becomes available in Oracle eAM.
Removing the Ready to Send Status from a Job

If you have marked a standard job as Ready to Send, but you need to
make changes, you can unmark the job as long as it has not been sent to
Oracle eAM.

To Remove the Ready to Send Status from a Job

1. Open the standard job.
3. Click Yes. The jobs integration status changes to Not ready to send,
and you can check out the job and make changes.
4. When you have finished making changes you can again mark the job
as Ready to Send.
Creating and Modifying PM Schedules in Oracle eAM

When you create a PM schedule for an integrated asset in Oracle eAM, a
matching standard job is created in Ivara EXP. If you modify an existing
PM schedule for an integrated asset, the integrated properties are
updated on the standard job.
Modifying and Resending Standard Jobs in Ivara EXP

Once a standard job is linked to an Oracle eAM PM schedule, the inte-
grated properties are locked and cannot be edited in Ivara EXP. How-
ever, a job might become out of sync if, for example, the integration is
synchronized with the wrong Oracle eAM database. As long as a PM
schedule with the same identifier does not exist in the Oracle eAM data-
base, you can change a property in Ivara EXP and resend the standard
job to Oracle eAM. To revise the standard job, you can temporarily unlock
it for editing.
Note: Changes to synchronized properties made in Ivara EXP will

be overwritten the next time the PM schedule is updated in Ora-
cle eAM.
For a list of integrated standard job properties, see Standard Jobs and
PM Schedules on page 27.
To Modify and Resend an Integrated Standard Job

1. Open the standard job in Ivara EXP.
2. From the Tools menu, select CMMS and then Allow Changes. A
warning message appears. Click Yes. The jobs properties can now be
edited.
4. Make your changes and save the job.

5. When you are ready to send the job, click the Tools menu, CMMS,
and then Mark as Ready to Resend. A confirmation message
appears. Click Yes.
The standard job is saved and re-locked. The integration status now
shows Ready to Send. Once the CMMS Outbound Processing action
is run, the PM schedule is created in Oracle eAM.
Changing a Standard Jobs CMMS Information in Ivara EXP

standard job is linked to a PM schedule in Oracle eAM. However, a prob-
lem with the integration process can result in the CMMS information
becoming out of sync with Oracle eAM. You can manually correct the
information. The next time that the PM schedule is updated in Oracle
eAM and inbound processing occurs, the information is overwritten.
To Change a Standard Jobs CMMS Information in Ivara EXP

1. Open the standard job in Ivara EXP.
4. Change the information as required and click OK. The information is

Deleting PM Schedules and Standard Jobs

If you delete a Oracle eAM PM schedule, you must manually delete the
matching standard job in Ivara EXP. A standard job task cannot be
deleted if it has been marked Ready to Send.

To Delete a Standard Job in Ivara EXP

1. From the site, select the Reliability Program view.
2. On the Jobs tab, right-click the job that you want to delete and click
Delete. A confirmation message appears.
3. Click Yes. The standard job is deleted.
Viewing Integration Information About Standard Jobs

You can view the integration status, integration events, and Oracle eAM
information for individual standard jobs.
To View Integration Information About Standard Jobs

1. Select the sites Reliability Program view and the Jobs tab.
2. To view information about an individual standard job, open it and

select the Properties view and then the CMMS tab.


to Send.
CMMS.

tion.



CMMS.
The Options tab contains the following information:
Work orders created When a standard job is created in Ivara EXP, it

from this job are is assigned a default option to automatically
automatically mark work orders as ready to send when they
marked as ready to are generated from a triggered standard job.
send The next time that outbound processing takes
place, the work orders are sent to Maximo.

Schedule type The schedule type can be rule-based or date list-

based.
Base interval Minimum period (such as 90 days) or meter

reading (such as 7,500 miles) between PM activ-
ities.
First trigger date The first due date for the scheduled activity.
3. Select the Events tab. This tab lists all of the integration events,
their directions, messages, and statuses. You can double-click an
event to view more information on the Integration Event dialog.
Work Requests
This section describes how to send work requests from Ivara EXP to Ora-
cle eAM, make changes to work requests in Oracle eAM, and modify work
requests in Ivara EXP. For detailed information on how work request
integration works, see Work Requests on page 30.
Exporting Work Requests

Once a work request has been completed in Ivara EXP, you can mark it
as Ready to Send. When the CMMS Outbound Processing action is run,
the work request is sent to Oracle eAM, where a matching work request
is created.
Note: The asset specified on the work request must exist in Oracle
eAM and have a CMMS number in Ivara EXP before you can
mark the work request as Ready to Send.
To Export a Work Request to Oracle eAM

1. Create the work request in Ivara EXP.
2. Select a work type that supports work request integration. The

CMMS tab is added to the window.
3. From the Tools menu, select CMMS and then Mark as Ready to
Send. A confirmation message appears. Click Yes.
Tip: Select the CMMS tab to view the integration status. For
example:

Once the CMMS Outbound Processing action has been run, a match-
ing work request becomes available in Oracle eAM. The Ivara EXP
work requests number is replaced with its Oracle eAM number.
Removing the Ready to Send Status from a Work Request

If you have marked a work request as Ready to Send but you need to
make changes, you can unmark the work request as long as it has not
been sent to Oracle eAM.
To Remove the Ready to Send Status from a Work Request

1. Open the work request.
3. Click Yes. The work requests integration status changes to Not

ready to send, and you can check out the work request and make
changes.
4. When you have finished making changes, you can again mark the
work request as Ready to Send.
Updating Work Request Status in Oracle eAM

Once a work request exists in Oracle eAM, it is maintained there. Status
changes performed in Oracle eAM are synchronized to Ivara EXP. When
the work requests status changes to Closed, the integration closes the
work request. Only work requests that originated in Ivara EXP are
updated when they are completed.

You can view a list of status changes on work requests. In the Work
Request window, select the Properties view, CMMS tab, and then the
Status Changes tab. The table lists the new statuses, event IDs, and
more.
Resending a Work Request to Oracle eAM

Once a work request is linked to an Oracle eAM work request, the inte-
grated properties are locked and cannot be edited in Ivara EXP. How-
ever, a work request might become out of sync if, for example, the
integration is synchronized with the wrong Oracle eAM database or the
Oracle eAM object was deleted in error. As long as a work request with
the same identifier does not exist in the Oracle eAM database, you can
resend the work request to Oracle eAM.
To Resend a Work Request to Oracle eAM

1. Open the work request in Ivara EXP.
2. From the Tools menu, select CMMS Information and then Mark
as Ready to Resend. A warning message appears. Click Yes.
The integration status now shows Ready to Send. Once the CMMS
Outbound Processing action is run, the notification is created in Ora-
cle eAM.
Changing a Work Requests CMMS Information in Ivara EXP

work request is exported to Oracle eAM and when the work request sta-
tus changes in Oracle eAM. However, a problem with the integration pro-
cess can result in the CMMS information becoming out of sync with
Oracle eAM. You can manually correct the information in Ivara EXP.
However, the next time that the documents status is updated in Oracle
eAM and inbound processing occurs, the information is overwritten.
To Update CMMS Information for a Work Request

1. Open the work request.
2. Select the Properties view and then the CMMS tab.

5. Change the information as needed and click OK. The information is

Viewing Integration Information About a Work Request

You can view integration information events for individual work
requests.
1. Select the Work Management view and the Work Requests tab.
2. Open the work request and select the Properties view and then the
CMMS tab.


to Send.
CMMS.

tion.


CMMS Status The status of the Ivara EXP document and the
matching document in the CMMS.
3. The Work Request Events tab lists all of the integration events,
their directions, messages, and statuses. You can open an event by
double-clicking it.
4. Select the Status Changes tab. This tab lists all of the status
changes applied to the work request.
Work Orders
This section describes how to send work orders from Ivara EXP to Oracle
eAM and make changes to work orders in Oracle eAM and Ivara EXP.
For detailed information on how work order integration works, see Work
Orders on page 34.

Note: An integrated standard job or standard task must have a

CMMS status of Active before work orders can be created from
it.
Exporting Work Orders

Once a work order has been completed in Ivara EXP, you can mark it as
Ready to Send. When the CMMS Outbound Processing action is run,
the work order is sent to Oracle eAM, where a matching work order and
operations are created.
To Export a Work Order to Oracle eAM

1. Create the work order in Ivara EXP.
2. From the Work Order menu, select CMMS and then Mark as
Ready to Send. A confirmation message appears. Click Yes. All of
the work orders tasks are marked as ready to send.
3. Open a work order task, select the Planning view and the CMMS
tab to view the integration status. For example:
Once the CMMS Outbound Processing action has been run, a match-
ing work order and operations are available in Oracle eAM.
Removing the Ready to Send Status from a Work Order

If you have marked a work order as Ready to Send but you need to
make changes, you can unmark the work order as long as it has not
been sent to Oracle eAM.

To Remove the Ready to Send Status from a Work Order

1. Open the work order and then one of its work order tasks.
2. On the Work Order Task window, click the Tools menu, click CMMS
and then Unmark as Ready to Send. A confirmation message
appears.
3. Click Yes. The integration status for each work order task changes to
Not ready to send. You can check out the work order tasks and
make changes.
4. When you have finished making changes, you can again mark the
work order as Ready to Send.
Resending a Work Order to Oracle eAM

Once a work order is linked to a Oracle eAM work order, the integrated
properties are locked and cannot be edited in Ivara EXP. However, a
work order might become out of sync if, for example, the integration is
synchronized with the wrong Oracle eAM database. As long as a work
order with the same identifier does not exist in the Oracle eAM database,
you can resend the work order to Oracle eAM.
To Resend a Work Order to Oracle eAM

1. Open the work order in Ivara EXP.
2. From the Tools menu, select CMMS and then Mark as Ready to
Resend. A warning message appears. Click Yes.
The integration status now shows Ready to Send. Once the CMMS
Outbound Processing action is run, the work order is created in Ora-
cle eAM.
Changing a Work Orders CMMS Information in Ivara EXP

work order is exported to Oracle eAM and when the work order status
changes in Oracle eAM. However, a problem with the integration process
can result in the CMMS information becoming out of sync with Oracle
eAM. You can manually correct the information in Ivara EXP. However,
the next time that the work orders status is updated in Oracle eAM and
inbound processing occurs, the information is overwritten.
To Update CMMS Information for a Work Order

1. Open the work order task.
2. Select the Planning view and then the CMMS tab.

4. Click Change. The Change CMMS Identification dialog appears.
5. Change the information as needed and click OK. The information is

Updating Work Order Status in Oracle eAM

Once a work order exists in Oracle eAM, it is maintained there. Work
order status changes performed in Oracle eAM are synchronized with
Ivara EXP work order tasks, which are updated to reflect changes to Ora-
cle eAM statuses. If the new Oracle eAM status is mapped to an
Ivara EXP status, the status is set on the work order task. If the status is
not mapped in Ivara EXP, the work order CMMS status only is updated.
When the work orders status changes to Closed, the integration closes
the work order task. Only work orders that originated in Ivara EXP are
updated when they are completed.
Note: A default work completion status must be selected for work

order closing in your Ivara EXP Work Management settings
before the integration process can close the work order in
Ivara EXP. See Set the Default Completion Status for Work
Orders on page 99.
You can view a list of status changes on work order tasks. In the Work
Order Task window, select the Properties view, CMMS tab, and then
the Status Changes tab. The table lists the new statuses, event IDs,
and more.
Viewing Integration Information About Work Orders

You can view integration information for individual work orders.

1. Select the Work Management view, the Work Orders tab, and the
Tasks tab.
2. To view information about an individual work order task, open it and

select the Planning view and then the CMMS tab.
Type of document The type of document created in the CMMS (for

example, work order).

to Send.
CMMS.

Work order The number of the work order created in the

CMMS for the Ivara work order.
Task The number of the work order task created in

the CMMS for the Ivara work order task.
CMMS Status The status of the Ivara EXP document and the
matching document in the CMMS.
The eAM tab displays the operation number of the work order in Ora-
cle eAM.
3. Select the Work Order Events tab. This tab lists all of the integra-
tion events, their directions, messages, and statuses. You can double-
click an event to view more information in the Integration Event dia-
log.

Acknowledging Indicator Alarms

When you acknowledge an Ivara EXP indicator alarm by creating a work
order or work request, you can mark the document as Ready to Send at
the same time.
If necessary, you can undo the acknowledgement of an indicator alarm.

This action is only possible if the status of the indicators most recent
reading is Acknowledged and if the work request or work order used to
acknowledge the alarm has not been sent to Oracle eAM. The work docu-
ments integration status must be Not ready to send. If the work docu-
ment has already been sent to Oracle eAM, it must be cancelled in Oracle
eAM. The acknowledgement cannot be undone.
This section explains how to acknowledge an indicator alarm and how to

undo an acknowledgement in an integrated environment.
To Acknowledge an Indicator Alarm with a Work Request or Order

1. In Ivara EXP, right-click the indicator that is in alarm and click
Acknowledge Alarm. The Acknowledgement Info dialog appears.

2. Select Work order or Work request as the acknowledgement

method.
3. If you are using an existing work order or request to acknowledge the

alarm, select Use an existing work document and click Browse.
Ivara EXP opens a selector dialog. Select the work document that you
want to use and click OK.
If you are creating a new work order or request, select Create a new
work document. Select how you want to create the work document:
New work docu- Select how you want to create the work docu-
ment source ment that will be used to acknowledge this indi-
cator alarm:
From scratch: When you click OK, a new

work document is created.
Note: From scratch is only available if a

default work type has been selected for
acknowledging alarms for the site. See
Setting up Acknowledgement Policies
in Help.
Based on a job: Click Browse to select the

standard job or template.
Based on a task: Click Browse to select
the standard task or template.
Note: If you select From scratch, a default work order or work

request title is created using the asset name and number and
indicator reading details. The work type used is the default work
type set in the sites acknowledgement policies.
4. To send the work order directly to Oracle eAM, select the option
Mark work document as ready to send to CMMS.
Tip: To enter more information on the work order or request

before sending it, clear this option.
5. Enter any applicable notes in the Acknowledgment comments sec-
tion.
6. If appropriate, enter information on the Failure tab.
7. Click OK.

Ivara EXP creates the work order or request and marks it as Ready
to Send to CMMS (if selected). The work document is sent to Oracle
eAM the next time the CMMS Outbound Processing action is run.
To Undo an Alarm Acknowledgement

1. Open the work order task or work request that was created to
acknowledge the alarm.
2. Select the Planning view, CMMS tab. Ensure that the integration
status is Ready to Send and that Waiting for outbound process-
ing is selected.
Note: If the work order or work request has already been sent to
Oracle eAM, the document must be cancelled in Oracle eAM. The
acknowledgement cannot be undone.
3. Click the Tools menu, CMMS, and then Unmark as Ready to
Send. Close the work document window.
4. Locate the indicator that has the acknowledged alarm in the sites or
assets Indicator Panel view.
5. Right-click the indicator and select Undo Acknowledgement. The

Undo Acknowledgement dialog appears.
6. The work document is displayed on the dialog. To cancel the work

document, select the cancellation option and then select a reason
from the list.
7. Click OK. Ivara EXP does the following:

If the indicator was acknowledged using a work order or a work

request and the work order or request is still open, Ivara EXP
checks if the work order or work request acknowledges any other
indicators. If this is the case, Ivara EXP removes the indicator
reading from the list of readings that the work document acknowl-
edges. If the work document does not acknowledge any other indi-
cator readings, Ivara EXP cancels the work document.
The status of the most recent reading is set back to Waiting for
acknowledgement.
The acknowledgement information associated with the reading is
removed.
The alarm or warning that was originally raised on the indicator
is turned on.
If a failure record was created when acknowledging the alarm, the
failure record is deleted.
When you acknowledge an Ivara EXP indicator alarm by creating a work
order or work request, you can mark the document as Ready to Send at
the same time.

Viewing CMMS Information for the Enterprise

The Integration view on the enterprise allows you to view the status of
all integration events.
2. Select the Events view. The Integration events configuration lists all
integration events. For example:
For information about using this view to troubleshoot integration activi-

ties, see Testing the Integration Setup on page 101.

Turning Off the Integration

In the future, you might wish to turn off or deactivate the integration to
your CMMS. Before turning the integration off, make sure that the
CMMS Inbound Processing action has been run (either through the
Action Scheduler or manually) for each of your sites. This ensures that
the Ivara EXP work orders are up to date and prevents you from having
to manually close the work orders.
The CMMS information attached to your assets and work order tasks is
not deleted. Although it is no longer required, the information is retained
in case the integration is turned back on.
To Turn Off CMMS Integration

1. In Ivara EXP, open the Enterprise window.
2. From the Administration menu, select Integration Settings. The

Integration Settings dialog appears.
3. On the General tab, clear the option Ivaras CMMS integration is
active and click Close.


Chapter 4 Customizing the Integration
This section explains how to add properties and objects to the integra-
tion.
Contents
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Adding Properties to Existing Interface Classes . . . . . . . . . . . . . . . . . 158
Adding Integration Objects Using New Interface Classes . . . . . . . . . . 165

Introduction
You can add new attributes and relationships to existing integration
classes. You can also create interface classes to add application objects to
the integration.
Interface Classes
An interface class defines which data members (attributes and relation-
ships) to upload or download for an object (such as a work order). For
example, the CloseIvara EXPWorkOrderTask interface class indicates
that the Ivara EXP work order task should be closed when the appropri-
ate status change is sent from Oracle eAM.
The interface classes generate the XML code that allows the data to be
transferred between Ivara EXP and Oracle eAM. Interface classes can be
used to send data to Oracle eAM (outbound) or return data from Oracle
eAM (inbound). Ivara EXP comes with a default package of interface
classes for copying data to Oracle eAM.
Adding Properties to Existing Interface Classes

If you wish to add attributes or relationships to an existing interface
class, create a custom copy of it to replace the original class. The new cus-
tom class inherits attributes from the source class.
Note: If you wish to remove properties from an existing interface

class or to create a new class that is based on an existing class but
without inherited properties, copy the original class and modify it.
Here is an overview of the steps involved in creating a custom version of

an interface class:
1. Create a custom class based on the existing Ivara EXP interface class
and add the properties. See Creating a Custom Interface Class on
page 159.
2. Associate an existing transform with the interface class and add the
new properties to the transform. See Modifying a Transform for an
Interface Class on page 163.
3. Update the appropriate integration objects on the Oracle eAM side.

Creating a Custom Interface Class

Create a custom version of an interface class when you wish to add an
attribute or relationship to an existing interface class. The new custom
class inherits properties from the original, to which you can add proper-
ties.
This topic explains how to create a custom class and add attributes and
relationships to it.
Note: To create or modify interface classes, you must be logged in

with an administrator license key.
To Create a Custom Interface Class

1. From the Enterprise window, select the Customization Center
view.
2. Select the Interfaces tab, Interface Classes tab. Select All inter-
face classes from the configuration list.
Tip: In the Search box, type letters to identify the CMMS and
press Enter to filter the table.
3. Right-click the class and click Customize. The Interface class win-
dow appears.

The new class is automatically given the same name as the original
class followed by _Custom. This naming convention is also used for
all properties you add to the class.
4. Add the interface class to the Oracle eAM integration package. Click
Browse, select the Oracle eAM package, and click OK.
5. Select the Properties tab.
6. In the New list, click Reference. The Properties dialog appears.

7. Enter the settings for the property:
Reference type If you are adding an attribute, select Attribute.

This is the default setting.
If you are adding a relationship, select Rela-

tionship. Select this option to add a single-ref-
erence relationship (references-one, owned by,
scoped-by, or hierarchical parent).
Join path The relationship (join path) is used to navigate

to the class and attribute or relationship to be
included as a property. If you are selecting an
attribute from the base class, leave this box
blank.
To select a join path, click . Expand the hier-

archy until you see the class that you want,
select it, and click OK. You can select any sin-
gle-reference relationship (that is, references-
one, owned by, scoped-by, hierarchical parent).

Reference type This box is only available if you selected Rela-

tionship.
Select the type of reference to use for the object

at the end of the relationship. For example, if
you are entering the WorkRequest.Asset-
ToWorkOn relationship as a property and you
select Base class user key as the reference
type, the property will contain the Asset number
of the work requests asset.
Base class user key: A unique name or

number used to identify each instance of an
object in the base class. Some user keys can
be edited by Ivara EXP users. For example,
the user key for an asset is the asset number.
Object ID: A unique object identification
number that is assigned and managed by
Ivara EXP.
Universal ID: A unique identification num-
ber generated by the system.
Application attri- This box is only available if you selected Attri-

bute bute to add an attribute to the class.
Select the name of the attribute that you want to

include. Only attributes owned by the base class
or by a selected related class are available.
You must ensure that the data type of the

selected attribute matches the data type of the
attribute to which you are matching it.
Property name The system automatically suggests a property

name based on the column name of the selected
attribute or relationship. If necessary, you can
edit it.
User key Select this option if this property is a user key

for the interface class. If multiple user keys are
added, you can set the order by editing the
sequence number.

Snapshot type Select whether you want the property to include

the net change in the attribute or the current
value of the attribute. This option is relevant for
numeric attributes (such as Base currency
amount, Currency amount, Duration, or Quan-
tity) and Ref-Many relationships.
If you are adding a Ref-Many relationship refer-

ence, you can select net change to output what
was deleted and what was added to the Ref-
Many relationship during the transaction.
8. Click OK.
9. Repeat steps 6 to 8 for each application attribute or relationship that

you need to add.
10. Save and close the interface class.
Modifying a Transform for an Interface Class

When you have created a custom interface class to add properties to the
existing integration, you can associate an existing transform with the
class, export the content, and add the new properties.
To Modify a Transform for an Interface Class

1. Open the custom interface class.
3. Select the Transforms tab.
4. Click Browse, select the XSLT file in the Selector dialog, and click
OK. The transform is added to the tab.
5. To modify the transform, double-click it. The Interface Transform dia-

log appears. For example:

6. You can copy the contents of the file by clicking Copy to notepad.
Microsoft Notepad opens.
7. When you are finished, close the interface class.

Adding Integration Objects Using New Interface Classes

Add an object to the integration when you wish to:
Integrate objects for classes not included in the shipped integration

package
Integrate objects for your own custom classes
Here are the general steps involved in adding a new object to the integra-
tion:
1. Create the class in Ivara EXP (if necessary).
2. Create an interface class in Ivara EXP, add the custom attributes and
relationships as properties, and add the class to the Oracle eAM inte-
gration package. See Creating an Interface Class on page 165.
3. Generate the XML schema. See Generating an XML Document on

page 168.
4. Create an XSLT transform that maps the Ivara EXP properties to the
Oracle eAM properties using an external application. Then add the
transform to the Oracle eAM integration package. See Adding a
Transform to the Integration Package on page 170.
5. Create an integration class mapping in the external system. See

Adding Class Mappings to the Ivara EXP External System on page
171.
6. Make the appropriate changes on the Oracle eAM side.
Creating an Interface Class

This section explains how to create an interface class in Ivara EXP, add
the custom attributes and relationships as properties, and add the class
to the Oracle eAM integration package.
Note: To create interface classes, you must be logged in with an

administrator license key.
To Create an Interface Class

1. From the Enterprise window, select the Customization Center
view.
2. Select the Interfaces tab, Interface Classes tab.
3. Click New. A Interface Class window appears.

4. Enter a name for the class (for example, CMMSWorkRequestOut-

Custom).
5. From the Class list, select the class on which the interface class will
be based (for example, the Work Request class).
6. Select the class Type and Reference type:

Type Select whether the interface class is inbound,

outbound, or both:
Inbound: The class is used for data coming

into Ivara EXP (that is, data sent from the
CMMS).
Outbound: The class is used for data being
transferred from Ivara EXP to the CMMS.
Both: The class is used for both inbound and
outbound messages.
Note: Note the different definitions of

inbound and outbound for Ivara EXP
and the CMMS. To create matching
classes, you would need an outbound
class on Ivara EXP and an inbound
class on the integrated system. Or, use
the both setting for each class.
Reference type The type of reference to be used for the interface

class. For custom interface classes, you will typi-
cally use the Universal ID option.
Base class user key: A unique name or

number used to identify each instance of an
object in the base class. Some object user
keys can be edited by Ivara EXP users. For
example, the user key for an asset is the
Asset number.
Object ID: A unique object identification
number used to identify an instance of an
object in the base class, assigned and man-
aged by Ivara EXP.
Interface class user key: A unique name
or a number used to identify each instance of
the interface class. You can select one or
more of the interface class properties to be
the user key.
Universal ID: A unique identification num-
ber generated by the system.
None

7. Add the class to the Oracle eAM interface package. Click Browse,
select the package, and click OK.
8. Select the Properties tab. On this tab, you can add your custom
attributes and relationships by adding Reference properties.
9. To add an attribute or relationship, in the New list, click Reference.

The Properties dialog appears.
10. Enter the settings for the property. The settings required depend on
the type of property that you are creating. For more information, see
Creating a Custom Interface Class on page 159.
11. Click OK.
12. Repeat steps 9 to 11 for each property that you need to add.
13. Save and close the interface class.
Generating an XML Document

Generate a schema document when you wish to create or test a trans-
form. This tool also allows you to generate non-transformed or trans-
formed XML.

Note: When you generate an XML document from a custom inter-

face class, new properties are added to the end of the document.
Consequently, new properties are processed after properties
inherited from the source class. You might wish to review the pro-
cessing order of properties in the document.
To Generate an XML Document

1. Open the interface class you wish to generate the document for.
2. In the Tools menu, click Generate XML Document. The Generate

XML Document dialog appears.
3. Select the generation option:
Non transformed XML - the document is not transformed for

Oracle eAM during the generation process. The resulting file con-
tains native XML content, and can be used as a sample document
for creating a transform.
Schema document - the document conforms to standard schema
requirements for use in an external transform application, such as
Altova MapForce. If you are creating a new transform, select this
option.
Transformed XML - the resulting document contains data that
has been transformed for Oracle eAM. You can use this option to
test a transform.
Note: By default, the file is saved to the Users\Username\Docu-

ments folder (Windows 7) or My Documents folder (Windows XP)
on your computer. The file name is the interface class name with
the extension XML or XSD (schema document). If you choose the
Transformed XML option, Transformed is added to the file-
name.

4. To include data from a base class object, select the option and then
enter the base class object ID. This option is not available for a
schema document.
5. Click OK. The document is generated and saved to the target loca-
tion.
Adding a Transform to the Integration Package

When you have created a transform using an external transform applica-
tion, you can add it to the Oracle eAM integration package and associate
it with the appropriate interface class. You can also copy the transform to
Notepad.
To Add a Transform to the Integration Package

1. Open an interface class that is included in the package. On the Gen-
eral tab, double-click the Oracle eAM package in the Packages
table. The Interface Package window appears.
2. Select the Transforms tab.
3. Click New. The Interface Transform dialog appears.
4. Enter the name of the transform.
5. Select the storage type: internal (stored in the database) or external

(stored in a separate file).

6. For an external transform, click to locate and select the XSLT file
that you created with the transform application.
7. For an internal transform, copy the content to the XSLT Transform

box.
You can copy the contents of the file by clicking Copy to notepad.
Microsoft Notepad opens. Save and close the file.
8. Select whether the transform is for inbound messages, outbound mes-
sages, or both.
9. Select the Interface Classes tab.
10. Click Browse to associate the transform with the appropriate inter-
face class.
11. When you are finished, save and close the transform.
12. Close the Interface Package window.
Adding Class Mappings to the Ivara EXP External System

Whenever you create an interface class to add an object to the integra-
tion, you must then map the new class to the Oracle eAM integration
interface in the Ivara EXP external system.
Open the Ivara EXP external system to map the Ivara EXP integration
classes to Oracle eAM interfaces.
1. On the computer hosting the server installation of Ivara EXP, log on

to Ivara EXP using an administrator license key.
2. On the Enterprise window, select the Integrations view, External

Systems tab.
3. Open the external system for Oracle eAM. The External System win-
dow appears.
4. Select the Inbound or Outbound tab and then the Classes tab.
5. Click New. The Class Mapping dialog appears. Here is an example

for an outbound class:

6. Enter the following settings:
Interface Class The name of the Ivara EXP interface class.
External interface The name of the Oracle eAM integration inter-

source face.
Processing Class mappings have sequence numbers that

sequence determine the order in which they are pro-
cessed. You can enter a sequence number, if you
wish.
7. Click OK.

Consequence Priority Numbers 11
Index Information Flow 21
Updating on Assets 125
Consequence Priority Numbers, Mapping to
Criticality Codes 91
A
Criticality Codes 11
Action Scheduler 16
Process Inbound Messages Action 114
Process Outbound Messages Action 114 D
Setting Up Actions 114 Default Completion Status, Work Orders 99
User Name for Action Scheduler 45 Departments, Mapping to Maintenance
Activities 10 Groups 88
Properties Synchronized 26 Documentation, Related 9
Asset Groups 10
Identifying on Asset Types 91 E
Asset Hierarchies 10 Event Instructions, Modifying 111
Information Flow 22 External Systems 71
Setting Synchronization Options 76 Adding Class Mappings 171
Showing Assets 122 Creating in Ivara EXP 71
Synchronization Options 22
Asset Numbers 10 G
Asset Priority Analysis 11 Generating CMMS Integration Information
Asset Statuses, Mapping 87 82
Asset Types, Mapping 89
Assets 10 I
Asset Classification 19 In 19
Changing CMMS Information 124 Indicator Alarms
Consequence Priority Information Flow Undoing Acknowledgements 150, 152
21 Indicator Alarms, Acknowledging 150
Deleting 125 Indicators 12
Importing into Ivara EXP 122 Installation Prerequisites 42
Information Flow 20 Integration Event Dialogs
Modifying in Ivara EXP 124 Viewing During Testing 105
Modifying in Oracle eAM 123 Integration Events
Properties Synchronized 20 Viewing 40, 154
Viewing Integration Status 126 Viewing During Testing 104
Viewing Messages During Testing 108
B Integration Events Tabs 82
Base Intervals 11 Integration Information, Viewing for Enter-
prise 40
C Integration Messages 108
Chunk Size for Inbound Messages 43 Integration Process, Overview 16
Classes, for CMMS Integration 115, 116 Integration, Turning Off 155
CMMS 11 Integrations View 104
CMMS Integration, Activating 75 Interface Classes 158
CMMS Tabs 82 Creating 165
Creating Custom 159

Index
J Security Profiles, Restricting Access to Inte-

Job Templates 27 gration Actions 115
Jobs, Standard 12 Setting Up Integration in Ivara, Overview 70
Setting Up the Integration 46
M Generating CMMS Information 82
Maintenance Groups Mapping Settings 87
Mapping to Departments 92 Overview 46
Maintenance Groups, Mapping to Depart- Scheduling Actions 114
ments 88 Securing Integration Objects 115
Mapping Testing 101
Asset Types 89 Turning on CMMS Integration 75
Consequence Criticality Codes 91 Type of CMMS 75
Maintenance Groups 92 Site Names, Mapping 93
Site Names 93 Software Requirements 42
Work Priorities 94 Standard Jobs 12
Work Statuses 95 Changing CMMS Information 137
Work Types 97 Check that Tasks Sent 78
Deleting 137
O Exporting to Oracle eAM 135
Oracle Client Components 42 Information Flow 27, 28
Oracle E-Business Suite 42 Integration Settings 78
Modifying in Ivara EXP 136
Properties Synchronized 29
P
Resending 136
PM Schedule Options
Viewing CMMS Information 138
Multiple Rules Date 98
Standard Tasks 12
Next Service 98
Changing CMMS Information 131
Schedule Type 98
Deleting 131
Set Name 98
Exporting to Oracle eAM 129
Use 98
Information Flow 23
PM Schedules 12, 29
Modifying in Ivara EXP 130
Default Options on Work Types 97
Deleting 137
Resending to Oracle eAM 130
Viewing CMMS Information 132
Priorities, Mapping 94
Process Inbound Messages
Manually 102, 104 T
Scheduled Action 114 Tasks, Standard 12
Process Outbound Messages Testing Integration Setup 101
Manually 102, 104 Thick-client, for Manual Processes 43
Scheduled Action 114 Transforms 170
Adding to Integration 170
Modifying 163
R
Troubleshooting Event Errors 110
Regenerating CMMS Integration Informa-
Type of CMMS, Specifying 75
tion 83, 86
W
S
Work Identification Analysis 12
Scheduling Integration Actions 114
Work Order Integration Level 76

Index
Work Order Priorities, Mapping to Work Pri-

orities 88
Work Order Statuses, Mapping with Oracle
eAM 33, 39
Work Order Tasks 13
Creating to Test Integration 102
Securing Access to Close, Cancel, Reopen
Actions 115
Viewing Integration Status 102, 143, 147
Work Orders 13
Changing CMMS Information 142, 146
Exporting to Oracle eAM 140, 145
Information Flow 34
Marking Generated WOs as Ready to
Send 134
Setting Default Completion Statuses 99
Status Changes 34
Updating Status 141, 147
Work Priorities, Mapping to Work Order Pri-
orities 94
Work Prorities, Mapping to Work Order Pri-
orities 88
Work Requests 13
Status Changes 31
Work Statuses, Mapping 95
Work Types
Mapping PM Scheduling Options 97
Work Types, Mapping 97
X
XML Documents, Generating 168
XML Packages 159
XSLT Files 163

IvaraEXPIntegration Oracle

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

IvaraEXPIntegration Oracle

Uploaded by

Copyright:

Available Formats

Ivara EXP Integration

Guide for OracleeAM

Information in this document is subject to change without notice.

The software described in this document is provided under license agree-

No part of this document may be reproduced, stored in a retrieval system

Ivara EXP Integration Guide for Oracle eAM

Published February 2012

Document identification code: IV-IO

Document version code: 1.6

2 Ivara EXP Integration Guide for Oracle eAM

2. Setting up the Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Ivara EXP Integration Guide for Oracle eAM 3

Testing the Integration Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

3. Working with the Integration . . . . . . . . . . . . . . . . . . . . . . . . . . 121

4 Ivara EXP Integration Guide for Oracle eAM

Work Orders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

4. Customizing the Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Ivara EXP Integration Guide for Oracle eAM 5

6 Ivara EXP Integration Guide for Oracle eAM

Ivara EXP Integration Guide for Oracle eAM 7

About This Guide

This guide contains the following sections:

1. Integration Overview on page 15

This chapter explains how to add new properties or objects to the

8 Ivara EXP Integration Guide for Oracle eAM

See this document ... For information on ... Where to find it

Ivara EXP Integration Guide for Oracle eAM 9

Ivara EXP standard tasks are sent to Oracle eAM,

In Ivara EXP, you can also create asset records for

10 Ivara EXP Integration Guide for Oracle eAM

Also see Consequence priority number.

When the priority analysis is complete, analysis

When Oracle eAM and Ivara EXP are synchronized,

Ivara EXP Integration Guide for Oracle eAM 11

In Ivara EXP, PM schedules are synchronized with

In Oracle eAM, Ivara EXP standard jobs are syn-

In Oracle eAM, Ivara EXP standard tasks are syn-

Reliability Centered Maintenance (RCM2)

12 Ivara EXP Integration Guide for Oracle eAM

When the integration is active, an Oracle eAM work

Ivara EXP Integration Guide for Oracle eAM 13

14 Ivara EXP Integration Guide for Oracle eAM

Using the Computerized Maintenance Management System (CMMS)

Note: The CMMS Integration functionality does not work with

This chapter provides an overview of the integration framework, the

Ivara EXP Integration Guide for Oracle eAM 15

The following diagram shows how data is moved between systems.

16 Ivara EXP Integration Guide for Oracle eAM

The following diagram shows what happens when a work order is

Once the work order is created in Oracle eAM, it is planned, scheduled,

Ivara EXP Integration Guide for Oracle eAM 17

18 Ivara EXP Integration Guide for Oracle eAM

Ivara EXP-Oracle eAM Integration Objects

Asset properties that are synchronized to an Oracle eAM asset property

When an asset is disassociated from its parent in Oracle eAM, the

Ivara EXP Integration Guide for Oracle eAM 19

If an asset is deleted in Oracle eAM, and you wish to delete the

The following diagram shows the flow of asset information between

Asset Properties that are Synchronized

Ivara EXP Asset Oracle eAM Asset Notes

20 Ivara EXP Integration Guide for Oracle eAM

Ivara EXP Asset Oracle eAM Asset Notes

Asset Consequence Priority

The following property is updated in Oracle eAM when an asset conse-