workflow-procs.tcl

Procedures in the workflow namespace.

Location:
packages/workflow/tcl/workflow-procs.tcl
Created:
8 January 2003
Authors:
Lars Pind <lars@collaboraid.biz>
Peter Marklund <peter@collaboraid.biz>
CVS Identification:
$Id: workflow-procs.tcl,v 1.36 2019/02/12 18:45:14 hectorr Exp $

Procedures in this file

Detailed information

workflow::cache_timeout (private)

 workflow::cache_timeout

Returns the timeout to give to util_memoize (max_age parameter) for all workflow level data. Should probably be an APM parameter.

Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::action::get_all_info workflow::action::get_all_info (private) workflow::cache_timeout workflow::cache_timeout workflow::action::get_all_info->workflow::cache_timeout workflow::get workflow::get (public) workflow::get->workflow::cache_timeout workflow::get_id workflow::get_id (public) workflow::get_id->workflow::cache_timeout workflow::role::get_all_info workflow::role::get_all_info (private) workflow::role::get_all_info->workflow::cache_timeout workflow::state::fsm::get_all_info workflow::state::fsm::get_all_info (private) workflow::state::fsm::get_all_info->workflow::cache_timeout

Testcases:
No testcase defined.

workflow::callback_insert (private)

 workflow::callback_insert -workflow_id workflow_id -name name \
    [ -sort_order sort_order ]

Add a side-effect to a workflow.

Switches:
-workflow_id (required)
The ID of the workflow.
-name (required)
Name of service contract implementation, in the form (impl_owner_name).(impl_name), for example, bug-tracker.FormatLogTitle.
-sort_order (optional)
The sort_order for the rule. Leave blank to add to the end of the list
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::edit workflow::edit (public) workflow::callback_insert workflow::callback_insert workflow::edit->workflow::callback_insert db_dml db_dml (public) workflow::callback_insert->db_dml db_string db_string (public) workflow::callback_insert->db_string db_transaction db_transaction (public) workflow::callback_insert->db_transaction util_memoize_flush util_memoize_flush (public) workflow::callback_insert->util_memoize_flush workflow::service_contract::get_impl_id workflow::service_contract::get_impl_id (public) workflow::callback_insert->workflow::service_contract::get_impl_id

Testcases:
No testcase defined.

workflow::clone (public)

 workflow::clone -workflow_id workflow_id [ -package_key package_key ] \
    [ -object_id object_id ] [ -array array ] \
    [ -workflow_handler workflow_handler ]

Clones an existing FSM workflow. The clone must belong to either a package key or an object id.

Switches:
-workflow_id (required)
-package_key (optional)
A package to which this workflow belongs
-object_id (optional)
The id of an ACS Object indicating the scope the workflow. Typically this will be the id of a package type or a package instance but it could also be some other type of ACS object within a package, for example the id of a bug in the Bug Tracker application.
-array (optional)
The name of an array in the caller's namespace. Values in this array will override workflow attributes of the workflow being cloned.
-workflow_handler (optional, defaults to "workflow")
Author:
Lars Pind <lars@collaboraid.biz>
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::fsm::clone workflow::fsm::clone (public) workflow::clone workflow::clone workflow::fsm::clone->workflow::clone

Testcases:
No testcase defined.

workflow::default_sort_order (private)

 workflow::default_sort_order -workflow_id workflow_id \
    -table_name table_name

By default the sort_order will be the highest current sort order plus 1. This reflects the order in which states and actions are added to the workflow starting with 1

Switches:
-workflow_id (required)
-table_name (required)
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::action::edit workflow::action::edit (public) workflow::default_sort_order workflow::default_sort_order workflow::action::edit->workflow::default_sort_order workflow::role::edit workflow::role::edit (public) workflow::role::edit->workflow::default_sort_order workflow::state::fsm::edit workflow::state::fsm::edit (public) workflow::state::fsm::edit->workflow::default_sort_order db_string db_string (public) workflow::default_sort_order->db_string

Testcases:
No testcase defined.

workflow::definition_changed_handler (public)

 workflow::definition_changed_handler -workflow_id workflow_id

Should be called when the workflow definition has changed while there are active cases. Will update the record of enabled actions in each of the case, so they reflect the new workflow.

Switches:
-workflow_id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::action::edit workflow::action::edit (public) workflow::definition_changed_handler workflow::definition_changed_handler workflow::action::edit->workflow::definition_changed_handler workflow::action::fsm::edit workflow::action::fsm::edit (public) workflow::action::fsm::edit->workflow::definition_changed_handler workflow::action::fsm::set_enabled_in_state workflow::action::fsm::set_enabled_in_state (public) workflow::action::fsm::set_enabled_in_state->workflow::definition_changed_handler workflow::install::after_upgrade workflow::install::after_upgrade (private) workflow::install::after_upgrade->workflow::definition_changed_handler workflow::role::edit workflow::role::edit (public) workflow::role::edit->workflow::definition_changed_handler db_list db_list (public) workflow::definition_changed_handler->db_list workflow::case::state_changed_handler workflow::case::state_changed_handler (private) workflow::definition_changed_handler->workflow::case::state_changed_handler workflow::flush_cache workflow::flush_cache (private) workflow::definition_changed_handler->workflow::flush_cache

