asset and work management - functional...

Asset and Work Management - FunctionalOverview

Asset and Work Management - FunctionalOverview

ContentsAsset and Work Management - Functional Overview 3

Commercial In Confidence 5

Introduction 6

Purpose 6

Executive Summary 6

Business Benefits 6

Scope 6

Baselines 7

Functional Scope 7

Business Rules / Design Decisions 7

Transformation and Data Enrichment 7

Data Mapping 7

Standard Job 7

Maintenance Schedule Task (MST) 7

Job Estimate 7

Project 8

Project Scheduling 8

Interface Details 9

Process Overview 9

Equipment 9

Work Request 9

Work Order 9

Standard Job 10

Maintenance Schedule Task (MST) 10

Job Estimate 10

Project 10

Project Schedule 10

Labour Costs 12

Ellipse Configuration 13

Equipment Register 13

Ellipse Events 13

EIP Configuration 13

Work Requests 14

Work Orders 15

Ellipse Events 16


Standard Jobs 17

Ellipse Events 18


Equipment Planned Maintenance 19

Ellipse Events 20


Job Estimate 21

Ellipse Events 22


Project 23

Ellipse Events 24


Project Schedule 25

Labour Costing 25

FAQs 27

Appendix 28

Ellipse Events Configuration 28

Commercial In ConfidenceCopyright 2016 ABB

All Rights Reserved

Confidential and Proprietary

Legal Disclaimer

The product described in this documentation may be connected to, and/or communicate information and data via, a networkinterface, which should be connected to a secure network. It is your sole responsibility to ensure a secure connection to thenetwork and to establish and maintain appropriate measures (such as but not limited to the installation of firewalls, applicationof authentication measures, encryption of data, installation of antivirus programs, etc.) to protect the product, the network,your systems, and the interface against any kind of security breach, unauthorised access, interference, intrusion, leakage,damage, or corruption or theft of data. We are not liable for damages or losses related to any such security breach,unauthorised access, interference, intrusion, leakage, damage, or corruption or theft of data.

Introduction

PurposeThe purpose of this document is to explain the business intent of the standard Asset and Work Management integrationsolution, including how to configure and use the new functionality. There is no "user interaction" within the integration solution,business processing will occur in Ellipse and the external system(s) as per standard processing. Where required the informationwill be shared between Ellipse and the external system(s) automatically. Business analysts/consultants will need to understandthe functionality of the Asset and Work Management integration solution integration in order to instruct the technical resourcesas to how to implement and configure this integration.

Executive SummaryMaximum asset use is critical to the business success of asset-intensive organisations. Ellipse provides comprehensive assetmanagement tools to monitor asset status and performance, to receive key condition measurements, and to recommend themost appropriate maintenance strategies. The main asset management tool in Ellipse is the equipment register. Built-inequipment configuration management, classification, and costing capabilities in the equipment register afford considerableopportunities for maintenance managers to proactively administer the assets under their control. The Asset and WorkManagement integration solution provides an Equipment adapter to process the sharing of asset information to and fromEllipse.

The Operations and Maintenance stream of Ellipse is designed to maximise the productivity and life cycle of capital equipmentand minimise downtime. The stream supports the timely scheduling of preventative maintenance activities, including resourcesand parts, while enabling support for corrective maintenance tasks. It manages the entire life cycle of a capital equipment itemfrom purchase through to disposal. The Asset and Work Management integration solution provides adapters to process thesharing of operations and maintenance information to and from Ellipse.

The standard Asset and Work Management integration solution provides a means of integrating Ellipse with third party systemsfor the purpose of:

• Project Planning

• Work Scheduling

• Work and Asset LocationThe following Ellipse data entities are available for integration through the standard Ellipse Asset and Work Managementintegration solution:

• Equipment

• Work Request

• Work Order

• Standard Job

• Equipment Planned Maintenance

• Job Estimate

• Project

• Project Schedule

• Labour Costs

Business BenefitsThe key business benefits of this integration solution include:

1. Standardised Ellipse integration software will provide a lower cost and a higher quality solution to meet Operations andMaintenance business process requirements.

2. Centralisation of asset information in Ellipse will allow utilisation in day-to-day asset management business processingand further detailed analysis for predictive asset management.

3. Automation of the loading of operations and maintenance data between Ellipse and external systems will eliminatepotential transposition errors from the process.

