KonaKart Logo Documentation
Search
Adding Custom Functionality to the Admin App

Adding Custom Functionality to the Admin App

From version 2.2.6.0 the Admin App allows you to define custom panels and custom buttons in defined areas, to allow you to extend the Admin App by adding your own administration functionality outside the standard Admin App.

Adding Panels

There are 10 custom panels that display a predefined URL in a frame. The urls are defined in the Configuration>>Custom Panel Config section of the Admin App and the labels of the panels can be changed by editing the message catalog. The panel links can be rendered visible / invisible by configuring the role based security. The session id of the logged in user is appended to the URL so that the custom application can control security using the Admin Engine API. The string appended to each url is similar to the following, except that the session id will be random:

sess=6596bd465a824bb9cdfa6080af07e02f

The urls defined in the admin app should always end in "?" or "&". For example:

http://www.mycustom.com/custom1.do?

or

http://www.mycustom.com/custom1.do?parm1=abc&

Each custom panel may have its own online help. The text for the online help is defined in the file AdminHelpMessages.properties under the keys, help.customPanel1 to help.customPanel10.

Adding Buttons

The buttons will call pre-defined urls and will normally pass some parameters to allow you to check security and/or operate on selected objects. The button labels are defined in the Configuration>>Admin App Configuration section of the Admin App and the buttons remain invisble until the button labels are set with some text. The buttons and parameters available are in the following panels:

  • Customer Panel

    • id - the customer id

    • sess - the session id of the admin user

  • Returned Products Panel

    • order_return_id - id of the OrderReturn object

    • order_id - id of the Order object

    • total_inc_tax - total amount of the Order

    • sess - session id

    • tx_id - gateway transaction