Building an Enterprise Reporting Framework Using Adobe Flex

Transcription

1 MAX 2006 Beyond Boundaries Presentation Outline Building an Enterprise Reporting Framework Using Adobe Flex Victor Rasputnis Senior Principal Farata Systems Anatole Tartakovsky Senior Principal Farata Systems Customer Challenges 2 min Challenges of the current process Requirement for the solution Technical Solution 45 min How we meet the requirement 2 min Architecture of the solution - 3 min DaoFlex Solution technical overview and demo -15 min Reporting Framework technical overview and demo - 25 min Q&A 7 min 1 2 Customer Challenges Requirements for the Solution IFS/StateStreet accountants are processing about 10,000 back-office generated reports on a daily basis Links to PDF of selected reports which pass accounting verification are exposed to the customers Fortune 100 financial corporations IFS customers are not able to manipulate the report data themselves, i.e: add/remove columns, filter/sort accounts, drilldown/rollup etc. IFS accountants are not able to manipulate the data either. All requests for adding computed fields, modifications of groupings, filtering, aggregation, pivoting etc. fall back to IFS IT IFS/StateStreet plans to introduce a new service Web-based user-driven reporting solution, allowing end-users and in-house accountants to manipulate the existing report data as well as build and persist the report structure for later reuse on personal and shared level Web-based Report Delivery Data Location Due to the volatile nature of the data, manipulation should be done on the client desktop, i.e. inside the browser as oppose to hitting the datastore again Intuitive User Interface to allow report manipulation : Adding/removing columns; Support of computed fields; Support dynamic grouping with group and cross-group computations; Support custom filtering and sorting Support bi-directional link with Excel Support of business quality client-side printing w/out server side trip (PDF generation, etc.) 3 4 Requirements for the Solution (continued) How Farata Systems meets the requirement Performance, look-and-feel, cross-browser Development and deployment has to be highly automated, currently labor intensive parts streamlined or eliminated Power users should be able to customize templates either via UI or directly but without low-level coding Customization has to be available on all levels independently, no black box integration Initial metadata has to automatically derive from SQL or stored procedure defined for a base report FlexBI Flex-based business intelligence solution SuperGrid control, a natural extension of standard DataGrid Custom MXML tags to support arbitrary groupings and computations Metadata as MXML Database as persistent storage of metadata and pre-compiled reports Dynamic visual modification of report MXML by the end-user Web-tier compilation, support of add-hoc expressions: filtering, sorting, formulas Printing, Excel Link DaoFlex XSL Template-based design-time code generator SQL statements as Java doclet annotations; mix and match pure Java and SQL methods Java code: DAO - both Remoting and DataServices flavors; data transfer objects; JARs Test MXML UI, ActionScript and Java data transfer objects Initial report Metadata Deployment descriptors, etc 5 6 1