4. Automation of the loading of operations and maintenance data between Ellipse and external systems will allow for fasterreaction times when processing maintenance activities in an operating environment.

5. Economical implementation of best-of-breed solutions integrated with Ellipse to meet specific business processingrequirements.

ScopeThe Ellipse portion of the interface is contained within the Ellipse Integration Platform (EIP). There will be additional third partysoftware required to integrate between the external system and EIP to complete the end-to-end integration solution withEllipse. The scope of the Asset and Work Management integration solution is detailed below:

BaselinesEllipse 8.5 onwards. This item is not suitable for back fit to prior versions of Ellipse 8.

Functional ScopeThe functional scope of the Ellipse side of the integration solution encompasses the following:

1. Access to asset information for the purpose of either providing updates to this in Ellipse or receiving this information fromEllipse.

2. Update of Work Requests in Ellipse for the identification of potential work that will be used in the maintenance planningprocesses. This allows users to create a work request that records the who, what, and where of any work requested byboth internal and external users.

3. Access to work order information for the purpose of either providing updates to this in Ellipse or receiving this informationfrom Ellipse. A Work Order defines individual jobs or small groups of jobs from an operational and maintenanceperspective, these then can be accessed by internal and external users.

4. Access to standard job information for the purpose of receiving this information from Ellipse only. A standard job is thework templating tool in Ellipse that provides maintenance personnel with the ability to set up simple or complex jobtemplates. Once a standard job has been created, it can be used and re-used to create work orders as often as necessary.

5. Access to maintenance schedule task information for the purpose of receiving this information from Ellipse only. Amaintenance schedule task is a template for regularly performed tasks, such as scheduled services for groupedequipment and / or their components.

6. Access to job estimate information for the purpose of receiving this information from Ellipse only. A job estimate is usedto estimate the work and associated costs required to complete a job. A job can range in complexity from a capital worksconstruction project to a routine maintenance job.

7. Access to project information for the purpose of either providing updates to this in Ellipse or receiving this informationfrom Ellipse. A project allows you to control construction and other projects as either capital or operating cost projects.Ellipse supports the project manager in controlling the physical execution of the work in addition to recording costs andbudgets.

8. Access to project schedule information for the purpose of either providing updates to this in Ellipse or receiving thisinformation from Ellipse. The project schedule information is the planning information maintained for Job Estimates,Projects, Work Orders and Tasks. To simplify the complexity of an external system integrating with Ellipse for projectscheduling, a single adapter provides access to the majority of the work.

9. Update of Labour Costs in Ellipse for work executed by allowing employees' hours to be allocated to work activities on adaily basis. Ellipse calculates the cost of the work together with any oncosts (if applicable) and applies the total hours andcost to the activity, which may be a work order, job, project, item of equipment, general ledger account, or cost centre.

Business Rules / Design Decisions

Transformation and Data EnrichmentIt is assumed that all transformation and enrichment of the data passed from the 3rd party system required for the message tobe processed into Ellipse, will be carried out within EIP. The provision of third party software required to integrate between the3rd party system and EIP will need to be catered for.

Data MappingThe XML messages to be passed to the EIP adapters for SCADA will be required to conform to the relevant OAGIS standard.Refer to the EIP adapter documentation under the Ellipse Knowledge Repository for the specific details of the messagesrequired for each EIP adapter.

Standard JobStandard Job information is provided from Ellipse as an aid to the creation of Work Orders from an external system only.Therefore no access to update Standard Jobs in Ellipse is provided.

Maintenance Schedule Task (MST)Maintenance Schedule Task information is provided from Ellipse as an aid to understanding the maintenance regime for anasset. This is defined by maintenance planners in Ellipse based on manufacturers recommendations, breakdown historyanalysis, statistics and condition monitoring information, availability and criticality requirements and resource availability.Therefore no access to update Maintenance Schedule Tasks in Ellipse is provided.

Job EstimateJob Estimate information is provided from Ellipse as an aid to understanding the design and costs of a work project. There isupdate capability to Job Estimates in relation to scheduling catered for by the Project Schedule adapter.

ProjectThe Project information available for access by an external system is limited to the control information only. The amount ofreference data required from Ellipse to an external system to support additional data updates is prohibitive.

Project SchedulingWhere Project Scheduling information is provided to an external system, the external system will be required to store theidentifiers of the Ellipse data entities included in this information in order to have updates to these entities by the externalsystem be successfully processed in Ellipse.

