1. A U.S. Department of Energy Office of Science Laboratory Operated by The University of Chicago Argonne National Laboratory Office of Science U.S. Department of Energy The IRMIS Object Model and Services API C. Saunders, D.A. Dohan, N.D. Arnold APS, Argonne National Laboratory, Argonne, IL, USA The submitted manuscript has been created by the University of Chicago as Operator of Argonne National Laboratory (“Argonne”) under Contract No. W-31-109-ENG-38 with the U.S. Department of Energy. The U.S. Government retains for itself, and others act- ing on its behalf, a paid-up, nonexclusive, irrevocable worldwide license in said article to reproduce, prepare derivative works, dis- tribute copies to the public, and perform pub- licly and display publicly, by or on behalf of the Government.

2. The IRMIS Object Model and Services API Pioneering Science and Technology Office of Science U.S. Department of Energy 2 IRMIS Integrated Relational Model of Installed Systems -Relational database and applications to comprehensively document an EPICS control system. -3 main areas documented: - PV (process variables) - Components (control and accelerator system hardware) - Cables (and conductors) Describe, not prescribe -IRMIS is not a design tool. It documents an as-built system. -Decoupled from EPICS IOC development process.

3. The IRMIS Object Model and Services API Pioneering Science and Technology Office of Science U.S. Department of Energy 3 IRMIS Designed to answer typical operations and maintenance questions: -What PVs are associated with this component? -What PVs were added, changed, or removed since last run? -Where does the other end of this cable go? -What components will be affected if we lock out this circuit breaker? -What do all these nonfunctional components have in common? -Which IOC controls the GPIB instrument in this rack?

4. The IRMIS Object Model and Services API Pioneering Science and Technology Office of Science U.S. Department of Energy 4 IRMIS – Getting Data In How is data entered into IRMIS? -Some automated -Some manual DB st.cmd dbd db … IOC 1 IOC n PV Crawler Component Type Editor Component Editor Cable Editor Miner – PV to Component

5. The IRMIS Object Model and Services API Pioneering Science and Technology Office of Science U.S. Department of Energy 5 IRMIS – Getting Data Out DB IOC Viewer PHP Pages Direct SQL Queries Cable Viewer Component Viewer Component Type Viewer PV Viewer

6. The IRMIS Object Model and Services API Pioneering Science and Technology Office of Science U.S. Department of Energy 6 An Implementation Challenge 40+ database tables, many foreign keys Complex database transactions Complex user interface use cases Database vendor independence Application platform independence Site independent (work for any EPICS installation) Extensible (accommodate site-specific extensions)

7. The IRMIS Object Model and Services API Pioneering Science and Technology Office of Science U.S. Department of Energy 7 Design Choices Business logic in application services layer, not in stored procedures/triggers -Allows for database vendor independence Java Swing applications -Allows for complex user interaction and application platform independence Hibernate Object Relational Modeling (ORM) -Elegantly manages gap between object-oriented data model and relational data model -Supports almost every known database vendor

8. The IRMIS Object Model and Services API Pioneering Science and Technology Office of Science U.S. Department of Energy 8 Software Layers DB Object Model Hibernate Session Data Access Objects (DAO) Layer IRMIS Transactional Services Layer Java Swing Applications (built using XAL app framework) XML mappings Provides object graph retrieve and save operations Provides operations on object graph Display/Edit object graph JDBC

9. The IRMIS Object Model and Services API Pioneering Science and Technology Office of Science U.S. Department of Energy 9 PV Object Model and Services Services -List findRecordList(PVSearchParameters searchParams) -List findCompleteRecordBootHistory(Record record) -List findReferringFieldsForRecord(List iocBootList, Record record)

10. The IRMIS Object Model and Services API Pioneering Science and Technology Office of Science U.S. Department of Energy 10 Component Object Model and Services Services -ComponentType findComponentTypeByName(String name) -List findComponentsByType(ComponentType type) -void saveComponent(Component component)

11. The IRMIS Object Model and Services API Pioneering Science and Technology Office of Science U.S. Department of Energy 11 PV Viewer and IOC Viewer

12. The IRMIS Object Model and Services API Pioneering Science and Technology Office of Science U.S. Department of Energy 12 PV Viewer in History Mode

13. The IRMIS Object Model and Services API Pioneering Science and Technology Office of Science U.S. Department of Energy 13 Component Type Viewer/Editor

14. The IRMIS Object Model and Services API Pioneering Science and Technology Office of Science U.S. Department of Energy 14 Component Viewer/Editor

15. The IRMIS Object Model and Services API Pioneering Science and Technology Office of Science U.S. Department of Energy 15 Component Viewer/Editor