The calling sequence diagrams demonstrate how the eProcess classes relate to each other and indicate which methods to call when using the eProcess Application Programming Interfaces (APIs).
These calling sequence diagrams are meant to be used with the detailed reference information found in the eProcess API Javadocs documentation. The eProcess API Javadocs documentation provide HTML-formatted class reference information taken directly from the Java source code of the classes (using the Sun Microsystems Javadoc utility).
The calling sequence diagrams are separated, by function, into three functional areas:
The diagrams are categorized to more easily present the calling sequences by functional activity. For example, when developing a system configuration utility you might want to refer primarily to the Administration and Configuration calling sequence diagram.
Additionally, this section includes some high-level information on the types of programmatic tasks supported by the APIs. See Working with eProcess APIs for more information. If you are using the eProcess APIs for Java development, refer to Java development, in the Developing for Java section of this guide. If you are using the APIs in COM development, refer to COM development, in the Developing for COM section of this guide.
Use the calling sequence diagrams, regardless of the development environment, to ensure you are using the preferred methods for calling these Application Programming Interfaces (APIs). The diagrams are not encyclopedic in detail; they show only the primary class relationships, and the preferred methods used to call them. Use the calling diagrams with the detailed class information found in the eProcess API reference documentation.
Some classes, like the interfaces and the VWAttachment and VWXMLUtil among others, do not appear on these calling diagrams. These classes can be created without first calling one of the primary classes. In most cases, however, the classes require that other API objects already have valid data or, as is the case with the VWAttachment class, require data from the IDM Objects to function correctly.
The calling sequence diagrams do not show deprecated methods, since in all cases the deprecated methods have been replaced by a new, preferred method (which are shown). All deprecated methods have been marked in the reference documentation, and in almost all cases you will find a suggestion for using an alternative method.
If this is the first time you are developing applications for Panagon eProcess, do not use the deprecated methods; these methods can be removed without notice. (You can find a listing of all of the current deprecated methods by selecting the Deprecated tab at the top of the each reference page from within the eProcess API JavaDoc documentation.)
If you have already developed applications for Visual WorkFlo and you are upgrading an existing Visual WorkFlo application, your code should continue to function with the deprecated method(s). FileNET recommends updating the application to replace the deprecated methods with the new methods before upgrading to the next release. In addition, you should review the new classes and changes to existing classes and methods in the What's New in 5.0 topic.
Tip The eProcess API documentation is located on the Panagon Web WorkFlo and Toolkit CD. Refer to the Install Panagon eProcess Toolkit topic for more information on locating the eProcess API documentation.