Conduit API
Case Study
ExternalMenu -> XML Specification
 
The "Dynamic_Menu" tag defines the external menu. The tags that the Dynamic_Menu may receive are described in the following table:
Tag Description Example
TYPE Indicates the type of external menu <TYPE>BUTTON_MENU</TYPE>
BUTTON Adds a button to the external menu which receives all of the button’s tags For the list of tags that Button receives, see Button below.
MENU Adds a menu to the external menu which receives all of the menu’s tags For the list of tags that Menu receives, see Menu below.
EXTERNAL_INTERVAL Defines the frequency (in minutes) between the "refreshes" of the external menu (optional) <EXTERNAL_INTERVAL>
60
</EXTERNAL_INTERVAL>

 
The "Button" tag defines the external menu’s button which is displayed on the toolbar. Clicking on the button will display the external menu. The possible tags that the button may receive are described in the following table:
Tag Description Example
DEFAULT_BUTTON_TEXT Text that appears on the menu button. Menu Button Caption
BUTTON_ICON_URL The URL containing the icon displayed on the button. Icon example
BUTTON_TOOLTIP The text that appears when the mouse hovers over the button. Button tooltip
WITH_DROPDOWN Indicates whether to use a dropdown button or spitted button <WITH_DROPDOWN>
TRUE
</WITH_DROPDOWN>

Example:
 
 
 
The "Separator" tag adds a separator between menu items within the external menu.
Example:
 
The "Data" tag defines the data which is displayed within the menu. The tags that the Data may receive are described in the following table:
Tag Description Example
TYPE The type of data which is displayed for this menu item <TYPE>LINK</TYPE>
OR
<TYPE>POP_HTML</TYPE>
LINK Link data type See LINK
POP_HTML Pop HTML data type launches a gadget from an external menu See POP_HTML

Example: Menu
 
 
The "Pop HTML" tag defines a pop window gadget menu item. The tags that POP_HTML may receive are described in the following table:
Tag Description Example
URL Link URL http://www.conduit.com/
WIDTH Width of the pop window (in pixels) -
HEIGHT Height of the pop window (in pixels) -

Example: Menu
 
The image below contains an example of XML code used to create an external menu:
Example: Menu
Here’s how different forms of implementing the XML inside the external menu will affect the
appearance of it
In case you have… You’ll get…
BUTTON with VALID DATA with NO MENU A button with no dropdown handle.
Clicking it will navigate to the link inside the DATA item.
BUTTON with VALID DATA and a VALID MENU A button alongside a dropdown handle.
Clicking the button will navigate to the link inside the
DATA item, and clicking the dropdown handle
(down-arrow) will open a drop-down menu.
BUTTON with NO DATA and a VALID MENU A dropdown.
Clicking it will open a drop-down menu.