GetInstrumentCapitalAccountDataSettings
This is a standard system SQL Wrapper [more info] provided by the platform and automatically upgraded on every new release. Do not change this SQL Wrapper unless you are confident about the changes you are making - Contact LemonEdge Support for any queries.
Get Instrument Capital Account Data Settings Features
This SQL Wrapper simply returns how transactions that should be allocated from instruments should be treated when calculating the period end process.
There are two properties against instruments that affect how their transactions are processed during the period end calculation. Those are:
- Exclude From Capital Account Data
This indicates any transactions against this instrument should be excluded from the period end calculation. - Split Override
This indicates the rule to use (either A or B) from the allocation path when allocating the transactions for this instrument. By default A is used.
This SQL Wrapper is used as part of the Create Capital Account Data Items process during Period End calculations.
Tip
This SQL Wrapper is designed so you can override it's behaviour and take those settings from other areas you've tied into the system you've designed. By default you can individually assign these settings to specific instruments, but it is much more likely that you'll have a more efficient mechanism for assigning this settings and you can override this SQL Wrapper with the method for returning those settings.
Parameters
In addition to the standard parameters of any SQL Wrapper more info this one takes the following parameters:
| Name | Description |
|---|---|
| Instrument ID | The ID of the instrument to return the capital account data settings for. If null it will return all instruments with settings. |
Results
The results have the following columns in the data set:
| Name | Description |
|---|---|
| Instrument ID | The ID of the instrument that has some capital account data settings |
| Instrument ID Label | The label for this instrument. This has the Instrument ID set as a parent index so the user sees this column instead of an unknown ID |
| Exclude From Capital Account Data | Indicates all transactions against this instrument should be excluded from the create capital account data items process during period end calculations |
| Capital Account Data Split Override | Holds the split (Either A or B) to use when allocating the transactions through the path for this instrument. By default A is used. |
Commands
Note
All SQL Wrappers have the standard set of commands and functions when being viewed from a grid. See our standard grid functionality.
See here for more information on the standard SQL Wrappers result view.