1. User Guide
  2. Object Management
  3. Adding Custom Instrument Tables
  4. Super-class Entities

3.3.1 Super-class Entities

Most instrument tables are used for OFSAA processing. OFSAA processing mandates the instrument table to have a certain set of columns.

These columns have been put together in super-class entities. The following are the seeded super-class entities:

  • LEAF_COLUMNS: contains the key dimension columns that are part of the Instrument tables.
  • BASIC_INSTRUMENT_REQ: contains the basic instrument columns like ID_NUMBER, IDENTITY_CODE, and so on.
  • MULTI_CUR_REQ: contains the columns required for multi-currency processing.
  • CASH_FLOW_EDIT_REQ: contains the columns required for Cash flow Edit processing.
  • CASH_FLOW_PROC_REQ: contains the columns required for Cash flow processing.
  • TP_BASIC_REQ: contains the columns required for Transfer Pricing processing.
  • TP_OPTION_COSTING_REQ: contains the columns required for Transfer Pricing Option Cost processing.
  • PORTFOLIO_REQ: contains the columns required for Portfolio table classification.
  • TRANS_LEAF_COLUMNS: contains the key dimension columns that are part of the transaction tables.
  • LEDGER_LEAF_COLUMNS: contains the key dimension columns that are part of the Ledger Stat table.
  • BASIC_LEDGER_CLASS_REQ: contains the columns required for Ledger Class tables example _Ledger.

Note:

Column Precision for Instrument Table:

You can increase the size of the columns to make them hold a value of larger precision, but the new size will impact FTP and ALM engines as follow:

Values/fields read by the engine are restricted to the size that the c++ variables can hold within the engine memory. In fact, having a value larger than the allowed precision can cause the engine to read the value incorrectly.

Changing the size of the fields that these engines write into does not affect the precision of the results

An upgrade could rollback such changes unless you remember to do a model merge.

Instrument table can link to any of the above super-class entities based on its purpose. For example, if the instrument table is used for Cash Flow Processing, then this table should be linked to the following super-class entities:

  • BASIC_INSTRUMENT_REQ
  • MULTI_CUR_REQ
  • LEAF_COLUMNS
  • CASH_FLOW_EDIT_REQ
  • CASH_FLOW_PROC_REQ

Note:

CASH_FLOW_PROC_REQ is required for all instrument tables where conditional assumptions will be applied.

Refer to the following mapping table that specifies the list of super-class entities required for each table classification:

Type of Client Data Object Table Classification List of Super-class entities
Instrument Instrument BASIC_INSTRUMENT_REQ LEAF_COLUMNS
Instrument ALM Standard BASIC_INSTRUMENT_REQ LEAF_COLUMNS MULTI_CUR_REQ CASH_FLOW_EDIT_REQ CASH_FLOW_PROC_REQ
Instrument TP Cash Flow BASIC_INSTRUMENT_REQ LEAF_COLUMNS MULTI_CUR_REQ CASH_FLOW_EDIT_REQ CASH_FLOW_PROC_REQ TP_BASIC_REQ
Instrument TP Non-Cash Flow BASIC_INSTRUMENT_REQ LEAF_COLUMNS MULTI_CUR_REQ CASH_FLOW_EDIT_REQ TP_BASIC_REQ
Instrument TP Option Costing BASIC_INSTRUMENT_REQ LEAF_COLUMNS MULTI_CUR_REQ CASH_FLOW_EDIT_REQ TP_BASIC_REQ TP_OPTION_COSTING_REQ
Instrument Instrument Profitability BASIC_INSTRUMENT_REQ MULTI_CUR_REQ PORTFOLIO
Instrument Portfolio BASIC_INSTRUMENT_REQ LEAF_COLUMNS MULTI_CUR_REQ PORTFOLIO
Transaction Transaction Profitability TRANS_LEAF_COLUMNS
Ledger Stat Ledger Stat LEDGER_LEAF_COLUMNS