Testcases:
No testcase defined.

workflow::delete (public)

 workflow::delete -workflow_id workflow_id

Delete a generic workflow and all data attached to it (states, actions etc.).

Switches:
-workflow_id (required)
The id of the workflow to delete.
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 bug_tracker::bug::instance_workflow_delete bug_tracker::bug::instance_workflow_delete (private) workflow::delete workflow::delete bug_tracker::bug::instance_workflow_delete->workflow::delete bug_tracker::bug::workflow_delete bug_tracker::bug::workflow_delete (private) bug_tracker::bug::workflow_delete->workflow::delete packages/workflow/www/admin/delete-confirm.tcl packages/workflow/ www/admin/delete-confirm.tcl packages/workflow/www/admin/delete-confirm.tcl->workflow::delete workflow::edit workflow::edit (public) workflow::edit->workflow::delete workflow::test::workflow_teardown workflow::test::workflow_teardown (public) workflow::test::workflow_teardown->workflow::delete db_exec_plsql db_exec_plsql (public) workflow::delete->db_exec_plsql workflow::flush_cache workflow::flush_cache (private) workflow::delete->workflow::flush_cache

Testcases:
No testcase defined.

workflow::edit (public)

 workflow::edit [ -operation operation ] [ -workflow_id workflow_id ] \
    [ -array array ] [ -internal ] [ -no_complain ]

Edit a workflow. Attributes of the array are:

  • short_name
  • pretty_name
  • object_id
  • package_key
  • object_type
  • description
  • description_mime_type
  • callbacks
  • context_id
  • creation_user
  • creation_ip

Switches:
-operation (optional, defaults to "update")
insert, update, delete
-workflow_id (optional)
For update/delete: The workflow to update or delete.
-array (optional)
For insert/update: Name of an array in the caller's namespace with attributes to insert/update.
-internal (optional, boolean)
Set this flag if you're calling this proc from within the corresponding proc for a particular workflow model. Will cause this proc to not flush the cache or call workflow::definition_changed_handler, which the caller must then do.
-no_complain (optional, boolean)
Silently ignore extra attributes that we don't know how to handle.
Returns:
workflow_id
Authors:
Peter Marklund
Lars Pind <lars@collaboraid.biz>
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 packages/workflow/www/admin/workflow-ae.tcl packages/workflow/ www/admin/workflow-ae.tcl workflow::edit workflow::edit packages/workflow/www/admin/workflow-ae.tcl->workflow::edit packages/workflow/www/admin/workflow-meta-edit.tcl packages/workflow/ www/admin/workflow-meta-edit.tcl packages/workflow/www/admin/workflow-meta-edit.tcl->workflow::edit workflow::fsm::edit workflow::fsm::edit (public) workflow::fsm::edit->workflow::edit workflow::new workflow::new (public) workflow::new->workflow::edit ad_conn ad_conn (public) workflow::edit->ad_conn db_dml db_dml (public) workflow::edit->db_dml db_exec_plsql db_exec_plsql (public) workflow::edit->db_exec_plsql db_transaction db_transaction (public) workflow::edit->db_transaction workflow::callback_insert workflow::callback_insert (private) workflow::edit->workflow::callback_insert

Testcases:
No testcase defined.

workflow::exists_p (public)

 workflow::exists_p -workflow_id workflow_id

Return 1 if the workflow with given id exists and 0 otherwise. This proc is currently not cached.

Switches:
-workflow_id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 db_string db_string (public) workflow::exists_p workflow::exists_p workflow::exists_p->db_string

Testcases:
No testcase defined.

workflow::flush_cache (private)

 workflow::flush_cache -workflow_id workflow_id

Flush all cached data related to the given workflow instance.

Switches:
-workflow_id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::case::new workflow::case::new (public) workflow::flush_cache workflow::flush_cache workflow::case::new->workflow::flush_cache workflow::definition_changed_handler workflow::definition_changed_handler (public) workflow::definition_changed_handler->workflow::flush_cache workflow::delete workflow::delete (public) workflow::delete->workflow::flush_cache workflow::edit workflow::edit (public) workflow::edit->workflow::flush_cache workflow::parse_spec workflow::parse_spec (private) workflow::parse_spec->workflow::flush_cache util_memoize_flush util_memoize_flush (public) workflow::flush_cache->util_memoize_flush util_memoize_flush_regexp util_memoize_flush_regexp (public) workflow::flush_cache->util_memoize_flush_regexp workflow::action::flush_cache workflow::action::flush_cache (private) workflow::flush_cache->workflow::action::flush_cache workflow::case::flush_cache workflow::case::flush_cache (private) workflow::flush_cache->workflow::case::flush_cache workflow::role::flush_cache workflow::role::flush_cache (private) workflow::flush_cache->workflow::role::flush_cache