Interface Details

Asset and Work Management Interface Schematic

Process Overview

EquipmentThe Equipment register in Ellipse identifies all maintainable assets as unique items in an equipment database. The Equipmentregister's essential role is to be the main database of information about the equipment that the client owns, operates, andmaintains. As the maintenance and operation of equipment is fundamental to many Ellipse applications, the equipment registeris a crucial element of the total system. Ellipse is expected to master the Equipment data and provide relevant details toexternal systems as required and be updated by external systems as required. The provision of Equipment details is typicallyrequired for mobile solutions and GIS Integration.

Work RequestEllipse is expected to be updated with Work Requests that will identify potential work that needs to be performed. Forcustomer-driven organisations for example, customers can report power outages or request a water meter installation,therefore they will contact a company representative to request the work. That company representative can obtain relevantkey information about the person requesting the work and the nature of work that is required. This information then can beloaded into Ellipse via the Work Request adapter. The Work Request module in Ellipse then is integrated to the Job Estimateand Work Orders modules to feed into the work planning and scheduling process. Typically the next step required to fulfil therequest will be estimating the costs or scheduling the work.

Work OrderThe Work Order module defines individual jobs or small groups of jobs from an operational and maintenance perspective. Thework order provides a means of notifying a person, work group, or crew about an activity. The Ellipse Work Order module alongwith supporting modules that are integrated will record, track, and analyse work that is performed. For each activity therequirements, schedule, progress and estimated and actual costs can be specified. Ellipse is expected to master the WorkOrder data and provide relevant details to external systems as required. In addition updates from external systems areexpected where scheduling is performed outside of Ellipse and where work is executed via a mobile solution.

Standard JobThe standard job is the work templating tool in Ellipse that provides maintenance personnel with the ability to set up simple orcomplex job templates. Once a standard job has been created, it can be used and re-used to create work orders as often asnecessary. Standard jobs can also be updated after consistent job feedback is obtained. Ellipse is expected to master theStandard Job data and provide relevant details to external systems as required. The scenario in which Standard Job data isexpected to be provided from Ellipse is where an external system will be creating Work Orders in Ellipse. The Standard Job willprovide a template for the creation of the Work Order, with the benefits of defaulting the necessary details in Ellipse andutilising a best practice approach to recurring work.

Maintenance Schedule Task (MST)The Maintenance Schedule Tasks module is designed to identify and create templates for regularly performed tasks, such asscheduled services for grouped equipment and / or their components. The module manages both scheduled and ad hoc tasksto schedule work subject to work group resource availability. Ellipse is expected to master the MST data and provide relevantdetails to external systems as required. The scenario in which MST data is expected to be provided from Ellipse is where anexternal system requires the recurring maintenance details for an asset.

Job EstimateThe Job Estimates application is used to estimate the work and associated costs required to complete a job. A job can range incomplexity from a capital works construction project to a routine maintenance job. This allows a comprehensive estimate ofrequirements for work by compiling a list of the tasks, materials, equipment, and resource requirements needed to completethe requested work. Cost can then be manually recorded, or they can be calculated by the system based on set requirements.Ellipse is expected to master the Job Estimate data and provide relevant details to external systems as required. The scenarioin which Job Estimate data is expected to be provided from Ellipse is where an external system requires the design and costsdetails for specific work.

ProjectThe Project Control Module allows you to control construction and other projects as either capital or operating cost projects.Ellipse supports the project manager in controlling the physical execution of the work in addition to recording costs andbudgets. It also supports planning and cost control for large infrequent operating jobs such as major plant shutdowns. Ellipse isexpected to master the Project data and provide relevant details to external systems as required. The scenario in which Projectdata is expected to be provided from Ellipse is where an external system requires the planning and cost controls details forspecific work.

Project ScheduleTo simplify the complexity of an external system integrating with Ellipse for project management, the Project Schedule adapterwill be used to perform the majority of the work. The adapter will be used to both extract a project and dependent items andwill also be used to send updates back. This is in contrast to other approaches where each of the distinct Ellipse elements (WO,WO Task, Project, etc) is exposed as individual entities. By combining this into a single adapter and message, the integrationimplementer will be shielded from the Ellipse complexities and will only need to focus on a project schedule and related tasks.To do this, the adapter will internally dispatch to the appropriate services to extract Job Estimate, WO, WO Task, Project detailsand combine them into a single entity. A prerequisite of this adapter is that the external project management application (PMA)will be able to maintain the identifiers of the various data elements exported. For instance, when a WO task is exported, it willcontain an identifier that must be sent back via the integration if the item is to be updated. If no identifier is sent in thesecases, the integration will interpret this as a new item and depending on the type, either create or reject. The adapter isdesigned in such a way as to allow this behaviour to be configured. For the purposes of this integration, only the following willbe allowed to be created:

• Equipment Requirements

• Labour RequirementsAll other entities will only be allowed to be updated.

For the Project Schedule adapter, only the elements outlined below will be allowed to be updated, this will be done via theProcess Method.

• Job Estimate Item

• Planned Start Date/Time

• Planned Finish Dates/Time

• Required Start Date/Time

• Required Finish Date/Time

NoteThe update of the Planned Start/Finish Date of Item Zero will result in the Estimate header Item being automaticallyupdated with the same value which is existing functionality.

Project

• Plan Start Date/Time

• Plan Finish Date/Time

• Schedule Start Date

• Schedule Finish Date

• Target Finish Date

• Actual Start Date

• Actual Finish DateWork Order


• Planned Finish Date/Time

• Actual Start Date/Time

• Actual Finish Date/Time

• Work Order User status

NoteThe normal Update of the Planned Dates of the Work Order is typically indirectly performed by the update of the Dates onthe tasks and the use of the Calc-Est-Duration Flag.

Work Order Task


• Planned Finish Date/Time

• Actual Start Date/Time

• Actual Finish Date/Time

• Work Order Task User StatusEquipment Requirements

• Equipment Type

• Unit of Measure

• Quantity Required

• Unit Quantity RequiredUpdates to Equipment Requirements may be made against a Job Estimate Item (where the Job Estimate is not yet packaged)and against a Work Order Task (where the Job Estimate is packaged).

NoteWhere creating an Equipment Requirement, then a Sequence No (ID value in the message) should NOT be provided. For acreate to be processed, values for each of the above fields should be provided. Where modifying or deleting an EquipmentRequirement, then the specific Sequence No (ID from the Show message) relating to the Requirement MUST be provided.For a modify to be processed, then one of the above fields MUST be provided. For a delete to be processed, then NONE ofthe above fields should be provided.

Resource Requirements

• Unit of Measure

• Quantity Required

• Hours RequiredUpdates to Resource Requirements may be made against a Job Estimate Item (where the Job Estimate is not yet packaged) andagainst a Work Order Task (where the Job Estimate is packaged).

NoteWhere creating a Resource Requirement, then a Resource Class, Resource Type MUST be provided and a Sequence No (IDvalue in the message) should NOT be provided. For a create to be processed, values for each of the above fields should be

provided. Where modifying or deleting an Resource Requirement, then a Resource Class, Resource Type MUST be providedand the specific Sequence No (ID from the Show message) relating to the Requirement MUST be provided. For a modify tobe processed, then one of the above fields MUST be provided. For a delete to be processed, then NONE of the above fieldsshould be provided.

Material RequirementsUpdates to Material Requirements are NOT supported by the Project Schedule adapter. It is understood that updates toMaterial Requirements are NOT part of the business process for Scheduling work.

Labour CostsEllipse is expected to be updated with the details of actual time spent by allocated resources to work executed. The LabourCosts adapter supports update of this data into Ellipse from external systems (for example a mobile system).

Ellipse then calculates the cost of the work together with any on costs (if applicable) and applies the total hours and cost to theactivity, which may be a work order, job, project, item of equipment, general ledger account, or cost centre. As a by-product ofthis process analysis of non-productive time and work group performance is supported and the budgeting process is alsosupported.

Ellipse ConfigurationIn order for the data to be processed to/from Ellipse via the Asset and Work Management adapters, there will be configurationrequired in Ellipse to allow this. The sections below briefly outline the requirements for this configuration.

Equipment RegisterThe Equipment Register is only available if the Equipment Register (3601) module is installed in Ellipse.

Equipment Register Module

Where changes to Equipment information is required to be published from Ellipse for consumption by an external system thenthere is additional configuration required for Ellipse and EIP as below.

Ellipse EventsEllipse Events must be configured to be enabled. To update this refer to the Ellipse 8 Customisation and Personalisation guidein the Ellipse Knowledge Repository. This can be found under a URL structured as follows:

