Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 3.69 KB

fmeflow_run.md

File metadata and controls

68 lines (49 loc) · 3.69 KB
Raw

fmeflow run

Run a workspace on FME Server.

Synopsis

Run a workspace on FME Server.

fmeflow run [flags]

Examples


  # Submit a job asynchronously
  fmeflow run --repository Samples --workspace austinApartments.fmw
	
  # Submit a job and wait for it to complete
  fmeflow run --repository Samples --workspace austinApartments.fmw --wait
	
  # Submit a job to a specific queue and set a time to live in the queue
  fmeflow run --repository Samples --workspace austinApartments.fmw --tag Queue1 --time-to-live 120
	
  # Submit a job and pass in a few published parameters
  fmeflow run --repository Samples --workspace austinDownload.fmw --published-parameter-list THEMES=railroad,airports --published-parameter COORDSYS=TX83-CF
	
  # Submit a job, wait for it to complete, and customize the output
  fmeflow run --repository Samples --workspace austinApartments.fmw --wait --output="custom-columns=Time Requested:.timeRequested,Time Started:.timeStarted,Time Finished:.timeFinished"
	
  # Upload a local file to use as the source data for the translation
  fmeflow run --repository Samples --workspace austinApartments.fmw --file Landmarks-edited.sqlite --wait

Options

      --repository string                      The name of the repository containing the workspace to run.
      --workspace string                       The name of the workspace to run.
      --wait                                   Submit job and wait for it to finish.
      --tag string                             The job routing tag for the request
      --published-parameter stringArray        Published parameters defined for this workspace. Specify as Key=Value. Can be passed in multiple times. For list parameters, use the --list-published-parameter flag.
      --published-parameter-list stringArray   A List-type published parameters defined for this workspace. Specify as Key=Value1,Value2. Can be passed in multiple times.
      --file string                            Upload a local file Source dataset to use to run the workspace. Note this causes the translation to run in synchonous mode whether the --wait flag is passed in or not.
      --run-until-canceled                     Runs a job until it is explicitly canceled. The job will run again regardless of whether the job completed successfully, failed, or the server crashed or was shut down.
      --time-until-canceled int                Time (in seconds) elapsed for a running job before it's cancelled. The minimum value is 1 second, values less than 1 second are ignored. (default -1)
      --time-to-live int                       Time to live in the job queue (in seconds) (default -1)
      --description string                     Description of the request.
      --success-topic stringArray              Topics to notify when the job succeeds. Can be specified more than once.
      --failure-topic stringArray              Topics to notify when the job fails. Can be specified more than once.
      --node-manager-directive stringArray     Additional NM Directives, which can include client-configured keys, to pass to the notification service for custom use by subscriptions. Specify as Key=Value Can be passed in multiple times.
  -o, --output string                          Specify the output type. Should be one of table, json, or custom-columns (default "table")
      --no-headers                             Don't print column headers
  -h, --help                                   help for run

Options inherited from parent commands

      --config string   config file (default is $HOME/.config/.fmeflow-cli.yaml)
      --json            Output JSON

SEE ALSO

  • fmeflow - A command line interface for interacting with FME Flow.