Class: Reset
Defines the reset value or fixing value produced in cashflow calculations, during the life-cycle of a financial instrument. The reset process defined in Create_Reset function joins product definition details with observations to compute the reset value.
URI: common_domain_model:Reset
classDiagram
class Reset
click Reset href "../Reset/"
Reset : averagingMethodology
Reset --> "0..1" AveragingCalculation : averagingMethodology
click AveragingCalculation href "../AveragingCalculation/"
Reset : observations
Reset --> "1..*" Observation : observations
click Observation href "../Observation/"
Reset : rateRecordDate
Reset : resetDate
Reset : resetValue
Reset --> "1" Price : resetValue
click Price href "../Price/"
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| resetValue | 1 Price |
Specifies the reset or fixing value | direct |
| resetDate | 1 date |
Specifies the date on which the reset occurred | direct |
| rateRecordDate | 0..1 date |
Specifies the 'Rate Record Day' for a Fallback rate | direct |
| observations | 1..* Observation |
Represents an audit of the observations used to produce the reset value | direct |
| averagingMethodology | 0..1 AveragingCalculation |
Identifies the aggregation method to use in the case where multiple observati... | direct |
Usages
| used by | used in | type | used |
|---|---|---|---|
| CalculateTransferInstruction | resets | range | Reset |
| TradeState | resetHistory | range | Reset |
In Subsets
Comments
- Rosetta condition: AveragingMethodologyExists — if observations count > 1 then averagingMethodology exists
- Rosetta func: ResolveInterestRateReset — Defines how to resolve the reset value for an InterestRatePayout.
- Rosetta func: InterestCashSettlementAmount — Defines the performance calculations relevant for a fixed or floating rate payout.
- Rosetta func: ResolveReset — Defines the interface for adopters to resolve a reset, given a trade state and a date.
- Rosetta func: ResolvePerformanceReset — Defines how to resolve the reset value for a performance payout.
- Rosetta func: ResolveSecurityFinanceBillingAmount — Calculates the billing amount for a Security Finance transaction.
Identifier and Mapping Information
Annotations
| property | value |
|---|---|
| metadata_key | True |
| rosetta_functions | [{"name":"ResolveInterestRateReset","description":"Defines how to resolve the reset value for an InterestRatePayout.","inputs":[{"name":"payouts","type":"InterestRatePayout","cardinality":"1.."},{"name":"observation","type":"Observation","cardinality":"1..1"},{"name":"resetDate","type":"date","cardinality":"1..1"},{"name":"rateRecordDate","type":"date","cardinality":"0..1"}],"output":{"name":"reset","type":"Reset","cardinality":"1..1"}},{"name":"InterestCashSettlementAmount","description":"Defines the performance calculations relevant for a fixed or floating rate payout.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"1..1"},{"name":"payout","type":"Payout","cardinality":"1..1"},{"name":"resets","type":"Reset","cardinality":"1.."},{"name":"date","type":"date","cardinality":"1..1"}],"output":{"name":"interestCashSettlementAmount","type":"Transfer","cardinality":"1..1"}},{"name":"ResolveReset","description":"Defines the interface for adopters to resolve a reset, given a trade state and a date.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"1..1"},{"name":"date","type":"date","cardinality":"1..1"}],"output":{"name":"reset","type":"Reset","cardinality":"1..1"},"code_implementation":true},{"name":"ResolvePerformanceReset","description":"Defines how to resolve the reset value for a performance payout.","inputs":[{"name":"performancePayout","type":"PerformancePayout","cardinality":"1..1"},{"name":"observation","type":"Observation","cardinality":"1..1"},{"name":"date","type":"date","cardinality":"1..1"}],"output":{"name":"reset","type":"Reset","cardinality":"1..1"}},{"name":"ResolveSecurityFinanceBillingAmount","description":"Calculates the billing amount for a Security Finance transaction.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"1..1"},{"name":"reset","type":"Reset","cardinality":"1..1"},{"name":"recordStartDate","type":"date","cardinality":"1..1"},{"name":"recordEndDate","type":"date","cardinality":"1..1"},{"name":"transferDate","type":"date","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"1..1"}}] |
Schema Source
- from schema: https://w3id.org/lmodel/common-domain-model
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | common_domain_model:Reset |
| native | common_domain_model:Reset |
LinkML Source
Direct
name: Reset
annotations:
metadata_key:
tag: metadata_key
value: true
rosetta_functions:
tag: rosetta_functions
value: '[{"name":"ResolveInterestRateReset","description":"Defines how to resolve
the reset value for an InterestRatePayout.","inputs":[{"name":"payouts","type":"InterestRatePayout","cardinality":"1..*"},{"name":"observation","type":"Observation","cardinality":"1..1"},{"name":"resetDate","type":"date","cardinality":"1..1"},{"name":"rateRecordDate","type":"date","cardinality":"0..1"}],"output":{"name":"reset","type":"Reset","cardinality":"1..1"}},{"name":"InterestCashSettlementAmount","description":"Defines
the performance calculations relevant for a fixed or floating rate payout.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"1..1"},{"name":"payout","type":"Payout","cardinality":"1..1"},{"name":"resets","type":"Reset","cardinality":"1..*"},{"name":"date","type":"date","cardinality":"1..1"}],"output":{"name":"interestCashSettlementAmount","type":"Transfer","cardinality":"1..1"}},{"name":"ResolveReset","description":"Defines
the interface for adopters to resolve a reset, given a trade state and a date.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"1..1"},{"name":"date","type":"date","cardinality":"1..1"}],"output":{"name":"reset","type":"Reset","cardinality":"1..1"},"code_implementation":true},{"name":"ResolvePerformanceReset","description":"Defines
how to resolve the reset value for a performance payout.","inputs":[{"name":"performancePayout","type":"PerformancePayout","cardinality":"1..1"},{"name":"observation","type":"Observation","cardinality":"1..1"},{"name":"date","type":"date","cardinality":"1..1"}],"output":{"name":"reset","type":"Reset","cardinality":"1..1"}},{"name":"ResolveSecurityFinanceBillingAmount","description":"Calculates
the billing amount for a Security Finance transaction.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"1..1"},{"name":"reset","type":"Reset","cardinality":"1..1"},{"name":"recordStartDate","type":"date","cardinality":"1..1"},{"name":"recordEndDate","type":"date","cardinality":"1..1"},{"name":"transferDate","type":"date","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"1..1"}}]'
description: Defines the reset value or fixing value produced in cashflow calculations,
during the life-cycle of a financial instrument. The reset process defined in Create_Reset
function joins product definition details with observations to compute the reset
value.
comments:
- 'Rosetta condition: AveragingMethodologyExists — if observations count > 1 then
averagingMethodology exists'
- 'Rosetta func: ResolveInterestRateReset — Defines how to resolve the reset value
for an InterestRatePayout.'
- 'Rosetta func: InterestCashSettlementAmount — Defines the performance calculations
relevant for a fixed or floating rate payout.'
- 'Rosetta func: ResolveReset — Defines the interface for adopters to resolve a reset,
given a trade state and a date.'
- 'Rosetta func: ResolvePerformanceReset — Defines how to resolve the reset value
for a performance payout.'
- 'Rosetta func: ResolveSecurityFinanceBillingAmount — Calculates the billing amount
for a Security Finance transaction.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- resetValue
- resetDate
- rateRecordDate
- observations
- averagingMethodology
slot_usage:
resetDate:
name: resetDate
description: Specifies the date on which the reset occurred.
Induced
name: Reset
annotations:
metadata_key:
tag: metadata_key
value: true
rosetta_functions:
tag: rosetta_functions
value: '[{"name":"ResolveInterestRateReset","description":"Defines how to resolve
the reset value for an InterestRatePayout.","inputs":[{"name":"payouts","type":"InterestRatePayout","cardinality":"1..*"},{"name":"observation","type":"Observation","cardinality":"1..1"},{"name":"resetDate","type":"date","cardinality":"1..1"},{"name":"rateRecordDate","type":"date","cardinality":"0..1"}],"output":{"name":"reset","type":"Reset","cardinality":"1..1"}},{"name":"InterestCashSettlementAmount","description":"Defines
the performance calculations relevant for a fixed or floating rate payout.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"1..1"},{"name":"payout","type":"Payout","cardinality":"1..1"},{"name":"resets","type":"Reset","cardinality":"1..*"},{"name":"date","type":"date","cardinality":"1..1"}],"output":{"name":"interestCashSettlementAmount","type":"Transfer","cardinality":"1..1"}},{"name":"ResolveReset","description":"Defines
the interface for adopters to resolve a reset, given a trade state and a date.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"1..1"},{"name":"date","type":"date","cardinality":"1..1"}],"output":{"name":"reset","type":"Reset","cardinality":"1..1"},"code_implementation":true},{"name":"ResolvePerformanceReset","description":"Defines
how to resolve the reset value for a performance payout.","inputs":[{"name":"performancePayout","type":"PerformancePayout","cardinality":"1..1"},{"name":"observation","type":"Observation","cardinality":"1..1"},{"name":"date","type":"date","cardinality":"1..1"}],"output":{"name":"reset","type":"Reset","cardinality":"1..1"}},{"name":"ResolveSecurityFinanceBillingAmount","description":"Calculates
the billing amount for a Security Finance transaction.","inputs":[{"name":"tradeState","type":"TradeState","cardinality":"1..1"},{"name":"reset","type":"Reset","cardinality":"1..1"},{"name":"recordStartDate","type":"date","cardinality":"1..1"},{"name":"recordEndDate","type":"date","cardinality":"1..1"},{"name":"transferDate","type":"date","cardinality":"1..1"}],"output":{"name":"transfer","type":"Transfer","cardinality":"1..1"}}]'
description: Defines the reset value or fixing value produced in cashflow calculations,
during the life-cycle of a financial instrument. The reset process defined in Create_Reset
function joins product definition details with observations to compute the reset
value.
comments:
- 'Rosetta condition: AveragingMethodologyExists — if observations count > 1 then
averagingMethodology exists'
- 'Rosetta func: ResolveInterestRateReset — Defines how to resolve the reset value
for an InterestRatePayout.'
- 'Rosetta func: InterestCashSettlementAmount — Defines the performance calculations
relevant for a fixed or floating rate payout.'
- 'Rosetta func: ResolveReset — Defines the interface for adopters to resolve a reset,
given a trade state and a date.'
- 'Rosetta func: ResolvePerformanceReset — Defines how to resolve the reset value
for a performance payout.'
- 'Rosetta func: ResolveSecurityFinanceBillingAmount — Calculates the billing amount
for a Security Finance transaction.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
resetDate:
name: resetDate
description: Specifies the date on which the reset occurred.
attributes:
resetValue:
name: resetValue
description: Specifies the reset or fixing value. The fixing value could be a
cash price, interest rate, or other value.
from_schema: https://w3id.org/lmodel/common-domain-model
rank: 1000
owner: Reset
domain_of:
- Reset
range: Price
required: true
resetDate:
name: resetDate
description: Specifies the date on which the reset occurred.
from_schema: https://w3id.org/lmodel/common-domain-model
rank: 1000
owner: Reset
domain_of:
- ResetInstruction
- Reset
- RateObservation
- FxLinkedNotionalAmount
- FloatingRateSettingDetails
range: date
required: true
rateRecordDate:
name: rateRecordDate
description: Specifies the 'Rate Record Day' for a Fallback rate. Fallback rate
fixing processes typically set the fixing rate in arrears, i.e., the Fallback
Rate corresponding to a Rate Record Date is set at the end of the interest accural
period. When this applies, Reset->resetDate occurs at the end of the interest
period, and the Reset->rateRecordDate occurs near the start of the interest
period. The Reset->rateRecordDate and Reset->observations->observationIdentifier->observationDate
will differ if a Fallback rate is unavailable on the Rate Record Date, and the
latest previous available rate is used as the observation.
from_schema: https://w3id.org/lmodel/common-domain-model
rank: 1000
owner: Reset
domain_of:
- ResetInstruction
- Reset
range: date
observations:
name: observations
annotations:
metadata_reference:
tag: metadata_reference
value: true
description: Represents an audit of the observations used to produce the reset
value. If multiple observations were necessary to produce the reset value, the
aggregation method should be defined on the payout.
from_schema: https://w3id.org/lmodel/common-domain-model
rank: 1000
owner: Reset
domain_of:
- Reset
- CalculatedRateDetails
range: Observation
required: true
multivalued: true
inlined: true
inlined_as_list: true
averagingMethodology:
name: averagingMethodology
description: Identifies the aggregation method to use in the case where multiple
observations are used to compute the reset value and the method is not defined
in a payout.
from_schema: https://w3id.org/lmodel/common-domain-model
rank: 1000
owner: Reset
domain_of:
- Reset
range: AveragingCalculation