mwlug 2016 : ad117 : xpages & jquery datatables

AD 117

Xpages & jQuery DataTables

Simplifying View creation while maximizing functionality in XPage applications.

• Notes & Domino developer for 17-18 years– Focused on XPages for past 5-6 years

• As a consultant was able to work at some very interesting companies

• Currently a Senior Developer for Mutual Boiler Re– We are kind of a niche inside a niche

• First time speaker!• My blog: http://xpage.me• Twitter: @michaelgsmith

Michael G. Smith - About Me

• Introduction to DataTables– Try to cut through the fat and focus on the most useful stuff– This is not a comprehensive overview

• Roadmap to quickly surface view data in your Xpage apps– Brand new or existing apps

• Share my experiences and lessons learned– I learned a lot just working on this presentation!

• How to take everything and utilize it in an enterprise application– Scalability

• You should be able to walk away and utilize these concepts immediately– If I’ve done my job

Goals for this session

• What is DataTables?• Why DataTables?• Getting started with DataTables• Putting the “Data” in DataTables• The DataTables lifecycle• Advanced configuration• Domino View Management• Putting it all together

Agenda

• Simply defined, it is:– A client side framework/library– A jQuery plugin– It’s HUGE!

• It is NOT:– the XPages control

• From the DataTables online manual:The stated goal of DataTables is "To enhance the accessibility of data in HTML tables”.

• My definition:– A great tool for creating Domino-like rich views in XPage and web

applications

What is DataTables?

• Very easy to hit the ground running• Integrates well with Bootstrap• Further separates data from design• Became more and more impressed with it’s capabilities• “A” way, not “The” way• Extremely well documented through online reference material

and support forums– When using example code try to make sure it is from v 1.10 or later

• Excellent at handling data types• Great replacement for views and embedded views

– Embedded views on tabs – only load data when tab is clicked

Why DataTables?

• Adding files to your project– CDN– Locally (WebContent)– Package Manager (Bower/NPM)

• Dependencies– jQuery 1.7 or later

• My Demos– DataTables 1.10.2– jQuery 1.11.2

Getting started with DataTables

• Styling options– Default DataTables css– Bootstrap

• Requires a reduced DataTables css • Use the Bootstrap table classes when assigning classes to the table

markup – Other frameworks

• Foundation• jQuery UI

– Use the DataTables theme creator to match your UI– https://datatables.net/manual/styling/theme-creator

Getting started with DataTables (cont.)

• Add appropriate source files to your theme– Core DataTables

• DataTables CSS• jQuery • DataTables js

– Bootstrap• Bootstrap css• DataTables Bootstrap css• jQuery js• Bootstrap js• DataTables js

Getting started with DataTables (cont.)

Putting the “Data” in DataTables

• From the Docs:Data for a DataTable can essentially come from three different locations:– HTML - ideal for when your table already exists and has been

populated with data.– Javascript Array - used when your data exists in a Javascript array– An Ajax data source

• Let’s start with a simple xp:repeat

Putting the “Data” in DataTables

Putting the “Data” in DataTables (cont.)• Adding a DataTable to a xp:repeat

• Simple xp:repeat Demo

Putting the “Data” in DataTables (cont.)

• DataTables default configuration

Adding a DataTable to a xp:repeat (cont.)

• DataTables default configuration

Adding a DataTable to a xp:repeat (cont.)

• DataTables default configuration

Adding a DataTable to a xp:repeat (cont.)

• DataTables configuration options

Adding a DataTable to a xp:repeat (cont.)

• Demo – adding simple configuration

Adding a DataTable to a xp:repeat (cont.)

• Simply add classes to your table markup• From the DataTables reference:

Adding style to the xp:repeat

• By applying classes to the markup we turn this:

Adding style to the xp:repeat (cont.)

• Into this:

Adding style to the xp:repeat (cont.)

• In Bootstrap:

Adding style to the xp:repeat (cont.)

Creating a DataTable from REST data

• Use the “ajax” option to retrieve data:

Creating a DataTable from REST data

• DataTables expects:– Array of arrays

• Columns object must be defined or ..• Markup must contain thead with th/td cells for each data column

– Array of objects (JSON)• Columns object must be defined!

Creating a DataTable from REST data (cont.)

• Array of arrays– Defining the columns object

• Need one object per column• With no data field, the order of the objects must correspond to the

order of the returned data• Use the data field to match up objects with 0 based index of the row

array (order doesn’t matter)

Creating a DataTable from REST data (cont.)

• Array of arrays– Using markup

• Must have a thead element and a th or td for each column• Order matters

Creating a DataTable from REST data (cont.)

• Array of objects (JSON)– Columns object must be defined!

Creating a DataTable from REST data

• Array of objects (JSON)– Map the “data” field of the columns object to the appropriate field

