The user-defined help for objects and properties has improved

Users can define their own help for object types, and property types. This functionality allows users to find out: what each object represents, what sort of input is appropriate to that object, or anything else you want your users to know about.

Corporate Modeler has included this functionality for some time, but this information is now presented to your users in a new, more convenient way.

Object help:

Object help tells your users what an object type (such as Process or Entity) represents, and therefore guides them as to what the object actually means. This information is displayed: 1. When you select an object on a diagram and right-click What's This?, 2. When you open the properties dialog for an object and click the help button.

Property help:

This improvement is significant!

Property help helps your users to understand what each property on the properties dialog is for, and what sort of information they should be adding to the field (letters, numbers, etc). This information is displayed when you hover your mouse over the name of any property on the dialog.

How to... Create object help

Object help tells your users what an object type (such as Process or Entity) represents, and therefore guides them as to what the object actually means. You can write your own help text for both user-defined and predefined design objects in the design view of Model Explorer.

This help information will be displayed when any user right-clicks an Object Type and clicks 'What's This..?', or when they click the Help button in the Object Properties dialog.

In Model Explorer's design view:

  1. In the left-hand tree, navigate to and select the model that contains the object you want to create help for.

  2. In the right-hand list, double-click the object that you want to write help for.

  3. The object type's properties dialog opens.

  4. Click the Help tab.

  5. Enter your help text.

  6. Click OK.

  7. Help has now been created or edited for this object.

How to... Create property help

Property help helps your users to understand what each property on the properties dialog is for, and what sort of information they should be adding to the field (letters, numbers, etc).

This information is displayed when you hover your mouse over the name of any property on the dialog.

In Model Explorer's design view:

  1. In the outlook bar, click Property type.

  2. In the left-hand tree, navigate to and select the object that contains the property you want to create help for.

  3. In the right-hand list, double-click the property that you want to write help for.

  4. The property type's properties dialog opens.

  5. Click the Help tab.

  6. Enter your help text.

  7. Click OK.

  8. Help has now been created or edited for this property.