Get information about project flows

This page shows you how to get a list of the flows that are added to your project and view the details of those flows. You can also list the predecessor-follower dependencies of flows that are connected.

Prerequisites

You must install the WVS Desktop client.

List flows for your project

To get a list of flows for your project, run the following command:

wvs flow status

The command returns something like the following:

C:\wvsProjects\ue4-shootergame>wvs flow status

  Name                  Display Name          Source Flow           Ctgry       Enabled
---------------------------------------------------------------------------------------
  LinuxNoPak            Linux no pak          UE Linux Build        build       true
  LinuxPak              Linux pak             UE Linux Build        build       true
  SendToDropbox         Send to Dropbox       Copy to Dropbox       deploy      false
  Editor                ShooterGame Editor    UE Linux Build        build       true
  LinuxNoPakToS3        To S3 LinuxNoPak      Deploy S3             deploy      true
  LinuxPakToS3          To S3 LinuxPak        Deploy S3             deploy      true
  WinNoPakToS3          To S3 WinNoPak        Deploy S3             deploy      true
  WinPakToS3            To S3 WinPak          Deploy S3             deploy      true
  ZipToS3               To S3 ZipAll          Deploy S3             deploy      true
  WinNoPak              Windows no pak        UE Windows Build      build       true
  WinPak                Windows pak           UE Windows Build      build       true
  ZipAll                Zip All               Zip                   other       true
OK

C:\wvsProjects\ue4-shootergame>_

The following table explains what each column shows:

Column heading Description
Name The name of the flow instance.
Display Name ???
Source Flow The flow that the flow instance is created from.
Ctgry The type of flow it is. Possible values include: build, deploy, render, data conversion, report, alert, and other.
Enabled Shows whether the flow is enabled or disabled for the project. For details, see Enable or disable flows.

List flow dependencies

Flows can be connected to other flows such that the output of one flow becomes the input of another. In this case, the flow whose output becomes the input of another flow is called the predecessor. The flow that takes output of another flow as its input is called the follower. In the following diagram, Flow1 is the predecessor of Flow2, which makes Flow2 the follower of Flow1:

Flow1 (predecessor) > Output1 > Flow2 (follower) > Output2

This predecessor-follower dependency between flows is relative. A flow that’s the predecessor of one flow can also be the follower of another flow. In the following diagram, Flow2 is the follower of Flow1 and the predecessor of Flow3:

Flow1 (predecessor) > Output1 > Flow2 (follower) > Output2

Flow2 (predecessor) > Output2 > Flow3 (follower) > Output3

List predecessors

To list the predecessors of each flow in your project, use the --predecessors flag with the wvs flow status command:

wvs flow status --predecessors

The command returns something like the following:

C:\wvsProjects\ue4-shootergame>wvs flow status --predecessors

  Name                  Display Name          Source Flow           Ctgry       Enabled
---------------------------------------------------------------------------------------
  LinuxNoPak            Linux no pak          UE Linux Build        build       true
  LinuxPak              Linux pak             UE Linux Build        build       true
  SendToDropbox         Send to Dropbox       Copy to Dropbox       deploy      false
  Editor                ShooterGame Editor    UE Linux Build        build       true
  LinuxNoPakToS3        To S3 LinuxNoPak      Deploy S3             deploy      true
  LinuxPakToS3          To S3 LinuxPak        Deploy S3             deploy      true
  WinNoPakToS3          To S3 WinNoPak        Deploy S3             deploy      true
  WinPakToS3            To S3 WinPak          Deploy S3             deploy      true
  ZipToS3               To S3 ZipAll          Deploy S3             deploy      true
  WinNoPak              Windows no pak        UE Windows Build      build       true
  WinPak                Windows pak           UE Windows Build      build       true
  ZipAll                Zip All               Zip                   other       true

Predecessors
    'SendToDropbox' Depends on:
        WinPak
    'LinuxNoPakToS3' Depends on:
        LinuxNoPak
    'LinuxPakToS3' Depends on:
        LinuxPak
    'WinNoPakToS3' Depends on:
        WinNoPak
    'WinPakToS3' Depends on:
        WinPak
    'ZipToS3' Depends on:
        ZipAll
    'ZipAll' Depends on:
        LinuxPak
        LinuxNoPak
        WinPak
        WinNoPak
