| ProcessStartStartProcess Method |
Starts a process and sets a reference from the new target object to the action object.
The method starts processes for each data object referred by targetRefPropSysName from the action object.
It can copy data from the action object to the new target object based on a copy rule.
The method can reassign the first activity based on a reference path expression to a user/user group.
It can send a mail to the new assignees based on a mail template uid.
Codemethod usage | |
---|
Designed to be used in a process only (Yes/No) | No |
Action Object (data object type) | Any |
Namespace:
Omada.OE.UtilityCodeAssembly
Assembly:
Omada.OE.UtilityCodeAssembly (in Omada.OE.UtilityCodeAssembly.dll) Version: 15.0.0.0
Syntaxpublic bool StartProcess(
CodeMethodInvokeContext context,
string targetRefPropSysName,
string processTemplateUIdStr,
string refPropSysName,
string copyRuleUIdStr,
string referencePathForActivityAssignee,
string mailTemplateUIdStr,
bool completeFirstActivity,
string completeOutTransitionGuid,
string runAsUserName
)
Parameters
- context
- Type: Omada.OE.ModelCodeMethodInvokeContext
- targetRefPropSysName
- Type: SystemString
System name of a reference property on the action object pointing to the object relevant for the launch of the process.
If the parameter is empty, the action object of the event is used.
In either case, the object is referred to as the action object in the documentation of the parameters below.
- processTemplateUIdStr
- Type: SystemString
UID of the process to launch - refPropSysName
- Type: SystemString
System name of reference property on the target object of the process pointing to the action object.
The value on the process target object will be updated with the action object.
The parameter must be provided.
- copyRuleUIdStr
- Type: SystemString
CopyRule UId to be used to copy from the action object to process target object, can be empty.
- referencePathForActivityAssignee
- Type: SystemString
Reference path expression pointing from the action object to the activity assignees. Can be empty.
- mailTemplateUIdStr
- Type: SystemString
Mail template UId for a notification email to the new assignees. Can be empty.
- completeFirstActivity
- Type: SystemBoolean
If set to True the first Activity in the process will be auto-completed.
- completeOutTransitionGuid
- Type: SystemString
The GUID of the transition used to auto-complete the first activity in the process.
If completeFirstActivity is set to True, the parameter value must be provided.
- runAsUserName
- Type: SystemString
The process will be launched in the context of this user.
Return Value
Type:
Boolean
See Also