Related Topics
Custom programming in Process Director is performed by using a number of classes that are built into the product SDK. Each class in the Process Director library contains all of the relevant Properties Methods and Events, along with the required and optional parameters available for each method. Each of the classes are listed in the Table of Contents displayed in the upper right corner of the page.
In most cases, each class is named after the specific Process Director object the class addresses. For instance, the ProcessTaskUser class provides the Methods for manipulating the user assigned to the generic process task that's created by a running Process Timeline Activity. Similarly, the ProjectActivityUser class contains the Methods for manipulating the user assigned to a specific Process Timeline Activity.
Exceptions to this Process Director object-based naming convention include:
- The bp class, which is the base class/namespace for all Process Director object classes. This class is universal, and the global
bpvariable provides the system context that is passed to many functions. - The PDF class, which provides the methods for manipulating PDF documents, irrespective of the Process Director object to which the PDF file is associated.
- The Excel class, which provides the methods for manipulating Microsoft Excel documents, again, irrespective of the Process Director object to which the file is associated.
Common Termination Reasons
The classes associated with Timeline Activities, Process Tasks, and Workflow Steps all have a common set of termination reasons associated with every task or activity. The termination reason is set when the task or activity is completed. A list of those classes would include:
- ProcessTask
- ProcessTaskUser
- ProjectActivity
- ProjectActivityUser
- Task
- WorkflowStep
- WorkflowStepUser
In the Process Director UI, text values are returned for the termination reasons. In Process Director database tables, however, numeric values are stored for the termination reason in the nTermReason field of the appropriate table. Thus, any records returned by database queries or views will display the numeric value for the termination reason. The numeric values that may appear in the nTermReason field, along with a description of each value, is provided in the Enumerators section of Database Guide's Table Definitions topic.
Documentation Feedback and Questions
If you notice some way that this document can be improved, we're happy to hear your suggestions. Similarly, if you can't find an answer you're looking for, ask it via feedback. Simply click on the button below to provide us with your feedback or ask a question. Please remember, though, that not every issue can be addressed through documentation. So, if you have a specific technical issue with Process Director, please open a support ticket.