in the returned JSON object

Creating a DataTable from REST data

• The most common ways to retrieve REST data in Domino:

Creating a DataTable from REST data (cont.)

• The most common ways to retrieve REST data in Domino:

• xeViewJsonService– Pros

• Easy to hit the ground running• Domino handles data serialization

– Cons• More difficult to fine tune the data returned (i.e. reduce payload size)

Creating a DataTable from REST data (cont.)

• The most common ways to retrieve REST data in Domino:

• xeCustomRestService– Pros

• More granular control• Easier to define the column definitions at the rest service

– Cons• Need to be aware of data types and make sure data is serialized

properly• Need to actually write the code that builds the data

Creating a DataTable from REST data (cont.)

• The most common ways to retrieve REST data in Domino:

• XAgent– Pros

• More granular control (even more?)• Easier to define the column definitions at the rest service

– Cons• Need to be aware of data types and make sure data is serialized

properly• Need to actually write the code that builds the data

Creating a DataTable from REST data (cont.)

• REST demo:

Creating a DataTable from REST data (cont.)

The DataTables Lifecycle

• Use callbacks to provide a “rich” view experience– initComplete()– drawCallback()– rowCallback()– createdRow()

• Similarities to the XPages lifecycle• Be cognizant of your users

– Don’t slow down user experience by adding too much client side processing

The DataTables “Lifecycle” (callbacks)

• Callback demo

The DataTables “Lifecycle” (callbacks) (cont.)

Advanced Configuration

• Adding click events– Use the “createdRow” or “rowCallback” callbacks

• DataTables docs say createdRow is more efficient• This *should* result in better browser performance, i.e. javascript

objects won’t be left behind when the DataTable is destroyed– Be aware when double clicking, click event is also fired unless the

timeout method is used• This is a browser issue, not DataTables

• Demo

Advanced Configuration

• Renderers– Possibly the most powerful aspect of DataTables– Executed whenever DataTables needs to get the data for a cell in the

column. – This function might be called multiple times, as DataTables will call it

for the different data types that it needs:• display• sorting • filtering

– Orthogonal Data• Each data point has the ability to take multiple forms

• Demo:

Advanced Configuration (cont.)

• Renderers

Advanced Configuration (cont.)

• Filtering programmatically– The real power of DataTables can be exploited through the use of

the API– Tables can be searched by row, column or globally across all data– Must call the draw() event after performing search

• Demo

Advanced Configuration (cont.)

• Filtering programmatically

Advanced Configuration (cont.)

• Filtering programmatically

Advanced Configuration (cont.)

• Lazy Loading– Grab additional data via REST and use DataTables api to insert rows

• Demo

Advanced Configuration

• Categorization– Not built in to DataTables but easy to add using the api and callbacks– Outdated, but sometimes still a requirement during the app

modernization process• Gently ease users into new tech by keeping some familiarity

• Demo

Advanced Configuration

• Reloading data– Avoid the dreaded “Can’t reinitialize DataTable” message

• When referencing your table be sure to use the same class it was instantiated with

– When data is reloaded current sort remains intact

Advanced Configuration

Putting it all together

• Manage your Domino views– Separation of data and functionality– Use views as strictly back end data containers

• Load em up with data!– Minimize “click to sort” columns to reduce view index size– Domino ISO-8601 dates can be problematic if not careful

• Ex. 1957-03-14T21:54:30Z• My preference: creating a text column

– Strip out unnecessary columns, i.e. colors, icons• May need to create REST only views in coexistence scenarios

– Fewer views• No more specialized views with only a handful of columns• Utilize categories and keys and ftsearch

Putting it all together

• Managing your Domino views (cont.)– Make sure columns have an itemName !!!

Putting it all together (cont.)

• In order to apply all of this to an enterprise application we need to be able to “connect” the data to the configurations

• My solution: REST View Manager– Configure DataTable configurations in a browser and store json in a

Notes Document• Minimizes need to touch designs• Makes view customization by users much easier to implement and

manage– Use a custom control that can be dragged and dropped into any

Xpage or custom control and configured through custom properties– Opens the door to allowing users to customize their views

Putting it all together (cont.)

• REST View Manager

Putting it all together (cont.)

• REST View Manager

Putting it all together (cont.)

nsf

REST configuration created client side

Xpage

DataTableClient Side

Serverside

REST ServiceRead view config

Read view config

GET data

Save view config

• The Grand Finale Demo!– Create a new REST configuration– Create an Xpage– Add the ccRestView custom control to the xpage– Configure the ccRestView custom control with new REST

configuration– Revel in view data!

Putting it all together (cont.)

• http://datatables.net• Extensions• Error handling• DataTables 1.10.6

– Uses AMD loader

Additional Topics