autodocs_module_workflow_ui

Module workflow_ui Owner: james@mirriad Work package: WPx.y Description: this allows the creation and maintenance of workflow templates, and running them on the system

Method call: database.get_ODBC_connection() Implemented in: database Called by: workflow_ui Description: this is a direct SQL pipe to the DB! Parameters: None Returns: Name: h Type: ODBC_handle Description: a handle to an ODBC connection

Responsible parties: james@mirriad, neil@mediachannel Work packages: WPx.y

Method call: performance_predictor.query_performance_prediction() Implemented in: performance_predictor Called by: workflow_ui Description: this estimates the predicted performance of an action, based on the facts available to the inference engine Parameters: Name: a Type: action_spec Description: a specification of an action to be performed

Returns: Name: p Type: performance_prediction Description: a set of numerical predictions, likely accompanied by metadata

Responsible parties: james@mirriad, jazz@imperial, tim@mirriad Work packages: WPx.y

Method call: database.create_workflow_template() Implemented in: database Called by: workflow_ui Description: creates a new workflow template in database Parameters: Name: w Type: workflow_template Description: human-designed work process

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.get_workflow_template() Implemented in: database Called by: workflow_ui Description: gets a specific workflow template from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: w Type: workflow_template Description: human-designed work process

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_workflow_template() Implemented in: database Called by: workflow_ui Description: updates a specific workflow template in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	w
Type:	workflow_template
Description:	human-designed work process

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_workflow_template() Implemented in: database Called by: workflow_ui Description: deletes a specific workflow template in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_workflow_templates() Implemented in: database Called by: workflow_ui Description: lists all workflow templates in database Parameters: None Returns: Name: w Type: A list of workflow_templates Description: human-designed work process

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_workflow_definition() Implemented in: database Called by: workflow_ui Description: creates a new workflow definition in database Parameters: Name: w Type: workflow_definition Description: filled in template, instances are stamped out from this

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.get_workflow_definition() Implemented in: database Called by: workflow_ui Description: gets a specific workflow definition from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: w Type: workflow_definition Description: filled in template, instances are stamped out from this

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_workflow_definition() Implemented in: database Called by: workflow_ui Description: updates a specific workflow definition in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	w
Type:	workflow_definition
Description:	filled in template, instances are stamped out from this

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_workflow_definition() Implemented in: database Called by: workflow_ui Description: deletes a specific workflow definition in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_workflow_definitions() Implemented in: database Called by: workflow_ui Description: lists all workflow definitions in database Parameters: None Returns: Name: w Type: A list of workflow_definitions Description: filled in template, instances are stamped out from this

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_workflow_instance() Implemented in: database Called by: workflow_ui Description: creates a workflow instance in database Parameters: Name: w Type: workflow_instance Description: a controller process, a bit like a make

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.get_workflow_instance() Implemented in: database Called by: workflow_ui Description: gets a specific workflow instance from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: w Type: workflow_instance Description: a controller process, a bit like a make

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_workflow_instance() Implemented in: database Called by: workflow_ui Description: updates a specific workflow instance in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	w
Type:	workflow_instance
Description:	a controller process, a bit like a make

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_workflow_instance() Implemented in: database Called by: workflow_ui Description: deletes a specific workflow instance in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_workflow_instances() Implemented in: database Called by: workflow_ui Description: lits all workflow instances in database Parameters: None Returns: Name: w Type: A list of workflow_instances Description: a controller process, a bit like a make

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.create_performance_rule() Implemented in: database Called by: workflow_ui Description: creates a performance rule in database Parameters: Name: p Type: performance_rule Description: a logical rule modeling system performance, either specified manually, or learned from recorded data

Returns: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke, tim@mirriad Work packages: WPx.y

Method call: database.get_performance_rule() Implemented in: database Called by: workflow_ui Description: gets a specific performance rule from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: Name: p Type: performance_rule Description: a logical rule modeling system performance, either specified manually, or learned from recorded data

Responsible parties: james@mirriad, jazz@imperial, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.update_performance_rule() Implemented in: database Called by: workflow_ui Description: updates a specific performance rule in database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Name:	p
Type:	performance_rule
Description:	a logical rule modeling system performance, either specified manually, or learned from recorded data

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.delete_performance_rule() Implemented in: database Called by: workflow_ui Description: deletes a specific performance rule from database Parameters: Name: u Type: uri Description: a Uniform Resource Identifier -- commonly used as unique identifiers for things like CRUDL

Returns: None Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: database.list_performance_rules() Implemented in: database Called by: workflow_ui Description: lists all performance rules in database Parameters: None Returns: Name: p Type: A list of performance_rules Description: a logical rule modeling system performance, either specified manually, or learned from recorded data

Responsible parties: james@mirriad, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: workflow_engine.run_workflow() Implemented in: workflow_engine Called by: workflow_ui Description: this runs a workflow, given a workflow definition Parameters: Name: w Type: workflow_definition Description: filled in template, instances are stamped out from this

Returns: None Responsible parties: james@mirriad Work packages: WPx.y

Method call: message_bus.send_message() Implemented in: message_bus Called by: workflow_ui Description: sends a message to the message switch Parameters: Name: m Type: message Description: a non-specific message

Returns: None Responsible parties: james@mirriad, john@ovation, neil@mediachannel, sam@smoke Work packages: WPx.y

Method call: message_bus.get_message() Implemented in: message_bus Called by: workflow_ui Description: called (possibly implicitly) by other modules to receive a message from the message switch Parameters: None Returns: Name: m Type: message Description: a non-specific message

Responsible parties: james@mirriad, john@ovation, neil@mediachannel, sam@smoke Work packages: WPx.y