Task: Author the cliquet fact table
Table of Contents
This page documents a task in the Rework the equity instruments to the instrument table rule story. It captures the goal, current status, acceptance, and any notes or results.
1. Goal
A cliquet's own terms have a table, and no cliquet column has to fit the vanilla option's shape.
2. Status
| Field | Value |
|---|---|
| State | DONE |
| Parent story | Rework the equity instruments to the instrument table rule |
| Now | Nothing. |
| Waiting on | Nothing. |
| Next | Nothing. |
| Last touched | 2026-10-18 |
3. Acceptance
4. Plan
(Implementation strategy. Written when work starts; key decisions
are distilled into the parent story's * Decisions at close, but the
plan itself stays — it is the historical record of what we did.)
5. Measurements
Every number this task claims about a tree, with the command that produced it
and the commit it was measured at. A number without both is not a measurement,
because a clean-up record describes a tree and trunk moves under a branch: a
consumer count, a gate's component count and a suite's size all change with no
code changing, and the reader of a bare number cannot tell which tree it came
from. Where the raw output matters, put it in an evidence/ file beside the
task and name that file in the Command column.
| What | Value | Command | Commit |
|---|---|---|---|
6. Notes
7. Test Scenarios
Manual QA scenarios (scaffolded via compass add test_scenario)
that verify this task. Link
new ones here as they're created; the scenario doc itself links back
via its "Verifies task" field.
| Scenario | State | Notes |
|---|---|---|
8. PRs
| PR | Title |
|---|---|
| #3495 | [trading] Author the cliquet fact table |
9. Review
| Comment summary | File | Decision | Notes |
|---|---|---|---|
10. Result
The cliquet has its own fact table. It is authored from the ORE cliquet binding, so every column answers to something the document states: the underlying, the currency, the notional, long or short, call or put, the moneyness, the local and global caps and floors, the settlement days, the premium with its currency and payment date.
Every amount is money and so an exact numeric: the notional, the four caps and floors and the premium. The moneyness is a ratio rather than an amount, so it is a continuous quantity and stays a binary float. Every column the binding makes optional is nullable, so an absent term stays null.
Verification. Full build clean and the whole suite passes 96 of 96 with the database recreated for the new table.
Not done, and named: no mapper writes this table, and the EquityCliquetOption code still routes to equity_option_instruments. Both move with the mapper migration the operator deferred until the XML changes settle.