Testcases:
No testcase defined.

workflow::fsm::clone (public)

 workflow::fsm::clone -workflow_id workflow_id \
    [ -package_key package_key ] [ -object_id object_id ] \
    [ -array array ]

Clones an existing FSM workflow. The clone must belong to either a package key or an object id.

Switches:
-workflow_id (required)
-package_key (optional)
A package to which this workflow belongs
-object_id (optional)
The id of an ACS Object indicating the scope the workflow. Typically this will be the id of a package type or a package instance but it could also be some other type of ACS object within a package, for example the id of a bug in the Bug Tracker application.
-array (optional)
The name of an array in the caller's namespace. Values in this array will override workflow attributes of the workflow being cloned.
Author:
Lars Pind <lars@collaboraid.biz>
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 bug_tracker::bug::instance_workflow_create bug_tracker::bug::instance_workflow_create (private) workflow::fsm::clone workflow::fsm::clone bug_tracker::bug::instance_workflow_create->workflow::fsm::clone packages/workflow/www/admin/workflow-clone.tcl packages/workflow/ www/admin/workflow-clone.tcl packages/workflow/www/admin/workflow-clone.tcl->workflow::fsm::clone workflow::clone workflow::clone (public) workflow::fsm::clone->workflow::clone

Testcases:
No testcase defined.

workflow::fsm::edit (public)

 workflow::fsm::edit [ -operation operation ] \
    [ -workflow_id workflow_id ] [ -array array ] [ -internal ]
Switches:
-operation (optional, defaults to "update")
-workflow_id (optional)
-array (optional)
-internal (optional, boolean)

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::edit workflow::edit (public) workflow::fsm::edit workflow::fsm::edit workflow::fsm::edit->workflow::edit

Testcases:
No testcase defined.

workflow::fsm::generate_spec (public)

 workflow::fsm::generate_spec -workflow_id workflow_id \
    [ -workflow_handler workflow_handler ] [ -handlers handlers ]

Generate a spec for a workflow in array list style.

Switches:
-workflow_id (required)
The id of the workflow to generate a spec for.
-workflow_handler (optional, defaults to "workflow")
-handlers (optional, defaults to " roles workflow::role actions workflow::action::fsm states workflow::state::fsm ")
Returns:
The spec for the workflow.
Author:
Lars Pind <lars@collaboraid.biz>
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::test::run_bug_tracker_test workflow::test::run_bug_tracker_test (public) workflow::fsm::generate_spec workflow::fsm::generate_spec workflow::test::run_bug_tracker_test->workflow::fsm::generate_spec workflow::generate_spec workflow::generate_spec (public) workflow::fsm::generate_spec->workflow::generate_spec

Testcases:
No testcase defined.

workflow::fsm::get_initial_state (public)

 workflow::fsm::get_initial_state -workflow_id workflow_id

Get the id of the state that a workflow case is in once it's started (after the initial action is fired).

Switches:
-workflow_id (required)
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 bug_tracker::get_mapped_bugs bug_tracker::get_mapped_bugs (public) workflow::fsm::get_initial_state workflow::fsm::get_initial_state bug_tracker::get_mapped_bugs->workflow::fsm::get_initial_state packages/bug-tracker/lib/nav-bar.tcl packages/bug-tracker/ lib/nav-bar.tcl packages/bug-tracker/lib/nav-bar.tcl->workflow::fsm::get_initial_state packages/bug-tracker/www/map-patch-to-bugs.tcl packages/bug-tracker/ www/map-patch-to-bugs.tcl packages/bug-tracker/www/map-patch-to-bugs.tcl->workflow::fsm::get_initial_state workflow::action::fsm::get_element workflow::action::fsm::get_element (public) workflow::fsm::get_initial_state->workflow::action::fsm::get_element workflow::get_element workflow::get_element (public) workflow::fsm::get_initial_state->workflow::get_element

Testcases:
No testcase defined.

workflow::fsm::get_states (public)

 workflow::fsm::get_states [ -all ] -workflow_id workflow_id \
    [ -parent_action_id parent_action_id ]

Get the state_id's of all the states in the workflow.

Switches:
-all (optional, boolean)
-workflow_id (required)
The ID of the workflow
-parent_action_id (optional)
Returns:
list of state_id's.
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 bug_tracker::status_get_options bug_tracker::status_get_options (public) workflow::fsm::get_states workflow::fsm::get_states bug_tracker::status_get_options->workflow::fsm::get_states workflow::action::get_all_info_not_cached workflow::action::get_all_info_not_cached (private) workflow::action::get_all_info_not_cached->workflow::fsm::get_states workflow::case::new workflow::case::new (public) workflow::case::new->workflow::fsm::get_states workflow::graph::draw workflow::graph::draw (public) workflow::graph::draw->workflow::fsm::get_states workflow::state::fsm::generate_states_spec workflow::state::fsm::generate_states_spec (private) workflow::state::fsm::generate_states_spec->workflow::fsm::get_states workflow::state::fsm::get_ids workflow::state::fsm::get_ids (private) workflow::fsm::get_states->workflow::state::fsm::get_ids

