Official Content

This data type represents a process definition, that is the equivalent of a diagram in the GeneXus IDE. It is provided by the Workflow API.

Properties

Property Type Access Description
Id WorkflowProcessDefinitioId  Read Identifier
Name WorkflowProcessName  Read Process Name
Version WorkflowProcessVersion  Read Process version
State WorkflowProcessDefinitionState  Read Definition state
isMain Boolean Read Indicates if it is main process
Calendar WorkflowCalendar Read Calendar associated to the process
Activities Collection (WorkflowActivity) Read Activities making up the process definition
ExtendedAttributes Collection (WorkflowAttribute) Read Process extended attributes
DocumentDefinitions Collection WorkflowDocumentDefinition Read Document definitions associated to the process
States Collection (WorkflowProcessDefinitionState) Read States that a process definition may have
Error WorkflowError Read Error code
BusinessEvents Collection (WorkflowBusinessEvent) Read Business Events
Description WorkflowDescription  Read Process definition description
Created DateTime Read Date of creation
Updated DateTime Read Date of last update
GUID WorkflowGUID  Read GUID
ApplicationDataDefinitions WorkflowApplicationDataDefinition (Collection)  Read Application data defitinitions belonging to the Process Definition
Nodes WorkflowNode (Collection) Read Nodes belonging to the Process Definition

Methods

  • Load

 Allows loading a process definition from the identifier.

Load (id) 

  • LoadByName

 Allows loading a process definition from the name.

LoadByName (name) 

  • LoadByGUID

Allows loading a process definition from the GUID

LoadByGUID(GUID) LoaLoadByName (name) Loa

  • CreateInstance

Creates a new process instance.

CreateInstance (): WorkflowProcessInstance 

  • GetActivityById

Returns an Activity type object whose identifier coincides with the specified one.

GetActivityById (id) : WorkflowActivity

Name Type Movement Description
Id Numeric Input Activity Identifier

 

  • GetActivityByName

Returns the first Activity type object whose name coincides with the specified one.

GetActivityByName (name): WorkflowActivity

Name Type Movement Description
Name Workflowname Input Activity Name

 

​​​​

  • GetNodeByName

Returns the first Node type object whose name coincides with the specified one.

GetNodeByName (name): WorkflowNode

Name Type Movement Description
Name Workflowname Input Node name

 

  • GetNodeById

Returns the first Node type object whose identifier coincides with the specified one.

GetNodeById (Id): WorkflowNode

Name Type Movement Description
Id WorkflowId Input Node identifier

 

  • ChangeState

Changes the process state.

ChangeState (state)

Name Type Movement Description
State Character (WorkflowProcessDefinitionState) Input Process State

 

  • Enable

Changes the process state to enabled.

Enable () 

  • Disable

Changes the process state to disabled.

Disable ()

  • GetBusinessEventById

Returns a Business Event type object whose identifier coincides with the specified one.

GetBusinessEventById(id):WorkflowBusinessEvent

Name Type Movement Description
Id Numeric (WorkflowBusinessEventId) Input Business Event Identifier
  • GetBusinessEventByName

Returns the first Business Event type object whose name coincides with the specified one.

GetBusinessEventByName(name):WorkflowBusinessEvent

Name Type Movement Description
Name Workflowname Input Business Event Name
  • GetDocumentDefinitionAllowedActions

Returns the allowed actions for the specified document.

GetDocumentDefinitionAllowedActions(DocumentDefinition):WorkflowDocumentAction 

Name Type Movement Description
DocumentDefinition WorkflowDocumentDefinition Input Business Event Name

 

See Also

Workflow Error Codes




—
Last update: 6 February 2023 by vdeambrosi
Last update: November 2024 | © GeneXus. All rights reserved. GeneXus Powered by Globant