Asset and Work Management - Functional Overview

Transcription

1 Asset and Work Management - Functional Overview

2 Asset and Work Management - Functional Overview Contents Asset and Work Management - Functional Overview 2 Commercial In Confidence 4 Introduction 5 Purpose 5 Executive Summary 5 Business Benefits 5 Scope 5 Baselines 6 Functional Scope 6 Business Rules / Design Decisions 6 Transformation and Data Enrichment 6 Data Mapping 6 Standard Job 6 Maintenance Schedule Task (MST) 6 Job Estimate 6 Project 7 Project Scheduling 7 Interface Details 8 Process Overview 8 Equipment 8 Work Request 8 Work Order 8 Standard Job 9 Maintenance Schedule Task (MST) 9 Job Estimate 9 Project 9 Project Schedule 9 Labour Costs 11 Ellipse Configuration 12 Equipment Register 12 Ellipse Events 12 EIP Configuration 12 Work Requests 13 Work Orders 14 Ellipse Events 15 EIP Configuration 15 Standard Jobs 16 Ellipse Events 17 EIP Configuration 17 Equipment Planned Maintenance 18 Ellipse Events 19 EIP Configuration 19

3 Job Estimate 20 Ellipse Events 21 EIP Configuration 21 Project 22 Ellipse Events 23 EIP Configuration 23 Project Schedule 24 Labour Costing 24 FAQs 26 Appendix 27 Ellipse Events Configuration 27

