Skip to content

sasjs flow

The sasjs flow command allows SAS Administrators to configure a batch schedule using a JSON file, to trigger the batch using a command line, and to capture the results of the flow in a CSV file.

Jobs can be executed in parallel, or in sequence following the successful completion of the previous job(s).

Prerequisites

Before using this command, you will need to:

  • install the SASjs CLI
  • add a deployment target.
  • Create a flow source (JSON) file.

Syntax

sasjs flow <action> [additional arguments]

Additional arguments may include:

  • --source (alias -s) - path to the flow definition source file (*.json).
  • --logFolder (alias -l) - path to the folder where job logs will be saved.
  • --csvFile (alias -c) - path to the CSV file containing job statuses will be saved. This file is replaced if the command is re-executed.
  • --target (alias -t) - the target environment in which to deploy the services. If not specified, default target will be used, mentioned in sasjsconfig.json. The target can exist either in the local project configuration or in the global .sasjsrc file.

Source JSON file

This is the file where the pattern of the flow is configured. A very simple flow definition might look like this:

{
  "name": "simpleFlow",
  "flows": {
    "flow01": {
      "jobs": [
        {
          "location": "/Projects/subfolder/someJob1"
        },{
          "location": "/Projects/subfolder/someJob2"
        }
      ],
      "predecessors": []
    }
  }
}

The above is named "simpleFlow" with one flow named "flow01" and two Viya Jobs - which will execute in parallel (as they are in the same flow).

A more complicated one would look like this:

{
  "name": "myAmazingFlow",
  "flows": {
    "ourveryfirstflow": {
      "jobs": [
        {
          "location": "/Projects/job1"
        },
        {
          "location": "/Projects/job2"
        },
        {
          "location": "/Projects/job3"
        }
      ],
      "predecessors": []
    },
    "secondflow": {
      "jobs": [
        {
          "location": "/Projects/job11"
        }
      ],
      "predecessors": [
        "firstflow"
      ]
    },
    "anotherflow": {
      "jobs": [
        {
          "location": "/Public/job15"
        }
      ],
      "predecessors": [
        "ourveryfirstflow",
        "secondflow"
      ]
    }
  },
    "yetanotherflow": {
      "jobs": [
        {
          "location": "/Public/job115"
        }
      ],
      "predecessors": []
    }
  }
}

The above contains a flow definition with 4 flows:

  1. "ourveryfirstflow" - triggers 3 jobs at once, runs immediately as no predecessors
  2. "yetanotherflow" - triggers 1 job, runs immediately as no predecesors
  3. "secondflow" - triggers as soon as firstflow is complete and ONLY if the jobs all finish with SUCCESS status
  4. "anotherflow" - triggers once firstflow and secondflow are complete, but ONLY if all finish with SUCCESS

sasjs flow execute

Used to trigger the execution a flow of jobs on the SAS server.

Syntax

sasjs flow execute --source /local/flow.json --logFolder /local/log/folder --csvFile /local/some.csv -t targetName

The following arguments are optional:

  • logFolder - will default to the sasjsresults folder
  • csvFile - will also default to the sasjsresults folder
  • t - will default to the defaultTarget attribute (if available)

Usage

# run the flow of jobs using the target defined in sasjs add
sasjs flow execute -s /local/flow.json -l /local/log/folder --csvFile /local/some.csv -t myTarget

This will schedule SAS jobs and execute them according to the flow definition in the JSON file. Job logs will be returned as ".log' text files and saved to the local (--logFolder) folder. Details of the Job Executions and their status will be saved to the CSV file.

See Also