Pipeline 1 GUI User Guide

Menu

• First Launch Welcome Screen
• Scripts, Jobs and Transformers

• Script
• Job
• Transformer

• Perspectives and Views

• Jobs Perspective
• Documentation Perspective
• Navigating Between Perspectives and Views
• The Error Log

• Preferences Dialog
• Applying an Update Patch
• Making a Feature Request
• Reporting a Bug

This document is a guide to the graphical user interface version (GUI) of the DAISY Pipeline 1. If you want to run DAISY Pipeline using the command line version read the Command Line User Guide instead.

The Pipeline 1 GUI is a standalone desktop application, usually deployed via an installer. It allows the end user to use a rich graphical user interface to create Pipeline jobs, execute them and track their progress.

If you read this document before having installed the Pipeline 1 GUI, please refer to the Pipeline Installation Instructions.

First Launch Welcome Screen

The first time you launch the Pipeline 1 GUI, a Welcome Screen will open containing links to subpages with introductory information which are intended primarily as a help for first time users. You should follow the links given in the welcome screen, and read the information displayed. In particular, you should go to the Preferences Dialog to set the paths for temporary file storage, and the location of external executables. Read more about this in the Installation instructions.

The second time you launch the Pipeline 1 GUI, the welcome screen will not automatically open. If you want to get back to this screen, you can use the Welcome menu item in the Help menu.

To close the Welcome Screen:

1. select Navigation in the Window Menu
2. select Show System Menu
3. select close

Alternatively, click on the close button in the top left corner of the Welcome screen.

Scripts, Jobs and Transformers

These are central to understanding how DAISY Pipeline 1 works.

Script

Scripts are used to drive DAISY Pipeline 1, encapsulating a series of operations (transformers) that are applied to the input data of each job.

DAISY Pipeline 1 has a series of predefined Scripts. Documentation for the predefined Scripts exists in the Documentation Perspective.

Advanced users can also create their own Scripts with refinements and/or variations on the predefined versions.

Job

When you have selected a script to run, assigned input data that the script should use, configured details of the script’s behaviour, and selected where the output should be placed, you have created a Job.

Jobs are added through the New Job Wizard which can be launched either by selecting the New… Pipeline Job item in the File menu, or by pressing the Wizard button at the top left part of the Jobs View.

Transformer

Each Script contains one or several Transformers that are applied in sequence to the input data. When a Job is being run, you can see which Transformers are actually used in the Progress View.

Understanding how Transformers work is really only required when you are creating your own Scripts. If you are happy and content with the predefined scripts, you need not worry about Transformers.

Perspectives and Views

The GUI uses the terms Perspective and View to refer to different parts of the interface. A Perspective is more or less synonymous to a main window which contains subsections, referred to as Views.

DAISY Pipeline 1 GUI contains two Perspectives

• Job Perspective which contains several views
• Documentation Perspective

Navigating Between Perspectives and Views

There are several ways to navigate between the different Perspectives and Views.

To switch between perspectives—select Open Perspective in the Window menu and select the Perspective you wish to open. Alternatively, you can make use of the Perspective Icons in the top right corner of your current Perspective.

To open or set the focus on a certain view—select the view you want in the Show View in the Window menu.

You can also cycle between the different Perspectives and Views by using the Window menus Navigation entry.

The Error Log

The Error Log is not shown by default. To find it—select Show View…, Error Log from the Window menu item.

The Preferences Dialog

The Preferences Dialog can be accessed via Preferences in the Window menu item. This dialog contains various settings for configuring the appearance of the GUI and you can also modify keyboard shortcuts here.

The most important part of this dialog is the Paths section. The Installation document.describes the various paths.

Applying an Update Patch

DAISY Pipeline 1 can be updated by applying zipped patches provided by the development team. This feature is available via Updates in the Help section of the main menu bar.

The wizard will ask you to select the ZIP file containing the update patch, and if the patch is valid it will show its content along with some textual description. Click on the Finish button to apply the software update.

Note: update patches will usually consist of small software updates (such as the import of new Pipeline scripts, documentation files, etc). Greater changes will probably require a new installation and will not be available as update patches.

Making a Feature Request

To make a feature request, please sign on to SourceForge, and use the DAISY Pipeline 1 Feature Request tracker.

Reporting a Bug

To report a bug, please sign on to SourceForge, and use the DAISY Pipeline 1 Bug tracker.