Calculation report template

The calculation PDF report can be configured based on a template. Calculation report templates can be defined in the Port management > Configuration > Report templates module. The following sections provide an overview of the supported variables for the calculation report template.

A calculation report template can be applied for a port on the port details page, in the Templates table under the Reporting tab. A template can be applied with type Report or Summary, corresponding to the actions with the same names on the calculation page.

Variable types

Four types of variables are distinguished: boolean, image, record set, textual.

Variables of type boolean can be used as part of a condition like:

1
2
3
<If Condition="...">
  ...
</If>

Variables of type record set can be used as part of a for-each (for a given set of supported members) like:

1
2
3
4
5
<ForEach Index="Value" Source="RecordSet">
  <GetVariable Name="Value.Member1"/>
  <GetVariable Name="Value.Member2"/>
  ...
</ForEach>

Variables

General

Variable	Type	Description
`TimeZone`	Textual	Time zone used timestamp throughout the report.
`Created`	Textual	Timestamp at which report is generated.
`Map`	Image	Map component with tidal window calculation information such as the route.
`Uri`	Textual	PROTIDE URL.

Flags

Variable	Type	Description
`IsJudged`	Boolean	Indicates whether the calculation result is judged (definitive, indicative, declined).
`HasJudgmentComment`	Boolean	Indicates whether a non-empty comment has been provided when judging the calculation result.
`HasAcknowledgments`	Boolean	Indicates whether the calculation has any acknowledgments.
`HasAirDraft`	Boolean	Indicates whether the calculation has an air draft.
`HasChecks`	Boolean	Indicates whether the calculation has any validation checks associated with it.
`HasElevations`	Boolean	Indicates whether the calculation has applied any channel bottom elevations.
`HasMaximumDraftResults`	Boolean	Indicates whether maximum draft calculation results pertaining to the calculation result are available.
`HasMeasurements`	Boolean	Indicates whether any measurements are attached to the calculation result (or the corresponding transit).
`HasRoute`	Boolean	Indicates whether the calculation result has a route defined (either safe or unsafe).
`HasRouteBottomTouchProbabilityCriterion`	Boolean	Indicates whether the calculation settings contain a safety criterion for route bottom touch probability.
`HasSegmentAlternatives`	Boolean	Indicates whether any segment alternatives have been considered as part of the calculation.
`HasAssociatedCalculations`	Boolean	Indicates whether any calculations for associated routes are coupled to the calculation.
`MetacentricHeightIsEstimated`	Boolean	Indicates whether the ship's initial metacentric height / GM₀ is estimated.
`FreeFluidsSurfaceCorrectionIsEstimated`	Boolean	Indicates whether the ship's free surface correction / GG' is estimated.
`RollPeriodIsEstimated`	Boolean	Indicates whether the ship's roll period is estimated.
`WaterDisplacementIsEstimated`	Boolean	Indicates whether the ship's water displacement is estimated.

Transit

Variable	Type	Description
`Transit.SubmittedBy`	Textual	Submitter of the transit.
`Transit.SubmittedAt`	Textual	Timestamp at which the transit is submitted.
`Transit.Route.Name`	Textual	Provides the route name.
`Transit.Route.Berth`	Textual	Provides the name of the route endpoint at berth.
`Transit.Route.PointAtSea`	Textual	Provides the name of the route endpoint at sea.
`Transit.Route.Depth`	Textual	Indicator for the route's depth (typically at berth).
`Transit.Route.Direction`	Textual	Provides the route's direction (inbound/outbound).
`Transit.Ship.Name`	Textual	Provides the ship name.
`Transit.Ship.Type`	Textual	Provides the ship type.
`Transit.Ship.ImoNumber`	Textual	IMO number of the ship.
`Transit.Ship.CallSign`	Textual	Call sign of the ship.
`Transit.Ship.Lpp`	Textual	Provides the ship's length (m) between perpendiculars.
`Transit.Ship.Width`	Textual	Provides the ship's width (m).
`Transit.Ship.DeadWeight`	Textual	Provides the ship's deadweight (t).
`Transit.Ship.Draft.Label`	Textual	Textual label for the draft.
`Transit.Ship.Draft.Value`	Textual	Provides the draft values or the draft range (if there are draft overrides).
`Transit.Ship.Draft.Forward`	Textual	Provides the draft at ship's forward.
`Transit.Ship.Draft.Mid`	Textual	Provides the draft at midship.
`Transit.Ship.Draft.Aft`	Textual	Provides the draft at ship's aft.
`Transit.Ship.Draft.Maximum`	Textual	Provides the maximum of the forward, midship, aft draft values.
`Transit.Ship.AirDraft.Label`	Textual	Textual label for the air draft.
`Transit.Ship.AirDraft.Value`	Textual	Provides the air draft value or the air draft range (if there are draft overrides).
`Transit.Ship.Stability.MetacentricHeight`	Textual	Provides the ship's initial metacentric height / GM₀ (m) for the considered transit.
`Transit.Ship.Stability.FreeFluidsSurfaceCorrection`	Textual	Provides the ship's free surface correction / GG' (m) for the considered transit.
`Transit.Ship.Stability.CorrectedMetacentricHeight`	Textual	Provides the ship's corrected metacentric height / G'M (m) for the considered transit.
`Transit.Ship.Stability.RollPeriod`	Textual	Provides the ship's roll period (s) for the considered transit.
`Transit.Ship.Stability.WaterDisplacement`	Textual	Provides the ship's water displacement (t) for the considered transit.
`Transit.Ship.Stability.Estimated.MetacentricHeight`	Textual	Indicates whether the ship's initial metacentric height / GM₀ is estimated for the considered transit.
`Transit.Ship.Stability.Estimated.FreeFluidsSurfaceCorrection`	Textual	Indicates whether the ship's free surface correction / GG' is estimated for the considered transit.
`Transit.Ship.Stability.Estimated.RollPeriod`	Textual	Indicates whether the ship's roll period is estimated for the considered transit.
`Transit.Ship.Stability.Estimated.WaterDisplacement`	Textual	Indicates whether the ship's water displacement is estimated for the considered transit.
`Transit.Ship.Stability.Calculator.RollPeriod`	Textual	Provides the name of the roll period calculator used to estimate the ship's roll period for the considered transit.