4 Commercial In Confidence Copyright 2018 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 network interface, which should be connected to a secure network. It is your sole responsibility to ensure a secure connection to the network and to establish and maintain appropriate measures (such as but not limited to the installation of firewalls, application of 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.

5 Introduction Purpose The purpose of this document is to explain the business intent of the standard Asset and Work Management integration solution, 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 information will be shared between Ellipse and the external system(s) automatically. Business analysts/consultants will need to understand the functionality of the Asset and Work Management integration solution integration in order to instruct the technical resources as to how to implement and configure this integration. Executive Summary Maximum asset use is critical to the business success of asset-intensive organisations. Ellipse provides comprehensive asset management tools to monitor asset status and performance, to receive key condition measurements, and to recommend the most appropriate maintenance strategies. The main asset management tool in Ellipse is the equipment register. Built-in equipment configuration management, classification, and costing capabilities in the equipment register afford considerable opportunities for maintenance managers to proactively administer the assets under their control. The Asset and Work Management integration solution provides an Equipment adapter to process the sharing of asset information to and from Ellipse. The Operations and Maintenance stream of Ellipse is designed to maximise the productivity and life cycle of capital equipment and minimise downtime. The stream supports the timely scheduling of preventative maintenance activities, including resources and parts, while enabling support for corrective maintenance tasks. It manages the entire life cycle of a capital equipment item from purchase through to disposal. The Asset and Work Management integration solution provides adapters to process the sharing 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 systems for the purpose of: Project Planning Work Scheduling Work and Asset Location The following Ellipse data entities are available for integration through the standard Ellipse Asset and Work Management integration solution: Equipment Work Request Work Order Standard Job Equipment Planned Maintenance Job Estimate Project Project Schedule Labour Costs Business Benefits The 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 and Maintenance business process requirements. 2. Centralisation of asset information in Ellipse will allow utilisation in day-to-day asset management business processing and further detailed analysis for predictive asset management. 3. Automation of the loading of operations and maintenance data between Ellipse and external systems will eliminate potential transposition errors from the process. 4. Automation of the loading of operations and maintenance data between Ellipse and external systems will allow for faster reaction times when processing maintenance activities in an operating environment. 5. Economical implementation of best-of-breed solutions integrated with Ellipse to meet specific business processing requirements. Scope The Ellipse portion of the interface is contained within the Ellipse Integration Platform (EIP). There will be additional third party software required to integrate between the external system and EIP to complete the end-to-end integration solution with Ellipse. The scope of the Asset and Work Management integration solution is detailed below:

6 Baselines Ellipse 8.5 onwards. This item is not suitable for back fit to prior versions of Ellipse 8. Functional Scope The 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 from Ellipse. 2. Update of Work Requests in Ellipse for the identification of potential work that will be used in the maintenance planning processes. This allows users to create a work request that records the who, what, and where of any work requested by both internal and external users. 3. Access to work order information for the purpose of either providing updates to this in Ellipse or receiving this information from Ellipse. A Work Order defines individual jobs or small groups of jobs from an operational and maintenance perspective, 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 the work templating tool in Ellipse that provides maintenance personnel with the ability to set up simple or complex job templates. 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. A maintenance schedule task is a template for regularly performed tasks, such as scheduled services for grouped equipment and / or their components. 6. Access to job estimate information for the purpose of receiving this information from Ellipse only. A job estimate is used to estimate the work and associated costs required to complete a job. A job can range in complexity from a capital works construction 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 information from 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 and budgets. 8. Access to project schedule information for the purpose of either providing updates to this in Ellipse or receiving this information 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 project scheduling, 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 a daily basis. Ellipse calculates the cost of the work together with any oncosts (if applicable) and applies the total hours and cost 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 Enrichment It is assumed that all transformation and enrichment of the data passed from the 3rd party system required for the message to be processed into Ellipse, will be carried out within EIP. The provision of third party software required to integrate between the 3rd party system and EIP will need to be catered for. Data Mapping The 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 messages required for each EIP adapter. Standard Job Standard 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 an asset. This is defined by maintenance planners in Ellipse based on manufacturers recommendations, breakdown history analysis, 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 Estimate Job Estimate information is provided from Ellipse as an aid to understanding the design and costs of a work project. There is update capability to Job Estimates in relation to scheduling catered for by the Project Schedule adapter.

7 Project The Project information available for access by an external system is limited to the control information only. The amount of reference data required from Ellipse to an external system to support additional data updates is prohibitive. Project Scheduling Where Project Scheduling information is provided to an external system, the external system will be required to store the identifiers of the Ellipse data entities included in this information in order to have updates to these entities by the external system be successfully processed in Ellipse.

8 Interface Details Asset and Work Management Interface Schematic Process Overview Equipment The Equipment register in Ellipse identifies all maintainable assets as unique items in an equipment database. The Equipment register s essential role is to be the main database of information about the equipment that the client owns, operates, and maintains. As the maintenance and operation of equipment is fundamental to many Ellipse applications, the equipment register is a crucial element of the total system. Ellipse is expected to master the Equipment data and provide relevant details to external systems as required and be updated by external systems as required. The provision of Equipment details is typically required for mobile solutions and GIS Integration. Work Request Ellipse is expected to be updated with Work Requests that will identify potential work that needs to be performed. For customer-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 relevant key information about the person requesting the work and the nature of work that is required. This information then can be loaded into Ellipse via the Work Request adapter. The Work Request module in Ellipse then is integrated to the Job Estimate and Work Orders modules to feed into the work planning and scheduling process. Typically the next step required to fulfil the request will be estimating the costs or scheduling the work. Work Order The Work Order module defines individual jobs or small groups of jobs from an operational and maintenance perspective. The work order provides a means of notifying a person, work group, or crew about an activity. The Ellipse Work Order module along with supporting modules that are integrated will record, track, and analyse work that is performed. For each activity the requirements, schedule, progress and estimated and actual costs can be specified. Ellipse is expected to master the Work Order data and provide relevant details to external systems as required. In addition updates from external systems are expected where scheduling is performed outside of Ellipse and where work is executed via a mobile solution.

9 Standard Job The standard job is the work templating tool in Ellipse that provides maintenance personnel with the ability to set up simple or complex job templates. Once a standard job has been created, it can be used and re-used to create work orders as often as necessary. Standard jobs can also be updated after consistent job feedback is obtained. Ellipse is expected to master the Standard Job data and provide relevant details to external systems as required. The scenario in which Standard Job data is expected to be provided from Ellipse is where an external system will be creating Work Orders in Ellipse. The Standard Job will provide a template for the creation of the Work Order, with the benefits of defaulting the necessary details in Ellipse and utilising 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 as scheduled services for grouped equipment and / or their components. The module manages both scheduled and ad hoc tasks to schedule work subject to work group resource availability. Ellipse is expected to master the MST data and provide relevant details to external systems as required. The scenario in which MST data is expected to be provided from Ellipse is where an external system requires the recurring maintenance details for an asset. Job Estimate The Job Estimates application is used to estimate the work and associated costs required to complete a job. A job can range in complexity from a capital works construction project to a routine maintenance job. This allows a comprehensive estimate of requirements for work by compiling a list of the tasks, materials, equipment, and resource requirements needed to complete the 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 scenario in which Job Estimate data is expected to be provided from Ellipse is where an external system requires the design and costs details for specific work. Project The 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 and budgets. It also supports planning and cost control for large infrequent operating jobs such as major plant shutdowns. Ellipse is expected to master the Project data and provide relevant details to external systems as required. The scenario in which Project data is expected to be provided from Ellipse is where an external system requires the planning and cost controls details for specific work. Project Schedule To simplify the complexity of an external system integrating with Ellipse for project management, the Project Schedule adapter will be used to perform the majority of the work. The adapter will be used to both extract a project and dependent items and will 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 integration implementer 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 details and 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 will contain an identifier that must be sent back via the integration if the item is to be updated. If no identifier is sent in these cases, the integration will interpret this as a new item and depending on the type, either create or reject. The adapter is designed in such a way as to allow this behaviour to be configured. For the purposes of this integration, only the following will be allowed to be created: Equipment Requirements Labour Requirements All 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 the Process Method. Job Estimate Item Planned Start Date/Time Planned Finish Dates/Time Required Start Date/Time Required Finish Date/Time Note The update of the Planned Start/Finish Date of Item Zero will result in the Estimate header Item being automatically updated with the same value which is existing functionality.

10 Project Plan Start Date/Time Plan Finish Date/Time Schedule Start Date Schedule Finish Date Target Finish Date Actual Start Date Actual Finish Date Work Order Planned Start Date/Time Planned Finish Date/Time Actual Start Date/Time Actual Finish Date/Time Work Order User status Note The normal Update of the Planned Dates of the Work Order is typically indirectly performed by the update of the Dates on the tasks and the use of the Calc-Est-Duration Flag. Work Order Task Planned Start Date/Time Planned Finish Date/Time Actual Start Date/Time Actual Finish Date/Time Work Order Task User Status Equipment Requirements Equipment Type Unit of Measure Quantity Required Unit Quantity Required Updates 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). Note Where creating an Equipment Requirement, then a Sequence No (ID value 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 Equipment Requirement, 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 of the above fields should be provided. Resource Requirements Unit of Measure Quantity Required Hours Required Updates to Resource 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). Note Where creating a Resource Requirement, then a Resource Class, Resource Type MUST be provided and a Sequence No (ID value in the message) should NOT be provided. For a create to be processed, values for each of the above fields should be