http:///documentation/external/customisation/E8_Cus_Per_chapters/E8_Cus_12_Eventing.html

In the JI Customisation - Eventing section there are some notes on how to configure this for Ellipse, refer to the screen shotunder Appendix > Ellipse Events Configuration.

EIP ConfigurationIn order to consume Ellipse event messages in an external system there are 2 options available:

1. Consume the messages generated from the changes in Ellipse to the database for Equipment directly. This will requirethe relevant tables on which Equipment information is stored to be identified and a durable subscription implemented toconsume these messages from the 'EllipseServices' JMS topic hosted in EIP.

2. Consume the messages generated from EIP for Equipment changes in Ellipse via the EIP Equipment adapter. TheEquipment adapter in EIP can be configured to process Equipment changes in Ellipse. The Equipment adapter will listenfor event messages generated by Equipment changes in Ellipse to the core database tables upon which Equipment datais held. The adapter will process these event messages to provide a message with all core Equipment details output tothe 'MIB.EVENT.REPLY' JMS topic hosted in EIP. This will require EIP to have the 'mib.equipment.eventsenabled' propertyset to 'true'.

http:/

EIP Equipment Events Configuration

NoteBoth of the both options will also require development. The durable subscription can be developed in EIP along withsupporting components to load the required details into the external system. Alternatively the durable subscription can bedeveloped in the customer's integration platform along with the supporting components to load the required details intothe external system.

Work RequestsWork Requests are only available if the Work Requests (3540) module is installed in Ellipse.

Work Requests Module

Work OrdersWork Orders are only available if the Work Orders (3620) module is installed in Ellipse.

Work Orders Module

Where changes to Work Order information is required to be published from Ellipse for consumption by an external system thenthere is additional configuration required for Ellipse and EIP as below.

Ellipse EventsEllipse Events must be configured to be enabled. To update this refer to the Ellipse 8 Customisation and Personalisation guidein the Ellipse Knowledge Repository. This can be found under a URL structured as follows:http:///documentation/external/customisation/E8_Cus_Per_chapters/E8_Cus_12_Eventing.html In the JI Customisation -Eventing section there are some notes on how to configure this for Ellipse, refer to the screen shot under Appendix > EllipseEvents Configuration.


1. Consume the messages generated from the changes in Ellipse to the database for Work Orders directly. This will requirethe relevant tables on which Work Order information is stored to be identified and a durable subscription implemented toconsume these messages from the 'EllipseServices' JMS topic hosted in EIP.

2. Consume the messages generated from EIP for Work Order changes in Ellipse via the EIP Work Order adapter. The WorkOrder adapter in EIP can be configured to process Work Order and Task changes in Ellipse. The Work Order adapter willlisten for event messages generated by Work Order and Task changes in Ellipse to the core database tables upon whichWork Order and Task data is held. The adapter will process these event messages to provide a message with all coreWork Order and Task details output to the 'MIB.EVENT.REPLY' JMS topic hosted in EIP. This will require EIP to have the'mib.workorder.eventsenabled' property set to 'true'.

http:/

EIP Work Order Events Configuration


Standard JobsStandard Jobs are only available if the Standard Jobs (3690) module is installed in Ellipse.

Standard Jobs Module

Where changes to Standard Job information is required to be published from Ellipse for consumption by an external systemthen there is additional configuration required for Ellipse and EIP as below.



1. Consume the messages generated from the changes in Ellipse to the database for Standard Jobs directly. This will requirethe relevant tables on which Standard Job information is stored to be identified and a durable subscription implementedto consume these messages from the 'EllipseServices' JMS topic hosted in EIP.

2. Consume the messages generated from EIP for Standard Job changes in Ellipse via the EIP Standard Job adapter. TheStandard Job adapter in EIP can be configured to process Standard Job and Task changes in Ellipse. The Standard Jobadapter will listen for event messages generated by Standard Job and Task changes in Ellipse to the core database tablesupon which Standard Job and Task data is held. The adapter will process these event messages to provide a messagewith all core Standard Job and Task details output to the 'MIB.EVENT.REPLY' JMS topic hosted in EIP. This will require EIP tohave the 'mib.standardjob.eventsenabled' property set to 'true'.

http:/

EIP Standard Job Events Configuration


Equipment Planned MaintenanceMaintenance Schedule Tasks are only available if the Maintenance Scheduling (3701) module is installed in Ellipse.

Maintenance Scheduling Module

Where changes to Maintenance Schedule Task information is required to be published from Ellipse for consumption by anexternal system then there is additional configuration required for Ellipse and EIP as below.


http:///documentation/external/customisation/E8_Cus_Per_chapters/E8_Cus_12_Eventing.html In the JI Customisation -Eventing section there are some notes on how to configure this for Ellipse, refer to the screen shot under Appendix > EllipseEvents Configuration.


1. Consume the messages generated from the changes in Ellipse to the database for Maintenance Schedule Tasks directly.This will require the relevant table on which Maintenance Schedule Tasks information is stored to be identified and adurable subscription implemented to consume these messages from the 'EllipseServices' JMS topic hosted in EIP.

2. Consume the messages generated from EIP for Maintenance Schedule Tasks changes in Ellipse via the EIP MaintenanceSchedule Tasks adapter. The Maintenance Schedule Tasks adapter in EIP can be configured to process MaintenanceSchedule Tasks changes in Ellipse. The Maintenance Schedule Tasks adapter will listen for event messages generated byMaintenance Schedule Tasks changes in Ellipse to the relevant database table upon which Maintenance Schedule Tasksdata is held. The adapter will process these event messages to provide a message with all Maintenance Schedule Tasksdetails output to the 'MIB.EVENT.REPLY' JMS topic hosted in EIP. This will require EIP to have the'mib.plannedmaintenance.eventsenabled' property set to 'true'.

http:/

EIP Maintenance Schedule Task Events Configuration


Job EstimateJob Estimates are only available if the Job Estimating (3655) module is installed in Ellipse.

Job Estimating Module

Where changes to Job Estimating information is required to be published from Ellipse for consumption by an external systemthen there is additional configuration required for Ellipse and EIP as below.



1. Consume the messages generated from the changes in Ellipse to the database for Job Estimates directly. This will requirethe relevant tables on which Job Estimate information is stored to be identified and a durable subscription implemented toconsume these messages from the 'EllipseServices' JMS topic hosted in EIP.

2. Consume the messages generated from EIP for Job Estimates changes in Ellipse via the EIP Job Estimate adapter. The JobEstimate adapter in EIP can be configured to process Job Estimate changes in Ellipse. The Job Estimate adapter will listenfor event messages generated by Job Estimate changes in Ellipse to the core database tables upon which Job Estimatedata is held. The adapter will process these event messages to provide a message with all Job Estimate details output tothe 'MIB.EVENT.REPLY' JMS topic hosted in EIP. This will require EIP to have the 'mib.jobestimate.eventsenabled' propertyset to 'true'.

http:/

EIP Job Estimate Events Configuration


ProjectProjects are only available if the Project Control (3660) module is installed in Ellipse.

Project Control Module

Where changes to Project information is required to be published from Ellipse for consumption by an external system thenthere is additional configuration required for Ellipse and EIP as below:


http:///documentation/external/customisation/E8_Cus_Per_chapters/E8_Cus_12_Eventing.html In the JI Customisation -Eventing section there are some notes on how to configure this for Ellipse, refer to the screen shot under Appendix > EllipseEvents Configuration.


1. Consume the messages generated from the changes in Ellipse to the database for Projects directly. This will require therelevant tables on which Project information is stored to be identified and a durable subscription implemented toconsume these messages from the 'EllipseServices' JMS topic hosted in EIP.

2. Consume the messages generated from EIP for Project changes in Ellipse via the EIP Project adapter. The Project adapterin EIP can be configured to process Project changes in Ellipse. The Project adapter will listen for event messagesgenerated by Project changes in Ellipse to the core database tables upon which Project data is held. The adapter willprocess these event messages to provide a message with all Project details output to the 'MIB.EVENT.REPLY' JMS topichosted in EIP. This will require EIP to have the 'mib.project.eventsenabled' property set to 'true'.

http:/

EIP Project Events Configuration


Project ScheduleProject Scheduling is only available if the Work Order (3620), Job Estimating (3655) and Project (3660) modules are installed inEllipse. Refer to the configuration for each of those module specified previously for the required Ellipse configuration.

Labour CostingLabour Costing is only available if the Labour Costing (3850) module is installed in Ellipse.

Labour Costing Module

FAQsThe following questions are answered in this FAQ section:

• What is required to obtain an end-to-end integration solution between Ellipse and an external system?

• What options are available if an adapter either doesn't exist for Ellipse or does but does not meet requirements?

• What documentation is available to find out further information on EIP and Ellipse adapters?

• Are adapters that are developed by the customer to integrate to the ERP system have to be built to be run in the EIP?

• Does this support the initial load of data entities into Ellipse?

• Does the EIP support synchronous integration with an external system?Question:

What is required to obtain an end-to-end integration solution between Ellipse and an external system?

Response:The Ellipse side of the integration solution is provided within the EIP that is provided with the Ellipse version installed onsite. Development will then be required to provide the integration to the external system. This development can beundertaken in EIP or in the customer's own integration platform. Where this is to be undertaken in EIP there is an SDK thatcan be downloaded from an EIP instance that provides code examples that will aid in this development. The SDK is in theform of an Eclipse project, so this can be imported into that IDE. The typical set of components required to provideintegration to an external system via EIP is as follows:

Message Router - this will contain the durable subscription to process messages published from Ellipse that are required andwill orchestrate the processing of these by supporting components.

Message Transforms - a message transform will extract the required content from an Ellipse message and package this eitherinto a Java format or an XML format.

Action Class - code that will perform message processing (transforms, defaults, enrichment, etc) and execute the update of therequired details into the external system via the appropriate API. In addition there is an EIP SDK Guide in the Ellipse KnowledgeRepository that will provide an aid in this development.Question:

What options are available if an adapter doesn't exist for Ellipse or does but does not meet requirements?

Response:A custom Ellipse adapter can be developed in EIP to meet specific customer requirements using the SDK that can bedownloaded from an EIP instance. In addition there is an EIP Ellipse Custom Adapter Guide in the Ellipse KnowledgeRepository that will provide an aid in this development.

Question:What documentation is available to find out further information on EIP and Ellipse adapters?

Response:The Ellipse adapter documentation, EIP guides and supporting documentation for the SDK are all available from the EllipseKnowledge Repository. This is available from any deployed Ellipse instance via a URL like this:

http:///documentation/Question:

Are adapters that are developed by the customer to integrate to the ERP system have to be built to be run in the EIP?

Response:The adapters that are developed to integrate to the ERP system do NOT have to be built to be run in the EIP. Thoseadapters can be developed to be run in the customer integration OR can be developed to be run in the EIP. The choice ofintegration platform will be dependent on the specific requirements of each customer. Where the customer integrationplatform is to be used to host the adapters for the ERP system, OAGIS XML messages will be expected to be passed to andfrom the EIP (over JMS) by the customer integration platform.

Question:Does this support the initial load of data entities into Ellipse?

Response:The integration solution is only intended to support the transfer of data in a normal, day-to-day operational environment.For the initial load of data the integration solution may suffice, however the volume of data to be loaded would need to bedetermined and the time frame in which this is required to be transferred determined and then load testing on aproduction strength physical environment conducted to determine if that is possible.

Question:Does the EIP support synchronous integration with an external system?

Response:The EIP is intended to provide asynchronous integration with an external system. A response messages for a requestmessage can be provided, however the response message is not immediate and therefore cannot be defined assynchronous. Where synchronous integration with Ellipse is required the Ellipse Web Services should be utilised.

http:/

Appendix

Ellipse Events Configuration

Ellipse Events Configuration Overview

Asset and Work Management - Functional OverviewCommercial In ConfidenceIntroductionPurposeExecutive SummaryBusiness BenefitsScopeBaselinesFunctional ScopeBusiness Rules / Design DecisionsTransformation and Data EnrichmentData MappingStandard JobMaintenance Schedule Task (MST)Job EstimateProjectProject Scheduling

Interface DetailsProcess OverviewEquipmentWork RequestWork OrderStandard JobMaintenance Schedule Task (MST)Job EstimateProjectProject ScheduleLabour Costs

Ellipse ConfigurationEquipment RegisterEllipse EventsEIP Configuration

Work RequestsWork OrdersEllipse EventsEIP Configuration

Standard JobsEllipse EventsEIP Configuration

Equipment Planned MaintenanceEllipse EventsEIP Configuration

Job EstimateEllipse EventsEIP Configuration

ProjectEllipse EventsEIP Configuration

Project ScheduleLabour Costing

FAQsAppendixEllipse Events Configuration

asset and work management - functional...

Documents