Calculation

Variable	Type	Description
`Calculation.Id`	Textual	Calculation ID.
`Calculation.SubmittedAt`	Textual	Timestamp at which the calculation is submitted.
`Calculation.StartTime`	Textual	Start time of the calculation period.
`Calculation.EndTime`	Textual	End time of the calculation period.
`Calculation.RollPeriodLow`	Textual	Lower bound of the roll period interval (s) used for the calculation.
`Calculation.RollPeriodHigh`	Textual	Upper bound of the roll period interval (s) used for the calculation.
`Calculation.Judgment`	Textual	Judgment assigned to the tidal window calculation.
`Calculation.CommentToJudgment`	Textual	Comment (if any) provided in combination with the judgment.
`Calculation.DataTime`	Textual	Timestamp (by means of a database snapshot) indicating the hydro meteo data used for the tidal window calculation.
`Calculation.Elevations`	Record set	Channel bottom elevations considered in the tidal window calculation. Members: `Segment`, `Low` (km), `High` (km), `GuaranteedDepth` (m), `Elevation` (m), `Depth` (m), `Comment`
`Calculation.Settings.Name`	Textual	Description of the calculation settings used for the tidal window calculation.
`Calculation.Settings.WaveModel`	Textual	Description of the type of waves used for the tidal window calculation (historical, predicted, none).
`Calculation.Settings.RouteBottomTouchProbabilityCriterion`	Textual	Configured value for the maximum allowed bottom touch probability across the whole route.
`Calculation.Speed.Name`	Textual	Description of the speed regime used for the tidal window calculation.
`Calculation.Speed.Values`	Record set	Speed regime values used in the tidal window calculation. Members: `StartPosition` (km), `EndPosition` (km), `Speed` (kn), `Distribution`
`Calculation.Validation.Checks`	Record set	Checks executed for the tidal window calculation with overview of any warnings. Members: `Description`, `Valid`, `Warnings`
`Calculation.Acknowledgements`	Record set	Overview of acknowledgments for the calculation. Members: `User`, `Comment`
`Calculation.SelectedAlternatives`	Textual	Description of the segment alternatives used as part of the calculation.
`Calculation.SubmittedBy`	Textual	Submitter of the calculation.
`Calculation.UseManualPredictions`	Textual	Indicates whether manual data overrides are considered (if available) in the calculation.
`Calculation.UseChannelBottomElevations`	Textual	Indicates whether channel bottom elevations are considered (if available) in the calculation.
`Calculation.Archived`	Textual	Indicates whether the calculation is archived.

Calculation result

Variable	Type	Description
`CalculationResult.Statistics.DownTime`	Textual	Calculated down time.
`CalculationResult.Statistics.BottomTouchProbability.Mean`	Textual	Calculated route bottom touch probability (mean).
`CalculationResult.Statistics.BottomTouchProbability.WorstCase`	Textual	Calculated route bottom touch probability (worst-case percentile).
`CalculationResult.Statistics.UnderKeelClearance.Mean`	Textual	Calculated average static UKC (m) over the route.
`CalculationResult.Statistics.UnderKeelClearanceMinusSquat.Mean`	Textual	Calculated average UKC minus squat (m) over the route.
`CalculationResult.Statistics.UnderKeelClearanceMinusAllCorrections.Mean`	Textual	Calculated average UKC minus all corrections (m) over the route.
`CalculationResult.Statistics.WaitTime`	Textual	Calculated wait time.
`CalculationResult.Passages`	Record set	Calculated passage timestamps for route and (if applicable) open/closure timestamps for tidal window. Members: `Name`, `Position` (km), `Open`, `Itinerary`, `Close`, `Speed` (kn), `StaticUkc` (m), `DynamicUkc` (m)
`CalculationResult.AssociatedRoutes`	Record set	Calculated associated routes with (if applicable) open/closure timestamps for tidal window. Members: `Name`, `Position` (km), `Open`, `Itinerary`, `Close`
`CalculationResult.MaximumDrafts`	Record set	Calculated maximum draft results. Members: `TimeOfDeparture`, `MinimumWidth` (h), `Value` (m)