Testcases:
No testcase defined.

workflow::fsm::new_from_spec (public)

 workflow::fsm::new_from_spec [ -package_key package_key ] \
    [ -object_id object_id ] -spec spec [ -array array ] \
    [ -workflow_handler workflow_handler ] [ -handlers handlers ]

Create a new workflow from spec. Workflows must belong to either a package key or an object id.

Switches:
-package_key (optional)
A package to which this workflow belongs
-object_id (optional)
The id of an ACS Object indicating the scope the workflow. Typically this will be the id of a package type or a package instance but it could also be some other type of ACS object within a package, for example the id of a bug in the Bug Tracker application.
-spec (required)
The workflow spec
-array (optional)
The name of an array in the caller's namespace. Values in this array will override workflow attributes of the workflow being cloned.
-workflow_handler (optional)
-handlers (optional)
Returns:
The ID of the workflow created
Author:
Lars Pind <lars@collaboraid.biz>
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 bug_tracker::bug::workflow_create bug_tracker::bug::workflow_create (private) workflow::fsm::new_from_spec workflow::fsm::new_from_spec bug_tracker::bug::workflow_create->workflow::fsm::new_from_spec workflow::test::workflow_setup_array_style workflow::test::workflow_setup_array_style (public) workflow::test::workflow_setup_array_style->workflow::fsm::new_from_spec workflow::new_from_spec workflow::new_from_spec (public) workflow::fsm::new_from_spec->workflow::new_from_spec

Testcases:
No testcase defined.

workflow::generate_short_name (public)

 workflow::generate_short_name -package_key package_key \
    [ -object_id object_id ] -pretty_name pretty_name \
    [ -short_name short_name ] [ -workflow_id workflow_id ]

Generate a unique short_name from pretty_name, or verify uniqueness of a given short_name.

Switches:
-package_key (required)
-object_id (optional)
-pretty_name (required)
-short_name (optional)
Suggested short_name.
-workflow_id (optional)
If you pass in this, we will allow that workflow's short_name to be reused.

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::edit workflow::edit (public) workflow::generate_short_name workflow::generate_short_name workflow::edit->workflow::generate_short_name _ _ (public) workflow::generate_short_name->_ util_text_to_url util_text_to_url (public) workflow::generate_short_name->util_text_to_url workflow::get_existing_short_names workflow::get_existing_short_names (public) workflow::generate_short_name->workflow::get_existing_short_names

Testcases:
No testcase defined.

workflow::generate_spec (public)

 workflow::generate_spec -workflow_id workflow_id \
    [ -workflow_handler workflow_handler ] [ -handlers handlers ]

Generate a spec for a workflow in array list style. Note that calling this directly with the default arguments will bomb, because workflow::action doesn't implement the required API.

Switches:
-workflow_id (required)
The id of the workflow to generate a spec for.
-workflow_handler (optional, defaults to "workflow")
-handlers (optional, defaults to " roles workflow::role actions workflow::action ")
An array-list with Tcl namespaces where handlers for various elements are defined. The keys are identical to the keys in the spec, and the namespaces are where the procs to handle them are defined.
Returns:
The spec for the workflow.
Author:
Lars Pind <lars@collaboraid.biz>
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::fsm::generate_spec workflow::fsm::generate_spec (public) workflow::generate_spec workflow::generate_spec workflow::fsm::generate_spec->workflow::generate_spec workflow::get workflow::get (public) workflow::generate_spec->workflow::get

Testcases:
No testcase defined.

workflow::get (public)

 workflow::get -workflow_id workflow_id -array array

Return information about a workflow. Uses util_memoize to cache values from the database.

Switches:
-workflow_id (required)
ID of workflow
-array (required)
name of array in which the info will be returned
Returns:
An array list with keys workflow_id, short_name, pretty_name, object_id, package_key, object_type, and callbacks.
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 packages/workflow/www/admin/index.tcl packages/workflow/ www/admin/index.tcl workflow::get workflow::get packages/workflow/www/admin/index.tcl->workflow::get packages/workflow/www/admin/workflow-ae.tcl packages/workflow/ www/admin/workflow-ae.tcl packages/workflow/www/admin/workflow-ae.tcl->workflow::get packages/workflow/www/admin/workflow-edit.tcl packages/workflow/ www/admin/workflow-edit.tcl packages/workflow/www/admin/workflow-edit.tcl->workflow::get packages/workflow/www/admin/workflow-meta-edit.tcl packages/workflow/ www/admin/workflow-meta-edit.tcl packages/workflow/www/admin/workflow-meta-edit.tcl->workflow::get workflow::case::action::notify workflow::case::action::notify (public) workflow::case::action::notify->workflow::get util_memoize util_memoize (public) workflow::get->util_memoize workflow::cache_timeout workflow::cache_timeout (private) workflow::get->workflow::cache_timeout workflow::get_not_cached workflow::get_not_cached (private) workflow::get->workflow::get_not_cached