11 provided. Where modifying or deleting an Resource Requirement, then a Resource Class, Resource Type MUST be provided and 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 of the above fields should be provided. Material Requirements Updates to Material Requirements are NOT supported by the Project Schedule adapter. It is understood that updates to Material Requirements are NOT part of the business process for Scheduling work. Labour Costs Ellipse is expected to be updated with the details of actual time spent by allocated resources to work executed. The Labour Costs 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 the activity, which may be a work order, job, project, item of equipment, general ledger account, or cost centre. As a by-product of this process analysis of non-productive time and work group performance is supported and the budgeting process is also supported.

12 Ellipse Configuration In order for the data to be processed to/from Ellipse via the Asset and Work Management adapters, there will be configuration required in Ellipse to allow this. The sections below briefly outline the requirements for this configuration. Equipment Register The 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 then there is additional configuration required for Ellipse and EIP as below. Ellipse Events Ellipse Events must be configured to be enabled. To update this refer to the Ellipse 8 Customisation and Personalisation guide in the Ellipse Knowledge Repository. This can be found under a URL structured as follows: In the JI Customisation - Eventing section there are some notes on how to configure this for Ellipse, refer to the screen shot under Appendix > Ellipse Events Configuration. EIP Configuration In 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 require the relevant tables on which Equipment information is stored to be identified and a durable subscription implemented to consume 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. The Equipment adapter in EIP can be configured to process Equipment changes in Ellipse. The Equipment adapter will listen for event messages generated by Equipment changes in Ellipse to the core database tables upon which Equipment data is held. The adapter will process these event messages to provide a message with all core Equipment details output to the MIB.EVENT.REPLY JMS topic hosted in EIP. This will require EIP to have the mib.equipment.eventsenabled property set to true.

13 EIP Equipment Events Configuration Note Both of the both options will also require development. The durable subscription can be developed in EIP along with supporting components to load the required details into the external system. Alternatively the durable subscription can be developed in the customer s integration platform along with the supporting components to load the required details into the external system. Work Requests Work Requests are only available if the Work Requests (3540) module is installed in Ellipse.

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

