Using the .hep file to link to helper applications

You can use a .hep file to group links to helper applications that help achieve the purpose of a IBM® Rational® Rhapsody® profile. Helper applications are custom programs created by you or a third‑party that you can link to within the product. Helper applications add functionality that a profile might not have, such as the ability to query a model or write to a project.

About this task

The method described here is the typical way to link to a helper application. If you prefer to not use Tools > Customize (which opens the Helpers window), you must review the options on the Helpers window to familiarize yourself with the available options and their syntax. For example, look at the Helper Trigger box for the list of available triggers and notice how they are spelled out and capitalized.

Procedure

  1. Open the product and choose Tools > Customize to create one or more links to helper applications.

    The code for your links is added to the rhapsody.ini file.
  2. Close the product.
  3. Open the rhapsody.ini file and from the [Helpers] section of the file, copy the code for your help application. The following example show helper application code that was added to the rhapsody.ini file:
    [Helpers]
    ...
    name30=AutoCommand45
    command30=C:\WINDOWS\NOTEPAD.EXE
    arguments30=
    initialDir30=C:\WINDOWS
    JavaMainClass30=
    JavaClassPath30=
    JavaLibPath30=
    isVisible30=1
    isMacro30=0
    isPlugin30=0
    isSynced30=0
    UsingJava30=0
    applicableTo30=
    applicableToProfile30=Auto2009
    helperTriggers30=After Project Open
    isPluginCommand30=0
    Note: Each section of link code starts with name##.
  4. Open your .hep file and paste the code for the link to a helper application (what you copied in the previous step).

    Your .hep file must have the same name as the name of the profile for your project. For example, if the profile for your project is called Auto2009, your .hep file must be called Auto2009.hep. In addition, both the profile and the .hep file must reside in the same folder.
  5. In the rhapsody.ini file, delete the code that you copied in Step 3. The code to link to a helper application must only reside in the .hep file when you are using a .hep file.
  6. Open Rational Rhapsody and open your model.
  7. Load the applicable profile that has the corresponding .hep file; see Step 4.
  8. Test to make sure that your link to a helper application works as expected.
    For example, if a link is suppose to open a helper application after you open a model (helperTriggers30=After Project Open, as shown in the sample code in Step 3), make sure that happens.

Results

Note: You can use the General::Model::HelpersFile property to associate a .hep file with a model.

If you specify a .hep file using this property, Rational Rhapsodydoes not recognize the helper applications defined in the profile-specific .hep file if one is provided for the profile you are using.

Feedback