Page Extensions allow the use of JavaScript to customize the EngageIP AdminPortal interface.
Page Extensions can modify the AdminPortal to suit your needs, for instance:
Default check boxes to ON or OFF
Pre-populating text boxes, areas or drop down menus
Adding custom links or markup to pages
Displaying external Data or webpages through the use of an iFrame for example
The key to Page Extensions is that you do not have to modify the AdminPortal backend, instead you can add these small scripts within the AdminPortal interface which are preserved when upgrading EngageIP.
Limitations / Rules
Page extensions operate PER branded owner so if you have multiple branded owners you will need to add the page extension per branded owner
Javascript is powerful enough that you need to ensure the following:
Security is not compromised through its use
Performance is not degraded (which can happen if you have a large number of extensions operating on one AdminPortal page)
Browser compatibility should be kept intact and confirmed before deploying Page Extensions in production environments
Disclaimer
The page extensions linked to below are provided as examples only, ‘as is’ and are tested and working on new installations of EngageIP. These are to be used or customized at your own risk. Page Extensions may cause in-browser errors or may not function correctly if:
The adminportal interface has been customized
Other page extensions are in place and interfering
The browser is not fully supported based on the scripting used , i.e. JavaScript
Lists or column preferences in reports or lists are changed, sorted, or paginated. Please be sure to fully test any page extension added to your system
Adding a Page Extension
Page Extensions allow you to inject a piece of JavaScript code into any page rendered through EngageIP’s view engine. The code can interact with the client DOM directly, intercept other executing code or invoke custom code blocks that you have added to the system. Here are the steps to add a page extension:
Log into EngageIP as an adminstrator
Navigate to the Setup page
Under the Extensibility heading select Page Extensions
On the Page Extension listing, click Add
What the Fields Mean
Here is a sample listing of Page Extensions added to one system:
There are really only two fields here that we care about: Name and Page.
The Name is simply used to help you remember what the script does. It is a good practice to name this script in a way that makes it easy to locate the source file where you maintain your scripts under source control. In this example, a prefix (“Application” or “Ticket”) is used to help sort the page extensions and each entry could represent a separate script file under source control.
The Page is the target of your script. This is the page that the script will be added to, and the code will be available for execution on when that page is rendered.