Diagrams

The template supports a collection of diagrams. For each diagram also a flag indicating its availability is supported.

Variable	Type	Description
`Has{Name}Diagram`	Boolean	Indicates whether diagram `{Name}` is available.
`Diagrams.{Name}`	Image	Provides an image for diagram `{Name}`.

Supported values (i.e. diagrams) for {Name}:

BottomTouchProbability
Channel
OverheadClearance
RollPitch
Speed
Squat
Tide
TimeLocation
UnderKeelClearance
VerticalMotion
WaveHeight
WaveSpectrum

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<Division Classes="TopLeft">
  <Division>
    <Localize><en-US>Calculation</en-US><nl>Berekening</nl></Localize>: <GetVariable Name="Calculation.Id"/>
  </Division>
  <Division>
    <Localize><en-US>Judgment</en-US><nl>Beoordeling</nl></Localize>: <GetVariable Name="Calculation.Judgment"/>
  </Division>
</Division>

<Division Classes="TopRight">
  <GetVariable Name="Uri"/>
</Division>

<Division Classes="BottomCenter">Calculated by PROTIDE</Division>

<H1><GetVariable Name="Transit.Ship.Name"/> (<GetVariable Name="Transit.Route.Direction"/>)</H1>

<P>
  IMO: <GetVariable Name="Transit.Ship.ImoNumber"/>,
  <Localize><en-US>Call sign</en-US><nl>Roepteken</nl></Localize>: <GetVariable Name="Transit.Ship.CallSign"/>
</P>

<Table>
  <Tr>
    <Th><Localize><en-US>Ship</en-US><nl>Schip</nl></Localize></Th>
    <Td>
      <GetVariable Name="Transit.Ship.Type"/>,
      lpp: <GetVariable Name="Transit.Ship.Lpp"/>m,
      w: <GetVariable Name="Transit.Ship.Width"/>m
    </Td>
  </Tr>
  <Tr>
    <Th><Localize><en-US>Draft</en-US><nl>Diepgang</nl></Localize></Th>
    <Td>
      <Localize><en-US>Forward</en-US><nl>Voor</nl></Localize>: <GetVariable Name="Transit.Ship.Draft.Forward"/>m,
      <Localize><en-US>Middle</en-US><nl>Midden</nl></Localize>: <GetVariable Name="Transit.Ship.Draft.Mid"/>m,
      <Localize><en-US>Aft</en-US><nl>Achter</nl></Localize>: <GetVariable Name="Transit.Ship.Draft.Aft"/>m
    </Td>
  </Tr>
</Table>

<GetVariable Name="Map"/>

<If Condition="HasRoute">
  <Table>
    <Tr>
      <Th><Localize><en-US>Location</en-US><nl>Locatie</nl></Localize></Th>
      <Th><Localize><en-US>Itinerary</en-US><nl>Vaarplan</nl></Localize></Th>
      <Th><Localize><en-US>Tidal window</en-US><nl>Tijpoort</nl></Localize></Th>
      <Th><Localize><en-US>Speed</en-US><nl>Snelheid</nl></Localize></Th>
      <Th><Localize><en-US>Static UKC</en-US><nl>Statische UKC</nl></Localize></Th>
      <Th><Localize><en-US>Dynamic UKC</en-US><nl>Dynamische UKC</nl></Localize></Th>
    </Tr>
    <ForEach Index="Passage" Source="CalculationResult.Passages">
      <Tr>
        <Td><GetVariable Name="Passage.Name"/></Td>
        <Td><GetVariable Name="Passage.Itinerary"/></Td>
        <Td><GetVariable Name="Passage.Open"/> - <GetVariable Name="Passage.Close"/></Td>
        <Td><GetVariable Name="Passage.Speed"/>kn</Td>
        <Td><GetVariable Name="Passage.StaticUkc"/>m</Td>
        <Td><GetVariable Name="Passage.DynamicUkc"/>m</Td>
      </Tr>
    </ForEach>
  </Table>
</If>

<If Condition="HasTimeLocationDiagram">
  <GetVariable Name="Diagrams.TimeLocation"/>
</If>