AX1157

Help command

Use the Help command to open the Axiom Software Help files.

Can be used in

  • Task panes
  • Ribbon tabs

This command is included in the default AxiomMain.AXL ribbon tab, as part of the Help group.

When the Help command is selected from the Command Library as the shortcut target, it displays as command://Help or command://HelpCommandAdapter (legacy syntax).

Shortcut parameters

This command uses the following shortcut parameters:

Item Description
Help Topic

Optional. The ID of a specific help topic. If a topic ID is specified, that help topic is opened.

For the general (platform) Axiom Software help file, the topic ID is the file name of the topic, minus the file extension. For example, if the file name for the topic is "Batch.htm", then you would enter "Batch" as the topic ID. The file name for each topic can be found in the lower right-hand corner of the topic, in the topic footer. Product help files may use different IDs.

If the topic ID is omitted, or if the specified ID cannot be found in the target help system, the default home page for the target help system is opened.

Help Type

Optional. The type of help system to open. You can specify the following:

  • Desktop (default): Opens the Desktop Client help file for the Axiom Software platform.
  • Web: Opens the Web Client help file for the Axiom Software platform.
  • Product: Opens a product help file, as specified in the Product parameter.

Product

The name of an Axiom Software product, such as Capital Planning or Budget Planning. This is required if Product is specified as the Help Type, and ignored otherwise.

The product name must exactly match the installed feature name.

The command automatically opens the help file for the current platform version or product version.

Visibility

This command does not depend on any security permissions or on any particular context. Items using this command will always be visible.