15 Work Orders Module Where changes to Work Order information is required to be published from Ellipse for consumption by an external system then there is additional configuration required for Ellipse and EIP as below. Ellipse Events Ellipse Events must be configured to be enabled. To update this refer to the Ellipse 8 Customisation and Personalisation guide in the Ellipse Knowledge Repository. This can be found under a URL structured as follows: In the JI Customisation - Eventing section there are some notes on how to configure this for Ellipse, refer to the screen shot under Appendix > Ellipse Events Configuration. EIP Configuration In 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 Work Orders directly. This will require the relevant tables on which Work Order information is stored to be identified and a durable subscription implemented to consume 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 Work Order adapter in EIP can be configured to process Work Order and Task changes in Ellipse. The Work Order adapter will listen for event messages generated by Work Order and Task changes in Ellipse to the core database tables upon which Work Order and Task data is held. The adapter will process these event messages to provide a message with all core Work 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.

16 EIP Work Order Events Configuration Note Both of the both options will also require development. The durable subscription can be developed in EIP along with supporting components to load the required details into the external system. Alternatively the durable subscription can be developed in the customer s integration platform along with the supporting components to load the required details into the external system. Standard Jobs Standard Jobs are only available if the Standard Jobs (3690) module is installed in Ellipse.

17 Standard Jobs Module Where changes to Standard Job information is required to be published from Ellipse for consumption by an external system then there is additional configuration required for Ellipse and EIP as below. Ellipse Events Ellipse Events must be configured to be enabled. To update this refer to the Ellipse 8 Customisation and Personalisation guide in the Ellipse Knowledge Repository. This can be found under a URL structured as follows: In the JI Customisation - Eventing section there are some notes on how to configure this for Ellipse, refer to the screen shot under Appendix > Ellipse Events Configuration. EIP Configuration In 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 Standard Jobs directly. This will require the relevant tables on which Standard Job information is stored to be identified and a durable subscription implemented to 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. The Standard Job adapter in EIP can be configured to process Standard Job and Task changes in Ellipse. The Standard Job adapter will listen for event messages generated by Standard Job and Task changes in Ellipse to the core database tables upon which Standard Job and Task data is held. The adapter will process these event messages to provide a message with all core Standard Job and Task details output to the MIB.EVENT.REPLY JMS topic hosted in EIP. This will require EIP to have the mib.standardjob.eventsenabled property set to true.

18 EIP Standard Job Events Configuration Note Both of the both options will also require development. The durable subscription can be developed in EIP along with supporting components to load the required details into the external system. Alternatively the durable subscription can be developed in the customer s integration platform along with the supporting components to load the required details into the external system. Equipment Planned Maintenance Maintenance Schedule Tasks are only available if the Maintenance Scheduling (3701) module is installed in Ellipse.

19 Maintenance Scheduling Module Where changes to Maintenance Schedule Task information is required to be published from Ellipse for consumption by an external system then there is additional configuration required for Ellipse and EIP as below. Ellipse Events Ellipse Events must be configured to be enabled. To update this refer to the Ellipse 8 Customisation and Personalisation guide in the Ellipse Knowledge Repository. This can be found under a URL structured as follows: In the JI Customisation - Eventing section there are some notes on how to configure this for Ellipse, refer to the screen shot under Appendix > Ellipse Events Configuration. EIP Configuration In 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 Maintenance Schedule Tasks directly. This will require the relevant table on which Maintenance Schedule Tasks information is stored to be identified and a durable 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 Maintenance Schedule Tasks adapter. The Maintenance Schedule Tasks adapter in EIP can be configured to process Maintenance Schedule Tasks changes in Ellipse. The Maintenance Schedule Tasks adapter will listen for event messages generated by Maintenance Schedule Tasks changes in Ellipse to the relevant database table upon which Maintenance Schedule Tasks data is held. The adapter will process these event messages to provide a message with all Maintenance Schedule Tasks details 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.

20 EIP Maintenance Schedule Task Events Configuration Note Both of the both options will also require development. The durable subscription can be developed in EIP along with supporting components to load the required details into the external system. Alternatively the durable subscription can be developed in the customer s integration platform along with the supporting components to load the required details into the external system. Job Estimate Job Estimates are only available if the Job Estimating (3655) module is installed in Ellipse.

