xpages extension library -...
TRANSCRIPT
XPages Extension Library
Martin Donnelly IBM Ireland Software Lab
Before We Begin...● Please turn off:
– Pagers– Cellphones– Anything else that buzzes, sings, screams, beeps, chirps, barks, etc.
3
NOTE :Information regarding potential future products is intended to outline our general product direction and it should not be relied on in making a purchasing decision. The information mentioned regarding potential future products is not a commitment, promise, or legal obligation to deliver any material, code or functionality. Information about potential future products may not be incorporated into any contract. The development, release, and timing of any future features or functionality described for our products remains at our sole discretion.
4
Agenda
● Introduction● XPages & The XPages Extension Library● An Overview of Extension Library Controls/Assets● Field Study – An Application built using XSP Ext Lib● XSP Extensibility – Do It Yourself!● FAQs● Your Questions!
Martin Donnelly● Software Architect: IBM Ireland
▬ IBM Lotus® Domino® Designer 8.5.x / IBM Lotus® Domino® XPages▬ IBM Lotus® Component Designer 6.0▬ JavaServer™ Faces (JSF) Tooling IBM® Rational® Application Developer ▬ Java Visual Editor extensions for IBM® Rational® Application Developer
● Software Developer: Iris Associates / Lotus Development▬ IBM Lotus® Domino® Designer V4.6 to V6.01▬ IBM Lotus® 1-2-3® for Unix®, ▬ LotusScript, etc.
● “Mastering XPages” - Author
Speaker Introduction
● Domino developers with some XPages experience ● Expertise not required, just basic XSP experience
● Web developers with experience of industry standard technologies
● IT Managers familiar with XPages design concepts● Knowledge of XPages fundamentals essential
● Abstract
For Whom The Talk Aims
▬ Using XPages? Want to get your hands on some cool new controls? Need a dialog, outline or application layout? The XPages Extension Library is your answer! The XPages Extension Library (ExtLib) is a free open source project, the largest IBM code drop to OpenNTF, EVER. It contains dozens of new controls, easy to install and use in your applications. This session will not only demonstrate the out-of-box features, but will discuss the concepts and frameworks provided for building truly dynamic XPages. You'll come away with a richer set of functionality in your toolbox ... and maybe even share your new riches with the wider world.
7
Agenda
● IntroductionIntroduction● XPages & The XPages Extension Library● An Overview of Extension Library Controls/AssetsAn Overview of Extension Library Controls/Assets● Field Study – An Application built using XSP Ext LibField Study – An Application built using XSP Ext Lib● The Extension Library & The Road To VulcanThe Extension Library & The Road To Vulcan● XSP Extensibility – Do It Yourself!XSP Extensibility – Do It Yourself!● FAQsFAQs● Your Questions!Your Questions!
8
Designer & XPages – The Road Thus Far
2010
2009- First release of Xpages- Runs on the Domino server
Notes/Domino 8.5
Notes/Domino 8.5.1 - Runs within the Notes client- Generates iWidget- Active Content Filtering- Performance/scalability improvements
• - Stability/performance improvements
• - Better client integration• - Fixing pending issues/requests• - Extensibility APIs
Notes/Domino 8.5.2
Notes/Domino 8.5.x
- Application preloading• - JavaScript Aggregation• - XULRunner Upgrade• - CKEditor Upgrade• - Bug Fixes
The information on the new product is intended to outline our general product direction and it should not be relied on in making a purchasing decision. The information on the new product is for informational purposes only and may not be incorporated into any contract. The information on the new product is not a commitment, promise, or legal obligation to deliver any material, code or functionality. The development, release, and timing of any features or functionality described for our products remains at our sole discretion
- Rebased to Eclipse platform- New XPage & Custom Control
design elements- Fully integrated XPages
development environment
XPages Runtime
Domino Designer
- Performance/Stability Improvements- New editors
- New Extensibility APIs - NO CHARGE Designer Download !!!
• - Designer Framework Enhancements• - Improved Version Awareness
• - Customer Driven Tactical Improvements
• - Source Control Integration• - Improved JavaScript Editors
• - CSS Preview
2009
Soon
XPages Extension Library
9
Goals for XPages 2nd Birthday
● Ease modernization of existing applications● Make prototyping faster than ever
▬ Create a brand new cool custom application in minutes !
● Simplify moving from prototype to production-ready apps !
● Make the development of Domino Web applications easier and faster● Lower the entry cost of Domino Web development
▬ Provide an extended set of out-of-the-box artifacts that encapsulate many common patterns
10
Goals for XPages 2nd Birthday
● Ease modernization of existing applications● Make prototyping faster than ever
▬ Create a brand new cool custom application in minutes !
● Simplify moving from prototype to production-ready apps !
● Make the development of Domino Web applications easier and faster● Lower the entry cost of Domino Web development
▬ Provide an extended set of out-of-the-box artifacts that encapsulate many common patterns
The XPages Extension Library has a big role here!
11
What is the XPages Extension Library?● A set of Java plugins that extend XPages functionality● A collection of advanced, optimized controls and other XPages assets
– Provides rich web applications through a set of new Web 2.0 controls/behaviors
– Does not require new knowledge beyond core XPages● Fully implemented using the XPages Extensibility API
– Code source is available– Installs on top of Notes/Domino 8.5.2
● Integrates with Domino Designer● Works on both the client and the server, and provides Mobile support● Designed for performance from the ground-up● Used internally for the next generation of Domino templates
– Teamroom, Document Library...
12
What is the Extension Library ?
com.ibm.xsp.core com.ibm.xsp.extsn
com.ibm.xsp.domino com.ibm.xsp.rcp
com.ibm.xsp.extlib
S/T fragment One UI fragment
Mobile fragment
XPages Core Runtime Library
XPages Extension Library
XPages core runtime plugins ship with Notes/Domino
XPages extension library plugins
available via OpenNTF
What is the Extension Library ?
XSP Core Plugins
Ext Lib Plugins
● Help > About > Plugin Details (Notes Client or Domino Designer)
14
What is on OpenNTF.Org ?● One project is available
● The binary plug-ins, ready to install as an update site● A sample database showing the features in action● PDF documentation
● https://extlib.openntf.org● The source code is available from a Subversion Server
– https://svn-166.openntf.org/svn/xpages
XSP Extension library packaged as a zip
Regular versioned releases
15
What is Currently Available and Where?● The Extension Library is currently under development
– Not supported by IBM, supported by the community● Watch this space - new proposal under discussion...
– Code checked-in can change without notice - Open Source – Look and feel can also change
● A project is available on openNTF, which comprises– A compiled version of the library, as an Eclipse update site
● Needs more optimization on the Dojo side (custom build)– A demo database showing the components in action– A documentation is a work in progress and is provided as a PDF file– A Subversion repository containing the full source code
● Read only access unless more is requested. We have to limit the committers and go through code reviews
16
What can YOU do with the Extension Library?
● Start to understand and experiment with these new capabilities– You can already use the library within your applications, just be aware that
this is under development and can change over time● Report early feedback in order to influence the design of any given component● Inspect the source code to better understand the XPages Extensibility API● Get Involved! Contribute ...
– Ideas– Components– Fixes– Documentation
17
Agenda
● IntroductionIntroduction● XPages & The XPages Extension LibraryXPages & The XPages Extension Library● An Overview of Extension Library Controls/Assets● Field Study – An Application built using XSP Ext LibField Study – An Application built using XSP Ext Lib● The Extension Library & The Road To VulcanThe Extension Library & The Road To Vulcan● XSP Extensibility – Do It Yourself!XSP Extensibility – Do It Yourself!● FAQsFAQs● Your Questions!Your Questions!
18
Using Extension Library ● Start with the demo application - XPagesExt.nsf
– Enhanced Dojo Control/Event Integration– Alternative View Controls– REST Services– iNotes Calendar Support– Predefined Managed Beans– Application Layout – Cross Portfolio Integration... and much more!
19
Extended Editing Context
In Context Editing
Modal Dialog
Tooltip Dialog
Dynamic Tabbed Interface
● Beyond the traditional web form/submit/navigate pattern
● Editing the data “In Context”● Provide various flavors of dialogs
20
Dynamic Pages
● Make the content of a page dynamic● Parts of the page are discarded/reconstructed on demand● The user never leaves the current page● Very efficient runtime behavior● The context is kept using the URL hash technique● Makes it “bookmarkable”, and enables the back button
21
Value and Name Pickers● Select data from any data source● Domino view, Address Book, Managed bean..● Integrated with the standard TypeAhead component● Pluggable UI for high degree of customization
22
User Actions Through Outlines/Menus
● Provide a generic way for building action bars● Hierarchical navigators, accordions, pop-up menus,
trees...● Content can be static (defined in the page), dynamic
(retrieved from a data source) or a mix of both.● Easy mapping to actions (client and/or server side)
23
New Dojo Controls for enhanced User Experience
● Leveraging the Dojo form controls● Extended set of input controls● Spinner, sliders,...● Dojo client side validation enabled● New Dojo containers for high user interactivity● Tabbed panels, layout...
24
Interactive Views● View content rendered in a scrollable grid● Either the Dojo grid or the iNotes virtual list, depending on the
need● iNotes virtual list supports categorization, document hierarchy...● Dojo grid supports editing and is not tied to Views● Data is accessed using REST services provided by the XPages● Custom columns can be computed, and events handled● Documents can also be updated for the column pointing to fields
25
New View Control with Custom Layout● Easy data binding to view data● Custom layout of the expandable detail section● A new managed bean keeps the view context (current page,
expanded rows...)
26
Getting Productive – Quickly!
From that
To this
● XPages simplifies the creation of a new application but there is a gap between the first shot and a full featured, slick application
● People often doesn't know where to start !● Requires a large amount of work to build the main application layout (code,
CSS...), the navigation mechanism, selection handling ...
27
Application Layout
● Abstract the main characteristics of an application into a set of parameters● Configure using Domino Designer● The XPages runtime renders the final application based on the layout
definition:● The abstraction does not preclude how the app will be finally rendered –
Different renderers could be used● Handles all the low level details
– e.g. displaying a pop-up menu, maintaining some current page context...
28
OneUI Application Layout● Get a running OneUI application in less than 5 minutes!● Fully customizable OneUI rendering● Abstracts all the OneUI application parts● Can even be customized by providing an inherited renderer● Get ready for the upcoming Vulcan look and feel
29
Predefined Managed Beans
● Get easy access to common data● Current user name, email...
30
Creating REST Services● Defines a REST service architecture
▬ Definition of parameterizable REST service engines▬ Created as a hierarchy of reusable, customizable services▬ Independent from XPages: can be triggered from a servlet▬ Multiple possible renderings: XML, JSON, binary...
● An XPages component can have 2 phases:▬ It renders HTML during the render phase▬ It can render other kind of data on postback request▬ Identified by a path info in the URL, or a component client id
● High level of security: ● View columns/field can be hidden, ● postback can be restricted to the pages running the
service...
31
XPages REST Service Component
● A new XPages component instantiates a REST service engine▬ Delegates to the engine on postback calls▬ Renders a Dojo store that connects to the service
● Many services are available▬ Domino View, Document, Value picker...▬ Can be consumed by client controls, like Dojo grid
32
Calling Server Code using JSON RPC
● JSON RPC allows a client to call methods running on the server– A client JavaScript object exposes methods that call a service– The server provides the implementation of the method
● The Extension Library provides an engine that can be triggered from a servlet or an XPages component
● An XPage component makes it easier
– Generates the client side JavaScript object that connects back to the server
– Uses JavaScript on the server for the method implementation● Allows complex JavaScript objects to be passed as parameters
33
Access to Calendar Views● Visualize calendar Notes/Domino views● Add CRUD operations through custom forms
34
Lotus Sametime Integration
● Sametime awareness rendering
35
Lotus Connections Integration
● Popup card
● Inline Business card
36
Agenda
● IntroductionIntroduction● XPages & The XPages Extension LibraryXPages & The XPages Extension Library● An Overview of Extension Library Controls/AssetsAn Overview of Extension Library Controls/Assets● Field Study – An Application built using XSP Ext Lib● The Extension Library & The Road To VulcanThe Extension Library & The Road To Vulcan● XSP Extensibility – Do It Yourself!XSP Extensibility – Do It Yourself!● FAQsFAQs● Your Questions!Your Questions!
37
The Team Room ● Next Gen Domino Team Room Template built using Ext Lib● Currently planned for internal deployment by IBM CIO office● Available for download on OpenNTF.Org
38
TeamRoom Redesign Features
● Using the OneUI Application Layout– Consistent with other Lotus applications. Title bar at the top, distinctive navigation
on the left.
● The new “Home” page– Showing Recent Activities; a “Project Vulcan”-like feed of recent changes– Using a Tag Cloud for easier identification of the most used categories.
● All Documents using a XPages Discussion-like UI– The code in the Discussion template was improved and extracted to a
drag-and-drop control in the ExtLib, for ease of reuse.– Abstracts of the body text available in the view.
● Thread view page based on the OneUI “Comment in a Forum” component– In-context editing in the Thread view, including response creation/editing.
– With some refinements to better fit with Domino® views.– Again, extracted to a control for ease of re-use.
39
TeamRoom Redesign Features (cont...)● Select View and Filter mechanism
– To simplify the UI design, uses multiple views of the same data on the same page, and provides a consistent UI for filtering categorized views to a specific category.
– Implementation uses the ExtLib Dynamic Content control, for switching between different content at a location in the page
● Simplification of the New / Edit Main Document UI
– Makes the required and most commonly used fields more prominent.
– Using ExtLib controls for selecting and displaying Reviewer lists.
● An XPages Calendar View control
– Used to display in-application calendar giving dates and times of team meetings, events, review due-dates etc.
– Single-click switching to day-at-a-glance, week, month, year modes
– Was not previously available, a great addition to the ExtLib
– Client side support for Drag 'n Drop, Delete, Double-Click edit
40
Team Room Redesign Features ● Members view and Topic views with User thumbnail photos
– As shown in Lotusphere Opening General Session! – The ExtLib gives a unified API for user information, including
thumbnail photos. – The TeamRoom is using photos stored in the NSF.
● Member creation using Name Picker control – ExtLib control with directory integration
● Members view using multi-column view control configuration.● Team Setup partly moved to in-context options in the other pages● Pager state restoration
– When you click into a doc and then return to the view, the redisplayed view remembers the page number.
41
Agenda
● IntroductionIntroduction● XPages & The XPages Extension LibraryXPages & The XPages Extension Library● An Overview of Extension Library Controls/AssetsAn Overview of Extension Library Controls/Assets● Field Study – An Application built using XSP Ext LibField Study – An Application built using XSP Ext Lib● The Extension Library & The Road To VulcanThe Extension Library & The Road To Vulcan● XSP Extensibility – Do It Yourself!● FAQsFAQs● Your Questions!Your Questions!
42
Building Extension Library Controls● Some Java experience a pre-req ...
– But not much for simple components ● A 3 Step Process
– Create an xsp-configuration file to declare the component, properties etc– Create a JSF UIComponent class to implement props, manage state etc – Create a renderer class to emit markup for the target platform
● Remember that UI Controls are just one type of Ext Lib asset
– You also have non-visual controls, data sources, actions etc.● The process is documented in Mastering XPages – Chapter 12
– Sample UISpinner control is implemented by way of example
43
Ext Lib FAQs
● Does Extension Library run on the server and the client?– Yes
● Will the new TeamRoom and DocLib templates ship with Notes/Domino 8.5.3?– No
● How do I deploy the Extension Library ?– Server: Expand update site and copy to <domino_data_folder>
● domino\data\domino\workspace\applications\eclipse– Client/Designer - Install update site using File > Install menu – New NSF deployment model under development ...
