CMFSetup.workflow

Package CMFSetup :: Module workflow

[show private | hide private]

Module CMFSetup.workflow

Classes: WorkflowConfigurator

$Id: workflow.py 37114 2005-07-07 15:33:13Z anahide $

Classes
`WorkflowDefinitionConfigurator`	Synthesize XML description of site's workflows.
`WorkflowToolConfigurator`	Synthesize XML description of site's workflow tool.

Function Summary
	`exportWorkflowTool(context)` Export worflow tool and contained workflow definitions as an XML file.
	`importWorkflowTool(context)` Import worflow tool and contained workflow definitions.
	`_convertVariableValue(value, type_id)`
	`_extractActionNode(parent, encoding)`
	`_extractDefaultNode(parent, encoding)`
	`_extractGuardNode(parent, encoding)`
	`_extractMatchNode(parent, encoding)`
	`_extractPermissionNodes(root, encoding)`
	`_extractScriptNodes(root, encoding)`
	`_extractStateNodes(root, encoding)`
	`_extractTransitionNodes(root, encoding)`
	`_extractVariableNodes(root, encoding)`
	`_extractWorklistNodes(root, encoding)`
	`_getScriptFilename(workflow_id, script_id, meta_type)` Return the name of the file which holds the script.
	`_getWorkflowFilename(workflow_id)` Return the name of the file which holds info for a given workflow.
	`_guessVariableType(value)`
	`_initDCWorkflow(workflow, title, state_variable, initial_state, states, transitions, variables, worklists, permissions, scripts, context)` Initialize a DC Workflow using values parsed from XML.
	`_initDCWorkflowScripts(workflow, scripts, context)` Initialize DCWorkflow scripts
	`_initDCWorkflowStates(workflow, states)` Initialize DCWorkflow states
	`_initDCWorkflowTransitions(workflow, transitions)` Initialize DCWorkflow transitions
	`_initDCWorkflowVariables(workflow, variables)` Initialize DCWorkflow variables
	`_initDCWorkflowWorklists(workflow, worklists)` Initialize DCWorkflow worklists

Variable Summary
`tuple`	`TRIGGER_TYPES` = `('AUTOMATIC', 'USER', 'WORKFLOW_METHOD')`
`str`	`_FILENAME` = `'workflows.xml'`
`dict`	`_METATYPE_SUFFIXES` = `{'Script (Python)': 'py', 'DTML Met...`
`SRE_Pattern`	`_SEMICOLON_LIST_SPLITTER` = `; *`

Function Details

exportWorkflowTool(context)

Export worflow tool and contained workflow definitions as an XML file.

o 'context' must implement IExportContext.

o Register via Python:

  registry = site.portal_setup.getExportStepRegistry()
  registry.registerStep( 'exportWorkflowTool'
                       , Products.CMFSetup.workflow.exportWorkflowTool
                       , 'Workflow export'
                       , 'Export worflow tool and contained workflow '
                         'definitions.'
                       )

o Register via XML:

  <export-script id="exportWorkflowTool"
                 version="20040518-01"
                 handler="Products.CMFSetup.workflow.exportWorkflowTool"
                 title="Workflow export"
  >Export worflow tool and contained workflow definitions.</export-script>

importWorkflowTool(context)

Import worflow tool and contained workflow definitions.

o 'context' must implement IImportContext.

o Register via Python:

  registry = site.portal_setup.getImportStepRegistry()
  registry.registerStep( 'importWorkflowTool'
                       , '20040602-01'
                       , Products.CMFSetup.workflow.importWorkflowTool
                       , ()
                       , 'Workflow import'
                       , 'Import worflow tool and contained workflow '
                         'definitions.'
                       )

o Register via XML:

  <setup-step id="importWorkflowTool"
              version="20040602-01"
              handler="Products.CMFSetup.workflow.importWorkflowTool"
              title="Workflow import"
  >Import worflow tool and contained workflow definitions.</setup-step>

_getScriptFilename(workflow_id, script_id, meta_type)

Return the name of the file which holds the script.

_getWorkflowFilename(workflow_id)

Return the name of the file which holds info for a given workflow.

_initDCWorkflow(workflow, title, state_variable, initial_state, states, transitions, variables, worklists, permissions, scripts, context)

Initialize a DC Workflow using values parsed from XML.

_initDCWorkflowScripts(workflow, scripts, context)

Initialize DCWorkflow scripts

_initDCWorkflowStates(workflow, states)

Initialize DCWorkflow states

_initDCWorkflowTransitions(workflow, transitions)

Initialize DCWorkflow transitions

_initDCWorkflowVariables(workflow, variables)

Initialize DCWorkflow variables

_initDCWorkflowWorklists(workflow, worklists)

Initialize DCWorkflow worklists

Variable Details

TRIGGER_TYPES

Type:: tuple
Value:: ('AUTOMATIC', 'USER', 'WORKFLOW_METHOD')

_FILENAME

Type:: str
Value:: 'workflows.xml'

_METATYPE_SUFFIXES

Type:: dict
Value:: {'Script (Python)': 'py', 'DTML Method': 'dtml', 'External Method': 'e\ m'}

_SEMICOLON_LIST_SPLITTER

Type:: SRE_Pattern
Value:: ; *

Generated by Epydoc 2.1 on Wed Nov 30 03:59:27 2005

http://epydoc.sf.net