OK

C:\wvsProjects\ue4-shootergame>_

List followers

To list the predecessors of each flow in your project, use the --followers flag with the wvs flow status command:

wvs flow status --followers

The command returns something like the following:

C:\wvsProjects\ue4-shootergame>wvs flow status --followers

  Name                  Display Name          Source Flow           Ctgry       Enabled
---------------------------------------------------------------------------------------
  LinuxNoPak            Linux no pak          UE Linux Build        build       true
  LinuxPak              Linux pak             UE Linux Build        build       true
  SendToDropbox         Send to Dropbox       Copy to Dropbox       deploy      false
  Editor                ShooterGame Editor    UE Linux Build        build       true
  LinuxNoPakToS3        To S3 LinuxNoPak      Deploy S3             deploy      true
  LinuxPakToS3          To S3 LinuxPak        Deploy S3             deploy      true
  WinNoPakToS3          To S3 WinNoPak        Deploy S3             deploy      true
  WinPakToS3            To S3 WinPak          Deploy S3             deploy      true
  ZipToS3               To S3 ZipAll          Deploy S3             deploy      true
  WinNoPak              Windows no pak        UE Windows Build      build       true
  WinPak                Windows pak           UE Windows Build      build       true
  ZipAll                Zip All               Zip                   other       true

Followers
    'LinuxNoPak' is a prerequisite for:
        LinuxNoPakToS3
        ZipAll
    'LinuxPak' is a prerequisite for:
        LinuxPakToS3
        ZipAll
    'WinNoPak' is a prerequisite for:
        WinNoPakToS3
        ZipAll
    'WinPak' is a prerequisite for:
        SendToDropbox
        WinPakToS3
        ZipAll
    'ZipAll' is a prerequisite for:
        ZipToS3
OK

C:\wvsProjects\ue4-shootergame>_

Get information about flow instances

To get information about a specific flow instance in your WVS project, run the following command:

wvs flow inspect <FLOW_NAME>

Where &lt;FLOW_NAME> is the name of the flow instance.

The command returns something like the following:

C:\wvsProjects\ue4-shootergame>wvs flow inspect WinPak

    Definition:
        Filename:               .wvs\flows\WinPak.json
        SystemName:             WinPak
        Location:               wvs
        Definition:             wvs-flows/build-ue5|/build_ue5_windows|v1.3.x

    Attributes:
        DisplayName:            Windows pak
        Flavor:                 Shipping Build
        Enabled:                true
        ManualOnly:             false
        ManualTrigger:          -doDevBuildWd
        Branches:               main
                                testFlows
                                develop
        Changes:                Content/**/*
                                Source/**/*
                                Plugins/**/*
                                Config/**/*
                                .wvs/flows/*
                                .wvs/flowRepo/*
                                .wvs/root-ci.yml
                                README.md
        EngineVersion:          4.27
        EngineTargetPlatform:   windows

    Required Input Variables:
        PROJECT_DIR                         : $CI_PROJECT_DIR
        PROJECT_FILE                        : $PROJECT_DIR/ShooterGame.uproject

    Optional Input Variables:
        SHARED_DDC_USER                     : Default ($WVSUSR_UE_DDC_KEY)
        SHARED_DDC_PASSWORD                 : Default ($WVSUSR_UE_DDC_SECRET)
        OUTPUT_NAME                         : Default ($CI_JOB_NAME)
        target                              : ShooterGame
        pak                                 : Default (true)
        map                                 : NOT SET

    Output Variables:
        OUTPUT_BUILD_ARTIFACT
OK

C:\wvsProjects\ue4-shootergame>_

The following chart explains the sections of the command output:

Section Description
Definition
Attributes Value that all flows have, regardless of its type.
Required input variables Values that are specific to a single flow and are documented by the author of that flow.
Optional input variables
Output variables

Next steps