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

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

Quick tip: Convert a number to String in EL

By
I just had a need to do this and a Google search didn't immediately turn up a solution. So I thought for a couple of minutes and came up with this: value="0#{numberVar}" This takes advantage of the way Java auto-converts objects to strings when doing a concatenation. So if your number is 13, Java EL turns this into new String("0"+13), which becomes "013". You can then strip off the leading zero or just parse the string back into a number.
Post a Comment
Read more

Project in Review - Part 3: What didn't work

By
Of course, not everything was an unmitigated success. I tried many things that didn't work out. Much of which I've removed and forgotten about, but a few things remain - either scarred into my psyche or woven too deeply to fix. What didn't work Storing my entire configuration in application.properties Using properties files is great. It let me get configuration out of a profile document and into something much easier to edit - particularly configuration that users will never see or maintain (and thus there is no need for an interface for). But I took it too far. The paths to the other databases are there, and that's good. But view aliases are also there, and that was a mistake. I already have a ViewDefinition enum that describes each view and all the information I need to know about it. I could have set view names there, but instead I'm reading them from the application config. I can change where a view is pointing without having to go into my code. Except of co
Post a Comment
Read more