Development Toolkit Overview(4.3)

Owned by Jenni Wallin
Last updated: Oct 17, 2024
2 min read

The Development Toolkit makes it possible to build the following plugins for the standard Global variable macro (Development) Platform:

  • Agent Plugins - for creating customized agents

  • APL Plugins - for creating customized APL functions

  • Event Plugins - for creating customized events

  • Notifier Plugins - for creating customized notifiers

  • Desktop Plugins - for creating customized menu options and dialogs

  • UDR Plugins - for creating customized UDRs

  • Ultra Plugins - for creating customized decoders

  • Workflow Service Plugins - for creating customized workflow services

DTK Contents

The Development Toolkit contains:

  • DTK classes in devkit.jar

  • Class documentation in Javadoc

  • Java class documentation for J2SE DTK

  • Example source code

  • DTK user's guide

Packages

The following packages are available for com.digitalroute.devkit:

Package

Description

Package

Description

apl

Provides support for creating APL plugin functions.

drudr

Used to create, manipulate and view UDR descriptions within Usage Engine.

event

Provides the definition of a Usage Engine event as well as the event and target used in Event Notification configurations.

exception

Provides Usage Engine exception classes.

ultra

Contains Ultra field plugin support classes.

wf

Contains all workflow related functionalities, for example, agent development, services, MIM usage, and Swing widget for MIM selection.

wf.udr

Contains classes for the specific FNTUDR and MultiForwardingUDR.

storable

Provides interfaces defining a Usage Engine storable.

storable.upgrade

Provides for configuration upgrade.

misc

Contains miscellaneous classes, for example, environment interfaces that are used by the plugins to call Usage Engine.

doc

Contains classes with support for adding online user documentation.

Filesystem Structure

When DTK is installed according to the instructions in Installation and Setup(4.3), the following files and folders are created in the $MZ_HOME/dtk folder:

Item

Description

Item

Description

examples

Contains source code for the reference implementations shipped with DTK. The examples can be used as a base for developing custom made Usage Engine plugins.

javadoc

Contains the DTK JavaDoc including documentation of all DTK classes and interfaces.

javadoc-examples

Contains the plugin examples available in DTK JavaDoc.

lib

Contains DTK library file(s) needed for building Usage Engine plugins.