Input Arguments

Function / Meaning

In

Please see the common parameters/arguments.

Object

The 'Object' parameter object can be:
- MetaNode moniker (help for the catalog/view opened only from this WF Node)
- MetaWorkflow (help for the catalog/view opened from any node in this WF)
- View
- Catalog
- Generic BO Type
- Technical Object Type Name
- Fixed Window id string
- Business View

Please see also the description on this page.

Output Arguments

Function / Meaning

Out

Please see the common parameters/arguments.

allHelpKeys

A collection of all the existing Help Topics (parsed from the help installation).

helpDir

A directory with help files for the current language.

helpIndex

A full path for the 'index.htm' file as defined in 'Global Settings' for the current language.

mainHelpTopics

A collection of Help Topics on the top level of the help hierarchy.

When the input parametr 'Object' is specified, then meaning of following output parameters is:

helpKeyAssignments

A collection of Help Topic Assignment objects which are linking the specified object.

assignedHelpKeys

A collection of Help Topic objects referenced by assignment objects from the helpKeyAssignments collection.

unassignedHelpKeys

A collection of other Help Topic objects which are not referenced directly to the specified object.

parentHelpKeyAssignments

A collection of Help Topic Assignment objects for parent hierarchical objects of the specified object (e.g. the assignments for the BO Type of the catalog and Business View are returned for the Catalog object).

Then the input parameter object is not specified, then:

helpKeyAssignments

A collection of all Help Topic Assignment objects.

assignedHelpKeys

A collection of Help Topic objects referenced by assignment objects from helpKeyAssignments collection.

unassignedHelpKeys

A collection of Help Topic objects which are not assigned.

parentHelpKeyAssignments

None.