| 294. WorkflowManager | ||
|---|---|---|
 |  | |
| 294. WorkflowManager | ||
|---|---|---|
| | | |
Provides API for configuring workflows
List of Global Functions
AddWorkflow - Stores new workflow (if such workflow exists) into the Worflow Store.
CleanWorkflowsDirectory - Removes all xml and ycp files from directory where
DumpCurrentSettings - Returns the current settings used by WorkflowManager. This function is just for debugging purpose.
GetAdditionalFinishSteps - Returns list of additional inst_finish steps requested by additional workflows.
GetAllUsedControlFiles - Returns list of control-file names currently used
HaveAdditionalWorkflows - Returns whether some additional control files are currently in use.
MergeWorkflows - Function uses the Base Workflow as the initial one and merges all added workflow into that workflow.
PrepareProposals - Check all proposals, split those ones which have multiple modes or architectures or stages into multiple proposals.
PrepareSystemProposals - Check all proposals, split those ones which have multiple modes or architectures or stages into multiple proposals. Works with base product proposals.
PrepareSystemWorkflows - Check all workflows, split those ones which have multiple modes or architectures or stages into multiple worlflows. Works with base product workflows.
PrepareWorkflows - Check all workflows, split those ones which have multiple modes or architectures or stages into multiple workflows
RedrawWizardSteps - Redraws workflow steps. Function must be called when steps (or help for steps) are active. It doesn't work in case of active another dialog.
RemoveWorkflow - Removes workflow (if such workflow exists) from the Worflow Store. Alose removes the cached file but in the installation.
ResetWorkflow - Resets the Workflow (and proposals) to use the base workflow. It must be stored. Clears also all additional workflows.
SetAllUsedControlFiles - Sets list of control-file names to be used. ATTENTION: this is dangerous and should be used in rare cases only!
SetBaseWorkflow - Stores the current ProductControl settings as the initial settings. These settings are: workflows, proposals, inst_finish, and clone_modules.
SomeWorkflowsWereChanged - Returns whether some additional control files were added or removed from the last time MergeWorkflows() was called.
List of Global Variables
additional_finish_steps_before_chroot - Additional inst_finish settings defined by additional control files. They are always empty at the begining.
Stores new workflow (if such workflow exists) into the Worflow Store.
Function parameters
symbol type
integer src_id
string name
Return value
boolean - whether successful (true also in case of no workflow file)
Removes all xml and ycp files from directory where
Return value
void
Returns the current settings used by WorkflowManager. This function is just for debugging purpose.
Return value
map <string, any> - of current settings
[ "workflows" : ... "proposals" : ... "inst_finish" : ... "clone_modules" : ... "unmerged_changes" : ... ];
Returns list of additional inst_finish steps requested by additional workflows.
Function parameters
string which_steps
Return value
list <string> - steps to be called ...see which_steps parameter
Returns list of control-file names currently used
Return value
list <string> - files
Returns whether some additional control files are currently in use.
Return value
boolean - some additional control files are in use.
Function uses the Base Workflow as the initial one and merges all added workflow into that workflow.
Return value
boolean - if successful
Check all proposals, split those ones which have multiple modes or architectures or stages into multiple proposals.
Function parameters
list <map> proposals
Return value
list <map> - updated proposals
Input: [ $["label":"Example", "name":"example","proposal_modules":["one","two"],"stage":"initial,firstboot"] ] Output: [ $["label":"Example", "name":"example","proposal_modules":["one","two"],"stage":"initial"] $["label":"Example", "name":"example","proposal_modules":["one","two"],"stage":"firstboot"] ]
Check all proposals, split those ones which have multiple modes or architectures or stages into multiple proposals. Works with base product proposals.
Return value
void
Check all workflows, split those ones which have multiple modes or architectures or stages into multiple worlflows. Works with base product workflows.
Return value
void
Check all workflows, split those ones which have multiple modes or architectures or stages into multiple workflows
Function parameters
list <map> workflows
Return value
list <map> - updated workflows
Redraws workflow steps. Function must be called when steps (or help for steps) are active. It doesn't work in case of active another dialog.
Return value
boolean
Removes workflow (if such workflow exists) from the Worflow Store. Alose removes the cached file but in the installation.
Function parameters
symbol type
integer src_id
string name
Return value
boolean - whether successful (true also in case of no workflow file)
Resets the Workflow (and proposals) to use the base workflow. It must be stored. Clears also all additional workflows.
Return value
void
Sets list of control-file names to be used. ATTENTION: this is dangerous and should be used in rare cases only!
Function parameters
list <string> new_list
Return value
void
Stores the current ProductControl settings as the initial settings. These settings are: workflows, proposals, inst_finish, and clone_modules.
Function parameters
boolean force
Return value
void
| | | |
| 293. Wizard_hw |  | 295. X11Version |