The document provides an agenda for an upcoming presentation on taking XPages development to the next level. The presentation will cover topics like improving application responsiveness through client-side execution, using server-side JavaScript (SSJS) and JSON RPC, modifying component output, working with Java in XPages, and developing custom controls. The presenters Brad Balassaitis and Paul Calhoun are introduced and their backgrounds and areas of expertise are outlined.
Boost PC performance: How more available memory can improve productivity
MWLUG 2015 - AD114 Take Your XPages Development to the Next Level
1. AD114: Take Your XPages Development
to the Next Level
Brad Balassaitis, PSC
Paul T. Calhoun, Qdiligence LLC, NetNotes Solutions
Unlimited, Inc.
2. Brad Balassaitis
• Senior Consultant for PSC Group
• Certified Notes developer since R4
• 2014 and 2015 IBM Champion
• Speaker / Writer / Blogger (xcellerant.net)
3. Paul Calhoun
• I have been working with Lotus/IBM technologies for the past
25 years.
• I have been certified in both Administration and Development
on every major release of Notes/Domino since release 3.
• My focus has always been on training and enablement of
Administrators and Developers, but I also provide mentoring
and consulting services.
• Most recently as co-owner of QDiligence I have been focused on
supporting a hosted XPages solution for public companies that
need to gather data from their board of directors.
• When not working, my passion is spending all my spare time
with my awesomely wonderful grand-kids. (WARNING: I have
pictures ! Lots and Lots of Pictures !!)
10. JSON RPC
• Remote procedure call
– Client / server interaction
• Asynchronous (not blocking)
• Faster
– No page submission or refresh
• Simple
11. JSON RPC
• Optionally accept parameters
• Send response
• Optionally attach callback
• Did I mention it’s asynchronous?
• Caveats
– No knowledge of page changes*
– Changes made to in-memory document may not be preserved**
18. AJAX / Custom REST
• AJAX
– Asynchronously get or post data
– Display update when done
• Custom REST Service
– Process updates server-side
– Return response when done
– Requires R9 or newer Ext Lib (“custom” option not in 8.5.3 UP1)
20. Appearing More Responsive
• Use visual indicator (“Loading” image, progress bar, text)
– Let’s user know something is happening
– Prevents “elevator impatience”
23. Mixing Client & Server Side Logic
• Evaluated on server; result rendered into page source
• Component ID: #{id: }
– XPages Source:
alert('Generated ID: #{id:phoneNumber1}');
– RenderedOutput:
alert('Generated ID: view:_id1:_id2:_id3:phoneNumber1');
• Computed Logic:
– #{javascript: }
• Expression Language
– #{currentDocument.fieldName}
• Tip: Does not work in script libraries
– Evaluate on page and pass to script library function
27. Every “Component” added to an XPage has a
corresponding API
This API allows developers access to a
Components properties
All Components API’s are accessible via the
“Resources” tab in the
SSJS Editor
SSJS: Server Side JavaScript
SSJS
28. Double clicking the component in the reference window will
add the component to the script window and assign it a
variable name
Methods can then be called against those variable names.
SSJS
SSJS
30. SSJS – Using libraries
• Once you have been coding XPages a while
– Code Patterns will emerge
– Same code used over and over
– This is the universe telling you it’s time to evolve to using libraries
• Once the library is created
– It can be re-used easily in multiple applications.
– Over time you will develop your “standard” library
• A library added to the beginning of every application development
project
• One of the most common libraries needed / used is for
validation
SSJS
31. Create the library
• In Domino Designer
– Expand the Code section
– Select “Script Libraries
– Click “New Script Library” action
– Provide a Name
– Set Type
• Type CANNOT be
changed once library
is created
SSJS
32. SSJS Libraries are typically a
series of functions
• Create the functions that provide the functionality needed from
the calling XPage
• Libraries can have multiple functions defined
• Each function is callable separately from the XPage that includes
it.
SSJS
33. Add the Library to the XPage
• Open the XPage that will use the library
• On the Properties tab select “Resources”
• Click the “Add” button
• Choose “JavaScript Library…”
from the list
SSJS
34. Add library to XPage
• From the dialog
– Select the SSJS library to add to the XPage
SSJS
35. Call the functions of the Library
• Once the Library has been added to the XPage
– Any of the defined functions are callable from SSJS code editors
SSJS
36. Finally ALWAYS Do this
• User the ‘var’ statement to define variables
• Terminate your JavaScript (client AND server) with a semi-colon
;
• Use a return statement to return values (even if returning ‘null’)
var fName = getComponent("firstName1").getValue();
var mi = getComponent("middleInit1").getValue();
var lName = getComponent("lastName1").getValue();
if (mi == null) {
return fName + " " + lName
} else {
return fName + " " + mi + " " + lName
}
39. tagName
• Computed Field (xp:text) or Panel property
• Default is <span> (computed field) or <div> (panel)
• Choose from list or manually enter
40. Suppressing Control Output Tag
• disableOutputTag property
– Repeat – prevents <div> tag
– Panel – prevents <div> tag
– Computed Field – prevents any output
• Note: Cannot use control as partial refresh target
41. Specifying the <body> Class
• styleClass property of XPage
– Adds the class to the <body> tag
– <body class="myClass xspView tundra">
• styleClass property of Custom Control
– Adds a <div> with the class
42. Control Attributes
• Useful for adding attributes for HTML5 data-*, Bootstrap,
jQueryUI, etc
• attrs
– name=value pairs to pass through
– source:
1 <xp:inputText id="inputText1“> <xp:this.attrs>
2 <xp:attr name="myFirstAttribute" value="value1"></xp:attr>
3 <xp:attr name="mySecondAttribute" value="value2"></xp:attr>
4 </xp:this.attrs></xp:inputText>
– output:
<input type="text" id="view:inputText1"
name="view:inputText1" class="xspInputFieldEditBox"
myFirstAttribute="value1" mySecondAttribute="value2" >
43. attrs - Example
• dijit.TitlePane - HTML
• HTML – Declarative
1 <div id="div0" data-dojo-type="dijit/TitlePane" data-dojo-props="title: 'TitlePane'">
2 Declarative
3 </div>
46. Themes
• Implement application-wide changes
• Conditionally render stylesheets
1 <resources>
2 <script src="/ssjsMyLibrary.jss" clientSide="false"></script>
3 <styleSheet href="/myStylesheet.css"
rendered="#{javascript:context.getUserAgent().isFirefox()}">
4 </styleSheet>
5 </resources>
• isIE() does not work with IE11
– http://openntf.org/XSnippets.nsf/snippet.xsp?id=detect-ie-11-in-
xpages
47. Themes
• Style fields consistently
<!-- Set all inputs to bootstrap styling by adding the form-control class -->
1 <control>
2 <name>InputField.EditBox</name>
3 <property mode="concat">
4 <name>styleClass</name>
5 <value>form-control</value>
6 </property>
7 </control>
48. Converters
• Modify data display
• Several built-in
<xp:convertDateTime type="date"></xp:convertDateTime>
<xp:convertNumber type="currency" integerOnly="false”
currencySymbol="$“></xp:convertNumber>
<xp:convertMask mask="(###) ###-####"></xp:convertMask>
49. Custom Converters
• Modify data display (not the output tags) and storage
– data > converter > xp:customConverter
– SSJS
• getAsString() - modify data to display
• getAsObject() – modify data to store
• Both required; both receive a value argument to modify and
return
– Java
• http://tobysamples.wordpress.com/xpages-custom-converters-
change-the-data-change-the-world/
50. Custom Renderers
• Modify data and tags
• 1. Create Java class for renderer to extend existing class for
component
– Receives component argument– use to get value
• 2. Register the renderer in faces-config
• 3. Set the rendererType property of a control to the renderer
class
– Or, set it application-wide via theme
53. Java: Why?
• We won’t debate whether you should or should not learn Java.
– You should. Yesterday, today, tomorrow NOW !!!!)
• XPages is built upon a Java framework (JSF/JSP)
– Even if you NEVER write a single line of Java code, you are executing
Java code in the background
• The more you know about the framework(JSF/JSP) the better
you will understand how to bend the framework to your will !!
(insert evil laugh here)
• If you want to integrate XPages with non-Domino
data/architectures then most of the code to do so is
implemented in Java
– JDBC
– JSON
– XML
Java
55. Java Code in XPages
• Java code can not be added directly to an XPage
– This is largest barrier to entry for most developers
• Java code can be “called” from SSJS to execute java code
methods
• Therefore;
– Java code does NOT interact with the UI
– Data (variables) passed to the back end java code comes from data
input into the XPage and scope variables set prior to executing the
code
Java
56. Java code execution from XPages
• The primary design pattern for executing Java code from an
XPage is;
– Call java code from an “event”
• Like a buttons onClick() event
– Call an “XAgent”
Java
57. What is an XAgent?
• An XAgent is an XPage with the rendering turned off
– In Java terms, the XPage becomes a servlet
– This requires the developer to handle the request/response
– All of the code is in either the “beforeRenderResponse” or
“afterRenderResponse” event
• What is this good for?
– Many JavaScript frameworks require data sources that are only
accessible by URL
• An XAgent that returns JSon or XML can be used in conjunction with
JavaScript graphing, charting and grid components
– Incorporating Third Party Java Libraries
• JDBC
• APACHE POI
• Excel and Word Document processing
Java
58. Create an XAgent
• Create an XPage
– Set the “rendered” Property to false
– This disables the output stream
Java
59. Tip: Document the XAgent
• Document the XAgent where you would normally place content
Java
60. Code in the
beforeRenderResponse event
• The code in the beforeRenderResponse event will
– Import Java code if needed
– Get JSF components
– Set the response type
– Call methods of the Java
code
– Close the response object
Java
63. Custom Controls != Subforms
• Conditional display
– rendered property
• Custom properties = flexibility for reuse
• Combine with repeat controls for dynamic output
64. Custom Properties
• Provide ability to customize each instance
• Data types
• Property editors
• Optionally required
• Single or multi-valued
• Combine into groups
65. Getting Custom Control Props
• Within the Custom Control
– compositeData.propertyName
• Outside of the Custom Control (SSJS)
– Add an ID to the custom control instance
<xc:myCC propertyName="myValue" id="ccID"></xc:myCC>
– Access via getComponent()
getComponent('ccID').getPropertyMap().getProperty(‘propertyName');
• Outside of the Custom Control (Client-Side JavaScript)
"#{javascript:getComponent('ccID').getPropertyMap().getProperty('propertyName')}"
66. Setting Custom Control Props
• Within the Custom Control
compositeData.myProperty = 'newValue';
• Outside of the Custom Control
getComponent('ccID').getPropertyMap().setProperty(‘myProperty', 'newValue');
67. Default Property Values via Theme
• Use themeId
• Custom Control
<xp:view xmlns:xp="http://www.ibm.com/xsp/core" themeId="CC_ThemeID">
<xp:text escape="true" id=“myField1” value="#{javascript:return
compositeData.foo;}"></xp:text>
</xp:view>
• Theme
<control>
<name>CC_ThemeID</name>
<property>
<name>foo</name>
<value>bar</value>
</property>
</control>
68. Default Property Values via Theme
• Custom Control can have a themeId
• Each instance can have a themeId (but it has no effect)
• Property value defined in theme overrides value defined on
custom control instance
69. Custom Controls as Reusable Fields
• Dynamic field binding – design once and reuse!
– Cannot compute within EL, but can compute CC property to pass
• Steps
– 1. Add a custom property to custom control for fieldName
– 2. Add a field to the custom control and set value binding
dynamically via EL
<xp:inputText id=“myID”
value=“#{currentDocument[compositeData.fieldName]}”>
</xp:inputText>
– 3. On custom control instance, pass in name of field to use
<xc:ccMyControl fieldName=“myFieldName”></xc:ccMyControl>
• Example: Time picker on scheduling form
71. Resources
• Sample Data Generation Tool
– http://www.generatedata.com/
• JavaScript Code Beautifier
– http://jsbeautifier.org/
• Notes in Nine
– http://www.notesin9.com
– Episode Guide
• http://www.mindmeister.com/280533435/notesin9
• TLCC
– www.tlcc.com
72. Resources
• Head First Books
– Java
– JavaScript
– Programming
• xcellerant.net
– Brad’s Blog
• Gridx in XPages
• Dojo in XPages
• Data Views in XPages
• Much More !!!
75. Debugging Java XPages
• If XPages make calls to Java Code elements then that Java code
can be debugged using a similar process to debugging agents.
• In order to debug Java code called by an XPage add the
following lines to the notes.ini
– JavaEnableDebug=1
– JavaDebugOptions=transport=dt_socket,server=y,suspend=n,addres
s=<port to listen on>
• GOTCHA !!
– If the previous ports are enabled for java agent debugging then
“connecting” to the port above will never work
– Disable the Java Debug Ports and restart your Notes, Designer client
prior to debugging Java called from XPages
Debugging Tips
76. Debug Configuration
• Create a new Debug Configuration to “listen” on the port that
was set in the notes.ini file
• Preview the XPage to start the local web preview
• Start the debugger
Debugging Tips
77. Execute XPage action
• Set breakpoints in the java code to be debugged
• In the XPage in the browser
– Execute the action that will call the Java code
• If not already in the Debug perspective you will be prompted to
switch to that perspective
• Step through your code reviewing the variable values at each
breakpoint
• Clear breakpoints and resume to end
• Dis-connect from Debugger when done.
Debugging Tips
78. Switch to the Debug Perspective
• If not already in the Debug Perspective a dialog will open
prompting to switch to that perspective
– Choose “Yes”
– Optionally choose “Remember my decision” to suppress this dialog
from popping up every time.
Debugging Tips
80. Debugging
• The Code will stop at the first breakpoint
• From there you can…
– Inspect variables
– Step through the code using the icons
Debugging Tips
81. Stop the Debugger
• After the debugging session is complete the debugger is still
“listening” on the open port
• In the debug perspective make sure to “Disconnect” from the
listening port to turn debugging off
Debugging Tips
84. Conditional Server-Side Event
• Can have client-side and server-side event handlers on same
component event
• return false; from client-side event to prevent server-side event
execution
1 <xp:eventHandler event="onclick" submit="true"
refreshMode="complete">
2 <xp:this.script><![CDATA[
3 return confirm('Run the server-side event handler?');]]>
4 </xp:this.script>
5 <xp:this.action><![CDATA[
6 #{javascript:print ('Running server-side event handler');}
7 ]]></xp:this.action>
8 </xp:eventHandler>
• Note: If the client-side code displays a non-blocking prompt,
server-side event will not wait
85. Conditionally Render Event Handler
• Select <xp:eventHandler> tag in source and compute the
rendered property
• Example: Alphabet Bar
• Tip: Combine with conditional style class
86. Getting Value/ID from Component
• Example: onChange event – take action based on selected value
• this keyword returns an XspEventHandler
(com.ibm.xsp.component.xp.XspEventHandler)
• Component Value
– this.getParent().getValue()
• Component ID
– this.getParent.getId()
88. Event Parameters
• Send information to event handling code; can be computed
• Parameter vars available to reference directly in SSJS
1 <xp:eventHandler event="onclick" submit="true" refreshMode="complete">
2 <xp:this.parameters>
3 <xp:parameter name="myEventParam" value=
"#{javascript:return session.getEffectiveUserName();}">
4 </xp:parameter>
5 </xp:this.parameters>
6 <xp:this.action>
7 <![CDATA[#{javascript:print ('User: ' + myEventParam);}]]>
8 </xp:this.action>
9 </xp:eventHandler>
89. Run Client JS After Server JS
• onComplete property (select <xp:eventHandler> tag in source)
– Attaches a callback
1 <xp:button value="Label" id="button1">
2 <xp:eventHandler event="onclick" submit="true“ refreshMode="partial"
3 refreshId="myPanel” onComplete="console.log('onComplete');">
4 <xp:this.action><![CDATA[#{javascript:// Do Stuff}]]></xp:this.action>
5 </xp:eventHandler>
6 </xp:button>
• Use case – display growl-style message; trigger refresh on
component outside of target
• Note: Will not run if event performs full page refresh
• onStart and onError callbacks also available
90. Order of Client-Side Events
• 5 ways to run client JS on an event handler
– Client JS event script, onstart, oncomplete, onerror*, view.postScript
(SSJS)
– onstart, onerror, and oncomplete are callbacks related to the server-
side event
• Conditionally triggered based on event handler refresh mode
– Full Refresh – client script, view.postScript
– Partial Refresh – client script, onstart, view.postScript, oncomplete
– No Update – client script, onstart, oncomplete
– No Submission – client script
91. Add Event Handler to Component
• Use case: Computed Field (no event properties)
• Add an event to some other control; move <xp:eventHandler>
within control in page source
• Tip: Finish event logic before moving event handler
– Cannot properly edit within computed field component – will not add
CDATA block
• Tip: Style cursor as pointer when clickable
<xp:text escape="false" id="computedField1" tagName="h1"
value="#{javascript:return 'Computed Text';}“ style="cursor:pointer;" >
<xp:eventHandler event="onclick" submit="false">
<xp:this.script><![CDATA[console.log('Clicked computed text');]]>
</xp:this.script>
</xp:eventHandler>
</xp:text>
93. Dojo Modules
• Many more modules available on server
– Charting, animation, enhanced grid, etc.
• Dojo Module Resource (xp:dojoModule) adds a dojo.require() to
include module
• Example:
<xp:this.resources>
<xp:dojoModule name="dojo.fx"></xp:dojoModule>
</xp:this.resources>
• Output
<script type="text/javascript">dojo.require('dojo.fx')</script>
94. Use a Module not on the Server
• Dojo Module Path
– Used to make Dojo plugins available to XPages
– Specify location where additional Dojo files are located
– Examples: Gridx, dGrowl
<xp:dojoModulePath url="/gridx" prefix="gridx"></xp:dojoModulePath>
95. Dijits (Dojo Widgets)
• dojoType – automatically turns an element into a dijit
– Must match a Dojo module name
– parseOnLoad will parse and generate dijit
– May need to set dojoTheme to true for styling
• Dojo Attributes
– Define dijit properties
• dijit.byId() (not dojo.byId())
– Use “#{id: }” syntax
96. Dijit Example – Declarative HTML
• dijit.TitlePane
• HTML – Declarative
1 <div id="div0" data-dojo-type="dijit/TitlePane" data-dojo-props="title:
'TitlePane'">
2 Declarative
3 </div>
