Skip to content

Applet PR Files

Oleg edited this page Dec 9, 2019 · 19 revisions

The Nexus Bridge includes several Applet Physical Renderer (PR) files. You do not have to use these files. However, if you use these files, you will get:

  • ability to remove the server-side rendered HTML from the DOM. If you do not use these files, you will need to keep it hidden.

  • easier usage of the popup applets as the returned object (when promise is resolved) already contains the instances of the Nexus Bridge.

  • the performance improvements as some jQuery code redundant when you build your custom PR will not be invoked

There are two types of PRs coming with the Nexus Bridge:

So there are three approaches:

  • Do not use Applet PR files.

  • Use Applet PR for each used applet (view applets and popup applets). You can use either Light PR files or Dual PR file.

  • Use Applet PR files only for popup applets. You can use either Light PR files or Dual PR file.

Light PR files

Nexus Bridge Default Applet PR

NBDefaultAppletPR file defines three helper functions in prototype:

  • initializeNexus

  • destroyNexus

  • removeHTML

You do not need to modify this file.

These files do not support displayed jQuery UI; therefore, even it extends standard PhysicalRenderer, it could be used also for list applets.

NBDefaultAppletPR file could be applied without any modifications. However, in this case, your application should take care of initializing the instance of the Nexus Bridge and optionally of removing the server-side rendered HTML from the DOM.

Custom Applet PR Files

Use NBAppletPR file as an example of the PR file that you can deploy using Siebel Manifests. It extends the NBDefaultAppletPR, creates the instance of the Nexus Bridge, and removes server-side rendered HTML.

Modify this file per your needs.

Dual PR files

If you prefer to use the same applets for Siebel views and custom views and do not want use manifest expressions, you can use the Dual PR files.

  • Static Files (not supposed to be modified):

    • NBPR.js - defined the functions to be used both, in NBDefaultFormAppletPR.js and NBDefaultListAppletPR.js.

    • NBDefaultFormAppletPR.js - PR for form applet.

    • NBDefaultListAppletPR.js - PR for list applet.

  • The examples of Applet PR files:

    • NBFormAppletPR.js.

    • NBListAppletPR.js.

In these examples, if the value of this.isOpenUI is true, the fully function Open UI is displayed. And if the value is false, the light PR approach is applied. You can assign the expression to the this.isOpenUI according to your requirements, e.g. SiebelApp.S_App.GetActiveView().GetName().toUpperCase().indexOf('NEXUS') === -1, and call the helper functions (removeHtml, initializeNexus, destroyNexus) as needed.

Notes

Note: If the same applet used by the Standard view and Custom view, the PR could be loaded conditionally using Manifest Expressions that checks a condition, for example the current view name

Note: If you use the popup applets, consider loading the custom PR also for Application/Common (load issue after hard reload)

Clone this wiki locally