Skip to main content

FlowAssign

Represents the FlowAssign class, inheriting from BaseErrorManagedApiStep<FlowAssignProperties> and implementing the IHasErrorOptions interface.

Properties

NameDescription
KeyA unique identifier for the workflow step.
WorkflowCodeInstanceThe workflow code instance associated with the flow object.
CachedDMObjectsThe cached document management objects related to the flow object.
ConstantProfessionGets or sets the constant profession details.
ConstantUserGets or sets the constant user details.
TargetObjectTypeCodeSpecifies the type code of the target object. (Obsolete, will be replaced by TargetObject on 01.01.2024.)
TypeCodeThe type code associated with the flow object.
ConstantDepartmentGets or sets the constant department details.
TargetObjectNameSpecifies the name of the target object. (Obsolete, will be replaced by TargetObject on 01.01.2024.)
ResumeOnErrorIndicates whether the process should continue on encountering an error. (Obsolete, will be replaced by ErrorOptions on 01.01.2024.)
ErrorDescriptionObjectNameSpecifies the name of the error description object. (Obsolete, will be replaced by ErrorOptions on 01.01.2024.)
ErrorOptionsDefines error-related options for the API step.
NameName for the workflow step.
SelectedManagerProfileGets or sets the selected manager profile position details.
SourceTypeGets or sets the source type for the assignment.
AssignmentNameGets or sets the name of the assignment.
SelectedObjectNameGets or sets the name of the selected object.
SelectedObjectPropertyGets or sets the selected object property name.
TargetObjectGets or sets the target object metadata.
ConstantValueGets or sets the constant value.
CaptionThe caption dictionary representing localized captions for the flow object.
ConstantPositionGets or sets the constant position details.
ManagerAccordingToTitleGets or sets the manager options according to the title.

Constructors

NameDescription
FlowAssign(name, workflowData, workflowCodeInstance)Constructor for the FlowAssign class. Initializes a new instance of the FlowAssign class.
FlowAssign(name, workflowData, workflowCodeInstance)Initializes a new instance of the FlowAssign class with the specified name, workflow data, and optional workflow code instance.
FlowAssign(name,workflowData,workflowCodeInstance)Initializes a new instance of the FlowAssign class with a name, workflow data, and workflow code instance.

Methods

NameDescription
SetConstantUser(targetPosition)Assigns a constant user to the target position.
SetUserFromFlowInitiatorManager(targetPosition)Assigns the manager of the flow initiator to the target position.
SetVariableFromDepartment(sourceDepartment, targetVariable)Assigns a value to the target variable from a department.
SetProfessionFromVariable(sourceVariable, targetProfession)Assigns a profession to the target profession based on a variable.
SetConstantVariable(targetVariable)Assigns a constant value to the target variable.
SetUserFromImpersonatingUser(targetPosition)Assigns the impersonating user to the target position.
SetManagerDepartmentFromDepartment(sourceDepartment, targetDepartment)Assigns a manager's department to the target department based on another department.
SetVariableFromVariable(sourceVariable, targetVariable)Assigns a value to the target variable from another variable.
SetDepartmentFromPosition(sourcePosition, targetDepartment)Assigns a department to the target department based on a position.
SetUserFromLogonUser(targetPosition)Assigns the current logged-on user to the target position.
SetDepartmentFromOther(sourceDepartment, targetDepartment)Assigns a department to the target department based on another department.
SetManagerUserAccordingToProfession(targetPosition, sourcePosition, flowAssign)Assigns the manager user to the target position according to the profession.
SetDepartmentFromVariable(sourceVariable, targetDepartment)Assigns a department to the target department based on a variable.
Initialize()Initializes the FlowAssign step with default settings.
SetConstantProfession(targetProfession)Assigns a constant profession to the target profession.
SetVariableProfession(sourceProfession, targetProfession)Assigns a variable profession from the source profession to the target profession.
SetVariableUser(id, targetPosition)Assigns a user to the target position based on a variable user ID.
SetDepartmentManagerUserFromDepartment(sourceDepartment, targetPosition)Assigns the manager of the department to the target position.
SetProfessionFromPosition(sourcePosition, targetProfession)Assigns a profession to the target profession based on a position.
IncrementVariable(targetVariable)Increments the value of the target variable.
SetConstantDepartment(targetDepartment)Assigns a constant department to the target department.
SetConstantPosition(targetPosition)Assigns a constant position as the target for the flow.
SetVariableFromProfession(sourceProfession, targetVariable)Assigns a value to the target variable from a profession.
SetVariableFromProjectName(targetVariable)Assigns a project name to the target variable.
SetPositionFromOther(sourcePosition, targetPosition)Sets the target position based on another source position.
GetTargetObject<T>()Retrieves the target object of the specified type for the current assignment.
Assign()Assigns the target object based on the provided assignment configuration.
SetPositionFromVariable(sourceVariable, targetPosition)Sets the target position based on a variable.
SetVariableFromPosition(sourcePosition, targetVariable)Assigns a value to the target variable from a position.
SetDepartmentFromFlowInitiator(targetDepartment)Assigns a department to the target department based on the flow initiator.
DecrementVariable(targetVariable)Decrements the value of the target variable.
SetManagerUserFromUser(sourcePosition, targetPosition)Assigns the manager of the user from the source position to the target position.
SetProfessionFromFlowInitiator(targetProfession)Assigns a profession to the target profession based on the flow initiator.
SetUserFromFlowInitiator(targetPosition)Assigns the user from the flow initiator to the target position.
SetUserFromVariable(sourceVariable, targetPosition)Sets the target user from the provided variable.

Events

NameDescription
OnBeforeExecution(sender, args)Occurs before the execution of the workflow step.
OnAfterExecution(sender, args)Occurs after the execution of the workflow step.

Generic Types

NameDescription
TPropertiesGeneric type of properties.