Testcases:
No testcase defined.

workflow::get_actions (public)

 workflow::get_actions [ -all ] -workflow_id workflow_id \
    [ -parent_action_id parent_action_id ]

Get the action_id's of all the actions in the workflow.

Switches:
-all (optional, boolean)
-workflow_id (required)
The ID of the workflow
-parent_action_id (optional)
Returns:
list of action_id's.
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 bug_tracker::bug::get_list bug_tracker::bug::get_list (public) workflow::get_actions workflow::get_actions bug_tracker::bug::get_list->workflow::get_actions bug_tracker::get_export_variables bug_tracker::get_export_variables (public) bug_tracker::get_export_variables->workflow::get_actions bug_tracker::get_page_variables bug_tracker::get_page_variables (public) bug_tracker::get_page_variables->workflow::get_actions workflow::action::get_existing_short_names workflow::action::get_existing_short_names (public) workflow::action::get_existing_short_names->workflow::get_actions workflow::action::get_options workflow::action::get_options (public) workflow::action::get_options->workflow::get_actions workflow::action::get_ids workflow::action::get_ids (public) workflow::get_actions->workflow::action::get_ids

Testcases:
No testcase defined.

workflow::get_callbacks (private)

 workflow::get_callbacks -workflow_id workflow_id \
    -contract_name contract_name

Return the implementation names for a certain contract and a given workflow.

Switches:
-workflow_id (required)
-contract_name (required)
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::case::action::do_side_effects workflow::case::action::do_side_effects (public) workflow::get_callbacks workflow::get_callbacks workflow::case::action::do_side_effects->workflow::get_callbacks workflow::case::action::notify workflow::case::action::notify (public) workflow::case::action::notify->workflow::get_callbacks workflow::case::get_activity_log_info_not_cached workflow::case::get_activity_log_info_not_cached (private) workflow::case::get_activity_log_info_not_cached->workflow::get_callbacks workflow::get_element workflow::get_element (public) workflow::get_callbacks->workflow::get_element

Testcases:
No testcase defined.

workflow::get_element (public)

 workflow::get_element -workflow_id workflow_id -element element

Return a single element from the information about a workflow.

Switches:
-workflow_id (required)
The ID of the workflow
-element (required)
Returns:
The element you asked for
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 packages/bug-tracker/www/admin/index.tcl packages/bug-tracker/ www/admin/index.tcl workflow::get_element workflow::get_element packages/bug-tracker/www/admin/index.tcl->workflow::get_element workflow::case::get_notification_object workflow::case::get_notification_object (public) workflow::case::get_notification_object->workflow::get_element workflow::case::new workflow::case::new (public) workflow::case::new->workflow::get_element workflow::fsm::get_initial_state workflow::fsm::get_initial_state (public) workflow::fsm::get_initial_state->workflow::get_element workflow::get_callbacks workflow::get_callbacks (private) workflow::get_callbacks->workflow::get_element workflow::get workflow::get (public) workflow::get_element->workflow::get

Testcases:
No testcase defined.

workflow::get_existing_short_names (public)

 workflow::get_existing_short_names -package_key package_key \
    [ -object_id object_id ] \
    [ -ignore_workflow_id ignore_workflow_id ]

Returns a list of existing workflow short_names for this package_key and object_id. Useful when you're trying to ensure a short_name is unique, or construct a new short_name that is guaranteed to be unique.

Switches:
-package_key (required)
-object_id (optional)
-ignore_workflow_id (optional)
If specified, the short_name for the given workflow will not be included in the result set.

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::generate_short_name workflow::generate_short_name (public) workflow::get_existing_short_names workflow::get_existing_short_names workflow::generate_short_name->workflow::get_existing_short_names db_foreach db_foreach (public) workflow::get_existing_short_names->db_foreach

Testcases:
No testcase defined.

workflow::get_id (public)

 workflow::get_id [ -package_key package_key ] [ -object_id object_id ] \
    -short_name short_name

Get workflow_id by short_name and object_id. Provide either package_key or object_id.

Switches:
-package_key (optional)
The key of the package workflow belongs to.
-object_id (optional)
The ID of the object the workflow's for (typically a package instance)
-short_name (required)
the short name of the workflow you want
Returns:
The id of the workflow or the empty string if no workflow was found.
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 bug_tracker::bug::get_package_workflow_id bug_tracker::bug::get_package_workflow_id (public) workflow::get_id workflow::get_id bug_tracker::bug::get_package_workflow_id->workflow::get_id bug_tracker::bug::new bug_tracker::bug::new (public) bug_tracker::bug::new->workflow::get_id workflow::test::workflow_id workflow::test::workflow_id (public) workflow::test::workflow_id->workflow::get_id util_memoize util_memoize (public) workflow::get_id->util_memoize workflow::cache_timeout workflow::cache_timeout (private) workflow::get_id->workflow::cache_timeout workflow::get_id_not_cached workflow::get_id_not_cached (private) workflow::get_id->workflow::get_id_not_cached

Testcases:
No testcase defined.

workflow::get_id_not_cached (private)

 workflow::get_id_not_cached [ -package_key package_key ] \
    [ -object_id object_id ] -short_name short_name

Private proc not to be used by applications, use workflow::get_id instead.

Switches:
-package_key (optional)
-object_id (optional)
-short_name (required)

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::get_id workflow::get_id (public) workflow::get_id_not_cached workflow::get_id_not_cached workflow::get_id->workflow::get_id_not_cached ad_conn ad_conn (public) workflow::get_id_not_cached->ad_conn db_string db_string (public) workflow::get_id_not_cached->db_string

Testcases:
No testcase defined.

workflow::get_not_cached (private)

 workflow::get_not_cached -workflow_id workflow_id

Private procedure that should never be used by application code - use workflow::get instead. Returns info about the workflow in an array list. Always goes to the database.

Switches:
-workflow_id (required)
Author:
Peter Marklund
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::case::new workflow::case::new (public) workflow::get_not_cached workflow::get_not_cached workflow::case::new->workflow::get_not_cached workflow::get workflow::get (public) workflow::get->workflow::get_not_cached db_1row db_1row (public) workflow::get_not_cached->db_1row db_foreach db_foreach (public) workflow::get_not_cached->db_foreach

Testcases:
No testcase defined.

workflow::get_notification_links (public)

 workflow::get_notification_links -workflow_id workflow_id \
    [ -case_id case_id ] [ -return_url return_url ]

Return a links to sign up for notifications.

Switches:
-workflow_id (required)
-case_id (optional)
-return_url (optional)
Returns:
A multirow with columns url, label, title

Partial Call Graph (max 5 caller/called nodes):
%3

Testcases:
No testcase defined.

workflow::get_roles (public)

 workflow::get_roles [ -all ] -workflow_id workflow_id \
    [ -parent_action_id parent_action_id ]

Get the role_id's of all the roles in the workflow.

Switches:
-all (optional, boolean)
-workflow_id (required)
The ID of the workflow
-parent_action_id (optional)
Returns:
list of role_id's.
Author:
Lars Pind <lars@collaboraid.biz>

Partial Call Graph (max 5 caller/called nodes):
%3 bug_tracker::search::bug::datasource bug_tracker::search::bug::datasource (private) workflow::get_roles workflow::get_roles bug_tracker::search::bug::datasource->workflow::get_roles workflow::case::action::notify workflow::case::action::notify (public) workflow::case::action::notify->workflow::get_roles workflow::case::role::add_assignee_widgets workflow::case::role::add_assignee_widgets (public) workflow::case::role::add_assignee_widgets->workflow::get_roles workflow::case::role::set_assignee_values workflow::case::role::set_assignee_values (public) workflow::case::role::set_assignee_values->workflow::get_roles workflow::role::add_assignee_widgets workflow::role::add_assignee_widgets (public) workflow::role::add_assignee_widgets->workflow::get_roles workflow::role::get_ids workflow::role::get_ids (private) workflow::get_roles->workflow::role::get_ids

Testcases:
No testcase defined.

workflow::new (public)

 workflow::new -pretty_name pretty_name [ -short_name short_name ] \
    -package_key package_key [ -object_id object_id ] \
    [ -object_type object_type ] [ -callbacks callbacks ]

Creates a new workflow. For each workflow you must create an initial action (using the workflow::action::new proc) to be fired when a workflow case is opened.

Switches:
-pretty_name (required)
A human readable name for the workflow for use in the UI.
-short_name (optional)
For referring to the workflow from Tcl code. Use Tcl variable syntax.
-package_key (required)
The package to which this workflow belongs
-object_id (optional)
The id of an ACS Object indicating the scope the workflow. Typically this will be the id of a package type or a package instance but it could also be some other type of ACS object within a package, for example the id of a bug in the Bug Tracker application.
-object_type (optional, defaults to "acs_object")
The type of objects that the workflow will be applied to. Valid values are in the acs_object_types table. The parameter is optional and defaults to acs_object.
-callbacks (optional)
List of names of service contract implementations of callbacks for the workflow in impl_owner_name.impl_name format.
Returns:
New workflow_id.
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 packages/workflow/www/admin/workflow-ae.tcl packages/workflow/ www/admin/workflow-ae.tcl workflow::new workflow::new packages/workflow/www/admin/workflow-ae.tcl->workflow::new workflow::test::workflow_setup workflow::test::workflow_setup (public) workflow::test::workflow_setup->workflow::new workflow::edit workflow::edit (public) workflow::new->workflow::edit

Testcases:
No testcase defined.

workflow::new_from_spec (public)

 workflow::new_from_spec [ -package_key package_key ] \
    [ -object_id object_id ] -spec spec [ -array array ] \
    [ -workflow_handler workflow_handler ] [ -handlers handlers ]

