Module: chiefWorkflow

Holds all of the functions that manage the workflows, system defined workflows, client defined workflows, setting the workflow data and getting the workflow data.

Author:
  • Seth Hollingsead
Copyright:
  • Copyright © 2022-… by Seth Hollingsead. All rights reserved
Source:

Requires

Methods

(inner) loadCommandWorkflowsFromPath(commandWorkflowFilePathConfigurationName, contextName) → {boolean|object}

Loads the command workflows XML file that is specified by the input.

Parameters:
Name Type Description
commandWorkflowFilePathConfigurationName string

The path and file name to the XML that contains the command workflows definitions. (Could be system defined command workflows or client command defined command workflows)
contextName string

The context name defines what parent workflow namespace the loaded and merged data should be stored in. Example: contextName = "framework" => D['CommandWorkflows']['Framework'] contextName = "application" => D['CommandWorkflows']['Application'] contextName = "plugin" => D['CommandWorkflows']['Plugins']['']
Author:
  • Seth Hollingsead
Source:
Returns:

True or False if the data to be loaded is not from a plugin, returns a JSON object is the data to be loaded is from a plugin.

Type
boolean | object