Skip to main content

Move all your code into script libraries

By
Here is a little tip and the reason behind it: If you have any code on an XPage, replace it with a single function call and move the code to a script library.

Example:
If you have code like this on your XPage
<xp:this.querySaveDocument><![CDATA[#{javascript: var foo = "hi";var bar="there";return (foo==bar?True:False);}]]></xp:this.querySaveDocument>
Replace it with this
<xp:this.querySaveDocument><![CDATA[#{javascript: return foobarQuerySave();}]]></xp:this.querySaveDocument>
And create and include a script library with this
function foobarQuerySave() {   var foo = "hi";   var bar = "there";   return (foo==bar?True:False);}
Even if there is no code there currently, if you think there may ever be a need for it you should add a stub function that just returns true and call it.

Here's why:

First, it consolidates all of the code so there is never any question where to find it.

Second, in an environment with multiple developers, you can assign out different sections of code and each person can own a single script library and there will not be any replication conflicts when two people are working on their code at once.

Third, in an environment that requires builds to only be done on the server (when you have multiple developers working on local replicas rather than the server copy), changing a script library does not require a rebuild, but changing an XPage does.

Comments

Post a Comment

Popular posts from this blog

Rows per page selection: Part 1

By
I was asked to create a control that would allow users to select the number of rows per page in a view/repeat control (the application uses both). It seemed simple at first, but I ran into a few issues that I thought I'd share the solutions to. First, lets start at the beginning. I went through the relevant design elements and set row="#{viewScope.tableRows}" , and I created an xp:comboBox with value="#{viewScope.tableRows}" and added items for 20, 30, 50, and 100, and I assigned it an onChange event handler that did a partial execution and partial refresh of a div containing the combo box, pager and the table. Then I started fixing all the problems. Problem 1: The combobox value was a string, but the rows parameter requires an integer. This was causing IllegalArgumentException / java.lang.String incompatible with java.lang.Integer. I added a NumberConverter, but this only slightly changed the exception message to java.lang.Long incompatible with java.lang....
Post a Comment
Read more

Pass data between XPages and existing LS scripts

By
I'm working on modernizing a fairly hefty application with a lot of existing script libraries which we want to leverage within the XPages environment. Here is a technique that works very well. First, create an in-memory document in SSJS. We can set any input values needed for the back end. Then we pass that document to a LS Agent which can work it's magic using the values set in SSJS and use the same document to return values back to the XPage. Here is how it works in detail:
6 comments
Read more

XPages Application Framework (Part 1?)

By
Note: I changed projects and priorities after my last POI article, resulting in a long hiatus. I anticipate using that framework on my current project and will likely refine and complete my related article series. For the past several months, I've been fortunate enough to lead a project overhaul from traditional Domino Webapp to XPages. I had a few goals in mind, but the top three were integrating Bootstrap, embracing MVC principles, and eliminating all SSJS . I imagine the motivation for Bootstrap integration is self-explanatory. There is an OpenNTF project out there called Bootstrap4XPages. I didn't use that for a number of reasons - the main being a policy in the current environment. But you may ask yourself (if you didn't follow that link), why so much hatred for SSJS? I have a litany of reasons. It impacts readability of the XPage source; it hurts maintainability when logic is scattered across dozens of XPages, custom controls, and script libraries; it mixes log...
Post a Comment
Read more