...

It is important that references to Workflow Template environment entities, such as route names and MIM resources, are also validated. The recommended way of designing, for instance route names selection, is to populate a user interface component in the displayConfig method. That way, the user cannot select one that is invalid. However, when the user interface dialog has been validated and confirmed, the user may change names on routes and on agents invalidating the previous validation. To prevent this, such external entities must be validated again in the Inspectable class.

Online Help

DRAgentUI provides support for documentation in JavaHelp format. The JavaHelp *.jar file must be installed with the package. There are many vendors that support generating JavaHelp for different source formats. DTK does not provide a documentation framework but just the ability to show the online help. Please see the official JavaHelp documentation for further information.

Once the JavaHelp *.jar file has been installed, the getHelpIdentifier method should be implemented and return a String array where the first element points out the name of the helpset, e g myagent.hs, and the second element, which is optional, points to an identifier within the help package. The files in the help package must be unique within the system. Therefore it is recommended to put the *.html and image files in a directory named after the agent. It is also recommended that the helpset itself is named after the agent.

The provided APIs to add a DTK developed package to the online-help is described in one of the DTK examples. The result will be that the package appears in the list of help packages that is displayed by selecting the About... option in the Desktop Help menu. See the DTK example: com.digitalroute.devkit.examples.diskcollection.DiskCollectionUserDoc.

See Documentation for Agent Plugins for information about how to create the online help content.

User Interface for Commands

...