Customization

Client-Side API

The One.ext.page.PageManager class contains several functions that allow Developers to expose things like Widgets that the Administrator can utilize when constructing Pages. Below is a list of APIs, although you should check out the JS API Documentation for more detailed information and examples:

  • One.ext.page.PageManager.registerModelLinkQuery: Registers a query that the Administrator can use within the Query configuration field for the Model Link field type. [JS API Documentation]

  • One.ext.page.PageManager.registerPageComponent: Registers a Custom Widget (like a custom field) that the Administrator can drag and drop into a Page. [JS API Documentation]

  • One.ext.page.PageManager.registerReport: Registers a report that the Administrator can drag and drop into a Page. [JS API Documentation]

These functions must be called within a file that gets added to your module's build.jsb (such as a GlobalRegister.js file). They should not be called within any files under the /web/public/jsmodules/ directory.

Exposing Actions

The Administrator selects an Action for each editable Page within the Page Flow Editor, and those Actions are exposed by the Developer through Studio. For an Administrator to see an Action, the following should be set:

  • System of Control should be checked

  • Allow Ent Role Customization should be checked

  • The Administrator (and all Role Types that need to use the Action) should have permissions to execute it

Server-Side Listener

There is a com.transcendsys.platform.rest.PageFlowDetailResourceListener which you can register by calling com.transcendsys.platform.rest.PageFlowDetailResource.registerListener() .