21 Job Estimating Module Where changes to Job Estimating information is required to be published from Ellipse for consumption by an external system then there is additional configuration required for Ellipse and EIP as below. Ellipse Events Ellipse Events must be configured to be enabled. To update this refer to the Ellipse 8 Customisation and Personalisation guide in the Ellipse Knowledge Repository. This can be found under a URL structured as follows: In the JI Customisation - Eventing section there are some notes on how to configure this for Ellipse, refer to the screen shot under Appendix > Ellipse Events Configuration. EIP Configuration In 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 Job Estimates directly. This will require the relevant tables on which Job Estimate information is stored to be identified and a durable subscription implemented to consume 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 Job Estimate adapter in EIP can be configured to process Job Estimate changes in Ellipse. The Job Estimate adapter will listen for event messages generated by Job Estimate changes in Ellipse to the core database tables upon which Job Estimate data is held. The adapter will process these event messages to provide a message with all Job Estimate details output to the MIB.EVENT.REPLY JMS topic hosted in EIP. This will require EIP to have the mib.jobestimate.eventsenabled property set to true.

22 EIP Job Estimate Events Configuration Note Both of the both options will also require development. The durable subscription can be developed in EIP along with supporting components to load the required details into the external system. Alternatively the durable subscription can be developed in the customer s integration platform along with the supporting components to load the required details into the external system. Project Projects are only available if the Project Control (3660) module is installed in Ellipse.

23 Project Control Module Where changes to Project information is required to be published from Ellipse for consumption by an external system then there is additional configuration required for Ellipse and EIP as below: Ellipse Events Ellipse Events must be configured to be enabled. To update this refer to the Ellipse 8 Customisation and Personalisation guide in the Ellipse Knowledge Repository. This can be found under a URL structured as follows: In the JI Customisation - Eventing section there are some notes on how to configure this for Ellipse, refer to the screen shot under Appendix > Ellipse Events Configuration. EIP Configuration In 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 Projects directly. This will require the relevant tables on which Project information is stored to be identified and a durable subscription implemented to consume 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 adapter in EIP can be configured to process Project changes in Ellipse. The Project adapter will listen for event messages generated by Project changes in Ellipse to the core database tables upon which Project data is held. The adapter will process these event messages to provide a message with all Project details output to the MIB.EVENT.REPLY JMS topic hosted in EIP. This will require EIP to have the mib.project.eventsenabled property set to true.

24 EIP Project Events Configuration Note Both of the both options will also require development. The durable subscription can be developed in EIP along with supporting components to load the required details into the external system. Alternatively the durable subscription can be developed in the customer s integration platform along with the supporting components to load the required details into the external system. Project Schedule Project Scheduling is only available if the Work Order (3620), Job Estimating (3655) and Project (3660) modules are installed in Ellipse. Refer to the configuration for each of those module specified previously for the required Ellipse configuration. Labour Costing Labour Costing is only available if the Labour Costing (3850) module is installed in Ellipse.

25 Labour Costing Module

26 FAQs The 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 on site. Development will then be required to provide the integration to the external system. This development can be undertaken in EIP or in the customer s own integration platform. Where this is to be undertaken in EIP there is an SDK that can be downloaded from an EIP instance that provides code examples that will aid in this development. The SDK is in the form of an Eclipse project, so this can be imported into that IDE. The typical set of components required to provide integration 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 and will 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 either into a Java format or an XML format. Action Class - code that will perform message processing (transforms, defaults, enrichment, etc) and execute the update of the required details into the external system via the appropriate API. In addition there is an EIP SDK Guide in the Ellipse Knowledge Repository 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 be downloaded from an EIP instance. In addition there is an EIP Ellipse Custom Adapter Guide in the Ellipse Knowledge Repository 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 Ellipse Knowledge Repository. This is available from any deployed Ellipse instance via a URL like this: 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. Those adapters can be developed to be run in the customer integration OR can be developed to be run in the EIP. The choice of integration platform will be dependent on the specific requirements of each customer. Where the customer integration platform is to be used to host the adapters for the ERP system, OAGIS XML messages will be expected to be passed to and from 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 be determined and the time frame in which this is required to be transferred determined and then load testing on a production 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 request message can be provided, however the response message is not immediate and therefore cannot be defined as synchronous. Where synchronous integration with Ellipse is required the Ellipse Web Services should be utilised.

27 Appendix Ellipse Events Configuration Ellipse Events Configuration Overview