VAP Documentation

Documentation of VAP procedures, short codes and Custom Properties.

Custom Properties is an editable propertiy that extends functionality to a VAP Navigation Item. Access to the Custom Properties dialog is found in the Edit Navigation Item pane of the VAP (see screenshot below). This pane is accessed by clicking on the title of a Navigation Item in the Navigation Tree.

Screenshot

Custom Properties Location Location of Custom Properties dialog in VAP.

Custom Properties Dialog Box Screenshot of Custom Properties Dialog.

List of Names and Values

The following is a list of known Custom Properties and thier possible values.

Page Related

Name Values Purpose
cssBodyClass rolepage, subpage (optional: MUTUAL_FUND, ETF, UIT, MONEY_MARKET, CASH, VI_ANNUITIES, CLOSED_END, SMA, INTC_FUND) Dictates the body class for the page
channel channel name Used when converting from the selected menu item to its fully qualified channel. Inverse to the title property. When using channel, the menu item's title is displayed while the channel's value is used in the WEM channel path. When using title, the menu item's title is used in the WEM channel path while the title's value is displayed. example value (Products and Performance) if this property is set, it will be used to match the channel setup in WEM.
title title text Sets custom title text in header and breadcrumb
subtitle subtitle text Sets custom subtitle text underneath header
showProspectusInGlobalFooter true Displays link to prospectus in the footer
showMoneyMarketHoldings true Displays link to Money Market Holdings in the footer
metaDesc Meta Description Adds a Meta Description for the page
metaKey Meta Keywords Adds Meta Keywords to the page

Global Navigation

Name Values Purpose
legal-entity,
legal-entity-(audience name)
Legal Entity text Dictates legal entity text that appears in top left of page
role Advisor, Investor, RIA, Institutions, DC Dictates what role the navigation item appears for. Only needed for top level navigation. Children navigation will inherit this from the parent.
target-dialog ID of dialog that is to be opened by Global Nav link. Allows specific dialog to be opened by navigation item
icon icon-white-(icon-name) Dictates icon to be shown to left of navigation item

Top Navigation

Name Values Purpose
isLocked true, false Displays lock icon and functionality to navigation menu item
hidden true, false Hides the navigation item for the top navigation while allowing a user to still acces it via a link, and displays the correct breadcrumb.
role Advisor, Investor, RIA, Institutions, DC Dictates what role the navigation item appears for
navLiClass oe_heading, oe_heading long, last oe_heading applies the sub-header styles, oe_heading long allows a heading to span two columns, and last removes the bottom divider of the navigation item
navBreak true, false Creates a break in the column and pushes the remaining navigation content to the next column
navContentId GUID Allows linkage to content that does not have a friendly ID
target-dialog ID of dialog that is to be opened by Global Nav link. Allows specific dialog to be opened by navigation item
icon icon-white-(icon-name) Dictates icon to be shown to left of navigation item

Custom Grid

Name Values Purpose
cssFile Relative path of file Allows custom css file, overriding default css file.
jsFile Relative path of file Allows custom js file, overriding default js file.