Edit this page on Github

Web User Interface Guide

Create Job

Clicking the "Get Started" button on the welcome screen, or the "Create Job" item in the top navigation bar, will take you to the page where you create jobs.

On the right, a list of scripts are displayed. On the left, you can upload files.

Now, click "Upload Files" (or drag-and-drop) to select the document you want to validate or transform. ZIP-files are treated as directories. If you want to upload a directory structure, the files has to be zipped.

Select the script you want to use.
After choosing a script, you will be taken to the options panel.

More options can be displayed by clicking "Show" next to the option group title.

Click "Start job" to start the job.

When the job is started you will be redirected to the "Job View" page and see that it is "Running".

Job View

You can access this page through the “Jobs” menu item in the navigation bar at the top of the page.

A new job will either be "Running" or "Queued". The Pipeline 2 engine will by default allow at most two jobs to run at the same time. If you create more jobs, those jobs will be queued.

If the job succeeds, the status will change to "Success".

If there is a validation error, the status will change to "Validation failed".

If an error occurs during transformation, the status will change to "Failed".

When a job completes without errors, the results from jobs can be downloaded through download links that appear under the "Success" state.

Just below the "Job Summary" headline, you can click "Show details" to get more technical info about the job, such as its ID, and when it was started.

Further down the page, there may be a validation report, or another type of report depending on which script the job were running.

You can check the execution log to see what kind of tasks the job has performed. This is especially useful when a job fails so that you can determine why it failed.

A link is also provided to a more detailed log. The detailed log is a text file with more technical information. If you encounter a problem while executing job and want to ask for help (for instance on the DAISY Pipeline 2 forum), you should ideally attach the detailed log and if possible also the input fileset and arguments used.

At the end, there are links to download the input files, and a list of what parameters were used to run the job. There are also shortcuts for restarting the job, and for creating a new job with the same inputs and parameters.

Jobs List

By clicking the "Jobs" item in the top navigation menu you will be presented with a list of jobs. Normal users will see only their own jobs, while administrators can see everyones jobs.

Templates

For more information on templates, see the Templating documentation.

About Page

The about page contains a description of what DAISY Pipeline 2 is as well as external links to where you can find more information and get support. At the bottom, the version of the currently running Pipeline 2 engine and the Web UI are displayed.

Account settings

In the account settings you can change your name, email and password.

Admin Settings (for administrators)

Administrators have access to the “Admin settings” page, where they can configure several aspects of the Web UI; Users and Permissions, the Pipeline 2 Web API, Upload directory, E-mail settings, Maintenance, and Appearance.

For more info, see the Administrator settings documentation.