Wednesday, August 1, 2012

Pull-to-Refresh with Sencha Touch NestedList

The NestedList widget in Sencha Touch is perfect for hierarchical navigation (tree structures).  Our solution repository
is just that, a database persistent file system.  Upon building our mobile application, this widget was a natural fit.
The NestedList is backed by a 'Store' - in our case I defined a Files store.  An AJAX call to our repository web service
returns a heap of XML, as much as I wish it to be JSON it's just not happening.  Not until SUGAR.  When SUGAR hits, we
have real REST services where I can specify the format I want it back in.  Until then I have XML and this Store really
seems to want JSON.  I wrote an xml2json converter, shown below.

Ext.define('PExt.json.XMLtoJSON', {

xml2Json : function(xml, isRoot) {

var jsonObj = {};

if (!isRoot) {
if (xml.nodeType == 1) {
jsonObj.file = {};
for (var i = 0; i < xml.attributes.length; i++) {
if (xml.attributes.item(i).nodeName == 'localized-name') {
jsonObj.file['localizedName'] = xml.attributes.item(i).nodeValue;
} else {
jsonObj.file[xml.attributes.item(i).nodeName] = xml.attributes.item(i).nodeValue;
}
}
} else if (xml.nodeType == 3) {
jsonObj = xml.nodeValue;
}
}

if (xml.hasChildNodes()) {
jsonObj.children = [];
for(var i = 0; i < xml.childNodes.length; i++) {
var child = xml.childNodes.item(i);
var visible = child.attributes['visible'].nodeValue;
if (visible === 'false') {
continue;
}
jsonObj.children.push(this.xml2Json(child, false));
}
}
return jsonObj;
}

});

It's not a generic converter, it cares about our repository/attributes it has.  But the beauty of it is that I get real
JSON that the Store can readily consume.  If only it were that easy, there are special attributes that the Store/NestedList
are looking for which we don't have.  Other attributes are provided as opposites, for example, the 'leaf' attribute the
NestedList is looking for is missing, we have an attribute to tell us if something is a folder (isDirectory).  The
solution, which was not at first obvious, was to define converters for each of the missing attributes.  These converters let us
write a function to perform any type of conversion or lookup to return whatever value we need.  For example:

 Ext.define('PentahoMobile.model.File', {
...
config: {
        fields: [
...
{name: 'leaf', type: 'boolean', mapping: 'file.isDirectory',
convert: function(value, record) {
// convert file.isDirectory into 'leaf'
// maybe check if a folder has children
...
}
},
]
}
...
});

After the store, mappings and converter function have been written, we have a NestedList which works against the
solution repository.  You can add markup to the HTML generated for each entry in the list, such as adding folder icons
or descriptions.

This all served its purpose quite well until our UX department asked about removing the refresh button in the toolbar
and doing the 'pull-to-refresh' that is becoming more common in mobile apps these days.  Fortunately, Sencha has such a
plugin, but I could not find any documentation on how to use it with a NestedList, only to the Ext.dataview.List.  After
a lot of reading and mostly trial/error I found a solution.  I had to 'use the source' in order to see how the NestedList
uses List internally, and maybe I could find some hint.

The key is a listConfig hidden within the config of the NestedList itself.  I basically used this config as if it were
literally the config for the internal List used by NestedList.  Thankfully this worked, after a few moments of wrestling
around with some improper refresh calls to my store I discovered that you can define your own refresh function for the
pull-to-refresh.  As a note for completeness, you can also override the text which displays when you pull/release the
control.  Here's the listConfig that I am using:

config: {
...
listConfig: {
plugins: [{
xclass: 'Ext.plugin.PullRefresh',
refreshFn: function(plugin) {
// refresh repository
}
 }]
},
...
}

Here is a screenshot of it in action.


Tuesday, April 17, 2012

Pentaho User Console now working with all REST services

Over the past week or so I've been busy rewriting parts of the Pentaho User Console (PUC aka Mantle) to talk with REST services and move away from GWT-RPC. The primary motivation to do this work was to make the system more accessible to system integrators and OEM developers.

I have broken MantleService into several logical REST end points.

Themes (/pentaho/api/theme)


A new service allowing you to list the available themes as well as set / get the current theme for the authenticated user.

User Settings (/pentaho/api/user-settings)


A general purpose user settings service API which lets you list settings (for the authenticated user) as well as get / set user settings.

Version (/pentaho/api/version)


Simple service to return the current product version and also provide a software updates list (if applicable).

System Refresh (/pentaho/api/system/refresh)


A collection of resource refresh/reload services for global actions, metadata, system settings, repository, mondrian and reporting.

User Console (/pentaho/api/mantle)


This was my dumping ground for services which I did not feel provided value to be separated into their own endpoint.  The service is able to return mantle settings (different than user settings), list mondrian cubes, and get/set the locale for the authenticated user.

This work has simplified the User Console from a development standpoint, we have less ivy dependencies and the debug configuration is much more simple. All of the services return XML or JSON (determined by request headers) except for the extremely simple services which just return a string (text/plain), such as getting the current theme. I had to change the client code in PUC to consume JSON rather than the convenience/luxury we had before with GWT-RPC. The approach I took was to create JSON overlay objects (which extend JavaScriptObject). These JSON overlays are returned from the JSON eval/parsing and we then re-gain all of the richness we once had, at the expense of rewriting our POJO mutators as JNI.

For example, in the simple case of themes, which have an id and a value we now have a JsTheme:

