ManPageW Workflow
Enjoy it, and help to fill it! But please, always respecting copyright.
Please write your contributions under the Contributions Section
Contents
Window: Workflow
Description : Maintain Workflow
Help : The Workflow Window defines Workflows in the system, the access level for the Workflow and the Nodes or Steps within the Workflow.
Tab: Workflow
Description : Define Workflow
Help : The Workflow Tab defines Workflows in the system.
Table Name : AD_Workflow
Fields
Name | Description | Help | Technical Data |
---|---|---|---|
Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
Organization | Organizational entity within client | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | AD_Org_ID
NUMBER(10) TableDir |
Search Key | Search key for the record in the format required - must be unique | A search key allows you a fast method of finding a particular record.
If you leave the search key empty, the system automatically creates a numeric number. The document sequence used for this fallback number is defined in the "Maintain Sequence" window with the name "DocumentNo_<TableName>", where TableName is the actual name of the table (e.g. C_Order). |
Value
NVARCHAR2(40) String |
Name | Alphanumeric identifier of the entity | The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. | Name
NVARCHAR2(60) String |
Description | Optional short description of the record | A description is limited to 255 characters. | Description
NVARCHAR2(255) String |
Comment/Help | Comment or Hint | The Help field contains a hint, comment or help about the use of this item. | Help
NVARCHAR2(2000) Text |
Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
Default | Default value | The Default Checkbox indicates if this record will be used as a default value. | IsDefault
CHAR(1) YesNo |
Workflow Type | Type of Worflow | The type of workflow determines how the workflow is started. | WorkflowType
CHAR(1) List |
Table | Database Table information | The Database Table provides the information of the table definition | AD_Table_ID
NUMBER(10) Search |
Document Value Logic | Logic to determine Workflow Start - If true, a workflow process is started for the document | You can enter simple logic using variables like @Created@=@Updated@, which fires, when a record is created. If you need to evaluate also values of other records, you need to use SQL logic and need to prefix this logic with "SQL=". Example: start a Order verify workflow, when a business partner ordered something and is over the credit limit "SQL=EXISTS (SELECT * FROM C_BPartner bp WHERE C_Order. C_BPartner_ID=bp. C_BPartner_ID AND SO_CreditUsed > SO_CreditLimit)".
Note that the SQL based logic checks for duplicate workflows (i.e. a workflow is started only once per record). |
DocValueLogic
NVARCHAR2(2000) String |
Data Access Level | Access Level required | Indicates the access level required for this record or process. | AccessLevel
CHAR(1) List |
Entity Type | Dictionary Entity Type; Determines ownership and synchronization | The Entity Types "Dictionary", "Adempiere" and "Application" might be automatically synchronized and customizations deleted or overwritten.
For customizations, copy the entity and select "User"! |
EntityType
VARCHAR2 Table |
Workflow Responsible | Responsible for Workflow Execution | The ultimate responsibility for a workflow is with an actual user. The Workflow Responsible allows to define ways to find that actual User. | AD_WF_Responsible_ID
NUMBER(10) TableDir |
Priority | Indicates if this request is of a high, medium or low priority. | The Priority indicates the importance of this request. | Priority
NUMBER(10) Integer |
Valid from | Valid from including this date (first day) | The Valid From date indicates the first day of a date range | ValidFrom
DATE Date |
Valid to | Valid to including this date (last day) | The Valid To date indicates the last day of a date range | ValidTo
DATE Date |
Publication Status | Status of Publication | Used for internal documentation | PublishStatus
CHAR(1) List |
Version | Version of the table definition | The Version indicates the version of this table definition. | Version
NUMBER(10) Integer |
Author | Author/Creator of the Entity | Author
NVARCHAR2(20) String | |
Start Node | Workflow Node, step or process | The Workflow Node indicates a unique step or process in a Workflow. | AD_WF_Node_ID
NUMBER(10) TableDir |
Workflow Processor | Workflow Processor Server | Workflow Processor Server | AD_WorkflowProcessor_ID
NUMBER(10) TableDir |
Duration Unit | Unit of Duration | Unit to define the length of time for the execution | DurationUnit
CHAR(1) List |
Duration Limit | Maximum Duration in Duration Unit | Maximum (critical) Duration for time management purposes (e.g. starting an escalation procedure, etc.) in Duration Units. | Limit
NUMBER(10) Integer |
Duration | Normal Duration in Duration Unit | Expected (normal) Length of time for the execution | Duration
NUMBER(10) Integer |
Cost | Cost information | Cost
NUMBER Integer | |
Working Time | Workflow Simulation Execution Time | Amount of time the performer of the activity needs to perform the task in Duration Unit | WorkingTime
NUMBER(10) Integer |
Waiting Time | Workflow Simulation Waiting time | Amount of time needed to prepare the performance of the task on Duration Units | WaitingTime
NUMBER(10) Integer |
Validate Workflow | Validate thet the workflos is correct | (limited checking) | ValidateWorkflow
CHAR(1) Button |
Valid | Element is valid | The element passed the validation check | IsValid
CHAR(1) YesNo |
Tab: Workflow Translation
Description :
Help :
Table Name : AD_Workflow_Trl
Fields
Name | Description | Help | Technical Data |
---|---|---|---|
Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
Organization | Organizational entity within client | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | AD_Org_ID
NUMBER(10) TableDir |
Workflow | Workflow or combination of tasks | The Workflow field identifies a unique Workflow in the system. | AD_Workflow_ID
NUMBER(10) TableDir |
Language | Language for this entity | The Language identifies the language to use for display and formatting | AD_Language
VARCHAR2 Table |
Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
Translated | This column is translated | The Translated checkbox indicates if this column is translated. | IsTranslated
CHAR(1) YesNo |
Name | Alphanumeric identifier of the entity | The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. | Name
NVARCHAR2(60) String |
Description | Optional short description of the record | A description is limited to 255 characters. | Description
NVARCHAR2(255) String |
Comment/Help | Comment or Hint | The Help field contains a hint, comment or help about the use of this item. | Help
NVARCHAR2(2000) Text |
Tab: Access
Description : Workflow Access
Help : The Workflow Access Tab defines the Roles who have access to this Workflow.
Table Name : AD_Workflow_Access
Fields
Name | Description | Help | Technical Data |
---|---|---|---|
Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
Organization | Organizational entity within client | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | AD_Org_ID
NUMBER(10) TableDir |
Workflow | Workflow or combination of tasks | The Workflow field identifies a unique Workflow in the system. | AD_Workflow_ID
NUMBER(10) TableDir |
Role | Responsibility Role | The Role determines security and access a user who has this Role will have in the System. | AD_Role_ID
NUMBER(10) TableDir |
Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
Read Write | Field is read / write | The Read Write indicates that this field may be read and updated. | IsReadWrite
CHAR(1) YesNo |
Tab: Node
Description : Define workflow nodes
Help : The Node Tab defines each Node, Activity or step in this Workflow.
The action (actibity) type determines the execution: "Route" may be used in routing control conditions. "None" identifies manual execution.
Table Name : AD_WF_Node
Fields
Name | Description | Help | Technical Data |
---|---|---|---|
Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
Organization | Organizational entity within client | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | AD_Org_ID
NUMBER(10) TableDir |
Workflow | Workflow or combination of tasks | The Workflow field identifies a unique Workflow in the system. | AD_Workflow_ID
NUMBER(10) TableDir |
Search Key | Search key for the record in the format required - must be unique | A search key allows you a fast method of finding a particular record.
If you leave the search key empty, the system automatically creates a numeric number. The document sequence used for this fallback number is defined in the "Maintain Sequence" window with the name "DocumentNo_<TableName>", where TableName is the actual name of the table (e.g. C_Order). |
Value
NVARCHAR2(40) String |
Name | Alphanumeric identifier of the entity | The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. | Name
NVARCHAR2(60) String |
Description | Optional short description of the record | A description is limited to 255 characters. | Description
NVARCHAR2(255) String |
Comment/Help | Comment or Hint | The Help field contains a hint, comment or help about the use of this item. | Help
NVARCHAR2(2000) Text |
Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
Centrally maintained | Information maintained in System Element table | The Centrally Maintained checkbox indicates if the Name, Description and Help maintained in 'System Element' table or 'Window' table. | IsCentrallyMaintained
CHAR(1) YesNo |
Entity Type | Dictionary Entity Type; Determines ownership and synchronization | The Entity Types "Dictionary", "Adempiere" and "Application" might be automatically synchronized and customizations deleted or overwritten.
For customizations, copy the entity and select "User"! |
EntityType
VARCHAR2 Table |
Workflow Responsible | Responsible for Workflow Execution | The ultimate responsibility for a workflow is with an actual user. The Workflow Responsible allows to define ways to find that actual User. | AD_WF_Responsible_ID
NUMBER(10) TableDir |
Priority | Indicates if this request is of a high, medium or low priority. | The Priority indicates the importance of this request. | Priority
NUMBER(10) Integer |
Start Mode | Workflow Activity Start Mode | How is the execution of an activity triggered. Automatic are triggered implicitly by the system, Manual explicitly by the User. | StartMode
CHAR(1) List |
Finish Mode | Workflow Activity Finish Mode | How the system operated at the end of an activity. Automatic implies return when the invoked applications finished control - Manual the user has to explicitly terminate the activity. | FinishMode
CHAR(1) List |
Join Element | Semantics for multiple incoming Transitions | Semantics for multiple incoming Transitions for a Node/Activity. AND joins all concurrent threads - XOR requires one thread (no synchronization). | JoinElement
CHAR(1) List |
Split Element | Semantics for multiple outgoing Transitions | Semantics for multiple outgoing Transitions for a Node/Activity. AND represents multiple concurrent threads - XOR represents the first transition with a true Transaition condition. | SplitElement
CHAR(1) List |
Action | Indicates the Action to be performed | The Action field is a drop down list box which indicates the Action to be performed for this Item. | Action
CHAR(1) List |
Image | Image or Icon | Images and Icon can be used to display supported graphic formats (gif, jpg, png).
You can either load the image (in the database) or point to a graphic via a URI (i.e. it can point to a resource, http address) |
AD_Image_ID
NUMBER(10) TableDir |
Window | Data entry or display window | The Window field identifies a unique Window in the system. | AD_Window_ID
NUMBER(10) TableDir |
Special Form | Special Form | The Special Form field identifies a unique Special Form in the system. | AD_Form_ID
NUMBER(10) TableDir |
Column | Column in the table | Link to the database column of the table | AD_Column_ID
NUMBER(10) TableDir |
Attribute Name | Name of the Attribute | Identifier of the attribute | AttributeName
NVARCHAR2(60) String |
Attribute Value | Value of the Attribute | Adempiere converts the (string) field values to the attribute data type. Booleans (Yes-No) may have the values "true" and "false", the date format is YYYY-MM-DD | AttributeValue
NVARCHAR2(60) String |
EMail Recipient | Recipient of the EMail | EMailRecipient
CHAR(1) List | |
EMail Address | Electronic Mail Address | The Email Address is the Electronic Mail ID for this User and should be fully qualified (e.g. joe.smith@company.com). The Email Address is used to access the self service application functionality from the web. | EMail
NVARCHAR2(60) String |
Mail Template | Text templates for mailings | The Mail Template indicates the mail template for return messages. Mail text can include variables. The priority of parsing is User/Contact, Business Partner and then the underlying business object (like Request, Dunning, Workflow object). So, @Name@ would resolve into the User name (if user is defined defined), then Business Partner name (if business partner is defined) and then the Name of the business object if it has a Name. |
R_MailText_ID
NUMBER(10) TableDir |
Duration Limit | Maximum Duration in Duration Unit | Maximum (critical) Duration for time management purposes (e.g. starting an escalation procedure, etc.) in Duration Units. | Limit
NUMBER(10) Integer |
OS Task | Operation System Task | The Task field identifies a Operation System Task in the system. | AD_Task_ID
NUMBER(10) TableDir |
Workflow | Workflow or tasks | The Workflow field identifies a unique workflow. A workflow is a grouping of related tasks, in a specified sequence and optionally including approvals | Workflow_ID
NUMBER(10) Table |
Subflow Execution | Mode how the sub-workflow is executed | SubflowExecution
CHAR(1) List | |
Process | Process or Report | The Process field identifies a unique Process or Report in the system. | AD_Process_ID
NUMBER(10) TableDir |
Document Action | The targeted status of the document | You find the current status in the Document Status field. The options are listed in a popup | DocAction
CHAR(2) List |
Wait Time | Time in minutes to wait (sleep) | Time in minutes to be suspended (sleep) | WaitTime
NUMBER(10) Integer |
Dynamic Priority Unit | Change of priority when Activity is suspended waiting for user | Starting with the Process / Node priority level, the priority of the suspended activity can be changed dynamically. Example +5 every 10 minutes | DynPriorityUnit
CHAR(1) List |
Dynamic Priority Change | Change of priority when Activity is suspended waiting for user | Starting with the Process / Node priority level, the priority of the suspended activity can be changed dynamically. Example +5 every 10 minutes | DynPriorityChange
NUMBER Number |
Duration | Normal Duration in Duration Unit | Expected (normal) Length of time for the execution | Duration
NUMBER(10) Integer |
Cost | Cost information | Cost
NUMBER CostsPrices | |
Working Time | Workflow Simulation Execution Time | Amount of time the performer of the activity needs to perform the task in Duration Unit | WorkingTime
NUMBER(10) Integer |
Waiting Time | Workflow Simulation Waiting time | Amount of time needed to prepare the performance of the task on Duration Units | WaitingTime
NUMBER(10) Integer |
Tab: Parameter
Description : Workflow Node Parameter
Help : Parameter for the execution of the Workflow Node
Table Name : AD_WF_Node_Para
Fields
Name | Description | Help | Technical Data |
---|---|---|---|
Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
Organization | Organizational entity within client | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | AD_Org_ID
NUMBER(10) TableDir |
Node | Workflow Node (activity), step or process | The Workflow Node indicates a unique step or process in a Workflow. | AD_WF_Node_ID
NUMBER(10) TableDir |
Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
Process Parameter | AD_Process_Para_ID
NUMBER(10) TableDir | ||
Attribute Name | Name of the Attribute | Identifier of the attribute | AttributeName
NVARCHAR2(60) String |
Attribute Value | Value of the Attribute | Adempiere converts the (string) field values to the attribute data type. Booleans (Yes-No) may have the values "true" and "false", the date format is YYYY-MM-DD | AttributeValue
NVARCHAR2(60) String |
Description | Optional short description of the record | A description is limited to 255 characters. | Description
NVARCHAR2(255) String |
Entity Type | Dictionary Entity Type; Determines ownership and synchronization | The Entity Types "Dictionary", "Adempiere" and "Application" might be automatically synchronized and customizations deleted or overwritten.
For customizations, copy the entity and select "User"! |
EntityType
VARCHAR2 Table |
Tab: Node Translation
Description : Node Translation
Help :
Table Name : AD_WF_Node_Trl
Fields
Name | Description | Help | Technical Data |
---|---|---|---|
Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
Organization | Organizational entity within client | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | AD_Org_ID
NUMBER(10) TableDir |
Node | Workflow Node (activity), step or process | The Workflow Node indicates a unique step or process in a Workflow. | AD_WF_Node_ID
NUMBER(10) TableDir |
Language | Language for this entity | The Language identifies the language to use for display and formatting | AD_Language
VARCHAR2 Table |
Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
Translated | This column is translated | The Translated checkbox indicates if this column is translated. | IsTranslated
CHAR(1) YesNo |
Name | Alphanumeric identifier of the entity | The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. | Name
NVARCHAR2(60) String |
Description | Optional short description of the record | A description is limited to 255 characters. | Description
NVARCHAR2(255) String |
Comment/Help | Comment or Hint | The Help field contains a hint, comment or help about the use of this item. | Help
NVARCHAR2(2000) Text |
Tab: Transition
Description : Workflow Node Transition
Help : The Next Nodes Tab defines the order or Nodes or Steps in a Workflow.
Table Name : AD_WF_NodeNext
Fields
Name | Description | Help | Technical Data |
---|---|---|---|
Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
Organization | Organizational entity within client | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | AD_Org_ID
NUMBER(10) TableDir |
Node | Workflow Node (activity), step or process | The Workflow Node indicates a unique step or process in a Workflow. | AD_WF_Node_ID
NUMBER(10) TableDir |
Next Node | Next Node in workflow | The Next Node indicates the next step or task in this Workflow. | AD_WF_Next_ID
NUMBER(10) Table |
Sequence | Method of ordering records; lowest number comes first | The Sequence indicates the order of records | SeqNo
NUMBER(10) Integer |
Description | Optional short description of the record | A description is limited to 255 characters. | Description
NVARCHAR2(255) String |
Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
Std User Workflow | Standard Manual User Approval Workflow | If selected, only documents with an open status (drafted, in progress, approved, rejected, invalid) and standard user actions (prepare, complete, approve, reject) are allowed to continue. Use this to prevent having to define details on how automatic processes (unlock, invalidate, post, re-activate) and when the document is closed for normal user action (completed, waiting, closed, voided, reversed). | IsStdUserWorkflow
CHAR(1) YesNo |
Entity Type | Dictionary Entity Type; Determines ownership and synchronization | The Entity Types "Dictionary", "Adempiere" and "Application" might be automatically synchronized and customizations deleted or overwritten.
For customizations, copy the entity and select "User"! |
EntityType
VARCHAR2 Table |
Tab: Condition
Description : Workflow Node Transition Condition
Help : Optional restriction of transition of one node to the next. The (string) value is converted to the datatype. Booleans (Yes-No) are represented by "true" and "false", the date format is YYYY-mm-DD
Table Name : AD_WF_NextCondition
Fields
Name | Description | Help | Technical Data |
---|---|---|---|
Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
Organization | Organizational entity within client | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | AD_Org_ID
NUMBER(10) TableDir |
Node Transition | Workflow Node Transition | The Next Nodes Tab defines the order or Nodes or Steps in a Workflow. | AD_WF_NodeNext_ID
NUMBER(10) TableDir |
Sequence | Method of ordering records; lowest number comes first | The Sequence indicates the order of records | SeqNo
NUMBER(10) Integer |
Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
And/Or | Logical operation: AND or OR | AndOr
CHAR(1) List | |
Column | Column in the table | Link to the database column of the table | AD_Column_ID
NUMBER(10) TableDir |
Operation | Compare Operation | Operation
CHAR(2) List | |
Value | Condition Value | Value
NVARCHAR2(40) String | |
Value To | Value To | Value2
NVARCHAR2(40) String | |
Entity Type | Dictionary Entity Type; Determines ownership and synchronization | The Entity Types "Dictionary", "Adempiere" and "Application" might be automatically synchronized and customizations deleted or overwritten.
For customizations, copy the entity and select "User"! |
EntityType
VARCHAR2 Table |
Contributions
How to Activate Document Approval Workflow is a good tutorial to set one workflow node up.