JET 4.1 : How to Setup a Functional Application Architecture

This week I had some interesting Oracle JET discussions with a couple of developers at one of our customers. One of the things was regarding the inline use of CSS that I found in the Views of the Modules. I didn't think that made sense so, after asking, I was told that this was because they did not find a way to use specific CSS per module. The question was if it was possible to use one specific CSS per Module in an Oracle JET Application. Besides that I thought it might also be useful to put everything that belongs to a module in its own folder. That could help developers to get a better understanding of the structure of the application. Besides that it is more like the structure of Oracle JET Composite Components where also everything that belongs to that component is under one folder.

Obviously this should be possible by explicitly loading a CSS in the view of the module. Geertjan already blogged about it : The same goes for restructuring the JET application into a more functional architecture:

So nothing really new here, although it is a slightly different approach. Just writing up things here for my own reference. Feel free to use this if you like. In this post I will describe the implementation somewhat more detailed and have a working sample application available.

For this blogpost I used the simple application that can be create on with the Oracle JET CLI. I will show you the steps to go from that to the "alternate" architecture.

The goal is to have all files for one module in one specific folder. The structure is shown in the image below.

Organizing the View and ViewModels.

As you can see from the image, the structure is as follows:  /src/js/modules//
Obviously that mean that for each functional module you have to create a new folder. Not difficult.
Based on the application created with the JET CLI, we need a folder for 'about', 'customers', 'dashboard' and 'incidents'. After these are created, simply move the views and viewModels for each module to their "own" folder.

Next in order to for the application to properly work, there are 2 more changes to be made

  • In main.js change set the proper locations for the viewModels and views

  • In appController.js, change the router as follows:

Easy as that. It works great, and everything fits together.

When you run the application, it will run properly and you have all files related to one Module in one single folder. Which reminds me of the css files.

Organizing the CSS files.

This is easy once you have the folder structure in place. Simply place the css (if any) for the module in the folder and use a STYLE import to make it work:

If you do this for each module, you can even have the same styleClass in every module specific css, with, for instance, a different background color. If you don't need a module specific style, simply don't put the styleClass in the module's css. Just put it in the application specific one. The module will use that one if it does not have it's own version of the styleClass.
For three out of our for modules I added the .epf-home-panel to the 'module specific' css, each with it's own color.

For the 'About' module we don't have that styleClass in the module specific css, so that will use the styleClass as defined in the application specific CSS. That styleClass has the same name, and uses color purple. When you run the application, it will run properly, showing the proper styles, and you have all files related to one Module in one single folder.

That's all.  The sample code can be downloaded from my GIT repo.


Kristina Nicole said…
useful information.Thanks for sharing.

Magento Popup Builder Plugin download free.

Popular posts from this blog

ADF 12.1.3 : Implementing Default Table Filter Values

ADF 12.2.x : Conditional Showing Message Instead of List of Values Popup

ADF 11g Quicky 3 : Adding Error, Info and Warning messages