public class JsTheme extends JavaScriptObject {
  protected JsTheme() {
  }
  public final native String getId() /*-{ return this.id; }-*/; //
  public final native String getName() /*-{ return this.name; }-*/; //
}

Once we return a list of JsTheme from JSON, our GWT app can go on enjoying life pretty much the same way as before. As a point of completeness, here is how we return get the themes from the JSON string:

JsArray<JsTheme> themes = JsonUtils.safeEval(JsonUtils.escapeJsonForEval(response.getText()));

As of Friday, April 13, 2012 the entire use of GWT-RPC has been replaced with REST. Enjoy!

Monday, April 16, 2012

New modules in the Administration perspective



Thanks goes out to Ezequiel Cuellar for being my ghost writer for this post.

The Administration perspective just got more love from the Sugar team. In an effort to migrate all the functionality from the Enterprise Console into Sugar the following two administration modules have been created: Users/Roles and Email/SMTP Server.

The User/Roles new UI allows you to easy administer users by creating or editing them and change their password, you can also create new roles and assign them to a user either one by one or by performing a multi selection.



In a similar way the roles section allow you to assign users.



The Email/SMTP Server module allows you to administer the BI Platform internal email settings (email_config.xml), you can test your changes by sending test emails before saving them and it also features a new error notification mechanism.

Wednesday, February 29, 2012

Pentaho Admin/Enterprise Console in SUGAR

If you've grabbed a recent build of SUGAR you'll notice some obvious changes to the UI as well as a top-level directory structure which is totally missing. The "administration-console" (or "enterprise-console") folder has been removed. We are actively working to integrate PAC/PEC functionality in the Pentaho User Console as an Administration perspective.

The layout of the Administration perspective is defined in mantle.xul (pentaho/mantle/xul/mantle.xul). This will allow the possibility of changing the UI and/or removing UI elements. Presently, we have action-based security (ABS) and authentication (Pentaho/LDAP) implemented in this UI. In the upcoming weeks we'll be adding other missing parts from the admin console such as email/auditing.

Here's a recent screenshot of the Administration perspective:

How to Add New Admin Functionality

New functionality can be plugged into the admin perspective with a platform plugin. The plugin.xml of a platform plugin will have a XUL overlay section to add an item to the admin category tree. For example, if you want to add a new item to the "security" category you would do this to the plugin.xml:

<overlays>
    <overlay id="admin.perspective.overlay.ee" resourcebundle="content/my-admin/resources/messages/messages">
        <treechildren id="security">
            <treeitem command="mantleXulHandler.loadAdminContent('my-admin-panel', 'api/repos/myadmin/resources/my-admin.html')">
                <treerow>
                    <treecell label="${myadmin.label}" />
                </treerow>
            </treeitem>
        </treechildren>
    </overlay>
</overlays>

We are adding a new panel to the admin perspective with an ID of 'my-admin-panel' and we are specifying the location of the UI (by URL). At this point you have adding your content to the admin category tree. Just like any plugin, you can have back-end code in a JAR, eg my-admin/lib/my-admin-plugin.jar.
Even more interesting is the new capability of a platform plugin to easily register its REST services in the plugin.spring.xml. We're using Jersey (v1.12) for exposing these web services. For reference take a look at the echo-plugin.

Finishing the Job: JavaScript Integration

Whatever your choice of JavaScript library, you will be coexisting with PUC/admin perspective. While not required, you can improve the user experience by registering your UI for state changes, etc. To do this create an object with an id and activate/passivate methods. For example:

var myAdminPanel = {
    id : "my-admin-panel",
    activate : function() {
        refreshConfig();
    },
    passivate : function(passivateCompleteCallback) {
        if(isConfigDirty()) {
            passivateCallback = passivateCompleteCallback;
            dijit.byId("saveChangesDialog").show();
        } else {
            passivateCompleteCallback(true);
        }
    }
};

Now register this object with the admin perspective:
window.top.mantle_registerSysAdminPanel(myAdminPanel);

That's all there is too it, you will be notified when the user selects on/off of your panel so you can check for "dirty" and prompt for saving.

REST services

In order to support the new admin functionality added to PUC, we added several new REST services which might be generally useful to OEMs, integrators, and developers.

/pentaho/api/userrole/users
Using GET, will return a list of all users in the system.

/pentaho/api/userrole/roles
Using GET, will return a list of all runtime roles in the system.

/pentaho/api/userrole/roleAssignments
Using PUT, will set role bindings between roles and permissions (logical roles)

/pentaho/api/userrole/logicalRoleMap
Using GET, will return the list of roles and the permissions (logical roles) which are assigned to them

The following LDAP REST API calls are in the EE product

/pentaho/api/ldap/config/getAttributeValues
Using GET, returns all name/value pairs from applicationContext-security-ldap.properties, plus the current securityProvider

/pentaho/api/ldap/config/setAttributeValues
Using PUT, sets (merges) name/value pairs and saves them to applicationContext-security-ldap.properties as well as set the authentication type in pentaho-spring-beans.xml.

/pentaho/api/ldap/config/ldapTreeNodeChildren
Using GET, returns the list of

/pentaho/api/ldap/config/userTest
Using GET, simple test if a user can be found.

/pentaho/api/ldap/config/rolesTest
Using GET, tests if search for a user returns roleAttribute successfully.

/pentaho/api/ldap/config/userRolesTest
Using GET, will perform a populator test (check if granted authorities for the given user works)

/pentaho/api/ldap/config/providerTest