Skip to main content
System StatusContact Support
VersionOne Community

Configuring the Flow Plugin

This feature is available in Ultimate edition only.

editions-u.png

Overview 

The Flow plugin in maintained by Continuum and contains a number of useful functions.

All plugins support variable replacement in their properties. See Plugin Variables for details.

Artifact

New Revision

Creates a new revision of an artifact in the Continuum database and associates any work items and changes in the pipeline manifest with this artifact revision. This command must be used to create a new Package revision.

Parameters

  • Project - Project where this named Artifact is defined. If omitted, will assume the Project of the running Pipeline Instance.

  • Artifact Name - The name of a pre-defined Artifact to increment the Revision. This artifact will be pre-defined on the Project.

  • Branch - Optional - Branch this Artifact was built in. If omitted, will assume the Group of the running Pipeline Instance.

  • Artifact Location - Optional - The full URL address or file system location for the Artifact. Includes the filename. Example could be the URL in Artifactory or Nexus or just the filename of the resulting artifact.

  • Version - Optional - A Version label to describe this specific Artifact.

  • Build Identifier - Optional - Build identifier or job number from an external build or CI tool.

  • Build URL - Optional - URL to the record of the build in an external build tool.

  • Build Details - Optional - Additional data from the external build system.

Group

Set Global

Sets a value in the Globals of a Pipeline Group. A Pipeline Group is the combination of the Pipeline Definition, Project and Group values.

Parameters

  • Key - Globals key to set. (Dotted path notation is allowed and denotes nesting of values.)

  • Value - Value (string, list, object or variable) to be set at the specified Key.

Interact

Action

Halt this Instance for manual user interaction, defining an ad-hoc automation action.

Parameters

  • Tags - A comma separated list of tags that define who is allowed to run the action. Default is everyone.

  • Actions Definition - JSON document defining one or more Actions to present. For more information see the Continuum documentation under Flow, General, Actions for JSON structure and options.

Confirmation

Halt this Instance for a manual user interaction, prompting for a confirmation.

Parameters

  • Tags - A comma separated list of tags that define who is allowed to run the action. Default is everyone.

  • Title - A title for the dialog prompt.

  • Text - A question or statement to guide or prompt the user.

Manifest

Evaluate Changes

Sometimes, decisions should be made when specific details of one or more changes on a Manifest match certain criteria.Evaluate Changes provides the ability to set several Workspace variables based on the true/false result of an evaluation expression which is applied to every change on the Manifest.

Parameters

  • Expression - (required) - An expression to apply to the change document.

  • Key - Key to set to True if any change matches the criteria, else False.

  • Count - Key to set with the count of changes that matched the expression.

Additional Arguments

Additional and less common arguments are supported:

  • notify_contributor - If 'true', will send a message to the person who made the change.

  • notify_cc - Additional comma-separated email addresses to receive a notification.

  • notify_subject - Custom subject for the notification. ("Invalid Changes - Continuum" if omitted.)

  • notify_message - Additional informational text that will be added to the default email message.

Evaluate Work Items

Sometimes, decisions should be made when specific details of one or more work items on a Manifest match certain criteria.Evaluate Workitems provides the ability to set several Workspace variables based on the true/false result of an evaluation expression which is applied to every work item on the Manifest.

Parameters

  • Expression - (required) - An expression to apply to the work item document.

  • Key - Key to set to True if any work item matches the criteria, else False.

  • Count - Key to set with the count of work item that matched the expression.

Package

New Revision

Create a new Revision of the specified Package from the Artifacts on the Manifest of this Instance.

Parameters

  • Package Name - Name of the Package to create a new revision on.

  • Version - Version identifier of the Package. Required to group revisions within a specific Package Version. Should be as precise as necessary for meaningful grouping. E.g: 3.4

  • Full Version - Usually a unique descriptive label of this exact Revision, typically a version and some sort of build identifier. (Tip: Will not be useful unless it's unique to this specific Package Revision.)

  • Globals Key - Optional - Workspace key to receive Package Globals.

  • Result Key - Optional - Workspace key to receive the results of this function.

Load Revision

Load the Manifest of the specified Package Revision into the Pipeline Instance Manifest.

Parameters

  • Package Name - Name of the Package.

  • Revision - Revision of the Package to laod into the pipeline instance.

  • Globals Key - Optional - Workspace key to receive Package Revision Globals.

Get Artifacts

Reads the Artifacts of the specified Package Revision into the Instance Workspace.

Parameters

  • Package Name - Name of the Package from which to load the artifacts.

  • Revision - Revision of the Package from which to load the artifacts into the pipeline instance workspace.

  • Artifact Key - Workspace key to receive Artifact details.

Get Artifact

Reads a specific Artifact in the specified Package Revision into the Instance Workspace.

Parameters

  • Package Name - Name of the Package from which to load the artifacts.

  • Revision - Revision of the Package from which to load the artifacts into the pipeline instance workspace.

  • Artifact Name - Name of the Artifact to load from the Package Revision.

  • Artifact Key - Workspace key to receive Artifact details.

Get Global

Load the Globals of the specified Package Revision into the Instance Workspace.

Parameters

  • Package Name - Name of the Package to load the globals from.

  • Revision - Revision of the Package to load the globals from.

  • Globals Key - Workspace key to receive Package Globals.

Set Global

Sets a value in the Globals of the specified Package.

Parameters

  • Package Name - Name of the Package to set the globals on.

  • Revision - Revision of the package on which to set a global value on.

  • Key - Globals key to set. (Dotted path notation is allowed and denotes nesting of values.)

  • Value - Value (string, list, object or variable) to be set at the specified Key.

Pipeline

Initiate

Initiate a new Pipeline at the successful completion of this one.

Parameters

  • Pipeline Definition - The name of the Pipeline Definition to initiate.
  • Project - The Project to run this Pipeline in.
  • Group - A grouping label for the many instances like this one (story, branch, 'master', etc.)
  • Initial Workspace Data - Optional - Initial Workspace Data to set on the target pipeline, must be a JSON object.
    { 'keyone': 'foo', 'keytwo': [ 'bar', 'bar2' ] }

Set Data

Set an explicit property in this Instance's data document.

Parameters

  • Key - A key to be set in the root of the Pipeline Instance data document. (Dotted path notation is allowed and denotes nesting of values.)

  • Value - Value (string, list or object) to be set at the specified Key.

Set Name

Set the Name property of the running Pipeline Instance.

Parameters

  • Name - Variable or expression to set as the new Name.

  • Project - New Version

  • Increment or set the version of the associated Project.

Parameters

  • To Version - Set the Project version to the specified number. If used, overrides 'Increment'.

  • Increment - 'major', 'minor' or 'plusone'. 'major/minor' will increment the specified segment by 1. 'plusone' will increment to the next ascending integer. If 'To Version' is set, increment is ignored.

  • Was this article helpful?