Related Topics
This class defines a Process Timeline object (definition or instance).
When developing Form scripts or Timeline scripts, you are automatically given an instance of the current Process Timeline with the CurrentProject variable.
This object extends the Process class, which, in turn, extends the ContentObject class. Thus all properties and methods from the Process and ContentObject classes are available in the Project class, in addition to those below.
Properties
PRID: The ID of the timeline definition.
PRINSTID: The ID of the timeline instance.
Methods
AddToProject
This method attaches an object to the process instance.
Parameters
ContentObject pObj: The content object to be attached to the project.
String pGroup (optional): The group name to use for the object.
String pID: The ID of the object to attach.
ObjectType pType (optional): The ObjectType of the attached object.
String pGroup (optional): The group name to use for the object.
Returns
Boolean: True if the operation succeeds.
Example
var oObject = Process.GetProcessByInstID(bp, "INSTID");
var document - Document.GetDocumentbyDID(bp, "DID");
bool success = oObject.AddToProject(document, "Group");
This method also has an overloaded method that can be called via the following parameters
GetActivityByName
This method returns a ProjectActivity object (Process Timeline Activity), given the name of the activity.
Parameters
String pActivity: Name of the requested activity.
Returns
ProjectActivity: The requested project activity.
Example
var oObject = Process.GetProcessByID(bp, "PID");
var someActivity = oObject.GetActivityByName("ActivityName");
GetProjectByPRID
This method returns a project object given the project’s ID.
Parameters
bp BP (only necessary if this is a static call): The bp environment.
String PRID: The ID of the timeline definition.
Example
var someProject = Project.GetProjectByPRID(bp, "PID");
Returns
Project: The project object with the specified ID.
PostEvent (static method)
This method posts an event to the specified project instance.
Parameters
bp BP: The bp environment.
String PRINSTID: ID of the project instance to post an event to.
String EventName: Name of the event to post.
Returns
Boolean: True if the operation succeeds.
Example
bool success = Project.PostEvent(bp, "PRINSTID", "EventName");
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.
