KBA-01543: Adding custom entries to the Spitfire Site Options (drop-down) menu

Question:

How do I add choices to the drop-down menu that appears next to my name at the top of the dashboard?

Answer:

Spitfire‘s Site Options menu can be configured using ICTool and the SiteConfig.XML file.

In ICTool, select Edit SiteConfig.xml from the Tools menu.
Copy the text shown in the section below and paste it above </PageConfig>.
Make changes as desired. Be mindful of using unformatted single quotes (‘) where appropriate.
Save your changes (File | Save) then close the window.
Click the Update/Publish Configuration button on the Finish tab of ICTool to make your changes live. Your custom entry will appear on the Site Options menu.

What to paste into SiteConfig.xml

Note: when copying this text, make sure to get all of the <HRef> line, which ends with </HRef>.

<DropDownMenuItems>
 <ddMenuID>DesktopBannerMenu</ddMenuID>
 <CommandName>CZCustomReports</CommandName>
 <Enabled>1</Enabled>
 <IconImageUrl>~/images/report.gif</IconImageUrl>
 <ItemText>Custom Reports...</ItemText>
 <HRef>javascript:popWin('http://www.SpitfireManagement.com/','mytabid',1000,500);</HRef>
 <UCModule>PAGE</UCModule>
 <UCFunction>sfReportViewer.aspx</UCFunction>
 <NeedPermits>1</NeedPermits>
 <MenuSeq>142</MenuSeq>
 <HideifDisabled>0</HideifDisabled>
</DropDownMenuItems>

Where

ddMenuID is not changed. (It identifies the menu being customized.)
CommandName is either one of the predefined command names (see below) or something starting with CZ, such as CZMySiteLink. Every menu item must have a unique Command Name.
Enabled is 1.
IconImageUrl is the path to the menu choices icon. This can be http:// with a full URL, or ~/ for something within the site (typically, ~/images/something.gif.)
ItemText is the text for the choice.
HRef is the command run. Typically this is in the form javascript:popWin(‘url‘,‘tabname‘,w,h).
- url is the URL to ‘open‘ in tabname
  - Remember to URL-encode special characters, for example,
    - for %, use %2f
    - for &, use &
    - for >, use >
    - for <, use <
- tabname is the name for the new tab.
- w and h are the size used by IE.
UCModule is part of the permission reference, such as PAGE, PART, DOC, SYS, LIST, CSTM. It can be omitted.
UCFunction is the function name for permission to see this chioce (see xsfUCFunction). It can be omitted.
NeedPermits is the total permission required. 0 = not permission sensitive, 1 = read/allow, 2 = insert, etc.
MenuSeq is the sequence position in the drop down menu. See below. Use a number ending in anything except 0, 5, or 9.
HideIfDisabled is 0 if the menu choice should be shown disabled or 1 if it should be completely removed when the user does not have the specified permission.

Distributed command names:

DTCreateProj (Seq = 80). Displays as Create Project
DTCreateDoc (Seq = 90). Displays as Create Document…
DTSEP099 (Seq = 99). Displays as a line.
DTRecentDocs (Seq = 120). Displays as Recent Documents
DTReportMenu (Seq = 150). Displays as Report Browser…
DTSEP199 (Seq = 199). Displays as a line.
DTContactPop (Seq 620). Displays as My Contact Detail
DTDiag (Seq = 640). Displays as Diagnostic Tools
DTSEP699 (Seq = 699). Displays as a line.
DTHelp (Seq = 800). Displays as Help.

KBA-01543: Adding custom entries to the Spitfire Site Options (drop-down) menu

Question:

Answer:

What to paste into SiteConfig.xml

Additional Comments: