Creating Online Help for CIM

The default CIM scripts ship with online help information. If you add your own custom scripts, you may want to provide assistance for users.

CIM help is provided in the form of a JS file, which contains a list of IDs that match CIM objects, and corresponding help text to be displayed when the user works with that object. The format is:

{"id":"CIMItemID","content":"Place your help text here"},

For example:

{"id":"AddOnSelectTask.addOns","content":"Select one or more of the listed
add-ons as part of your installation."},

The help file is located at <ATG9dir>/CIM/plugins/ProductConfig/helpContent.js. The IDs are automatically generated using standard formats for each item type. You can turn on debugging in the CIM GLOBAL.properties file to see help IDs displayed whenever you access the help.

For property file steps, the ID convention is to replace the dot in the filename with an underscore:

/Nucleus_path/filename_properties.propertyname

For example:

/atg/dynamo/Configuration_properties.httpPort

For a navigation step, the help ID format is:

For task, such as selecting from a list, the help ID format is:

taskID.propertyname.listItemID

For example:

DatasourcePropTask.databaseType.oracle

Some items you may want to add that would benefit from added online help are:

 
loading table of contents...