Pipeline 2—Web Application User Guide
- Listing Templates
- Creating a New Job Based on a Template
- Creating a Template from Scratch
- Sharing a Template with Other Users
- User and Permissions
- Authenticated Mode
- Guest Mode
- Public Mode
- Pipeline 2 API
- Storage Directories
- Email Settings
Creating a 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 can create jobs.
- A list of scripts are displayed on the right
- To upload files 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 have to be zipped.
- Select the script you want to use.
- 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. When the job is started you will be redirected to the Job View page where you will see that the job is Running.
The Job View
The Job View page can be accessed through the Jobs menu item in the navigation bar at the top of the page. The details of this view are described below:
Job Summary Status
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 than 2 jobs, those jobs will be queued.
- Success—If the job succeeds, the status will change to Success. Results from jobs can be downloaded through download links that appear under the Success state.
- Validation Failed—If there is a validation error, the status will change to Validation failed.
- Failed—If an error occurs during transformation, the status will change to Failed.
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.
The Execution Log
You can check this 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. If you encounter a problem while executing a job and want to ask for help, you should ideally attach the this detailed log file.
At the end of the Job View page, 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.
By clicking Jobs 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 everyone’s jobs.
To list templates, click the Templates tab in the navigation bar at the top of the page. By default, all templates available to you will be displayed. If you only want to display the templates that you have created yourself, click Your Templates.
Creating a New Job Based on a Template
Clicking New job on a template will create a new job. The job will be given a name that reflects the template that it is based on. You will be asked if you want to upload any additional files. Some files may already be present here if the template contains files.
The script that you should use is already defined by the template. As this has been predetermined, you can move on to complete the mandatory options. Some of the optional parameters may already have been pre-filled by the template—different templates can have different values.
When you are ready click Start job. You will then be redirected to the job view. At the bottom of the page you have three buttons, letting you either:
- restart the job
- create a similar job with slightly different option values
- save the job inputs and option values as a template for use later
Creating a Template from Scratch
To create a new template from scratch:
- Click New job
- Upload the files you want to include in the template, if any.
- Choose a script. You cannot create a template without choosing a script.
- Fill out the options as you want them to be stored in the template
- Click Save as template. You will notice that you are redirected to the template listing, where the new template is now highlighted.
- Rename your file if you wish. Click Rename next to the template, fill out a new name, and click Save.
Sharing a Template with Other Users
When you create templates, they are by default only visible to yourself (and administrators). Other users cannot use your private templates. If you wish to share a template, click Share with others in the template listing
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.
In the account settings area you can change your name, email and password.
Administrators have access to the Admin settings page, where they can configure several aspects of the Web UI.
Users and Permissions
The Users and Permissions tab lets you configure who gets access to the Web UI. General Settings contains two items:
- Show optional parameters: If you find that you need to use the optional parameters of a script a lot (when creating jobs) then you may want to enable the Show optional parameters option so that you don’t have to expand the parameter groups all the time.
- Authentication—the three available modes are described here:
- For the User—In authenticated mode, only users with a username and password can log in. If your server is available on the web, this is most likely the mode you will want to use. It is also the default mode. Users can change their own account details from the account page, by clicking their own name right next to the Log out menu item in the top navigation bar. If the user forgets their password they can initiate a reminder email from the login page.
- For the Administrator—The Add user link lets the administrator create a user. Users are uniquely identified by their e-mail address. If e-mails are enabled under E-mail settings then you don’t have to provide an initial password. Instead, the user that was created will receive an e-mail with a link to where they can set a password and activate their account. The name of the user that was created will appear in the list of users on the left side of the Users and permissions tab in Admin settings. You can change the details of the user here, as well as re-send the activation e-mail in case the user didn’t get the previous e-mail. If the user has forgotten their password, then a new forgotten password e-mail can be sent from here as well.
The difference between normal users and administrator users is that administrators have access to the Admin settings, and can see the jobs from all users. Normal users can only see their own jobs in the jobs listing.
Guests without a username can also use the Web UI if the Web UI is running in guest mode. Guest mode can be useful if you want to let users try the Web UI without having an account.
- For the User—In guest mode, users will be presented with the login page where they have the option of logging in as a guest. Guests do not see each other’s jobs in the jobs listing. If e-mail is enabled, the guest can fill in their e-mail address when creating a job and get an e-mail with a link to the job they create so that you can access the job later.
- For the Administrator—By clicking the name of the guest in the list of users under the Users and permissions tab in Admin settings, you can change the name of the guest user to something else.
In public mode, everyone is automatically logged in as a public user and redirected to the Create Job page. Public mode is useful if the Web UI is installed behind a firewall for use inside an organization, where requiring users to log in might not be very useful. All public users have access to the jobs created by other public users.
Under Scripts the administrator can choose which scripts to make available to users. This is useful if you want to clean up the list of jobs so that it is easier to create jobs, or if you want to prevent users from using certain resource intensive scripts.
Pipeline 2 API
Under the Pipeline 2 Web API tab you can configure the Pipeline 2 Web API endpoint you want to connect to.
Uploaded files, jobs, and templates, need to be stored and the default location for this is under the installation folder for the Web UI. You can change these directories if you want to use a bigger disk on the server.
If you enable e-mails then users can retrieve lost passwords, and guest users can get a link to their jobs. If you have a Gmail account you can simply enter your username and password in the Gmail panel. You can configure any other SMTP server manually in the SMTP panel.
In the Maintenance tab you can set up the automatic deletion of jobs after a certain duration. This is useful if there are a lot of jobs, or if the jobs contain big books (i.e. audio books), and you want to preserve disk space. There is also a link to download the system log, which can be useful for debugging.
Under Appearance you can change the title and visual theme of the Web UI. The title appears to the left of the top navigation bar, and as the tab or window title in the browser. Visual themes change the colors and fonts of the Web UI. More information on how to create themes can be found in the Web UI Branding guide.
Branding is the process of applying the name of your organization, logo, colors and overall appearance to the Web UI so that it matches your organization’s profile.
The default title of the Web UI is DAISY Pipeline 2. It appears on the left side of the top navigation bar, in the web browsers window or tab title, as well as other places. It can be customized through the Admin settings under Appearance.
Themes must be stored in the themes directory. A theme stored in themes/My Theme will appear as My Theme in the list of themes under Admin settings > Appearance > Visual themes. Resources stored inside /themes/My Theme will override the default resources if present. There are many Bootstrap themes available online, and they are typically distributed as a file called bootstrap.min.css. If you find a theme you like or create one using online tools, simply place the bootstrap.min.css file in the stylesheets directory of your theme to use it.
Tags: Pipeline 2