Create a new workflow from spec. Workflows must belong to either a package key or an object id.

Switches:
-package_key (optional)
A package to which this workflow belongs
-object_id (optional)
The id of an ACS Object indicating the scope the workflow. Typically this will be the id of a package type or a package instance but it could also be some other type of ACS object within a package, for example the id of a bug in the Bug Tracker application.
-spec (required)
The workflow spec
-array (optional)
The name of an array in the caller's namespace. Values in this array will override workflow attributes of the workflow being cloned.
-workflow_handler (optional, defaults to "workflow")
-handlers (optional, defaults to " roles workflow::role actions workflow::action ")
Returns:
The ID of the workflow created
Author:
Lars Pind <lars@collaboraid.biz>
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::fsm::new_from_spec workflow::fsm::new_from_spec (public) workflow::new_from_spec workflow::new_from_spec workflow::fsm::new_from_spec->workflow::new_from_spec util_memoize_flush_regexp util_memoize_flush_regexp (public) workflow::new_from_spec->util_memoize_flush_regexp workflow::parse_spec workflow::parse_spec (private) workflow::new_from_spec->workflow::parse_spec

Testcases:
No testcase defined.

workflow::parse_spec (private)

 workflow::parse_spec -short_name short_name \
    [ -package_key package_key ] [ -object_id object_id ] -spec spec \
    [ -workflow_handler workflow_handler ] [ -handlers handlers ]

Create workflow, roles, states, actions, etc., as appropriate

Switches:
-short_name (required)
-package_key (optional)
-object_id (optional)
-spec (required)
The roles spec
-workflow_handler (optional, defaults to "workflow")
-handlers (optional, defaults to " roles workflow::role actions workflow::action ")
Author:
Lars Pind <lars@collaboraid.biz>
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::new_from_spec workflow::new_from_spec (public) workflow::parse_spec workflow::parse_spec workflow::new_from_spec->workflow::parse_spec db_transaction db_transaction (public) workflow::parse_spec->db_transaction workflow::flush_cache workflow::flush_cache (private) workflow::parse_spec->workflow::flush_cache

Testcases:
No testcase defined.

workflow::service_contract::action_side_effect (public)

 workflow::service_contract::action_side_effect

Partial Call Graph (max 5 caller/called nodes):
%3 bug_tracker::install::register_capture_resolution_code_impl bug_tracker::install::register_capture_resolution_code_impl (private) workflow::service_contract::action_side_effect workflow::service_contract::action_side_effect bug_tracker::install::register_capture_resolution_code_impl->workflow::service_contract::action_side_effect bug_tracker::install::unregister_implementations bug_tracker::install::unregister_implementations (private) bug_tracker::install::unregister_implementations->workflow::service_contract::action_side_effect workflow::case::action::do_side_effects workflow::case::action::do_side_effects (public) workflow::case::action::do_side_effects->workflow::service_contract::action_side_effect workflow::install::create_action_side_effect_service_contract workflow::install::create_action_side_effect_service_contract (private) workflow::install::create_action_side_effect_service_contract->workflow::service_contract::action_side_effect workflow::install::delete_service_contracts workflow::install::delete_service_contracts (private) workflow::install::delete_service_contracts->workflow::service_contract::action_side_effect

Testcases:
No testcase defined.

workflow::service_contract::activity_log_format_title (public)

 workflow::service_contract::activity_log_format_title

Partial Call Graph (max 5 caller/called nodes):
%3 bug_tracker::install::register_format_log_title_impl bug_tracker::install::register_format_log_title_impl (private) workflow::service_contract::activity_log_format_title workflow::service_contract::activity_log_format_title bug_tracker::install::register_format_log_title_impl->workflow::service_contract::activity_log_format_title bug_tracker::install::unregister_implementations bug_tracker::install::unregister_implementations (private) bug_tracker::install::unregister_implementations->workflow::service_contract::activity_log_format_title workflow::case::get_activity_log_info_not_cached workflow::case::get_activity_log_info_not_cached (private) workflow::case::get_activity_log_info_not_cached->workflow::service_contract::activity_log_format_title workflow::install::create_activity_log_format_title_service_contract workflow::install::create_activity_log_format_title_service_contract (private) workflow::install::create_activity_log_format_title_service_contract->workflow::service_contract::activity_log_format_title workflow::install::delete_service_contracts workflow::install::delete_service_contracts (private) workflow::install::delete_service_contracts->workflow::service_contract::activity_log_format_title

Testcases:
No testcase defined.

workflow::service_contract::get_impl_id (public)

 workflow::service_contract::get_impl_id -name name
