You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Docs/UserGuide/tradecomponents/legdatanotionals.tex
+6-2Lines changed: 6 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ \subsubsection{Leg Data and Notionals}
52
52
53
53
Allowable values: See Table \ref{tab:currency} \lstinline!Currency!. When \lstinline!LegType! is \emph{Equity}, Minor Currencies in Table \ref{tab:currency} are also allowable.
54
54
55
-
\item PaymentCalendar [Optional]: The payment calendar of the leg coupons. The \lstinline!PaymentCalendar! is used in conjunction with the \lstinline!PaymentConvention!and the \lstinline!PaymentLag! to determine the payments dates, unless the \lstinline!PaymentDates! node is used which defines the payment dates explicitly.
55
+
\item PaymentCalendar [Optional]: The payment calendar of the leg coupons. The \lstinline!PaymentCalendar! is used in conjunction with the \lstinline!PaymentConvention!, \lstinline!PaymentLag! and \lstinline!NotionalPaymentLag! to determine the payments dates, unless the \lstinline!PaymentDates! node is used which defines the payment dates explicitly.
56
56
57
57
Allowable values: See Table \ref{tab:calendar} \lstinline!Calendar!. If left blank or omitted, defaults to the calendar in the \lstinline!ScheduleData! node, unless \lstinline!LegType! is \emph{Floating} and \lstinline!Index! is OIS, in which case this defaults to the index calendar.
58
58
@@ -62,12 +62,16 @@ \subsubsection{Leg Data and Notionals}
62
62
63
63
Allowable values: See Table \ref{tab:convention}.
64
64
65
-
\item PaymentLag [optional]: The payment lag applies to Fixed legs, Equity legs, and Floating legs with Ibor and OIS indices (but not to BMA/SIFMA indices), as well as CMS legs, CMSSpread legs, CPI legs and Zero Coupon Fixed legs. \\
65
+
\item PaymentLag [optional]: The payment lag applies to the coupons on Fixed legs, Equity legs, and Floating legs with Ibor and OIS indices (but not to BMA/SIFMA indices), as well as CMS legs, CMSSpread legs, CPI legs and Zero Coupon Fixed legs. \\
66
66
PaymentLag is also not supported for CapFloor Floating legs that have Ibor coupons with sub periods (HasSubPeriods = \emph{true}), nor for CapFloor Floating legs with averaged ON coupons (IsAveraged = \emph{true}).
67
67
68
68
Allowable values: Any valid period, i.e. a non-negative whole number, optionally followed by \emph{D} (days), \emph{W} (weeks), \emph{M} (months),
69
69
\emph{Y} (years). Defaults to \emph{0D} if left blank or omitted. If a whole number is given and no letter, it is assumed that it is a number of \emph{D} (days).
70
70
71
+
\item NotionalPaymentLag [optional]: The notional payment lag (in days) applied to any notional exchanges.
72
+
73
+
Allowable values: Any non-negative integer. Defaults to zero if left blank or omitted.
74
+
71
75
\item DayCounter: The day count convention of the leg coupons. Note that \lstinline!DayCounter! is mandatory for all leg types except \emph{Equity}.
72
76
73
77
Allowable values: See \lstinline!DayCount Convention! in Table \ref{tab:daycount}. For \emph{Equity} legs, if left blank or omitted, it defaults to \emph{ACT/365}.
\caption{Composite trade data with Reference Data}
37
+
\end{listing}
38
+
26
39
The meanings and allowable values of the elements in the \lstinline!CompositeTradeData! node follow below.
27
40
28
41
\begin{itemize}
@@ -43,4 +56,8 @@ \subsubsection{Composite Trade}
43
56
Allowable values: Any non-negative real number.
44
57
\item Components: The portfolio of trades that make up the composite trade. \\
45
58
Allowable values: These trades should be valid xmls that could otherwise be entered into the portfolio, with the exception that they can have empty ids.
59
+
\item PortfolioBasket [Optional]: Indicate if the Component represent a portfolio basket. \\
60
+
Allowable values: Boolean true or false.
61
+
\item BasketName [Optional]: The portfolio Id. \\
62
+
Allowable values: Any string. Note that if PortfolioBasket is True then there must be a BasketName. We look up the Basket within the reference data.
A CPI swap can be set up as a swap with trade type \emph{Swap}, with one leg of type {\tt CPI}. Listing \ref{lst:cpiswap}
4
-
shows an example. The CPI leg contains an additional {\tt CPILegData} block. See \ref{ss:cpilegdata} for details on the
5
-
CPI leg specification.
3
+
A CPI inflation swap can be set up using the \emph{InflationSwap} trade type, with one leg of type {\tt CPI}. and the other leg(s) can be of any leg type. Listing \ref{lst:cpiinflationswap} shows an example. The CPI leg contains an additional {\tt CPILegData} block. See \ref{ss:cpilegdata} for details on the
4
+
CPI leg specification.
5
+
6
+
Note that Cross Currency Inflation Swaps are supported, as the currencies on the legs of an \emph{InflationSwap} do not need to be the same.
7
+
6
8
7
9
\begin{listing}[H]
8
10
%\hrule\medskip
9
11
\begin{minted}[fontsize=\footnotesize]{xml}
10
-
<SwapData>
12
+
<InflationSwapData>
11
13
<LegData>
12
14
<LegType>Floating</LegType>
13
15
<Payer>true</Payer>
@@ -21,18 +23,19 @@ \subsubsection{CPI Swap}
21
23
...
22
24
</CPILegData>
23
25
</LegData>
24
-
</SwapData>
26
+
</InflationSwapData>
25
27
\end{minted}
26
-
\caption{CPI Swap Data (using \emph{Swap} trade type)}
27
-
\label{lst:cpiswap}
28
+
\caption{CPI Swap Data (using \emph{InflationSwap} trade type)}
29
+
\label{lst:cpiinflationswap}
28
30
\end{listing}
29
31
30
-
Alternatively, a CPI swap can be set up using the \emph{InflationSwap} trade type, see Listing \ref{lst:cpiinflationswap}. The structure of the {\tt InflationSwapData} container is the same as for {\tt SwapData} above.
32
+
33
+
Alternatively, a CPI swap can be set up as a swap with trade type \emph{Swap}, with one leg of type {\tt CPI}, see listing \ref{lst:cpiswap}.
31
34
32
35
\begin{listing}[H]
33
36
%\hrule\medskip
34
37
\begin{minted}[fontsize=\footnotesize]{xml}
35
-
<InflationSwapData>
38
+
<SwapData>
36
39
<LegData>
37
40
<LegType>Floating</LegType>
38
41
<Payer>true</Payer>
@@ -46,8 +49,9 @@ \subsubsection{CPI Swap}
46
49
...
47
50
</CPILegData>
48
51
</LegData>
49
-
</InflationSwapData>
52
+
</SwapData>
50
53
\end{minted}
51
-
\caption{CPI Swap Data (using \emph{InflationSwap} trade type)}
52
-
\label{lst:cpiinflationswap}
53
-
\end{listing}
54
+
\caption{CPI Swap Data (using \emph{Swap} trade type)}
0 commit comments