Workflow Configuration

In this section, we introduce you to the possible settings in the workflow configuration file _wfconfig.ps1.

Each workflow must have its own configuration file.

The name _wfconfig.ps1 is fixed and can not be changed.

The file _wfconfig.ps1 is always a valid PowerShell script. This basically allows the format of the file to be PowerShelled. That means it can be tested e.g. in the "PowerShell ISE".

The _wfconfig.ps1 contains a command at the end of the file that starts a kenaflow check of that file when the _wfconfig.ps1 is executed as a script in PowerShell.




Apart from this check, the execution of the file in PowerShell directly, outside of kenaflow, is without effect and harmless - insofar as you have not implemented any code in this file.

It is important to understand that the configuration file _wfconfig.ps1 is a script, not a mere text file. So there can be executable code (PowerShell) in the file. During the execution of the workflow, the configuration file is read and executed. For example, dynamic workflow configurations can be created during execution. Please read Advanced Workflow Configuration for details.

Some settings in the workflow configuration file are identical for all workflow types.

They are documented here: General Workflow Settings

Other settings are special to the workflow type.

Most Important Settings to Start With

Following settings are included in every workflow configuration file _wfconfig.ps1:

  • Version [String] This is the version of kenaflow for which the workflow was built. This should only be changed if a workflow has been migrated to a new version of kenaflow.

  • Enabled [Boolean] If this value is set to $false, then the workflow will not be executed, unless the option --noignore is used with kenaflow.exe.

  • Name [String] Name of the workflow.

  • Id [Guid] This value specifies the unique ID of the workflow. This value must be unique at least in the kenaflow installation!