DialogsHelpInfo.Xml

This file is used by ConfigMgr to link user context (where the user is in the console) to associated help information in the ConfigMgr help file. The file is located in the following directory:

C:\Program Files\Microsoft Configuration Manager\AdminUI\XmlStorage\Other


It contains a list of DialogID's (class names of dialogs) and HelpIDs (GUIDs referring to a location in the SCCM Help file). The basic XML format is like this:

     <AllHelpInfo>
          <AllDialogsHelpInfo>
               <HelpInfo>
                    <DialogID>_your full class name for the dialog_</DialogID> 
                    <HelpID>_a GUID within the ConfigMgr help CHM file_</HelpID> 
               </HelpInfo>
          </AllDialogsHelpInfo>
     </AllHelpInfo>


Note: You cannot use this to add new help to the ConfigMgr-provided help buttons. The GUID used above must refer to an existing GUID within the ConfigMgr CHM file. When I create custom actions, I use the GUID associated with the task sequence editor in general (27b1bcd0-a0ac-4bbe-ae86-01c4bd052a4d).

If you do not supply a new HelpInfo element for a custom task sequence step, the admin console throws an exception when the user clicks on the Help button in the task sequence editor when your custom step is active. This is simply because ConfigMgr does not have a GUID linked to the assembly (DialogID) currently shown in the console.

For some sample code written to help auto-generate updates to this file during an installation, see the UpdateDialogsHelpInfo method in IntegrationKit.ObjectInstaller.cs

Related Links

Last edited Jan 23, 2009 at 11:11 PM by rhearn, version 1

Comments

No comments yet.