How to Add a Link to External App to the Module Menu

AVAILABLE SINCE VERSION 9.1

You can add a link to an external application to the Module menu.

The link is configured in Advanced Configuration Options. It opens a page with an iframe element that embeds another page with the application.

To configure a link to an external app:

1. Go to Administration > Configuration > Advanced Configuration Options.

2. Click Add.

3. In the Name field, specify the name of the option. It must have the following pattern: pfxExternalApp_LinkName

4. The Value field contains the definition of the link. Example:

   {
      "name":"PSPDesigner",
      "label":"Pricing Strategy Designer",
      "url":"https://developer.pricefx.eu/tools/pricing-strategies-blockly-unity/",
      "businessRole":"Pricing",
      "entryPoints":[
         {
            "hook":"menu_visual_configuration",
            "label":"Pricing Strategy Designer"
         },
         {
            "hook":"pricelists",
            "label":"Open Strategy Designer"
         },
         {
            "hook":"pricelistDetail",
            "label":"Open Strategy Designer",
            "inputs":[
               "pricelistId"
            ]
         }
      ]
   }

label – Defines the link as it appears in the Module menu.
url – The web address of the embedded application.

businessRole – The menu item will be displayed only to users who have this business role assigned.
entryPoints – Provide a list of possible entry points (hooks) where the app can hook itself. Each entry point needs to have the following information:
path – An identifier of the entry point provided by Unity or a list of points forming a path (in a menu and its sub-menus).
label – The label of the menu item, button, etc.
tooltip – Optional tooltip/help text displayed on/next to the menu item, button, etc.