User guide

The Rail dashboard

The module home screen: two summary cards, relation coverage and train path usage, leading to each screen already filtered.

The Rail transport screen is the entrance to the Rail module. It answers two questions for the current period or the next one: how many relations remain to cover, and how many train paths are wasted. Nothing is done there: every figure is a link to the screen where you can act, already filtered on what needs looking at.

The two cards. Each has its own period tabs: you can read the coverage of the current period and the usage of the next one at the same time.
The two cards. Each has its own period tabs: you can read the coverage of the current period and the usage of the next one at the same time.
The Rail transport screen: the Reference transport plan card on the left with its gauge, the Train paths card on the right with its usage percentage

Swipe sideways to browse the screenshot

Required right View the Rail module

The screen opens from the 4PL side menu, entry “Rail transport” (railway track icon), or from its address …/rail. The menu entry only exists if the account has the Rail feature. A card is only shown if the user has the matching read right: reading transport plans for the left card, reading train paths for the right one.

Choosing the period

Each card has its own tabs, independent from those of the other card.

  1. Current or next period

    Current period is the timetable period that contains today’s date. Next is the one that follows it, or, if there is no period in progress, the next one to come. Below the tabs, the period code and its start and end dates.

    The two tabs Current period and Next of a card, with the period code and dates below them
  2. A tab can be missing

    A tab is hidden when the matching period does not exist; the card then switches to the other one by itself. Without any period, the card shows “No period scheduled”.

The indicators are computed when the screen opens and every time a tab changes.

The Reference transport plan card

It sums up the relation coverage of the period: among all the relations of the transport plans, how many are covered by train paths.

  1. Reading the gauge

    The circular gauge gives the percentage of covered relations: relations with the Covered or Over-covered status, divided by the total number of relations in the period. It is green from 90%, orange from 60%, red below. Under the gauge, “N relations to cover” counts the Not covered and Partial relations; when everything is covered, the sentence “All relations of the period are covered” is shown in green.

    The circular coverage gauge, with its percentage in the centre and the number of relations to cover below
  2. Reading the breakdown

    Under the gauge, one line per status present (Covered, Partial, Not covered, Over-covered): a coloured dot, the label, the number of relations. A status with no relation does not appear.

    The breakdown by status under the gauge: a coloured dot, the label and the number of relations for each status

What each area opens

Area What it opens
The gauge the Reference transport plan screen on the period, Coverage filter on Not covered and Partial: the list of what remains to do
A status of the breakdown the same screen, Coverage filter on that single status
“Open the screen” button the same screen on the period, without filter
“Week view” button the Week view screen: on the current week for the current period, on the first day of the period for the next one

While computing, the card shows an animated icon; on a loading error, a red error icon; on a period without any offer, “No offer on this period”.

The Train paths card

It sums up the train path usage of the period: among all the train paths, how many serve at least one relation.

  1. Reading the percentage and the bar

    The large percentage is the share of used train paths (Used, Partial or Over-used) over the total number of train paths in the period. The bar repeats it: blue for used train paths, pale red for unused ones. Below, two counters: “N used” (blue dot) and “N wasted” (pale red dot), the latter highlighted as soon as it exceeds zero.

    The large usage percentage, the blue and pale red progress bar, and the two counters used and wasted
  2. Spotting the over-used

    If train paths are used by several offers on the same day, an alert link “N over-used train paths” appears under the counters. It does not appear when there are none.

What each area opens

Area What it opens
“N used” the Train paths screen on the period, Usage status facet on Used, Partial and Over-used
“N wasted” the same screen, facet on Unused: the train paths you pay for without running them
The alert link the same screen, facet on Over-used
“Open the screen” button the same screen on the period, without filter

Same states as the left card: animated icon while computing, red error icon, and “No train path on this period” when the period has none.

A reading routine

The dashboard is read in an order, that of the questions it asks:

  1. Is the gauge green? If not, click it: the list of relations to cover opens, and each relation says how many train paths it is missing. See The reference transport plan.
  2. How many wasted? An unused train path costs without serving. Click the counter: either an offer is waiting for that train path and it needs linking, or the train path is surplus. See Train paths.
  3. Are there over-used ones? Two offers on the same train path on the same day cannot both run. The alert link lists them.
  4. And next week? The “Week view” button shows, day by day, what is still missing. See The week view.