Pipeline Lite

Overview

The Pipeline Lite is a minimalist user interface used to run single Pipeline jobs.

It consists in a sequence of dialogs to select a Pipeline script, configure the job, run it and report the result.

The main idea is to ease the development of "export" functionality based on the Pipeline in third-party applications.

Detailed Walkthrough

The following is a detailed description of the different dialogs making up the Pipeline Lite. Note that some of these dialogs are skippable or customizable via command line options.

1. Script Selection

This dialog allows the user to select a script to instantiate into a job.

The script list is matching the content of the scripts directory in the Pipeline home.

script selection dialog

The script selection dialog is skipped if the user directly specifies a script file with the --script option.

2. Job Configuration

When a script is selected (via the script selection dialog or the --script command line option), a job is created and the job configuration dialog is shown to set the job parameters.

The dialog initially shows only the required parameters for the job. The Run button becomes enabled when all these required parameters are set.

02-jobconfig

Additionally, the user can expand the dialog to access the optional parameters by pressing the Advanced button.

03-jobconfigexpanded

The job configuration dialog is skipped if the user specified the --execute option and set all the required parameters with the -params option.

3. Job Progress

When the job is finally launched (via the Run button of job configuration dialog or directly via the --execute command line option), a progress information dialog is shown.

This dialog consists in a simple progress bar labelled with the job name. The name of the subtask is displayed by default below the progress bar and can be hidden with the --no-subtask command line option.

04-jobprogress

The job execution can be cancelled by pressing on the Cancel button. The modifications of the file system that already occurred will not be undone though.

4. Job Result

Finally, when the job execution is completed a result dialog is shown.

05-jobcompleted

The user can access the detailed list of Pipeline messages by pressing on the Details button.

06-jobcompletedexpanded

The messages can be copied to the system clipboard using the usual keyboard shortcuts or a popup menu.

The severity above which messages are logged is configurable with the --verbosity command line option.

The job result dialog is skipped if the user specified the --quit option.

5. Error Dialog

When the job execution fails, an error dialog is shown.

07-jobfailed

The user can access the detailed list of Pipeline messages by pressing on the Details button.

08-jobfailedexpanded

The messages can be copied to the system clipboard using the usual keyboard shortcuts or a popup menu.

The severity above which messages are logged is configurable with the --verbosity command line option.

Options

Here is a description of the different options of Pipeline Lite.

usage: pipeline [options] [-s <file>] [-p <param#value,...>]

Options:
 -i,--info display information on the script
 specified with '-s'
 --no-subtask don't display the subtask label in the
 progress dialog
 -h,--help print this help message
 -p,--params <param#value,...> set script parameters
 -q,--quit quit after a successful execution (no
 result dialog)
 -s,--script <file> the script file to execute
 -v,--verbosity <threshold> the severity above which messages are
 logged.
 Possible values are: DEBUG, INFO_FINER (default),
 INFO, WARNING, ERROR
 -x,--execute execute the script directly if all
 required parameters are set

Examples:
 1. pipeline -i -s path/to/DTBAudioEncoder.taskScript
 2. pipeline -x -q -s path/to/DTBAudioEncoder.taskScript -p input#path/to/manifest.opf output#path/to/dir bitrate#32

Note that on Windows, the user can launch the Pipeline Lite via a pipeline-lite.bat DOS script on the command line, or via a pipeline-lite.exe executable file. In the latter case the application will be run in GUI mode, and the options can be passed by creating a shortcut pointing to this executable.