Switches:
-name (required)

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::action::callback_insert workflow::action::callback_insert (public) workflow::service_contract::get_impl_id workflow::service_contract::get_impl_id workflow::action::callback_insert->workflow::service_contract::get_impl_id workflow::callback_insert workflow::callback_insert (private) workflow::callback_insert->workflow::service_contract::get_impl_id workflow::role::callback_insert workflow::role::callback_insert (public) workflow::role::callback_insert->workflow::service_contract::get_impl_id acs_sc::impl::get_id acs_sc::impl::get_id (public) workflow::service_contract::get_impl_id->acs_sc::impl::get_id

Testcases:
No testcase defined.

workflow::service_contract::notification_info (public)

 workflow::service_contract::notification_info

Partial Call Graph (max 5 caller/called nodes):
%3 bug_tracker::install::register_bug_notification_info_impl bug_tracker::install::register_bug_notification_info_impl (private) workflow::service_contract::notification_info workflow::service_contract::notification_info bug_tracker::install::register_bug_notification_info_impl->workflow::service_contract::notification_info bug_tracker::install::unregister_implementations bug_tracker::install::unregister_implementations (private) bug_tracker::install::unregister_implementations->workflow::service_contract::notification_info workflow::case::action::notify workflow::case::action::notify (public) workflow::case::action::notify->workflow::service_contract::notification_info workflow::install::create_get_notification_info_service_contract workflow::install::create_get_notification_info_service_contract (private) workflow::install::create_get_notification_info_service_contract->workflow::service_contract::notification_info workflow::install::delete_service_contracts workflow::install::delete_service_contracts (private) workflow::install::delete_service_contracts->workflow::service_contract::notification_info

Testcases:
No testcase defined.

workflow::service_contract::role_assignee_pick_list (public)

 workflow::service_contract::role_assignee_pick_list

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::case::role::get_picklist workflow::case::role::get_picklist (public) workflow::service_contract::role_assignee_pick_list workflow::service_contract::role_assignee_pick_list workflow::case::role::get_picklist->workflow::service_contract::role_assignee_pick_list workflow::install::create_assignee_pick_list_service_contract workflow::install::create_assignee_pick_list_service_contract (private) workflow::install::create_assignee_pick_list_service_contract->workflow::service_contract::role_assignee_pick_list workflow::install::delete_service_contracts workflow::install::delete_service_contracts (private) workflow::install::delete_service_contracts->workflow::service_contract::role_assignee_pick_list workflow::install::register_pick_list_current_assignee_impl workflow::install::register_pick_list_current_assignee_impl (private) workflow::install::register_pick_list_current_assignee_impl->workflow::service_contract::role_assignee_pick_list workflow::install::unregister_implementations workflow::install::unregister_implementations (private) workflow::install::unregister_implementations->workflow::service_contract::role_assignee_pick_list

Testcases:
No testcase defined.

workflow::service_contract::role_assignee_subquery (public)

 workflow::service_contract::role_assignee_subquery

Partial Call Graph (max 5 caller/called nodes):
%3 workflow::case::role::get_search_query workflow::case::role::get_search_query (public) workflow::service_contract::role_assignee_subquery workflow::service_contract::role_assignee_subquery workflow::case::role::get_search_query->workflow::service_contract::role_assignee_subquery workflow::install::create_assignee_subquery_service_contract workflow::install::create_assignee_subquery_service_contract (private) workflow::install::create_assignee_subquery_service_contract->workflow::service_contract::role_assignee_subquery workflow::install::delete_service_contracts workflow::install::delete_service_contracts (private) workflow::install::delete_service_contracts->workflow::service_contract::role_assignee_subquery workflow::install::register_search_query_registered_users_impl workflow::install::register_search_query_registered_users_impl (private) workflow::install::register_search_query_registered_users_impl->workflow::service_contract::role_assignee_subquery workflow::install::unregister_implementations workflow::install::unregister_implementations (private) workflow::install::unregister_implementations->workflow::service_contract::role_assignee_subquery

Testcases:
No testcase defined.

workflow::service_contract::role_default_assignees (public)

 workflow::service_contract::role_default_assignees

Partial Call Graph (max 5 caller/called nodes):
%3 bug_tracker::install::register_component_maintainer_impl bug_tracker::install::register_component_maintainer_impl (private) workflow::service_contract::role_default_assignees workflow::service_contract::role_default_assignees bug_tracker::install::register_component_maintainer_impl->workflow::service_contract::role_default_assignees bug_tracker::install::register_project_maintainer_impl bug_tracker::install::register_project_maintainer_impl (private) bug_tracker::install::register_project_maintainer_impl->workflow::service_contract::role_default_assignees bug_tracker::install::unregister_implementations bug_tracker::install::unregister_implementations (private) bug_tracker::install::unregister_implementations->workflow::service_contract::role_default_assignees workflow::case::role::set_default_assignees workflow::case::role::set_default_assignees (public) workflow::case::role::set_default_assignees->workflow::service_contract::role_default_assignees workflow::install::create_default_assignees_service_contract workflow::install::create_default_assignees_service_contract (private) workflow::install::create_default_assignees_service_contract->workflow::service_contract::role_default_assignees

Testcases:
No testcase defined.
[ show source ]