The route

Export a print-ready PDF

Some readers want a file — for an audit, a handover, a ticket, an email. Export PDF turns the same documentation into one, laid out for printing, with the diagrams and every node's configuration in it.

Goal

A PDF of one pipeline, and a PDF of the whole project.

You'll need

  • Level 8.1 done.
  • About 10 minutes.

Steps

1. Pick what to export

In Documentation, click Export PDF:

Export Current or Export All

  • Export Current — the item selected in the sidebar: one pipeline, maestro or resource.
  • Export All — the whole project in one odara-documentation.pdf. Before building it, Odara renders any diagram that hasn't been captured yet, so no page has a blank diagram.

The PDF is built inside Odara — no external tools needed — and downloaded by your browser.

2. Read a page

Open the file and find w1-4-filter-to-csv:

One pipeline, as printed

The overview, the diagram, a Data Flow list with one line per connection (customers → active_pro), the node configurations and the SQL — the same content as the screen, in a layout meant for paper. The description you wrote in 8.1 is on the pipeline's page.

Expected result

  • Export Current on w1-4-filter-to-csv downloads a PDF of that pipeline only.
  • Export All downloads odara-documentation.pdf with a table of contents and one section per item — for the course project, around fifty pages.
  • Database connections appear as postgres://user:***@host…: no passwords.

Common pitfalls

Can't find the file. It went to your browser's download folder. The toast after the export names the usual location for your system, but if your browser saves elsewhere, that's where it is.

The PDF shows the host and user of your database. It does; only the password is hidden. Before sending a PDF outside your team, decide whether the reader should see where your database lives.

What you built

A snapshot of the project you can attach to anything. It's a snapshot, though: next week it's out of date. For something that stays current, publish it — the next level.

Check yourself

One question, drawn from a larger bank. Get it right to pass.

  1. Export Current exports…