Escolar Documentos
Profissional Documentos
Cultura Documentos
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.
Ivara Corporation
5046 Mainway
Burlington, Ontario
Canada. L7L 5Z1
Tel: 905-632-8000
Fax: 905-632-5129
www.ivara.com
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
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
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
Related Documentation
See the following documents for more information about installing Ivara,
using its work management functions, and troubleshooting integration
errors.
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.
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.
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.
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.
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.
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.
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 the asset hierarchy is built in Ivara EXP, the Oracle eAM assets
parent asset is used in the hierarchy.
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.
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:
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.
When only new assets are synchronized, the asset hierarchy is updated
in Ivara EXP only when the asset is added in Oracle eAM.
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:
Manual Synchronization
For standard task 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
Maintenance group Maintenance group Department
Work priority Work priority Work Order Priority
Site Site Site
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.
Job templates are not integrated with Oracle eAM, but they can still be
used in Ivara EXP to create standard jobs.
Information Flow
The following diagrams show the flow of standard job/PM schedule infor-
mation between Ivara EXP and Oracle eAM:
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.
Manual Synchronization
For standard job 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
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.
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:
Manual Synchronization
For work request synchronization, the following Ivara EXP property
must be manually mapped to the Oracle eAM property.
Ivara EXP Property Ivara EXP Value List Oracle eAM Value List
Work priority Work priority Work Order Priority
The following table shows the standard statuses that are automatically
mapped between Oracle eAM and Ivara EXP.
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.
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.
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.
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
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.
Manual Synchronization
For work order 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
Work type Work type Work Order Type
Maintenance group Maintenance group Department
Work priority Work priority Work Order Priority
The following table shows the standard statuses that are automatically
mapped between Oracle eAM and Ivara EXP.
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.
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.
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
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 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.
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.
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.
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
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 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:
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 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.
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.
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.
<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;
<IvaraInstallDirectory>\bin\Integration\Oracle eAM\Deploy-
ment\xxivara_org_id_filter.tbl
2. Open the file with an editor of your choice. Here is an excerpt from
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;
<IvaraInstallDirectory>\bin\Integration\Oracle eAM\Deploy-
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;
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.
<IvaraInstallDirectory>\bin\Integration\Oracle eAM\Deploy-
ment\xxivara_error_control.tbl
2. Open the file with an editor of your choice. Here is an excerpt from
the table:
DROP TABLE xxivara_error_control
/
CREATE TABLE xxivara_error_control
(interface VARCHAR2(30)
,enabled_flag VARCHAR2(1)
,severity NUMBER)
TABLESPACE ivara;
<IvaraInstallDirectory>\bin\Integration\Oracle eAM\Deploy-
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;
5. Run the script on the Oracle eAM database using SQL Plus.
1. Run the script on the Oracle eAM database using SQL Plus.
2. When prompted, enter and confirm the following:
Activity
Asset
PM schedule
Work order
Work request
Activity Export
1. Navigate to Concurrent:Program:Executable and enter data, as
shown:
Asset Export
1. Navigate to Concurrent:Program:Executable and enter data, as
shown:
PM Schedule Export
1. Navigate to Concurrent:Program:Executable and enter data, as
shown.
4. This work order export report is now available by logging on using the
Enterprise Asset Management responsibility, navigating to Reports,
and selecting Ivara Work Order Export:
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
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
2. Select the External Systems tab and click New. The New External
System dialog appears.
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.
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.
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.
Note: If you are integrating with version 11.5, the system version
shown in Integration Settings should be Oracle eAM 12.0.
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.
Next, you can select options for handling standard tasks and jobs.
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.
Standard job num- Use these options to control how standard job
bers numbers are constructed. Choose from:
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.
Standard task num- Use these options to control how standard task
bers numbers are constructed. Choose from:
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.
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.
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.
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.
6. Select the work types for which you want to activate integration.
2. Select the Asset Statuses tab. This tab shows a list of the current
asset statuses.
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.
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.
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.
7. Click OK.
3. Select the Consequence Priorities tab. This tab lists all of your
Ivara EXP consequence priorities.
3. On the General tab, enter the code for the matching Oracle eAM
Organization ID in the Site name box.
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.
3. Select the Priorities tab. Double-click a priority to open it. The Work
Priority dialog appears. Click Edit.
5. Click OK.
Repeat this procedure for the other work priorities.
3. On the General tab, you will see the Work status mapping table.
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.
2. On the Work Management tab, select the Work Types tab. This
tab lists all of the Ivara EXP work types.
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.
Set name The value entered here must exactly match the
corresponding set name in Oracle eAM.
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:
7. Click OK.
4. Click Save.
Ivara EXP provides tools to help you test the connection and your inte-
gration information. You can:
2. Check the XML directory to ensure that the XML files were gener-
ated.
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.
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:
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.
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.
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:
Event tab
Instruction tab
The Instruction tab displays the XML instructions used to send the
message between the two systems.
Details tab
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.
Message obtained
Processed successfully
Warning
Information
Error
Error - retried
Error - manually resolved
<IvaraInstallDirectory>\Docs\English\Integration_Guides
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.
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>
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.
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.
The following table shows some of the classes and their elements that are
related to CMMS 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.
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.
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.
9. On the View menu, click Refresh. The asset and its children now
appear in the hierarchy.
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.
5. From the Tools menu, select CMMS Information and then Disal-
low Changes. The synchronized properties are re-locked.
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.
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.
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.
5. Select the Integration Events tab. This tab lists all of the integra-
tion events, their directions, messages, and statuses.
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.
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.
2. From the Tools menu, select CMMS and then Unmark as Ready to
Send. A confirmation message appears.
4. When you have finished making changes you can again mark the task
as Ready to Send.
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.
2. From the Tools menu, select CMMS and then Allow Changes. A
confirmation message appears. Click Yes.
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.
2. On the Tasks tab, right-click the task that you want to delete and
select Delete. A confirmation message appears.
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.
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.
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: 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.
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.
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.
2. From the Tools menu, select CMMS and then Unmark as Ready to
Send. A confirmation message appears.
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.
2. From the Tools menu, select CMMS and then Allow Changes. A
warning message appears. Click Yes. The jobs properties can now be
edited.
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.
2. On the Jobs tab, right-click the job that you want to delete and click
Delete. A confirmation message appears.
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.
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.
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.
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.
2. From the Tools menu, select CMMS and then Unmark as Ready to
Send. A confirmation message appears.
4. When you have finished making changes, you can again mark the
work request as Ready to Send.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
1. Select the Work Management view, the Work Orders tab, and the
Tasks tab.
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.
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.
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:
4. To send the work order directly to Oracle eAM, select the option
Mark work document as ready to send to CMMS.
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.
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.
2. Select the Events view. The Integration events configuration lists all
integration events. For example:
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.
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.
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.
This topic explains how to create a custom class and add attributes and
relationships to it.
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.
8. Click OK.
4. Click Browse, select the XSLT file in the Selector dialog, and click
OK. The transform is added to the tab.
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.
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.
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. 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:
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.
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.
12. Repeat steps 9 to 11 for each property that you need to add.
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.
6. For an external transform, click to locate and select the XSLT file
that you created with the transform application.
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.
10. Click Browse to associate the transform with the appropriate inter-
face class.
11. When you are finished, save and close the transform.
Open the Ivara EXP external system to map the Ivara EXP integration
classes to Oracle eAM interfaces.
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.
X
XML Documents, Generating 168
XML Packages 159
XSLT Files 163