workflow::case::action::execute (public)
workflow::case::action::execute [ -no_notification ] \ [ -no_perm_check ] [ -no_logging ] \ [ -enabled_action_id enabled_action_id ] [ -case_id case_id ] \ [ -action_id action_id ] \ [ -parent_enabled_action_id parent_enabled_action_id ] \ [ -comment comment ] [ -comment_mime_type comment_mime_type ] \ [ -user_id user_id ] [ -initial ] [ -entry_id entry_id ] \ [ -package_id package_id ]
Defined in packages/workflow/tcl/case-procs.tcl
Execute the action. Either provide (case_id, action_id, parent_enabled_action_id), or simply enabled_action_id.
- Switches:
- -no_notification (optional, boolean)
- -no_perm_check (optional, boolean)
- Set this switch if you do not want to have any workflow_case loggings.
- -no_logging (optional, boolean)
- -enabled_action_id (optional)
- The ID of the enabled action to execute. Alternatively, you can specify the case_id/action_id pair.
- -case_id (optional)
- The ID of the case.
- -action_id (optional)
- The ID of the action
- -parent_enabled_action_id (optional)
- -comment (optional)
- Comment for the case activity log
- -comment_mime_type (optional, defaults to
"text/plain"
)- MIME Type of the comment, according to OpenACS standard text formatting
- -user_id (optional)
- The user who's executing the action
- -initial (optional, boolean)
- Use this switch to signal that this is the initial action. This causes permissions/enabled checks to be bypasssed, and causes all roles to get assigned.
- -entry_id (optional)
- Optional item_id for double-click protection. If you call workflow::case::fsm::get with a non-empty action_id, it will generate a new entry_id for you, which you can pass in here.
- -package_id (optional)
- The package_id the case object belongs to. This is optional but is useful if the case objects are not CR items.
- Returns:
- entry_id of the new log entry (will be a cr_item).
- Author:
- Lars Pind <lars@collaboraid.biz>
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.