2 Session Agenda Introductions Introductions DaoFlex MXML/ActionScript/Java code generator Generated code review (live demo) SuperGrid Control WebTier compilation engine for business formulas, expressions and complete design Database-based deployment of the reports Who we are Mentoring consultants Software Engineers Educators What we do Mentoring Consulting Training Saving base reports as templates FlexBI flexible end-user driven reporting tool Publications Books Articles Blogs Adobe Exchange Open Source Projects DaoFlex FlexBI fant log4f Brief Introduction 7 8 DaoFlex: RAD approach to Data Access in Flex DaoFlex At A Glance P R O D U C T I V I T Y Eliminate the need for manual Java coding of data access tasks Eliminate the need of manual synchronization of data transfer classes on Java and ActionScript side Eliminate the need of manual synchronization of DataGridColumn definitions with ActionScript classes. And more package com.theriabook.datasource; /** * pool=jdbc/theriabook public abstract class Employee { /** * sql= select * from employee where start_date < :startdate * transfertype=employeedto[] * keycolumns=emp_id public abstract List getemployees(date startdate); Code generation solution that completely automates manual Java coding for CRUD (create, retrieve, update, delete) tasks Integrates with Eclipse or works standalone as Ant task Goes all the way from simple annotated Java class to deployed JARs in the WEB-INF/lib Generates all required Java, ActionScript, MXML, XML 9 10 DaoFlex Input: Annotated Abstract Class Application Completely Built by DaoFlex package com.theriabook.datasource; /** * pool=jdbc/theriabook public abstract class Employee { /** * sql= select * from employee where start_date < :startdate * transfertype=employeedto[] * keycolumns=emp_id public abstract List getemployees(date startdate); The compete source code of the Employee class is here 11 The deployed sample application is here 12 2

3 DaoFlex At A Glance DaoFlex Process Diagram package com.theriabook.datasource; * pool=jdbc/theriabook Written by developer Annotated abstract Java class public abstract class Employee { * sql= select * from employee where start_date < :startdate * transfertype=employeedto[] * keycolumns=emp_id public abstract List getemployees(date startdate); Physical data source pointed by pool=jdbc/theriabook DaoFlex DAO Test MXML Java DTO Pre-built + custom DaoFlex Report Templates Assembler DataGrid AS DTO metadata Code-generation of all required Java, ActionScript, MXML, configuration files is based on the pre-written customizable XSL templates Code generation includes connecting to the database and obtaining result set metadata XSL Templates are processing combined metadata extracted from DB with info extracted from the Doclet tags Generated by DaoFlex Deployed by DaoFlex Java MXML, Implementation ActionScript classes classes JAR with JAR with abstract implementation classes classes DaoFlex Directory Structure ANT Process Based on DaoFlex Directory structure can be viewed here Generated Java DAO: Fill Method public final List getemployees(java.util.date startdate) { String sql = "select * from employee where start_date <? or start_date=?"; conn = JDBCConnection.getConnection("jdbc/theriabook"); stmt = conn.preparestatement(sql); stmt.setdate(1, DateTimeConversion.toSqlDate(startDate)); rs = stmt.executequery(); while( rs.next() ) { EmployeeDTO dto = new EmployeeDTO(); dto.emp_fname = rs.getstring("emp_fname"); dto.salary = rs.getdouble("salary"); dto.start_date = DateTimeConversion.toUtilDate(rs.getDate("START_DATE")); list.add(dto); return list; // catch finally Generated Java DAO: doupdate private void doupdate_getemployees(connection conn, ChangeObject co) { StringBuffer sql = new StringBuffer("UPDATE EMPLOYEE SET "); String [] names = co.getchangedpropertynames(); for (int ii=0; ii < names.length; ii++) { sql.append((ii!=0?", ":"") + names[ii] +" =? "); sql.append( " WHERE (EMP_ID=?)" ); stmt = conn.preparestatement(sql.tostring()); Map values = co.getchangedvalues(); int ii=0; for (ii=0; ii < names.length; ii++) { stmt.setobject( ii+1, values.get(names[ii])); ii++; stmt.setobject(ii++, co.getpreviousvalue("emp_id")); if (stmt.executeupdate()==0) throw new DataSyncException(co); The full source of the generated JavaDAO can be seen here 17 The full source of the generated JavaDAO can be seen here 18 3

4 Generated Java DAO: docreate private ChangeObject docreate_getemployees(connection conn, ChangeObject co) throws { PreparedStatement stmt = null; String sql = "INSERT INTO EMPLOYEE " + "(EMP_ID, SALARY,START_DATE)"+ " values (?,?,?)"; stmt = conn.preparestatement(sql); EmployeeDTO item = (EmployeeDTO) co.getnewversion(); stmt.setint(1, item.emp_id);... stmt.setstring(12, item.ss_number); if (Double.isNaN(item.SALARY)) stmt.setnull(13,types.double); else stmt.setdouble(13, item.salary); stmt.setdate(14, DateTimeConversion.toSqlDate(item.START_DATE));... if (stmt.executeupdate()==0) throw new DAOException("Failed inserting."); co.setnewversion(item); return co; Generated Java DAO: Sync Method public final List searchemployees_sync(list items) { Connection conn = null; ChangeObject co = null; try { conn = JDBCConnection.getPooledConnection("jdbc/theriabook"); Iterator iterator = items.iterator(); while (iterator.hasnext() ) { // Do all deletes first co = (ChangeObject)iterator.next(); if(co.isdelete()) dodelete_searchemployees(conn, co); iterator = items.iterator(); while (iterator.hasnext()) { // Proceed to all updates next iterator = items.iterator(); while (iterator.hasnext()) { // Finish with inserts catch finally { if( conn!=null ) JDBCConnection.releasePooledConnection(conn); return items; The full source of the generated JavaDAO can be seen here Generated Java DTO Generated ActionScript DTO /* Generated by DAOFLEX Utility (JavaDTO.xsl) package com.theriabook.datasource.dto; public class EmployeeDTO implements Serializable{ private static final long serialversionuid = 1L; public int EMP_ID; public String EMP_FNAME; public double SALARY; public java.util.date START_DATE; private String _uid; public EmployeeDTO() { _uid = UUIDGen.getUUID(); public String getuid() { return _uid; public void setuid(string value) { _uid = value; /* Generated by DAOFLEX Utility (ActionScriptDTO.xsl) package com.theriabook.datasource.dto{ [Managed] [RemoteClass(alias="com.theriabook.datasource.dto.EmployeeDTO")] public dynamic class EmployeeDTO { public var EMP_ID : Number; public var EMP_FNAME : String;... public var SALARY : Number; public var START_DATE : Date;... private var _uid:string; public function get uid():string { return _uid; public function set uid(value:string):void {_uid = value; public function EmployeeDTO() {_uid = UIDUtil.createUID(); //EmployeeDTO The full source of the generated JavaDAO can be seen here 21 The full source of the generated ActionScriptDTO can be seen here 22 Generated Test MXML Application DaoFlex in Action <mx:application xmlns:mx=" creationcomplete="oncreationcomplete()"> <mx:dataservice id="ds" destination="employee"... /> <mx:panel title="employee::getemployees()" > <mx:datagrid id="dg" dataprovider="{collection" editable="true" height="100%"> <mx:columns><mx:array> <mx:datagridcolumn datafield="emp_fname" headertext="emp Fname" />... <mx:datagridcolumn datafield="salary" headertext="salary" itemeditor="{numbereditor" labelfunction="numberlabelfunction"/> </mx:array></mx:columns> </mx:datagrid> <mx:controlbar><mx:button label="fill" click="fill_onclick()"/><mx:button label="delete" click="delete_onclick()". <mx:button label="commit" click="commit_onclick() enabled="{ds.commitrequired"/> </mx:controlbar> </mx:panel> </mx:application> The full source of the generated Test MXML application can be seen here

5 Wait, There is More Controlling DaoFlex Java Assembler Remoting DAO classes Configuration XML files Report metadata for FlexBI Forms and Master/Detail Project specific templates Rebuild DaoFlex from the source code: daoflex-runtime.jar & daoflexgenerator.jar DaoFlex runtime - a tiny (13 Kb) JAR with a handful of simple classes DaoFlex Generator s templates external XSL files Customize existing templates and/or add your own to generate as per your project organization Extend standard metadata with custom tags Employing DaoFlex in Reporting Systems RAD Approach: Provide visual development tools with full editing capabilities including, but not limited to drag-n-drop Put the end-user in the driver s seat to extend the system Cut and Paste Approach (works for data entry as well): Copy generated code to the application Add business functionality on top Development cycle: standard incremental process of design, test, deployment FlexBI Business Intelligence Tool C O S T O F O W N E R S H I P Native Flex approach for reporting solutions Eliminate the need to integrate and customize 3 rd party BI packages Control performance and security issues Simplify deployment Support report personalization by the end user FlexBI Business Intelligence Tool Key Ingredients of FlexBI SuperGrid control, a natural extension of standard DataGrid Run-time use of MXML for VISUAL editing by the end-user

6 SuperGrid In Action SuperGrid: Business Domain MXML New functionality: header/footer bands; formulas Automation of routine tasks: formatting <fx:columns><mx:array> <fx:supergridcolumn colid="lname" datafield="lname" headertext="name "/> <fx:supergridcolumn colid="salary datafield="salary" format="currency" /> <fx:supergridcolumn colid="birth_date datafield="birth_date" format="shortdate" /> </mx:array></fx:columns> <fx:bandcolumns><mx:array>. <fx:supergridcolumn bandname="header1" colid= h1" headertext="department:" /> <fx:supergridcolumn bandname="header1" colid="d1" datafield="dept_id" fontweight= bold /> <fx:supergridcolumn bandname="trailer1" colid= st1" headertext="sub-total:" /> <fx:supergridcolumn bandname="trailer1" colid="s_t1" datafield="salary" boundto="salary" format="currency formula= SUM(SALARY for CURRENT)"/>. </mx:array></fx:bandcolumns> FlexBI Report Metadata - MXML FlexBI Reports Deployment: Publishing Def: MXML of the Report persisted in the database Initially produced by DaoFlex as SQL INSERT statement Iteratively and interactively edited via FlexBI Designer Regular MXML: can be edited and standalone tested MXML-to-components serialization/de-serialization allows ad-hoc modification of the report by the end user (column list, grouping, sorting, formulas, etc.) Are we going to have build for each additional report? Are we going to update server with each additional destination? Are we going to stop/start server after adding each additional report? How are we going to maintain security of the reports? insert into COMPOSITIONLIST (description, columns, arguments, method, classname) values ( 'Template for Employee::getDepartments', '<fx:columns><mx:array><fx:supergridcolumn datafield="dept_id" headertext="dept Id" /></mx:array>.</fx:columns>', null, 'getdepartments', 'com.theriabook.composition.employee ); FlexBI Reports Performance FlexBI Process Diagram For each report composition there is appropriate editable MXML stored in the database User Machine FlexBI Designer Report Run-time The end-user can interactively change layout, grouping, formulas, formatting, etc. Report Filters Formulas <fx:supergrid/> state= CA SUM(salary,1) SWF Executables The changes are applied as modifications to the original MXML and are stored in the database for future sessions There is also a set of SWF files to be used for high-performance view J2EE Application Server with FDS Expression Compiler Flex Web Tier Compiler Business expressions to ActionScript translation Wrapped mxmlc compiler Database Source MXML, filters-, formulas-, and compiled SWF files

7 Grouping with SuperGrid Grouping with SuperGrid Continued <fx:groups><mx:array> <fx:groupsort level="1"> <fx:fields><mx:array> <mx:sortfield name="dept_id" descending="false" numeric="true"/> </mx:array></fx:fields> </fx:groupsort> <fx:groupsort level="2" ><fx:fields><mx:array> <mx:sortfield caseinsensitive="true" name="state" descending="false" /> </mx:array></fx:fields></fx:groupsort> </mx:array></fx:groups> <fx:sort> /fx:sort> <fx:groups> <fx:groups> <fx:sort> <mx:sort> <mx:fields><mx:array> <mx:sortfield caseinsensitive="true" name="emp_lname" descending="false" /> <mx:sortfield caseinsensitive="true" name="emp_fname" descending="false" /> </mx:array></mx:fields> </mx:sort> </fx:sort> Grouping as natural progression of standard Flex sorting Seamless integration of the concept in the underlying platform Inner Sorting Data Driven Programming Real-world scenario Reporting Application The MXML in the previous slides can be either compiled or interpreted on the client Interpreting subset of MXML on the client is relatively inexpensive due to E4X support in the player Once MXML is processed, fully functional report is instantiated The end-user can interactively change layout, grouping, formulas, formatting, etc. The changes are applied as modifications to the original MXML and are saved to Database for reuse in the future sessions Application objects become data and are available for modification through the application life cycle Business Analysts need high-level widgets understanding business functionality / no low-level coding Has to be customizable and extensible in almost real-time Has to support standard office integration and functions Developers (like us) want it to be: Easy to develop Easy to deploy Easy to maintain Should require very little testing Should be easy to turn to operations Providing developers and business analyst with common markup widgets to assemble applications Separate and hide programming implementation of common tasks, make them data driven Engage end-user in the application customization and personalization Customizable Report Designer Layout Designer Base Interface for creating, extending and running dynamic reports Customizable set of painters and utility functions for reporting Built-in personalization layer

8 Grouping Designer Grouping Designer Sorts data based on the grouping Adds customizable theader and footer bands to each group Automatic calculation of the bands formulas Filter Designer Filter: Behind-The-Stage Web Tier Compilation Client-side data filtering, with automatic recalculation of the formulas Automatic generation and compilation of the filter expressions for better performance Data Sorting More SuperGrid MXML Applies sorting WITHIN groups Does not cause recalculations

9 FlexBI Benefits Q & A No builds for each additional report No need to change config files with extra remoting destinations No server stop/start after adding an additional report No large SWF files, no hundreds of small SWFs Complete personalization of reports by the end-user Complete control of the default enterprise formatting by the business analyst Complete automation of development and testing environments for developer Links Introduction into DaoFlex Introduction into fxreporter Demo of Contact Information vrasputnis@faratasystems.com atartakovsky@faratasystems.com Downloads DaoFlex fant Flex Ant Automation XPanel tracing/debugging console PojoFacade for remoting Q & A