GetInstrumentSets
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 Sets Features
This SQL Wrapper dynamically returns all instruments contained within a set.
Instrument Sets [see here for more information] provide a mechanism to specifically identify individual instruments, along with methods for any instrument that matches certain criteria. By default that criteria is:
- All instruments, and just exclude those matching, or vice-versa
- Individually specified instruments
- Instruments that have a specific owning entity
- Instruments in specific currencies
This allows you to easily create groups of instruments that automatically include new instruments depending on their characteristics. A lot of functions within our Financial Services functionality work with instrument sets.
Tip
This SQ Wrapper is designed to return all the matching instruments in a given instrument set. More than that it's designed so you can override it's behaviour with your own instrument matching options. As you design your system, it's likely your instruments (such as insurance policies for example) will have a number of different characteristics other than the base instrument properties. This way you can easily add those properties to your instrument matching capabilities and update this SQL Wrapper to take all those additional attributes into account when determining which instrument match a set.
This is used throughout the Financial Services functionality including in places like setting up automatic Path Mappings [more info].
Parameters
In addition to the standard parameters of any SQL Wrapper more info this one takes the following parameters:
| Name | Description |
|---|---|
| Instrument Set ID | The ID of the instrument set to return all matching instruments for. If null it will return all instrument sets and the instruments that belong to them. |
Results
The results have the following columns in the data set:
| Name | Description |
|---|---|
| Instrument Set ID | The ID of the instrument set |
| Instrument ID | The ID of the matching instrument in this instrument set |
| Currency ID | The ID of the currency for this matching instrument |
| Owning Entity ID | The ID of the owning entity of this matching instrument |
| Currency ID Label | The label for this currency. This has the Currency ID set as a parent index so the user sees this column instead of an unknown ID |
| Owning Entity ID Label | The label for this owning entity. This has the Owning Entity ID set as a parent index so the user sees this column instead of an unknown ID |
| Instrument Set ID Label | The label for this instrument set. This has the Instrument Set ID set as a parent index so the user sees this column instead of an unknown ID |
| 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 |
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.