IO OLE Programmer's Guide - SunGarddocs.sungard.com/InvestOne/140Doc/OLE/IO_OLE.pdf · io ole...

THIS DOCUMENT CONTAINS PROPRIETARY INFORMATION OF SUNGARD ASSET ARENA INVESTMENT ACCOUNTING. NO COPY OR OTHER REPRODUCTION SHALL BE MADE WITHOUT WRITTEN PERMISSION OF SUNGARD.

SunGard Asset Arena Investment Accounting Lombard, Illinois

IO OLE Programmer’s Guide

IO OLE PROGRAMMER’S GUIDE


Table of Contents 1. WHAT IS IO OLE? .................................................................................................................................................... 16

ABOUT IO OLE .................................................................................................................................................................. 16 IO OLE OBJECT MODEL AND PAGE LOCATION IN THIS DOCUMENT .................................................................................... 16

2. INSTALLING IO OLE .............................................................................................................................................. 17 CRITICAL PREREQUISITES ................................................................................................................................................ 17 IO OLE INSTALLATION INSTRUCTIONS .............................................................................................................................. 18

Restricted Operator Options ......................................................................................................................................... 18 Engine Password Option .............................................................................................................................................. 19 IO OLE Installation Contents ....................................................................................................................................... 20

REGISTRY SETTINGS ........................................................................................................................................................... 21 Relevant Registration Entries ....................................................................................................................................... 21

3. USING IO OLE ........................................................................................................................................................... 22 USING IO OLE IN YOUR ENVIRONMENT ............................................................................................................................ 22

4. USING THE IOCONNECTION OBJECT .............................................................................................................. 23 PURPOSE............................................................................................................................................................................. 23 PROPERTIES & METHODS ................................................................................................................................................... 23

CommType .................................................................................................................................................................... 23 CreateDistRequest ........................................................................................................................................................ 24 CreateFundRequest ...................................................................................................................................................... 24 CreateRelief .................................................................................................................................................................. 26 CreateReliefBlock ......................................................................................................................................................... 26 CreateSecurity .............................................................................................................................................................. 27 CreateSecurityBlock ..................................................................................................................................................... 27 CreateTranRequest ....................................................................................................................................................... 28 CreateTransaction ........................................................................................................................................................ 28 CreateTransactionBlock ............................................................................................................................................... 29 CreateCorporateAction ................................................................................................................................................ 29 CreateCorporateActionBlock ....................................................................................................................................... 30 CreateComplexCorpAction ........................................................................................................................................... 30 CreateComplexCorpActionBlock .................................................................................................................................. 31 CreatePartialEleCorpAction ........................................................................................................................................ 31 CreatePartialEleCorpActionBlock ............................................................................................................................... 32 CreateSuperMessage .................................................................................................................................................... 32 CreateMBSPoolBalance ............................................................................................................................................... 33 CreateVACRNUM ......................................................................................................................................................... 33 CheckConnection .......................................................................................................................................................... 34 CreateSecurityExtension ............................................................................................................................................... 34 CreateSecurityExtensionBlock ...................................................................................................................................... 35 CreateCollateralMaintenance ...................................................................................................................................... 35 CreateCollateralMaintenanceBlock ............................................................................................................................. 36 CreateIncomeDistGenerator......................................................................................................................................... 36 GetHostIPAddress ........................................................................................................................................................ 37 DictionaryFile ............................................................................................................................................................... 37 Gateway ........................................................................................................................................................................ 38 HostIP ........................................................................................................................................................................... 39 Operator ....................................................................................................................................................................... 40 Password ...................................................................................................................................................................... 41 Port ............................................................................................................................................................................... 42 Syntax ............................................................................................................................................................................ 42



SideInfo ......................................................................................................................................................................... 43 UserID .......................................................................................................................................................................... 44

5. USING IOSPECTRADISTREQUEST ..................................................................................................................... 45 PURPOSE............................................................................................................................................................................. 45 VISUAL BASIC EXAMPLE .................................................................................................................................................... 45 PROPERTIES AND METHODS ............................................................................................................................................... 46

Account ......................................................................................................................................................................... 46 AddFilter ....................................................................................................................................................................... 47 AddItem ......................................................................................................................................................................... 48 Connection .................................................................................................................................................................... 48 EOF .............................................................................................................................................................................. 49 ItemCount ..................................................................................................................................................................... 49 Items.............................................................................................................................................................................. 50 ItemValue ...................................................................................................................................................................... 50 MoveNext ...................................................................................................................................................................... 51 Record ........................................................................................................................................................................... 51 RecordFormat ............................................................................................................................................................... 52 RequestDate .................................................................................................................................................................. 53 SecuritiesOnly ............................................................................................................................................................... 53 Aggregate ...................................................................................................................................................................... 54 Start .............................................................................................................................................................................. 55 Status ............................................................................................................................................................................ 55 Traded Cash.................................................................................................................................................................. 56

6. USING IOSPECTRAFUNDREQUEST ................................................................................................................... 57 PURPOSE............................................................................................................................................................................. 57 VISUAL BASIC EXAMPLE .................................................................................................................................................... 57 PROPERTIES AND METHODS ............................................................................................................................................... 58

Account ......................................................................................................................................................................... 58 AddFilter ....................................................................................................................................................................... 59 AddItem ......................................................................................................................................................................... 60 ClassOfShares ............................................................................................................................................................... 60 Connection .................................................................................................................................................................... 61 EOF .............................................................................................................................................................................. 61 ItemCount ..................................................................................................................................................................... 62 Items.............................................................................................................................................................................. 62 ItemValue ...................................................................................................................................................................... 63 MoveNext ...................................................................................................................................................................... 63 Periods .......................................................................................................................................................................... 64 PeriodType .................................................................................................................................................................... 65 Record ........................................................................................................................................................................... 66 RecordFormat ............................................................................................................................................................... 67 RequestDate .................................................................................................................................................................. 68 Start .............................................................................................................................................................................. 68 Status ............................................................................................................................................................................ 69

7. USING IOSPECTRATRANREQUEST ................................................................................................................... 70 PURPOSE............................................................................................................................................................................. 70 VISUAL BASIC EXAMPLE .................................................................................................................................................... 70 PROPERTIES AND METHODS ............................................................................................................................................... 71

Account ......................................................................................................................................................................... 71 AddFilter ....................................................................................................................................................................... 72 AddItem ......................................................................................................................................................................... 73 Connection .................................................................................................................................................................... 73 DateType ....................................................................................................................................................................... 74



EOF .............................................................................................................................................................................. 75 FromDate ...................................................................................................................................................................... 75 ItemCount ..................................................................................................................................................................... 76 Items.............................................................................................................................................................................. 76 ItemValue ...................................................................................................................................................................... 77 MoveNext ...................................................................................................................................................................... 77 Positions ....................................................................................................................................................................... 78 Record ........................................................................................................................................................................... 79 Record Format .............................................................................................................................................................. 79 Start .............................................................................................................................................................................. 80 Status ............................................................................................................................................................................ 80 ToDate .......................................................................................................................................................................... 81

8. USING IOSPECTRAFXRATEREQUEST .............................................................................................................. 82 PURPOSE............................................................................................................................................................................. 82 VISUAL BASIC EXAMPLE .................................................................................................................................................... 82 PROPERTIES AND METHODS ............................................................................................................................................... 83

RequestDate .................................................................................................................................................................. 83 SctyCusip ...................................................................................................................................................................... 83 BaseCurrency ............................................................................................................................................................... 84 PricingSource ............................................................................................................................................................... 84 PricingTime .................................................................................................................................................................. 85 PricingType................................................................................................................................................................... 85 Periods .......................................................................................................................................................................... 86 PeriodType .................................................................................................................................................................... 86 ProcessAll ..................................................................................................................................................................... 88 AddFilter ....................................................................................................................................................................... 89 AddItem ......................................................................................................................................................................... 90 Connection .................................................................................................................................................................... 90 EOF .............................................................................................................................................................................. 91 ItemCount ..................................................................................................................................................................... 91 Items.............................................................................................................................................................................. 92 ItemValue ...................................................................................................................................................................... 92 MoveNext ...................................................................................................................................................................... 93 Record ........................................................................................................................................................................... 93 RecordFormat ............................................................................................................................................................... 94 RequestDate .................................................................................................................................................................. 95 SecuritiesOnly ............................................................................................................................................................... 95 Status ............................................................................................................................................................................ 96

9. USING IOSPECTRAITEM ....................................................................................................................................... 97 PURPOSE............................................................................................................................................................................. 97 VISUAL BASIC EXAMPLE .................................................................................................................................................... 97 PROPERTIES AND METHODS ............................................................................................................................................... 98

Code .............................................................................................................................................................................. 98 Decimal ......................................................................................................................................................................... 98 Description ................................................................................................................................................................... 99 Display .......................................................................................................................................................................... 99 EDW_Field ................................................................................................................................................................. 100 EDW_Table................................................................................................................................................................. 100 IsValid ......................................................................................................................................................................... 101 ItemType ..................................................................................................................................................................... 101 Title ............................................................................................................................................................................. 102

10. USING IOACCOUNT .............................................................................................................................................. 103 PURPOSE........................................................................................................................................................................... 103



VISUAL BASIC EXAMPLE .................................................................................................................................................. 103 PROPERTIES AND METHODS ............................................................................................................................................. 104

Clear ........................................................................................................................................................................... 104 Connection .................................................................................................................................................................. 104 Execute ........................................................................................................................................................................ 105 GetValue ..................................................................................................................................................................... 105 Message ...................................................................................................................................................................... 106 Mode ........................................................................................................................................................................... 106 NetName ..................................................................................................................................................................... 107 Reply ........................................................................................................................................................................... 107 ReplyCount ................................................................................................................................................................. 108 SetValue ...................................................................................................................................................................... 108

11. USING IOACCOUNTBLOCK ................................................................................................................................ 110 PURPOSE........................................................................................................................................................................... 110 VISUAL BASIC EXAMPLE .................................................................................................................................................. 110 PROPERTIES AND METHODS ............................................................................................................................................. 112

AccountCount ............................................................................................................................................................. 112 Connection .................................................................................................................................................................. 112 Execute ........................................................................................................................................................................ 113 Reply ........................................................................................................................................................................... 113 ReplyCount ................................................................................................................................................................. 114 StageAccount .............................................................................................................................................................. 114

12. USING IOTRANSACTION ..................................................................................................................................... 115 PURPOSE........................................................................................................................................................................... 115 VISUAL BASIC EXAMPLE .................................................................................................................................................. 115 PROPERTIES AND METHODS ............................................................................................................................................. 116

Clear ........................................................................................................................................................................... 116 Connection .................................................................................................................................................................. 116 Execute ........................................................................................................................................................................ 117 GetValue ..................................................................................................................................................................... 118 Message ...................................................................................................................................................................... 118 Mode ........................................................................................................................................................................... 119 Reply ........................................................................................................................................................................... 119 ReplyCount ................................................................................................................................................................. 120 SetValue ...................................................................................................................................................................... 120

13. USING IOTRANSACTIONBLOCK ...................................................................................................................... 121 PURPOSE........................................................................................................................................................................... 121 VISUAL BASIC EXAMPLE .................................................................................................................................................. 121 PROPERTIES AND METHODS ............................................................................................................................................. 122

Connection .................................................................................................................................................................. 122 Execute ........................................................................................................................................................................ 123 Reply ........................................................................................................................................................................... 124 ReplyCount ................................................................................................................................................................. 124 ReplyEXTID ................................................................................................................................................................ 125 ReplyTRDORD ........................................................................................................................................................... 125 StageTrade .................................................................................................................................................................. 126 TradeCount ................................................................................................................................................................. 126

14. USING IOSECURITY ............................................................................................................................................. 127 PURPOSE........................................................................................................................................................................... 127 VISUAL BASIC EXAMPLE .................................................................................................................................................. 127 PROPERTIES AND METHODS ............................................................................................................................................. 128

Clear ........................................................................................................................................................................... 128



Connection .................................................................................................................................................................. 128 Execute ........................................................................................................................................................................ 129 GetValue ..................................................................................................................................................................... 130 Message ...................................................................................................................................................................... 130 Mode ........................................................................................................................................................................... 131 Reply ........................................................................................................................................................................... 131 ReplyCount ................................................................................................................................................................. 132 SetValue ...................................................................................................................................................................... 132

15. USING IOSECURITYBLOCK ............................................................................................................................... 133 PURPOSE........................................................................................................................................................................... 133 VISUAL BASIC EXAMPLE .................................................................................................................................................. 133 PROPERTIES AND METHODS ............................................................................................................................................. 134

Connection .................................................................................................................................................................. 134 Execute ........................................................................................................................................................................ 135 Reply ........................................................................................................................................................................... 136 ReplyCount ................................................................................................................................................................. 136 ReplySCTY .................................................................................................................................................................. 137 SecurityCount ............................................................................................................................................................. 137 StageSecurity .............................................................................................................................................................. 138

16. USING IORELIEF ................................................................................................................................................... 139 PURPOSE........................................................................................................................................................................... 139 VISUAL BASIC EXAMPLE .................................................................................................................................................. 139 PROPERTIES AND METHODS ............................................................................................................................................. 140


17. USING IORELIEFBLOCK ..................................................................................................................................... 145 PURPOSE........................................................................................................................................................................... 145 VISUAL BASIC EXAMPLE .................................................................................................................................................. 145 PROPERTIES AND METHODS ............................................................................................................................................. 146

Connection .................................................................................................................................................................. 146 Execute ........................................................................................................................................................................ 147 Reply ........................................................................................................................................................................... 147 ReplyCount ................................................................................................................................................................. 148 ReliefCount ................................................................................................................................................................. 148 StageRelief .................................................................................................................................................................. 149

18. USING IOHOLDING ............................................................................................................................................... 150 PURPOSE........................................................................................................................................................................... 150 VISUAL BASIC EXAMPLE .................................................................................................................................................. 150 PROPERTIES AND METHODS ............................................................................................................................................. 151

Clear ........................................................................................................................................................................... 151 Connection .................................................................................................................................................................. 151 Execute ........................................................................................................................................................................ 152 GetValue ..................................................................................................................................................................... 152 Message ...................................................................................................................................................................... 153 Mode ........................................................................................................................................................................... 153



Reply ........................................................................................................................................................................... 154 ReplyCount ................................................................................................................................................................. 154 SetValue ...................................................................................................................................................................... 155

19. USING IOHOLDINGBLOCK ................................................................................................................................ 156 PURPOSE........................................................................................................................................................................... 156 VISUAL BASIC EXAMPLE .................................................................................................................................................. 156 PROPERTIES AND METHODS ............................................................................................................................................. 157

Connection .................................................................................................................................................................. 157 Execute ........................................................................................................................................................................ 158 Reply ........................................................................................................................................................................... 158 ReplyCount ................................................................................................................................................................. 159 HldgCount................................................................................................................................................................... 159 StageHldg ................................................................................................................................................................... 160

20. USING IOTAXLOTADJ ......................................................................................................................................... 161 PURPOSE........................................................................................................................................................................... 161 VISUAL BASIC EXAMPLE .................................................................................................................................................. 161 PROPERTIES AND METHODS ............................................................................................................................................. 162


21. USING IOTAXLOTADJBLOCK ........................................................................................................................... 167 PURPOSE........................................................................................................................................................................... 167 VISUAL BASIC EXAMPLE .................................................................................................................................................. 167 PROPERTIES AND METHODS ............................................................................................................................................. 168

Connection .................................................................................................................................................................. 168 Execute ........................................................................................................................................................................ 169 Reply ........................................................................................................................................................................... 169 ReplyCount ................................................................................................................................................................. 170 TxlAdjCount ................................................................................................................................................................ 170 StageTxlAdj ................................................................................................................................................................. 171

22. USING IOCORPORATEACTION ......................................................................................................................... 172 PURPOSE........................................................................................................................................................................... 172 VISUAL BASIC EXAMPLE .................................................................................................................................................. 172 PROPERTIES AND METHODS ............................................................................................................................................. 173


23. USING IOCORPORATEACTIONBLOCK .......................................................................................................... 178 PURPOSE........................................................................................................................................................................... 178



VISUAL BASIC EXAMPLE .................................................................................................................................................. 178 PROPERTIES AND METHODS ............................................................................................................................................. 179

Connection .................................................................................................................................................................. 179 Execute ........................................................................................................................................................................ 179 Reply ........................................................................................................................................................................... 180 ReplyCount ................................................................................................................................................................. 180 StageCorporateAction ................................................................................................................................................ 181 CorporateActionRateCount ........................................................................................................................................ 181

24. USING IOCOMPLEXCORPACTION ................................................................................................................... 183 PURPOSE........................................................................................................................................................................... 183 VISUAL BASIC EXAMPLE .................................................................................................................................................. 183 PROPERTIES AND METHODS ............................................................................................................................................. 184


25. USING IOCOMPLEXCORPACTIONBLOCK .................................................................................................... 189 PURPOSE........................................................................................................................................................................... 189 VISUAL BASIC EXAMPLE .................................................................................................................................................. 189 PROPERTIES AND METHODS ............................................................................................................................................. 190

Connection .................................................................................................................................................................. 190 Execute ........................................................................................................................................................................ 190 Reply ........................................................................................................................................................................... 191 ReplyCount ................................................................................................................................................................. 192 StageMessage ............................................................................................................................................................. 192 ComplexCorporateActionCount ................................................................................................................................. 193

26. USING IOPARTELECORPACTION .................................................................................................................... 194 PURPOSE........................................................................................................................................................................... 194 VISUAL BASIC EXAMPLE .................................................................................................................................................. 194 PROPERTIES AND METHODS ............................................................................................................................................. 195


27. USING IOPARTELECORPACTIONBLOCK ...................................................................................................... 200 PURPOSE........................................................................................................................................................................... 200 VISUAL BASIC EXAMPLE .................................................................................................................................................. 200 PROPERTIES AND METHODS ............................................................................................................................................. 201

Connection .................................................................................................................................................................. 201 Execute ........................................................................................................................................................................ 201 Reply ........................................................................................................................................................................... 202 ReplyCount ................................................................................................................................................................. 202



StagePElectionCorpAction ......................................................................................................................................... 203 PElectionCorpActionCount ........................................................................................................................................ 204

28. USING IOSUPERMESSAGE.................................................................................................................................. 205 PURPOSE........................................................................................................................................................................... 205 VISUAL BASIC EXAMPLE .................................................................................................................................................. 205 PROPERTIES AND METHODS ............................................................................................................................................. 206

Clear ........................................................................................................................................................................... 206 Connection .................................................................................................................................................................. 206 Execute ........................................................................................................................................................................ 207 GetValue ..................................................................................................................................................................... 207 Message ...................................................................................................................................................................... 208 Reply ........................................................................................................................................................................... 208 ReplyCount ................................................................................................................................................................. 208 SetValue ...................................................................................................................................................................... 209

29. USING IOMBSPOOLBALANCE ........................................................................................................................... 210 PURPOSE........................................................................................................................................................................... 210 VISUAL BASIC EXAMPLE .................................................................................................................................................. 210 PROPERTIES AND METHODS ............................................................................................................................................. 211


30. USING IOVACRNUM ............................................................................................................................................. 215 PURPOSE........................................................................................................................................................................... 215 VISUAL BASIC EXAMPLE .................................................................................................................................................. 215 PROPERTIES AND METHODS ............................................................................................................................................. 216


31. USING IOSECURITYEXTENSION ...................................................................................................................... 220 PURPOSE........................................................................................................................................................................... 220 VISUAL BASIC EXAMPLE .................................................................................................................................................. 220 PROPERTIES AND METHODS ............................................................................................................................................. 221


32. USING IOCOLLATERALMAINTENANCE ........................................................................................................ 225



PURPOSE........................................................................................................................................................................... 225 VISUAL BASIC EXAMPLE .................................................................................................................................................. 225 PROPERTIES AND METHODS ............................................................................................................................................. 226


33. USING IOACCTFEEBALANCES ......................................................................................................................... 230 PURPOSE ....................................................................................................................................................................... 230 VISUAL BASIC EXAMPLE .......................................................................................................................................... 230 PROPERTIES AND METHODS .................................................................................................................................... 230


34. USING IOACCTFEEBALANCESBLOCK ........................................................................................................... 235 PURPOSE ....................................................................................................................................................................... 235 VISUAL BASIC EXAMPLE .......................................................................................................................................... 235 PROPERTIES AND METHODS .................................................................................................................................... 236

AcctFeeBalCount ........................................................................................................................................................ 236 Connection .................................................................................................................................................................. 236 Execute ........................................................................................................................................................................ 237 Reply ........................................................................................................................................................................... 237 ReplyCount ................................................................................................................................................................. 238 StageAcctFeeBal ......................................................................................................................................................... 238

35. USING IOACCTFEESCHEDULE ......................................................................................................................... 239 PURPOSE ....................................................................................................................................................................... 239 VISUAL BASIC EXAMPLE .......................................................................................................................................... 239 PROPERTIES AND METHODS .................................................................................................................................... 239


36. USING IOACCTFEESCHEDULEBLOCK ........................................................................................................... 245 PURPOSE ....................................................................................................................................................................... 245 VISUAL BASIC EXAMPLE .......................................................................................................................................... 245 PROPERTIES AND METHODS .................................................................................................................................... 246

AcctFeeSchedCount .................................................................................................................................................... 246



Connection .................................................................................................................................................................. 246 Execute ........................................................................................................................................................................ 247 Reply ........................................................................................................................................................................... 247 ReplyCount ................................................................................................................................................................. 248 StageAcctFeeSched ..................................................................................................................................................... 248

37. USING IOCALENDARSET .................................................................................................................................... 250 PURPOSE ....................................................................................................................................................................... 250 VISUAL BASIC EXAMPLE .......................................................................................................................................... 250 PROPERTIES AND METHODS .................................................................................................................................... 250


38. USING IOCALENDARSETBLOCK ...................................................................................................................... 255 PURPOSE ....................................................................................................................................................................... 255 VISUAL BASIC EXAMPLE .......................................................................................................................................... 255 PROPERTIES AND METHODS .................................................................................................................................... 256

CalendarSetCount ....................................................................................................................................................... 256 Connection .................................................................................................................................................................. 256 Execute ........................................................................................................................................................................ 257 Reply ........................................................................................................................................................................... 257 ReplyCount ................................................................................................................................................................. 257 StageCalendarSet ....................................................................................................................................................... 258

39. USING IOEFFECTIVEYIELD ............................................................................................................................... 259 PURPOSE ....................................................................................................................................................................... 259 VISUAL BASIC EXAMPLE .......................................................................................................................................... 259 PROPERTIES AND METHODS .................................................................................................................................... 259


40. USING IOEFFECTIVEYIELDBLOCK ................................................................................................................ 264 PURPOSE ....................................................................................................................................................................... 264 VISUAL BASIC EXAMPLE .......................................................................................................................................... 264 PROPERTIES AND METHODS .................................................................................................................................... 265

EffYldCount................................................................................................................................................................. 265 Connection .................................................................................................................................................................. 265 Execute ........................................................................................................................................................................ 266 Reply ........................................................................................................................................................................... 266 ReplyCount ................................................................................................................................................................. 266 StageEffYld ................................................................................................................................................................. 267

41. USING IOEXCHRATES ......................................................................................................................................... 268



PURPOSE ....................................................................................................................................................................... 268 VISUAL BASIC EXAMPLE .......................................................................................................................................... 268 PROPERTIES AND METHODS .................................................................................................................................... 268


42. USING IOEXCHRATESBLOCK ........................................................................................................................... 273 PURPOSE ....................................................................................................................................................................... 273 VISUAL BASIC EXAMPLE .......................................................................................................................................... 273 PROPERTIES AND METHODS .................................................................................................................................... 274

ExchRateCount ........................................................................................................................................................... 274 Connection .................................................................................................................................................................. 274 Execute ........................................................................................................................................................................ 275 Reply ........................................................................................................................................................................... 275 ReplyCount ................................................................................................................................................................. 275 StageExchRate ............................................................................................................................................................ 276

43. USING IOFIXEDEXPENSES ................................................................................................................................. 277 PURPOSE ....................................................................................................................................................................... 277 VISUAL BASIC EXAMPLE .......................................................................................................................................... 277 PROPERTIES AND METHODS .................................................................................................................................... 277


44. USING IOFIXEDEXPENSESBLOCK ................................................................................................................... 282 PURPOSE ....................................................................................................................................................................... 282 VISUAL BASIC EXAMPLE .......................................................................................................................................... 282 PROPERTIES AND METHODS .................................................................................................................................... 283

FixedExpensesCount ................................................................................................................................................... 283 Connection .................................................................................................................................................................. 283 Execute ........................................................................................................................................................................ 284 Reply ........................................................................................................................................................................... 284 ReplyCount ................................................................................................................................................................. 284 StageFixedExpenses.................................................................................................................................................... 285

45. USING IOPREPAYRATE ....................................................................................................................................... 286 PURPOSE ....................................................................................................................................................................... 286 VISUAL BASIC EXAMPLE .......................................................................................................................................... 286 PROPERTIES AND METHODS .................................................................................................................................... 286

Clear ........................................................................................................................................................................... 286 Connection .................................................................................................................................................................. 287 Execute ........................................................................................................................................................................ 287



GetValue ..................................................................................................................................................................... 288 Message ...................................................................................................................................................................... 288 Mode ........................................................................................................................................................................... 288 Reply ........................................................................................................................................................................... 289 ReplyCount ................................................................................................................................................................. 290 SetValue ...................................................................................................................................................................... 290

46. USING IOPREPAYRATEBLOCK......................................................................................................................... 291 PURPOSE ....................................................................................................................................................................... 291 VISUAL BASIC EXAMPLE .......................................................................................................................................... 291 PROPERTIES AND METHODS .................................................................................................................................... 292

PrepayRateCount ........................................................................................................................................................ 292 Connection .................................................................................................................................................................. 292 Execute ........................................................................................................................................................................ 293 Reply ........................................................................................................................................................................... 293 ReplyCount ................................................................................................................................................................. 293 StagePrepayRate ......................................................................................................................................................... 294

47. USING IOPRICES ................................................................................................................................................... 295 PURPOSE ....................................................................................................................................................................... 295 VISUAL BASIC EXAMPLE .......................................................................................................................................... 295 PROPERTIES AND METHODS .................................................................................................................................... 295


48. USING IOPRICESBLOCK ..................................................................................................................................... 301 PURPOSE ....................................................................................................................................................................... 301 VISUAL BASIC EXAMPLE .......................................................................................................................................... 301 PROPERTIES AND METHODS .................................................................................................................................... 302

PriceCount .................................................................................................................................................................. 302 Connection .................................................................................................................................................................. 302 Execute ........................................................................................................................................................................ 303 Reply ........................................................................................................................................................................... 303 ReplyCount ................................................................................................................................................................. 304 StagePrice ................................................................................................................................................................... 304

49. USING IOACCOUNTDEFINITION ...................................................................................................................... 306 PURPOSE ....................................................................................................................................................................... 306 VISUAL BASIC EXAMPLE .......................................................................................................................................... 306 PROPERTIES AND METHODS .................................................................................................................................... 307

Clear ........................................................................................................................................................................... 307 Connection .................................................................................................................................................................. 307 Execute ........................................................................................................................................................................ 308 GetValue ..................................................................................................................................................................... 308 Mode ........................................................................................................................................................................... 308 Reply ........................................................................................................................................................................... 309 ReplyCount ................................................................................................................................................................. 310 SetValue ...................................................................................................................................................................... 310



50. USING IOACCTASSETPROOVERRIDES .......................................................................................................... 311 PURPOSE ....................................................................................................................................................................... 311 VISUAL BASIC EXAMPLE .......................................................................................................................................... 311 PROPERTIES AND METHODS .................................................................................................................................... 311


51. USING IOADVISORCODES .................................................................................................................................. 316 PURPOSE ....................................................................................................................................................................... 316 VISUAL BASIC EXAMPLE .......................................................................................................................................... 316 PROPERTIES AND METHODS .................................................................................................................................... 316


52. USING IOFLEXIBLEPRICING ............................................................................................................................. 321 PURPOSE ....................................................................................................................................................................... 321 VISUAL BASIC EXAMPLE .......................................................................................................................................... 321 PROPERTIES AND METHODS .................................................................................................................................... 321


53. USING IORPTGRPACCOUNT .............................................................................................................................. 326 PURPOSE ....................................................................................................................................................................... 326 VISUAL BASIC EXAMPLE .......................................................................................................................................... 326 PROPERTIES AND METHODS .................................................................................................................................... 326


54. USING IOUSERDEFINEDFIELDS ....................................................................................................................... 331 PURPOSE ....................................................................................................................................................................... 331 VISUAL BASIC EXAMPLE .......................................................................................................................................... 331



PROPERTIES AND METHODS .................................................................................................................................... 331 Clear ........................................................................................................................................................................... 331 Connection .................................................................................................................................................................. 332 Execute ........................................................................................................................................................................ 332 GetValue ..................................................................................................................................................................... 333 Mode ........................................................................................................................................................................... 333 Reply ........................................................................................................................................................................... 334 ReplyCount ................................................................................................................................................................. 334 SetValue ...................................................................................................................................................................... 335

55. USING IOADHOCFAS ............................................................................................................................................ 336 PURPOSE ....................................................................................................................................................................... 336 VISUAL BASIC EXAMPLE .......................................................................................................................................... 336 PROPERTIES AND METHODS .................................................................................................................................... 337


56. USING IOTOLERANCEPROFILE ....................................................................................................................... 341 PURPOSE ....................................................................................................................................................................... 341 VISUAL BASIC EXAMPLE .......................................................................................................................................... 341 PROPERTIES AND METHODS .................................................................................................................................... 343


57. USING IOTAXRATETABLE ................................................................................................................................. 347 PURPOSE ....................................................................................................................................................................... 347 VISUAL BASIC EXAMPLE .......................................................................................................................................... 347 PROPERTIES AND METHODS .................................................................................................................................... 348


58. USING IOPOSITIONLEVELPRICING ................................................................................................................ 352 PURPOSE ....................................................................................................................................................................... 352 VISUAL BASIC EXAMPLE .......................................................................................................................................... 352 PROPERTIES AND METHODS .................................................................................................................................... 353




59. USING IORELATEDSECURITESMAINTENANCE .......................................................................................... 358 PURPOSE ....................................................................................................................................................................... 358 VISUAL BASIC EXAMPLE .......................................................................................................................................... 358 PROPERTIES AND METHODS .................................................................................................................................... 359


60. USING IOINCOMEDISTRIBUTIONGENERATOR .......................................................................................... 364 PURPOSE ....................................................................................................................................................................... 364 VISUAL BASIC EXAMPLE .......................................................................................................................................... 364 PROPERTIES AND METHODS .................................................................................................................................... 364


61. APPENDIX A – INSTALLING IP SOCKETS ...................................................................................................... 369 INFORMATION AND TASKS ............................................................................................................................................... 369 INSTALLING ARSIPS - THE CICS IP SECURITY EXIT ....................................................................................................... 370

IO OLE PROGRAMMER’S GUIDE WHAT IS IO OLE?


16

1. WHAT IS IO OLE? ABOUT IO OLE IO OLE is a desktop developer’s tool which provides a series of OLE Automation objects. These objects allow data to be communicated to and from the Investment Accounting (InvestOne) Engine. Messages may be sent from any Microsoft Windows application which can use OLE objects. IO OLE OBJECT MODEL AND PAGE LOCATION IN THIS DOCUMENT IOACCOUNT, 103 IOAccountBlock, 110 IOAcctFeeBalances, 230, 336, 341, 347, 352, 358 IOAcctFeeBalancesBlock, 235 IOAcctFeeSchedule, 239 IOAcctFeeScheduleBlock, 245 IOCalendarSet, 250 IOCalendarSetBlock, 255 IOCollateralMaintenance, 225 IOComplexCorpAction, 183 IOComplexCorpActionBlock, 189 IOConnection Object, 23 iocorporateaction, 172 IOCorporateActionBlock, 178 IOEffectiveYield, 259 IOEffectiveYieldBlock, 264 IOExchRates, 268 IOExchRatesBlock, 273 IOFixedExpenses, 277 IOFixedExpensesBlock, 282 IOHOLDING, 150 IOHOLDINGBlock, 156

ioMBSPOOLBALANCE, 210, 215 IOPartEleCorpAction, 194 IOPartEleCorpActionBlock, 200 IOPrepayrate, 286 IOPrepayRateBlock, 291 IOPrices, 295 IOPricesBlock, 301 IORelief, 139 IOReliefBlock, 145 IOSecurity, 127 IOSecurityBlock, 133 IOSecurityExtension, 220 IOSpectraDistRequest, 45 IOSpectraFundRequest, 57 IOSpectraFXRATERequest, 82 IOSpectraItem, 97 IOSpectraTranRequest, 70 ioSUPERMESSAGE, 205 IOTAXLOTADJ, 161 IOTAXLOTADJBlock, 167 IOTransaction, 115 IOTransactionBlock, 121

IO OLE PROGRAMMER’S GUIDE INSTALLING IO OLE


17

2. INSTALLING IO OLE CRITICAL PREREQUISITES

• IO OLE must be installed while logged in as the user who will be using the product.

• This user must have Administrative rights to the PC. There are no exceptions.

• IO OLE is intended to be a desktop tool which is installed locally. It should not be run from a server.

• If using APPC connectivity to the host, Microsoft SNA Client must be installed on your PC.

• If using IP/Socket connectivity, WSOCK32.DLL must be loaded and configured correctly on your PC.

You must also have IP Sockets configured and running in the CICS region. See Appendix A for details on installing IP Sockets. (Installed Customers Only)



18

IO OLE INSTALLATION INSTRUCTIONS

1. Obtain the IO OLE installation serial # for the specific release. 2. Insert the installation CD or download it from Sungard’s support site 3. Open the contents of the CD or downloaded folder 4. Double-click on the setup.exe 5. Click Next on the Welcome screen 6. Read and click Yes to the Software License Agreement 7. Insert your Name, Company and Serial # and click Next 8. Choose a custom program locations or Click Next to choose the default path location 9. Click Next on the Program folder screen 10. Choose a restriction level and click Next 11. Read the Engine Password Option and decide if you want to select Prompt for Engine Password, then

click Next 12. Click Finish to complete Setup

Restricted Operator Options

This installation prompt has been added to provide the following Operator Restriction options:

• Invest One Operator must equal Invest One UserID • Invest One Operator and UserID must equal PC’s Logon ID



19

Both options may be selected during installation or may be implemented post-installation by means of the registry. Please contact Sungard Technical Services for details. Engine Password Option

This installation option prevents the Investment Accounting (InvestOne) Engine User’s password from being saved in the local PC’s registry. If the password already exists in the registry when the installation is executed (with this option on), the existing password is removed. Note that when the password is not stored, IO OLE prompts for the connection information with each execution request. All connection information from the previous connection setup is displayed except the password. The password must be re-entered each time. Again, this option may be selected during installation or may be implemented post-installation by means of the registry. Please contact Sungard Technical Services for details.



20

IO OLE Installation Contents

File Purpose IOOLE32.DLL IO OLE TAGLEG.DAT IO OLE DB Support File I1DICT.MDB IO OLE Data Dictionary MSVBVM50.DLL VB Runtime DLL STDOLE2.TLB VB Support File OLEAUT32.DLL VB Support File OLEPRO32.DLL VB Support File ASYCFILT.DLL VB Support File CTL3D32.DLL VB Support File COMCAT.DLL VB Support File COMCTL32.OCX Windows Common Controls DAO350.DLL DAO Support File MSJTER35.DLL DAO Support File MSJINT35.DLL DAO Support File MSVCRT40.DLL DAO Support File MSJET35.DLL DAO Support File VBAJET32.DLL DAO Support File ODBCJT32.DLL DAO Support File ODBCJI32.DLL DAO Support File ODBCTL32.DLL DAO Support File



21

REGISTRY SETTINGS IO OLE uses the system registry to hold configuration settings. Relevant Registration Entries HKEY_CURRENT_USER Software VB and VBA Program Settings INVEST1

General (added during IO OLE installation)

Dictionary The string value that identifies the location of the IO OLE Data Dictionary. The program must be able to see this registry entry to function.

Communications (dynamically created on first communication) Gateway Either “Novell SAA” or “Microsoft SNA Server”. This setting is only used when the Type setting is “APPC”. Default is “Microsoft SNA Server”.

Host IP This is the TCP/IP address of the server the Investment Accounting (InvestOne) Engine is running on. This setting is only used when the Type setting is “IP”. There is no default for this setting.

Password The password which accesses the Investment Accounting (InvestOne) Engine. The value is encrypted. There is no default for this setting.

Port This is the port the Investment Accounting (InvestOne) Engine is listening on the machine specified by the Host IP setting. This setting is only used when the Type setting is “IP”. There is no default for this setting.

SideInfo This is the CPI-C side information file IO OLE should use to locate the Investment Accounting (InvestOne) Engine. This setting is only used when the Type setting is “APPC”. There is no default for this setting.

Type Either “APPC” or “IP” based on your installation. The default for this for this setting is “APPC”.

UserID The Investment Accounting (InvestOne) Engine login name. There is no default for this setting.

IO OLE PROGRAMMER’S GUIDE USING IO OLE


22

3. USING IO OLE USING IO OLE IN YOUR ENVIRONMENT IO OLE consists of a series of OLE Automation objects. Any environment which can use OLE 2.0 objects can make use of IO OLE. This includes Visual Basic, C++, PowerBuilder, Microsoft Excel, Microsoft Access, Microsoft Word, and Delphi are just some of the possibilities. The examples in the manual will show how to use IO OLE in Microsoft Excel. Please check the documentation of your environment for more specific information on using OLE Automation objects.

IO OLE PROGRAMMER’S GUIDE USING THE IOCONNECTION OBJECT


23

4. USING THE IOCONNECTION OBJECT PURPOSE The IOConnection object is used to store information on how IO OLE should connect to the Investment Accounting (InvestOne) Engine. In general, when you create a new instance of the IOConnection object, its properties are defaulted to the corresponding settings in the Windows System Registry. You may then override those properties before connecting to the Investment Accounting (InvestOne) Engine. PROPERTIES & METHODS CommType Description

Returns or sets the communications type which is being used for communications with the Investment Accounting (InvestOne) Engine.

Syntax object.CommType [= type] The CommType property syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object. Type A string representing the type of communication being used.

Settings The settings for CommType are: Part Description APPC Communications with the Investment Accounting (InvestOne) Engine will be based on APPC

protocol. IP Communications with the Investment Accounting (InvestOne) Engine will be based on IP/Socket

protocol. Remarks

If this property is set to “APPC”, the Gateway and SideInfo property settings will be used to locate the Investment Accounting (InvestOne) / Engine. If this property is set to “IP”, the HostIP and Port property settings will be used to locate the Investment Accounting (InvestOne) / Engine. The default for this property is loaded from the system registry setting:



24

HKEY_CURRENT_USER/Software/VB and VBA Program Settings/INVEST1/Communications/Type

CreateDistRequest Description

Returns a new IOSpectraDistRequest object for this connection.

Syntax

object.CreateDistRequest The CreateDistRequest method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOSpectraDistRequest object (see Chapter 5) which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOSpectraDistRequest object. You must manually set the IOSpectraDistRequest.Connection property to do this.

CreateFundRequest Description

Returns a new IOSpectraFundRequest object for this connection.

Syntax

object.CreateFundRequest

The CreateFundRequest method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOSpectraFundRequest object (see Chapter 6) which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine.



25

After executing this method, changing properties of this IOConnection object will not effect the IOSpectraFundRequest object. You must manually set the IOSpectraFundRequest.Connection property to do this.



26

CreateRelief Description

Returns a new IORelief object for this connection.

Syntax

object.CreateRelief The CreateRelief method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IORelief object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IORelief object. You must manually set the IORelief.Connection property to do this.

CreateReliefBlock Description

Returns a new IOReliefBlock object for this connection.

Syntax

object.CreateReliefBlock The CreateReliefBlock method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOReliefBlock object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOReliefBlock object. You must manually set the IOReliefBlock.Connection property to do this.



27

CreateSecurity Description

Returns a new IOSecurity object for this connection. Syntax object.CreateSecurity

The CreateSecurity method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks This method returns an IOSecurity object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOSecurity object. You must manually set the IOSecurity.Connection property to do this. CreateSecurityBlock Description

Returns a new IOSecurityBlock object for this connection. Syntax

object.CreateSecurityBlock The CreateSecurityBlock method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks This method returns an IOSecurityBlock object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOSecurityBlock object. You must manually set the IOSecurityBlock.Connection property to do this.



28

CreateTranRequest Description

Returns a new IOSpectraTranRequest object for this connection.

Syntax

object.CreateTranRequest The CreateTranRequest method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOSpectraTranRequest object (see Chapter 5) which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOSpectraTranRequest object. You must manually set the IOSpectraTranRequest.Connection property to do this.

CreateTransaction Description

Returns a new IOTransaction object for this connection. Syntax

object.CreateTransaction The CreateTransaction method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOTransaction object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOTransaction object. You must manually set the IOTransaction.Connection property to do this.



29

CreateTransactionBlock Description

Returns a new IOTransactionBlock object for this connection.

Syntax

object.CreateTransactionBlock The CreateTransactionBlock method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOTransactionBlock object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOTransactionBlock object. You must manually set the IOTransactionBlock.Connection property to do this.

CreateCorporateAction Description

Returns a new IOCorporateAction object for this connection. Syntax

object.CreateCorporateAction The CreateCorporateAction method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOCorporateAction object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOCorporateAction object. You must manually set the IOCorporateAction Connection property to do this.



30

CreateCorporateActionBlock Description

Returns a new IOCorporateActionBlock object for this connection.

Syntax

object.CreateCorporateActionBlock The CreateCorporateActionBlock method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOCorporateActionBlock object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine.

After executing this method, changing properties of this IOConnection object will not effect the IOCorporateActionBlock object. You must manually set the IOCorporateActionBlock Connection property to do this. CreateComplexCorpAction Description

Returns a new IOComplexCorpAction object for this connection. Syntax

object.CreateComplexCorpAction The CreateComplexCorpAction method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOComplexCorpAction object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOComplexCorpAction object. You must manually set the IOComplexCorpAction Connection property to do this.



31

CreateComplexCorpActionBlock Description

Returns a new IOComplexCorpActionBlock object for this connection.

Syntax

object.CreateComplexCorpActionBlock The CreateComplexCorpActionBlock method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOComplexCorpActionBlock object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOComplexCorpActionBlock object. You must manually set the IOComplexCorpActionBlock Connection property to do this.

CreatePartialEleCorpAction Note: This is only available in the desktop version of OLE. Description

Returns a new IOPartEleCorpAction object for this connection. Syntax

object.CreatePartialEleCorpAction The CreatePartialEleCorpAction method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOPartEleCorpAction object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine.



32

After executing this method, changing properties of this IOConnection object will not effect the IOPartEleCorpAction object. You must manually set the IOPartEleCorpAction Connection property to do this.

CreatePartialEleCorpActionBlock Note: This is only available in the desktop version of OLE. Description

Returns a new IOPartEleCorpActionBlock object for this connection.

Syntax

object.CreatePartialEleCorpActionBlock The CreatePartialEleCorpActionBlock method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOPartEleCorpActionBlock object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOPartEleCorpActionBlock object. You must manually set the IOPartEleCorpActionBlock Connection property to do this.

CreateSuperMessage Description

Returns a new IOSuperMessage object for this connection. Syntax

Object.CreateSuperMessage The CreateSuperMessage method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOSuperMessage object which uses the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine.



33

After executing this method, changing properties of this IOConnection object will not effect the IOSuperMessage object. You must manually set the IOSuperMessage.Connection property to do this.

CreateMBSPoolBalance Description

Returns a new IOMBSPoolBalance object for this connection. Syntax

Object.CreateMBSPoolBalance The CreateMBSPoolBalance method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOMBSPoolBalance object which uses the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOMBSPoolBalance object. You must manually set the IOMBSPoolBalance.Connection property to do this.

CreateVACRNUM

Description

Returns a new IOVACRNUM object for this connection.

Syntax object.CreateVACRNUM The CreateVACRNUM method syntax has these parts:

Part Description object An object expression that evaluates to an IOConnection object.

Remarks This method returns an IOVACRNUM object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not affect the IOVACRNUM object. You must manually set the IOVACRNUM.Connection property to do this.



34

CheckConnection Description

Returns true if connection failed to IO engine and false if it is successful. Syntax

object.CheckConnection The CheckConnection method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an true if the communication fails to the IOEngine. It will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. Before executing this method, all the properties of the IOConnection object needs to be set. This function can be used to check to see whether ioConnection object’s properties for the IOEngine are correct.

CreateSecurityExtension Description

Returns a new IOSecurityExtension object for this connection. Syntax object.CreateSecurityExtension

The CreateSecurityExtension method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks This method returns an IOSecurityExtension object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOSecurityExtension object. You must manually set the IOSecurityExtension.Connection property to do this.



35

CreateSecurityExtensionBlock Description

Returns a new IOSecurityExtensionBlock object for this connection. Syntax

object.CreateSecurityExtensionBlock The CreateSecurityExtensionBlock method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks This method returns an IOSecurityExtensionBlock object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine.

After executing this method, changing properties of this IOConnection object will not effect the IOSecurityExtensionBlock object. You must manually set the IOSecurityExtensionBlock.Connection property to do this.

CreateCollateralMaintenance Description

Returns a new IOCollateralMaintenance object for this connection. Syntax object. CreateCollateralMaintenance

The CreateCollateralMaintenance method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks This method returns an IOCollateralMaintenance object which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOCollateralMaintenance object. You must manually set the IOCollateralMaintenance.Connection property to do this.



36

CreateCollateralMaintenanceBlock Description

Returns a new IOCollateralMaintenanceBlock object for this connection. Syntax

object.CreateCollateralMaintenanceBlock The CreateCollateralMaintenanceBlock method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOCollateralMaintenanceBlock object which uses the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine. After executing this method, changing properties of this IOConnection object will not effect the IOCollateralMaintenanceBlock object. *Manually set the IOCollateralMaintenanceBlock.Connection property to do this.

CreateIncomeDistGenerator Description

Returns a new IOIncomeDistributionGenerator object for this connection.

Syntax

object.CreateIncomeDistGenerator The CreateIncomeDistGenerator method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IOIncomeDistributionGenerator object (see Chapter 5) which will use the current properties of this IOConnection object for communications with the Investment Accounting (InvestOne) / Engine.



37

After executing this method, changing properties of this IOConnection object will not effect the IOSpectraTranRequest object. You must manually set the IOIncomeDistributionGenerator.Connection property to do this.

GetHostIPAddress Description

Returns a string containing the IP Address for the given Host Entry. Otherwise, an error message will be posted. Syntax

object.GetHostIPAddress The CheckConnection method syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object.

Remarks

This method returns an IP Address for a valid DNS Entry. If the DNS Entry could not be found, a message stating “Authoritative answer host not found”. DNS Entry needs to be established by contacting the Administrator. OLE provides the flexibility only to use DNS Entry instead of IP Address and does not provide the DNS Entry.

DictionaryFile Description

Returns or sets the file name of the Investment Accounting (InvestOne) Data Dictionary. Syntax

object.DictionaryFile [= File] The DictionaryFile property syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object. DictionaryFile A string representing the location of the Investment Accounting (InvestOne) Data Dictionary

database. Remarks

The dictionary file is installed in your Windows System directory as I1DICT.MDB. The default for this property is loaded from the system registry setting:



38

HKEY_CURRENT_USER/Software/VB and VBA Program Settings/INVEST1/General/Dictionary

Gateway Description

Returns or sets the type of Gateway used for APPC communications. Syntax

object.Gateway [= Type]

The Gateway property syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object. Type Specifies what type of SNA Gateway is being used to connect to the Investment Accounting

(InvestOne) / Engine. Valid values are: Novell SAA Gateway Microsoft SNA Server

Remarks

This property is only used if the CommType property is set to “APPC”. It is used in conjunction with the SideInfo property to locate the Investment Accounting (InvestOne) / Engine. The default for this property is loaded from the system registry setting:

HKEY_CURRENT_USER/Software/VB and VBA Program Settings/INVEST1/Communications/Host IP



39

HostIP Description

Returns or sets the IP address of the machine on which the Investment Accounting (InvestOne) / Engine is running.

Syntax

object.HostIP [= Addr] The HostIP property syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object. Addr A string representing the IP address (that is, 168.162.200.125) or the DNS entry of the host machine

for Investment Accounting (InvestOne).

Remarks This property is only used if the CommType property is set to “IP”. It is used in conjunction with the Port property to locate the Investment Accounting (InvestOne) / Engine. DNS entry is optional. If the DNS entry is available for the Investment Accounting (InvestOne) /Engine, IO OLE will use the DNS Server to find the IP address of the host machine. The user has the flexibility of using the DNS entry if it is available. The set up of the DNS entry is typically performed by the network administrator. The default for this property is loaded from the system registry setting:

HKEY_CURRENT_USER/Software/VB and VBA Program Settings/INVEST1/Communications/Host IP



40

Operator Description

Returns or sets the Investment Accounting (InvestOne) operator which will be used in communications.

Syntax

object.Operator [= oper] The Operator property syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object. oper A string representing a valid Investment Accounting (InvestOne) operator ID.

Remarks

If this property is not set, Investment Accounting (InvestOne) will use the UserID property for both host security and internal Investment Accounting (InvestOne) security. If this property is set, the UserID property will be used (in conjunction with the Password property) for host security, and the Operator property will be used for internal Investment Accounting (InvestOne) security. The Investment Accounting (InvestOne) operator is defined to the Investment Accounting (InvestOne) engine using the OP00 screen. This value will be provided to you by your Investment Accounting (InvestOne) security officer. The default for this property is loaded from the system registry setting:

HKEY_CURRENT_USER/Software/VB and VBA Program Settings/INVEST1/Communications/Operator



41

Password Description

Returns or sets the Investment Accounting (InvestOne) password which will be used in communications.

Syntax

object.Password [= pass] The Password property syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object. pass A string representing the password associated with the UserID property.

Remarks

This property is used in conjunction with the UserID property to access the Investment Accounting (InvestOne) / Engine. Although this property is normally not stored in the registry, the default for this property is loaded from the system registry setting:

HKEY_CURRENT_USER/Software/VB and VBA Program Settings/INVEST1/Communications/Password



42

Port Description

Returns or sets the port on which the Investment Accounting (InvestOne) / Engine is listening on the host machine.

Syntax

object.Port [= number] The Port property syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object. Port An integer representing the port on the host machine.

Remarks This property is only used if the CommType property is set to “IP”. It is used in conjunction with the HostIP property to locate the Investment Accounting (InvestOne) / Engine. The default for this property is loaded from the system registry setting:

HKEY_CURRENT_USER/Software/VB and VBA Program Settings/INVEST1/Communications/Port



43

SideInfo Description

Returns or sets the CPI-C side information record used to communicate with the Investment Accounting (InvestOne) / Engine.

Syntax

object.SideInfo [= record] The SideInfo property syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object. record A string representing the side information record configured to communicate to the desired

Investment Accounting (InvestOne) / Engine. Engine is Novell SAA.

Remarks

This property is only used if the CommType property is set to “APPC”. It is used in conjunction with the Gateway property to locate the Investment Accounting (InvestOne) / Engine. Side information records contain the necessary SNA information used to connect to a CICS region. Each gateway product has its own interface for configuring side information records. Please review the documentation associated with your gateway installation. The default for this property is loaded from the system registry setting:

HKEY_CURRENT_USER/Software/VB and VBA Program Settings/INVEST1/Communications/SideInfo



44

UserID Description

Returns or sets the Investment Accounting (InvestOne) User ID which will be used in communications.

Syntax

object.UserID [= user] The UserID property syntax has these parts: Part Description object An object expression that evaluates to an IOConnection object. user A string representing a valid Investment Accounting (InvestOne) User ID.

Remarks

If the Operator property is not set, Investment Accounting (InvestOne) will use the UserID property for both host security and internal Investment Accounting (InvestOne) security. If the Operator property is set, the UserID property will be used (in conjunction with the Password property) for host security, and the Operator property will be used for internal Investment Accounting (InvestOne) security. This value will be provided to you by your Investment Accounting (InvestOne) security officer. The default for this property is loaded from the system registry setting:

HKEY_CURRENT_USER/Software/VB and VBA Program Settings/INVEST1/Communications/UserID

IO OLE PROGRAMMER’S GUIDE USING IOSPECTRADISTREQUEST


45

5. USING IOSPECTRADISTREQUEST PURPOSE The IOSpectraDistRequest provides access to Investment Accounting (InvestOne) position, security and taxlot information. Using this Normally you will set the Account and RequestDate properties. Execute the AddItem and AddFilter methods to set your request. VISUAL BASIC EXAMPLE

Public Sub InvestOneDistribution() Dim c As IOConnection Dim sp As IOSpectraDistRequest 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build Request Set sp = c.CreateDistRequest sp.Account = 12345 sp.RequestDate = DateSerial(1997, 12, 31) sp.AddItem ("CU")

sp.AddItem ("SD") sp.AddItem ("MV") sp.AddItem ("AI") sp.AddFilter Item:="MV", Operand:="!", Value:=0 'Start INVEST ONE Request sp.Start 'Retrieve INVEST ONE messages and write the results to the debug screen sp.MoveNext Do Until sp.EOF Debug.Print “-------------------“ Debug.Print “Cusip: “ & sp.ItemValue("CU") Debug.Print “Description: “ & sp.ItemValue("SD") Debug.Print “Market + Accrued: “ & CDbl(sp.ItemValue("MV"))+CDbl(sp.ItemValue(“AI”)) Loop End Sub



46

PROPERTIES AND METHODS Account Description

Returns or sets the account number to be extracted.

Syntax

object.Account [= number] The Account property syntax has these parts:

Part Description object An object expression that evaluates to an IOSpectraDistRequest object. number An long integer specifying the Investment Accounting (InvestOne) account being requested.

Remarks

The Investment Accounting (InvestOne) account may be an individual, group or reporting account. If the account specified is a reporting account, a row will be returned for each position and/or taxlot and/or collateral record within each sub-account of that reporting account. If the Account is set to zero, the request will retrieve one row per Investment Accounting (InvestOne) security matching the query. Any Items requested which are not security related will return either “0” or null. This property must be set before invoking the Start method.



47

AddFilter Description

Adds a filter to limit the number of rows returned based on item values.

Syntax

object. AddFilter (Item As String, Operand As String, Value As String) The AddFilter method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object. Item A two-byte string specifying the field to be checked. A current list of valid items can be found in the

Enterprise Spectra Data Items manual. Operand The type of compare that should be used: “=“ if the Item must be equal to Value. “!” if the Item must not be equal to Value. “>“ if the Item must be greater than Value. “<“ if the Item must be less than Value. Value The value the actual value of the item should be compared against.

Remarks

Only rows passing all filters will be returned. If the item is a string and the Operand is either “=“ or “!”, a list of values can be checked in a single filter by separating the values with a colon “:” or tilde “~” character. This achieves “OR” logic within a filter. When delimiting fields using the tilde, the tilde must be placed immediately after the operand as well as separating each specified field.

Colon as delimiter (AG=G1:G2) Tilde as delimiter (AG=~G1~G2)

This method cannot be executed after the Start method has been executed.



48

AddItem Description

Adds an Item to the list of items to be returned.

Syntax

object. AddItem (Item As String) The AddItem method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object. Item A two-byte string specifying the field to be checked. A current list of valid items can be found in the

Enterprise Spectra Data Items manual. This method cannot be executed after the Start method has been executed.

Connection Description

Sets the IOConnection object associated with this IOSpectraDistRequest. Syntax

object. Connection [= connect] The AddFilter method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object. connect An IOConnection object.

Remarks

When the IOSpectraDistRequest object is created with the IOConnection.CreateDistRequest method, the Connection property will automatically be set. But changing the properties of the IOConnection object will not effect this object until this property is set again. This method cannot be executed after the Start method has been executed.



49

EOF Description

Indicates if the object currently has a row.

Syntax

object. EOF The EOF method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object.

Remarks

This method returns a Boolean value indicating if there is currently a record loaded. This property differs from a database recordset object in that on the last returned record, EOF will still be false. For this reason, EOF should be checked immediately after every MoveNext method execution.

ItemCount Description

Indicates the number of columns in each row.

Syntax

object. ItemCount The ItemCount property syntax has these parts:

Part Description object An object expression that evaluates to an IOSpectraDistRequest object.

Remarks

This method returns an integer value indicating the number of items which will be returned in each row.



50

Items Description

A collection of the items and their attributes for all items requested. Syntax

object. Items The Items property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object.

Remarks

This collection will be a collection of IOSpectraItem objects. See chapter 99 for information on IOSpectraItem properties.

ItemValue Description

Returns the value for the specified item in the current row.

Syntax

object. ItemValue (Item As String) The ItemValue method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object. Item A two-byte string specifying the item value to be returned. This Item must have been previously

added using the AddItem method.

Remarks

This method returns an variant for the integer value indicating the number of items which will be returned in each row. If there is no current row loaded in the object, an error will be raised. This method cannot be executed before the Start method has been executed.



51

MoveNext Description

Retrieves the next row satisfying the query into the object.

Syntax

object. MoveNext The MoveNext method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object.

Remarks

This method loads the next row satisfying the query into the object. After this method is executed, the EOF property should be checked immediately. This method cannot be executed before the Start method has been executed.

Record Description

Returns all the fields in the current row formatted as specified by the RecordFormat property.

Syntax

object. Record The Record method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object.

Remarks

Returns a string displaying the row as returned from the Investment Accounting (InvestOne) Engine. This method cannot be executed before the Start and MoveNext methods have been executed.



52

RecordFormat Description

Returns or sets the account number to be extracted. Syntax

object. RecordFormat [= Format] The RecordFormat method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object. Format An integer specifying the format items will be returned in the Record method.

Settings The settings for Format are:

Part Description 0 Fixed format. Each item takes the same width in each row. 1 Comma delimited. Each item is delimited by commas.

2 Tab delimited. Each item is delimited by tabs. Remarks

This property must be set before invoking the Start method. If you will be using the ItemValue method, this property must be set to “2” before invoking the Start method.



53

RequestDate Description

Returns or sets the request date to be extracted. Syntax

object. RequestDate [= Date] The RequestDate method syntax has these parts:

Part Description object An object expression that evaluates to an IOSpectraDistRequest object. Date A date which will control what data will be extracted.

Remarks

This must be an Investment Accounting (InvestOne) valuation date for the requested account. This property must be set before invoking the Start method.

SecuritiesOnly Description


object. SecuritiesOnly [= Boolean] The SecuritiesOnly method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object. Boolean Boolean value indicating if only securities should be returned by the Investment Accounting

(InvestOne) Engine. Remarks

When this property is set to true, securities with a security number of “CASH”, “EXPENSE“, or “UNITS” will not be retrieved from the Investment Accounting (InvestOne) Engine. The default for this property is True. This property must be set before executing the Start method.



54

Aggregate Description

Causes eligible items to aggregate when a Group “M”, Group “G”, or Reporting account is requested. Syntax

object. Aggregate [=Value] The Aggregate property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object. Value A String value containing either “Y” or “N” indicating if aggregation should be performed.

Remarks

The default for this property is “N”. This property must be set before executing the Start method.



55

Start Description

Connects to the Investment Accounting (InvestOne) Engine. Syntax

object. Start The Start method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object.

Remarks Some properties and methods will only be effective is used before invoking this method, other properties and methods will only be effective if used after invoking this method. Please refer to each property and method for the effect of this method on its behavior. Status Description

Returns the current status of communications between the object and the Investment Accounting (InvestOne) Engine.

Syntax

object. Status The Status property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object.

Remarks The return values are:

Part Description 0 The object has not yet connected to the Investment Accounting (InvestOne) Engine. (The Start

method has not been successfully invoked). 1 The object is currently connected to the Investment Accounting (InvestOne) Engine and a row is

currently loaded in the object. 2 The connection with the Investment Accounting (InvestOne) Engine object has been terminated and

no row is currently loaded in the object.



56

Traded Cash Description

Returns or sets the property for the “Traded Cash” calculation as applied to the extracted Cash Balances. Syntax

object.TradedCash [=Value] The TradedCash property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object. Value A String value containing either “Y” or “N” indicating if the “Traded Cash” calculation should

be applied. Remarks

This property defaults to “N”.

IO OLE PROGRAMMER’S GUIDE USING IOSPECTRAFUNDREQUEST


57

6. USING IOSPECTRAFUNDREQUEST PURPOSE The IOSpectraFundRequest provides access to Investment Accounting (InvestOne) valuation information. Information such as Shareholder Equity, Net Asset Value, Public Offering Price, etc. VISUAL BASIC EXAMPLE

Public Sub InvestOneValuation() Dim c As IOConnection Dim sp As IOSpectraFundRequest 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build Request Set sp = c.CreateFundRequest sp.Account = 12345 sp.ClassOfShares = 1 sp.RequestDate = DateSerial(1997, 12, 31) sp.Periods = 365 sp.PeriodType = “D” sp.AddItem “DT” sp.AddItem “EQ” sp.AddItem “NV” 'Start INVEST ONE Request sp.Start 'Retrieve INVEST ONE messages and write the results to the debug screen sp.MoveNext Do Until sp.EOF Debug.Print “-------------------“ Debug.Print “Date: “ & sp.ItemValue("DT") Debug.Print “Shareholder Equity: “ & sp.ItemValue("EQ") Debug.Print “NAV: “ & sp.ItemValue(“NV”) Loop End Sub



58



object.Account [= number] The Account property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object. number An long integer specifying the Investment Accounting (InvestOne) account being requested.

Remarks The Investment Accounting (InvestOne) account can only be an individual or group account. Reporting accounts are not supported. This property must be set before invoking the Start method.



59



Syntax

object. AddFilter (Item As String, Operand As String, Value As String) The AddFilter method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object. Item A two-byte string specifying the field to be checked. A current list of valid items can be found in the


Remarks Only rows passing all filters will be returned. If the item is a string and the Operand is either “=“ or “!”, a list of values can be checked in a single filter by separating the values with a colon “:” or tilde “~” character. This achieves “OR” logic within a filter. When delimiting fields using the tilde, the tilde must be placed immediately after the operand as well as separating each specified field.





60

AddItem Description


Syntax

object. AddItem (Item As String) The AddItem method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object. Item A two-byte string specifying the field to be checked. A current list of valid items can be found in the


ClassOfShares Description

Returns or sets the class of shares to be extracted.

Syntax

object.ClassOfShares [= number] The ClassOfShares property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object. number An integer specifying the class of shares associated with the Account property to be extracted.

Remarks

For accounts containing multiple classes of shares, each request can only extract one class of shares. This property defaults to “0”. This property must be set before invoking the Start method.



61


Sets the IOConnection object associated with this IOSpectraFundRequest.

Syntax

object. Connection [= connect] The AddFilter method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object. connect An IOConnection object.

Remarks

When the IOSpectraFundRequest object is created with the IOConnection.CreateFundRequest method, the Connection property will automatically be set. But changing the properties of the IOConnection object will not effect this object until this property is set again. This method cannot be executed after the Start method has been executed.

EOF Description


Syntax

object. EOF The EOF method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object.

Remarks




62



Syntax

object. ItemCount The ItemCount property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object.

Remarks


Items Description

A collection of the items and their attributes for all items requested.

Syntax

object. Items The Items property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object.

Remarks




63



Syntax

object. ItemValue (Item As String) The ItemValue method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object. Item A two-byte string specifying the item value to be returned. This Item must have been previously

added using the AddItem method. Remarks This method returns an variant for the integer value indicating the number of items which will be returned in each row. If there is no current row loaded in the object, an error will be raised. This method cannot be executed before the Start method has been executed. MoveNext Description


Syntax

object. MoveNext The MoveNext method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object.

Remarks This method loads the next row satisfying the query into the object. After this method is executed, the EOF property should be checked immediately. This method cannot be executed before the Start method has been executed.



64

Periods Description

Returns or sets the number of periods to be extracted.

Syntax

object.Periods [= number] The Periods property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object. number An integer specifying the number of periods to be returned.

Remarks

This property will normally control the number of rows returned. It used in conjunction with the RequestDate and PeriodType properties. This number specifies the number of periods including and prior to the RequestDate to be returned. For example if RequestDate is 31-Mar-97, and PeriodType is “Q” (quarters), and Periods is 4: you will receive four rows. The first row would contain data for 31-Mar-97, the second row for 31-Dec-96, the third row for 30-Sep-96, and the fourth row for 30-Jun-97.

This property is not relevant if the PeroidType property is set to “A”. This property defaults to “1”. This property must be set before invoking the Start method.



65

PeriodType Description

Returns or sets the type of periods which should be returned.

Syntax

object.PeriodType [= type] The Periods property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object. type A one-character string specifying the period types to be extracted.

Settings The valid settings for type are:

Part Description A Return a row for all periods starting from the value of RequestDate forward. D Return a row for each day, starting with value of the RequestDate property and going back the

number of days in the Period property. W Return a row for each week, starting with value of the RequestDate property and going back the

number of weeks in the Period property. M Return a row for each month, starting with value of the RequestDate property and going back the

number of months in the Period property. Q Return a row for each quarter, starting with value of the RequestDate property and going back the

number of quarters in the Period property. Y Return a row for each year, starting with value of the RequestDate property and going back the

number of years in the Period property. P Return a row for each Investment Accounting (InvestOne) valuation point, starting with value of the

RequestDate property and going back the number of valuation points in the Period property.

Remarks

This property is used in conjunction with the RequestDate and Periods properties. This property specifies what each row in the result set will represent.. For example if RequestDate is 31-Mar-97, and PeriodType is “Q” (quarters), and Periods is 4: you will receive four rows. The first row would contain data for 31-Mar-97, the second row for 31-Dec-96, the third row for 30-Sep-96, and the fourth row for 30-Jun-97. This property defaults to “D”. This property must be set before invoking the Start method.



66

Record Description


Syntax

object. Record The Record method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object.

Remarks

Returns a string displaying the row as returned from the Investment Accounting (InvestOne) Engine This method cannot be executed before the Start and MoveNext methods have been executed.



67



Syntax

object. RecordFormat [= Format] The RecordFormat method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object. Format An integer specifying the format items will be returned in the Record method.







68


Returns or sets the request date to be extracted.

Syntax

object. RequestDate [= Date] The RequestDate method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object. Date A date which will control what data will be extracted.

Remarks


Start Description

Connects to the Investment Accounting (InvestOne) Engine

Syntax

object. Start The Start method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object.

Remarks

Some properties and methods will only be effective is used before invoking this method, other properties and methods will only be effective if used after invoking this method. Please refer to each property and method for the effect of this method on its behavior.



69

Status Description


Syntax

object. Status The Status property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFundRequest object.

Remarks

The return values are: Part Description

0 The object has not yet connected to the Investment Accounting (InvestOne) Engine. (The Start method has not been successfully invoked.)

1 The object is currently connected to the Investment Accounting (InvestOne) Engine and a row is currently loaded in the object.

2 The connection with the Investment Accounting (InvestOne) Engine object has been terminated and no row is currently loaded in the object.

IO OLE PROGRAMMER’S GUIDE USING IOSPECTRATRANREQUEST


70

7. USING IOSPECTRATRANREQUEST PURPOSE The IOSpectraTranRequest provides access to Investment Accounting (InvestOne) transaction and taxlot relief information. Set the Account and RequestDate properties. Execute the AddItem and AddFilter methods to set your request. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim sp As IOSpectraTranRequest 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build Request Set sp = c.CreateTranRequest sp.Account = 12345 sp.FromDate = DateSerial(1997, 12, 1) sp.ToDate = DateSerial(1997, 12, 31) sp.AddItem “TO” sp.AddItem “SN” sp.AddItem “ED” sp.AddItem “CD” 'Start INVEST ONE Request sp.Start 'Retrieve INVEST ONE messages and write the results to the debug screen sp.MoveNext Do Until sp.EOF Debug.Print “-------------------“ Debug.Print “Memo Number: “ & sp.ItemValue("TO") Debug.Print “Security Number: “ & sp.ItemValue("SN") Debug.Print “Effective Date: “ & sp.ItemValue(“ED”) Debug.Print “Tran Code: “ & sp.ItemValue(“CD”) Loop End Sub



71



Syntax

object.Account [= number] The Account property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object. number An long integer specifying the Investment Accounting (InvestOne) account being requested.

Remarks

The Investment Accounting (InvestOne) account may be an individual, group or reporting account. If the account specified is a reporting account, a row will be returned for each transaction and/or relief record within each sub-account of that reporting account. This property must be set before invoking the Start method.



72


Adds a filter to limit the number of rows returned based on item values. Syntax

object. AddFilter (Item As String, Operand As String, Value As String) The AddFilter method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object. Item A two-byte string specifying the field to be checked. A current list of valid items can be found in the


Remarks






73

AddItem Description

Adds an Item to the list of items to be returned. Syntax

object. AddItem (Item As String) The AddItem method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object. Item A two-byte string specifying the field to be checked. A current list of valid items can be found in the



Sets the IOConnection object associated with this IOSpectraTranRequest.

Syntax

object. Connection [= connect] The AddFilter method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object. connect An IOConnection object.

Remarks

When the IOSpectraTranRequest object is created with the IOConnection.CreateTranRequest method, the Connection property will automatically be set. But changing the properties of the IOConnection object will not effect this object until this property is set again. This method cannot be executed after the Start method has been executed.



74

DateType Description

Sets or returns what type of date the FromDate and ToDate properties represent. Syntax

object. DateType [= type] The DateType method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object. type An one-character string value representing what Investment Accounting (InvestOne) transaction date

the FromDate and ToDate properties should be checked against.

Settings

The settings for type are:

TSECGN Part Description

T Trade date S Actual settle date E Effective date C Contractual settle date G Generated date N Entry date Remarks

The default for this property is “E” (Effective date). This property must be set before the Start method is invoked.



75

EOF Description


Syntax

object. EOF The EOF method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object.

Remarks


FromDate Description

Returns or sets the starting date transaction should be retrieved.

Syntax

object. FromDate [= Date] The FromDate method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object. Date A date which will control what data will be extracted.

Remarks

This is the starting date transactions will be pulled from. The transaction date checked against this date is determined by the DateType property. If the Positions property is “N”, this date is inclusive. Otherwise this date is exclusive. This property must be set before invoking the Start method.



76



Syntax

object. ItemCount The ItemCount property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object.

Remarks


Items Description

A collection of the items and their attributes for all items requested.

Syntax

object. Items The Items property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object.

Remarks




77



Syntax

object. ItemValue (Item As String) The ItemValue method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object. Item A two-byte string specifying the item value to be returned. This Item must have been previously


Remarks




Syntax

object. MoveNext The MoveNext method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object.

Remarks




78

Positions Description

Controls whether or not summary position records will be included in the extract.

Syntax

object. Positions [= Type] The Positions method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object. Type A one-character string value which specifies if position rows should be returned.

Settings

The settings for Type are: Part Description

A A beginning and ending position row will be returned for each security held by the Account during the FromDate and the ToDate.

O A beginning and ending position row will be returned for each security held by the Account during the FromDate and the ToDate which has a transaction returned.

N No position rows will be returned. P Only transactions on the Pending File will be returned.

Remarks

Position records will be returned before the transactions. For a given security, the first row will always be the beginning holding, the second row will always be the ending holding, and the remaining rows (if any) will be the transactions. You can use the AddItem method to add the item “RT” (record type) and then use the ItemValue method on each row to determine if you have a beginning position (ItemValue will return “B”), an ending position (ItemValue will return “Z”), or a transaction (ItemValue will return “T”). If this property is “O” or “A”, the DateType property must be “E”. The default for this property is “N”. This property must be set before executing the Start method.



79

Record Description


Syntax

object. Record

The Record method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object.

Remarks


Record Format Description


Syntax

object. RecordFormat [= Format] The RecordFormat method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object. Format An integer specifying the format items will be returned in the Record method.

Settings

The settings for Format are: Part Description

0 Fixed format. Each item takes the same width in each row. 1 Comma delimited. Each item is delimited by commas.





80

Start Description

Connects to the Investment Accounting (InvestOne) Engine.

Syntax

object. Start The Start method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object.

Remarks

Some properties and methods will only be effective is used before invoking this method, other properties and methods will only be effective if used after invoking this method. Please refer to each property and method for the effect of this method on its behavior.

Status Description


Syntax

object. Status The Status property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object.



method has not been successfully invoked.) 1 The object is currently connected to the Investment Accounting (InvestOne) Engine and a row is





81

ToDate Description

Returns or sets the ending date transaction should be retrieved.

Syntax object. ToDate [= Date]

The ToDate method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraTranRequest object. Date A date which will control what data will be extracted.

Remarks

This is the ending date transactions will be pulled from. The transaction date checked against this date is determined by the DateType property. This date is always inclusive. This property must be set before invoking the Start method.

IO OLE PROGRAMMER’S GUIDE USING IOSPECTRAFXRATEREQUEST


82

8. USING IOSPECTRAFXRATEREQUEST PURPOSE The IOSpectraFXRateRequest provides access to Investment Accounting (InvestOne) Exchange rate information. Set the RequestDate, SctyCusip, BaseCurrency, PricingSource, PricingTime and PricingType properties. Execute the AddItem method to set your request. VISUAL BASIC EXAMPLE

Public Sub InvestOneDistribution() Dim c As IOConnection Dim sp As IOSpectraFXRateRequest 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build Request Set sp = c.CreateFXRateRequest sp.RequestDate = DateSerial(1997, 12, 31) sp.SctyCusip = CAD sp.BaseCurrency = USD sp.PricingSource = X1 sp.PricingTime = X2 sp.PricingType = X3 sp.Periods = 1 sp.PeriodType = “D” sp.ProcessAll = “X” sp.AddItem ("FX")

sp.AddItem ("F3") 'Start INVEST ONE Request sp.Start 'Retrieve INVEST ONE messages and write the results to the debug screen sp.MoveNext Do Until sp.EOF Debug.Print “-------------------“ Debug.Print “Spot: “ & sp.ItemValue("FX") Debug.Print “30 Days: “ & sp.ItemValue("F3") Loop End Sub



83

PROPERTIES AND METHODS RequestDate Description

Returns or sets the date to be extracted.

Syntax

object.RequestDate [= Date] The RequestDate property syntax has these parts:

Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. Date A date which that controls what data is extracted.

Remarks This property must be set before invoking the Start method. SctyCusip Description

Returns or sets the Currency Code to be extracted.

Syntax

object.SctyCusip [= Value] The SctyCusip property syntax has these parts:

Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. Value A string value containing the Currency Code of the requested exchange rate.

Remarks

To return all exchange rates for a given date, enter ALL in the SctyCusip property. This property must be set before invoking the Start method.



84

BaseCurrency Description

Returns or sets the Base Currency to be extracted.

Syntax

object.BaseCurrency [= Value] The BaseCurrency property syntax has these parts:

Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. Value A string value containing the Base Currency of the requested exchange rate.

Remarks This property must be set before invoking the Start method. PricingSource Description

Returns or sets the Pricing Source to be extracted.

Syntax

object.PricingSource [= Value] The PricingSource property syntax has these parts:

Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. Value A string value containing the Pricing Source of the requested exchange rate.

Remarks

This property must be set before invoking the Start method.



85

PricingTime Description

Returns or sets the Pricing Time to be extracted.

Syntax

object.PricingTime [= Value] The PricingTime property syntax has these parts:

Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. Value A String value containing the Pricing Time of the requested exchange rate.

Remarks

This property must be set before invoking the Start method. PricingType Description

Returns or sets the Pricing Type to be extracted.

Syntax

object.PricingType [= Value] The PricingType property syntax has these parts:

Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. Value A string value containing the Pricing Type of the requested exchange rate.

Remarks




86

Periods Description

Returns or sets the number of periods to be extracted.

Syntax

object.Periods [= number] The Periods property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. number An integer specifying the number of periods to be returned.

Remarks

This property will normally control the number of rows returned. It used in conjunction with the RequestDate and PeriodType properties. This number specifies the number of periods including and prior to the RequestDate to be returned. For example if RequestDate is 31-Mar-05, and PeriodType is “Q” (quarters), and Periods is 4: you will receive four rows. The first row would contain data for 31-Mar-05, the second row for 31-Dec-04, the third row for 30-Sep-04, and the fourth row for 30-Jun-04.

Only one (1) period is allowed for the IOSpectraFXRateRequest. This property must be set before invoking the Start method.

PeriodType Description

Returns or sets the type of periods which should be returned.

Syntax

object.PeriodType [= type] The PeriodType property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. type A one-character string specifying the period types to be extracted.



87

Settings The valid settings for type are:

Part Description D Return a row for each day, starting with value of the RequestDate property and going back the

number of days in the Period property. W Return a row for each week, starting with value of the RequestDate property and going back the

number of weeks in the Period property. M Return a row for each month, starting with value of the RequestDate property and going back the

number of months in the Period property. Q Return a row for each quarter, starting with value of the RequestDate property and going back the

number of quarters in the Period property. Y Return a row for each year, starting with value of the RequestDate property and going back the

number of years in the Period property.

Remarks

This property is used in conjunction with the RequestDate and Periods properties. This property specifies what each row in the result set will represent.. For example if RequestDate is 31-Mar-05, and PeriodType is “Q” (quarters), and Periods is 4: you will receive four rows. The first row would contain data for 31-Mar-05, the second row for 31-Dec-04, the third row for 30-Sep-04, and the fourth row for 30-Jun-04. Since only one (1) period can be requested for the IOSpectraFXRateRequest, all PeriodType values will return the same result. This property must be set before invoking the Start method.



88

ProcessAll Description

Returns or sets the type of process to be returned.

Syntax

object.ProcessAll [= type] The ProcessAll property syntax has these parts:

Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. type A one-character string specifying the process to be extracted.

Settings

The valid settings for type are:

Part Description P Return a row for each price. X Return a row for each exchange rate. A Return a row for both price and exchange rate.

Remarks




89



Syntax

object. AddFilter (Item As String, Operand As String, Value As String) The AddFilter method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraDistRequest object. Item A two-byte string specifying the field to be checked. A current list of valid items can be found in the


Remarks






90

AddItem Description


Syntax

object. AddItem (Item As String) The AddItem method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. Item A two-byte string specifying the field to be checked. A current list of valid items can be found in the



Sets the IOConnection object associated with this IOSpectraFXRateRequest. Syntax

object. Connection [= connect] The AddFilter method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. connect An IOConnection object.

Remarks

When the IOSpectraFxRateRequest object is created with the IOConnection.CreateFXRateRequest method, the Connection property will automatically be set. But changing the properties of the IOConnection object will not effect this object until this property is set again. This method cannot be executed after the Start method has been executed.



91

EOF Description


Syntax

object. EOF The EOF method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object.

Remarks




Syntax

object. ItemCount The ItemCount property syntax has these parts:

Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object.

Remarks




92

Items Description

A collection of the items and their attributes for all items requested. Syntax

object. Items The Items property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object.

Remarks




Syntax

object. ItemValue (Item As String) The ItemValue method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. Item A two-byte string specifying the item value to be returned. This Item must have been previously


Remarks




93



Syntax

object. MoveNext The MoveNext method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object.

Remarks


Record Description


Syntax

object. Record The Record method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object.

Remarks




94



object. RecordFormat [= Format] The RecordFormat method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. Format An integer specifying the format items will be returned in the Record method.







95



object. RequestDate [= Date] The RequestDate method syntax has these parts:

Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. Date A date which will control what data will be extracted.

Remarks


SecuritiesOnly Description


object. SecuritiesOnly [= Boolean] The SecuritiesOnly method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object. Boolean Boolean value indicating if only securities should be returned by the Investment Accounting

(InvestOne) Engine. Remarks

When this property is set to true, securities with a security number of “CASH”, “EXPENSE”, or “UNITS” will not be retrieved from the Investment Accounting (InvestOne) Engine. The default for this property is True. This property must be set before executing the Start method.



96

Start Description

Connects to the Investment Accounting (InvestOne) Engine. Syntax

object. Start The Start method syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object.

Remarks Some properties and methods will only be effective is used before invoking this method, other properties and methods will only be effective if used after invoking this method. Please refer to each property and method for the effect of this method on its behavior. Status Description


Syntax

object. Status The Status property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraFXRateRequest object.



method has not been successfully invoked.) 1 The object is currently connected to the Investment Accounting (InvestOne) Engine and a row is



IO OLE PROGRAMMER’S GUIDE USING IOSPECTRAITEM


97

9. USING IOSPECTRAITEM PURPOSE The SpectraItem object is used by IOSpectraDistRequest, IOSpectraFundRequest, and IOSpectraTranRequest objects. The SpectraItem contains dictionary information about each item added to the request. The SpectraItems associated with a specific request can be interrogated using the Items property of the request. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim sp As IOSpectraTranRequest 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build Request Set sp = c.CreateTranRequest sp.Account = 12345 sp.FromDate = DateSerial(1997, 12, 1) sp.ToDate = DateSerial(1997, 12, 31) sp.AddItem “TO” sp.AddItem “SN” sp.AddItem “ED” sp.AddItem “CD” 'Start INVEST ONE Request sp.Start 'Retrieve INVEST ONE messages and write the results to the debug screen sp.MoveNext Do Until sp.EOF Debug.Print “-------------------“ Debug.Print sp.Items(1).Title & “: “ & sp.ItemValue("TO") Debug.Print sp.Items(2).Title & “: “ &sp.ItemValue("SN") Debug.Print sp.Items(3).Title & “: “ & sp.ItemValue(“ED”) Debug.Print sp.Items(4).Title & “: “ & sp.ItemValue(“CD”) Loop End Sub



98

PROPERTIES AND METHODS Code Description

Loads the object properties with the properties of the specified field, or returns the Spectra code currently loaded in the object.

Syntax

object.Code [ = value] The Code property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraItem object. value A valid two-character Spectra code.

Remarks

A current list of valid items can be found in the Enterprise Spectra Data Items manual. If referencing this property from the Items collection of an IOSpectra*Request object, this value should not be changed.

Decimal Description

Returns the maximum precision for this field which will be returned from the Investment Accounting (InvestOne) / Engine.

Syntax

object.Decimal The Decimal property syntax has these parts:

Part Description object An object expression that evaluates to an IOSpectraItem object.

Remarks

If the currently loaded Code is a string, this property will return “0”.



99

Description Description

Returns the description for the field.

Syntax

object.Description The Description property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraItem object.

Remarks

Returns a string giving a long description for the loaded item. Display Description

Returns the standard display format for the field.

Syntax

object.Display The Display property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraItem object.

Remarks

Returns a string representing the standard format to use for formatting the item. The return value of the Property can be used directly in the Visual Basic Format function.



100

EDW_Field Description

Returns the field name of the item within the Investment Accounting (InvestOne) / EDW module.

Syntax

object.EDW_Field The EDW_Field property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraItem object.

Remarks

Returns a string representing the field name for this item within the optional Investment Accounting (InvestOne) / EDW module.

EDW_Table Description

Returns the table within the Investment Accounting (InvestOne) / EDW module in which the field resides.

Syntax

object.EDW_Table The EDW_Table property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraItem object.

Remarks

Returns a string representing the table in which this item is located within the optional Investment Accounting (InvestOne) / EDW module.



101

IsValid Description

Indicates if a valid item is currently loaded into the object.

Syntax

object.IsValid The IsValid property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraItem object.

Remarks

Returns a Boolean indicating of a valid item is currently loaded into the object.

ItemType Description

Indicates the data type in which the field is represented.

Syntax

object.ItemType

The ItemType property syntax has these parts:

Part Description object An object expression that evaluates to an IOSpectraItem object.

Remarks

Returns an integer value indicating the type of the current item:

Value VB Constant Description 2 vbInteger Whole number between -32,768 and 32,767. 3 vbLong Whole number between -2,147,483,648 and 2,147,483,647 5 vbDouble -1.79769313486232E308 to -4.94065645841247E-324 for negative values;

4.94065645841247E-324 to 1.79769313486232E308 for positive values. 7 vbDate January 1, 100 to December 31, 9999. 8 vbString Variable length string



102

Title Description

The standard title used for this item.

Syntax

object.Title The Title property syntax has these parts: Part Description object An object expression that evaluates to an IOSpectraItem object.

Remarks

Returns a string representing the commonly used title, or short description, for the loaded item.

IO OLE PROGRAMMER’S GUIDE USING IOACCOUNT


103

10. USING IOACCOUNT PURPOSE The IOAccount object is used to add, change, delete and view Account Definition data in the Investment Accounting (InvestOne) Engine. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim a As IOAccount Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the Account object Set a = c.CreateAccount 'set the desired account fields a.SetValue Field:="MODE", Value:="A" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field:="MDLACCT", Value:=1000 a.SetValue Field:="ACSDESC", Value:=”NEW ACCOUNT 12345” a.SetValue Field:="ACINCP", Value:=”20001231” a.SetValue Field:="ACBALN", Value:=”20020630” a.SetValue Field:="ACSCHD", Value:=”20020630” a.SetValue Field:="ACFFYE", Value:=”20011231” a.SetValue Field:="ACVALFR", Value:=”AA” a.SetValue Field:="ACACTIV", Value:=”Y” a.SetValue Field:="ACSWEEP", Value:=”Y” 'Execute the Account ‘Add’ function to add the Account Definition to INVEST ONE a.Execute 'show the user any messages returned from INVEST ONE For i = 1 To t.ReplyCount Dubug.Print t.Reply(i) Next I End Sub



104

PROPERTIES AND METHODS Clear Description

Clears all the values set with the SetValue method.

Syntax

object.Clear The Clear method syntax has these parts: Part Description object An object expression that evaluates to an IOAccount object.

Remarks

Resets the object, effectively clearing all values set with the SetValue method. Connection Description

Sets the IOConnection object associated with this IOAccount. Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOAccount object. connect An IOConnection object.

Remarks

Changing the properties of the IOConnection object will not effect this object until this property is set again. This method cannot be executed after the Execute method has been executed.



105

Execute Description

Sends the currently loaded transaction to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOAccount object.

Remarks

The execution process for the Account object will communicate with the Investment Accounting (InvestOne) Engine using a “Screen Scripting” technique. This technique is based on usage of an internal IO OLE class used to facilitate invocation of the Investment Accounting (InvestOne) Engine screens (ioScreen.cls). This “screen” class uses a “Screen Message” to send/receive data to/from the Investment Accounting (InvestOne) Engine. The various account object execution modes have been “scripted” into pre-defined screen progressions. The account object message data is loaded into and/or retrieved from the various screen messages.

GetValue Description

Returns the value of a specific field within the currently loaded transaction.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOAccount object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in the Investment Accounting (InvestOne) Software Developer’s Kit. The field names are in the right most column labeled Field. The settings for Occur are dependent upon which field is being requested. If the field is “AEDESC”, this may be a value between “1” and “10”. For all other fields this value must be “1” or omitted.



106

Message Description

Returns a formatted string that represents the complete Account message as defined within the Data Dictionary “FDXAE01 Account Message”.

Syntax

object.Message The Message property syntax has these parts: Part Description object An object expression that evaluates to an IOAccount object.

Remarks

This message is NOT ACCEPTED directly by the Investment Accounting (InvestOne) / Engine. It is used in conjunction with the StageAccount function in the IOAccountBlock object.

Mode Description

Returns or sets the type of processing being requested of the Investment Accounting (InvestOne) / Engine.

Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOAccount object. action The type of processing being requested of the Investment Accounting (InvestOne) / Engine

Settings

The valid settings action parameter are: Setting Description A Add the loaded account. C Change the loaded account. D Delete the loaded account. V View the requested account.



107

Remarks

The following fields are applicable in Add Mode only:

• “MDLACCT” Model Account Number • “ACFFYE” First Fiscal Year End • “ACVALFR” Valuation Frequency • “ACACTIV” Activate Account (“Y” or “N”) • “ACSWEEP” Sweep Account Open (“Y” or “N”)

The View Mode is not compatible with the ioAccountBlock object.

NetName Description

Returns or sets the NetName value required for “Screen” processing.

Syntax

object.NetName [=vValue] The NetName property syntax has these parts: Part Description object An object expression that evaluates to an IOAccount object. value A string value (up to characters) used by the Investment Accounting (InvestOne) Engine to

uniquely identify the message-based screen processing “conversation”. If this value is not unique to the Investment Accounting (InvestOne) Engine results will be unpredictable.

NOTE: This provides the Investment Accounting (InvestOne) Engine XS file record key.

Reply Description

Contains informational and warning messages returned from the Investment Accounting (InvestOne) / Engine.

Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOAccount object. number The number of the reply being requested.



108

Remarks

The ReplyCount property can be used to retrieve the number of reply messages returned from the Investment Accounting (InvestOne) / Engine.

ReplyCount Description

Returns the number of reply messages returned from the Investment Accounting (InvestOne) / Engine.

Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOAccount object.

Remarks

This property is normally used in conjunction with the Reply() property to interrogate responses from the Investment Accounting (InvestOne) / Engine.

SetValue Description

Sets the value of a specific field within the currently loaded account.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOAccount object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to be returned.



109

Remarks

The settings for Field can be found, with their descriptions, in Section 2.2.1 of the Software Developer’s Kit. The field names are in the right most column labeled Field. The settings for Occur are dependent upon which field is being requested. If the field is “AEDESC”, this may be a value between “1” and “10”. For all other fields this value must be “1” or omitted. The Value parameter is a variant which will be dependent on the setting in the Field parameter. The fields themselves will not be edited until the Execute method is invoked.

IO OLE PROGRAMMER’S GUIDE USING IOACCOUNTBLOCK


110

11. USING IOACCOUNTBLOCK PURPOSE The IOAccountBlock is used to add, change or delete accounts in the Investment Accounting (InvestOne) Engine. When sending multiple accounts, IOAccountBlock is more efficient then using individual IOAccount objects. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim a As IOAccount Dim ab As IOAccountBlock Dim i As Integer 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create Account Block Set ab = c.CreateAccountBlock ' Create Work Account Set a = c.CreateAccount 'set the desired transaction fields a.SetValue Field:="MODE", Value:="A" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field:="MDLACCT", Value:=1000 a.SetValue Field:="ACSDESC", Value:=”NEW ACCOUNT 12345” a.SetValue Field:="ACINCP", Value:=”20001231” a.SetValue Field:="ACBALN", Value:=”20020630” a.SetValue Field:="ACSCHD", Value:=”20020630” a.SetValue Field:="ACFFYE", Value:=”20011231” a.SetValue Field:="ACVALFR", Value:=”AA” a.SetValue Field:="ACACTIV", Value:=”Y” a.SetValue Field:="ACSWEEP", Value:=”Y” 'stage the account in the account block object ab.StageAccount (a.Message()) 'clear the account object for the next account a.Clear



111

'set the account fields a.SetValue Field:="MODE", Value:="A" a.SetValue Field:="ACCT", Value:=54321 a.SetValue Field:="MDLACCT", Value:=1000 a.SetValue Field:="ACSDESC", Value:=”NEW ACCOUNT 54321” a.SetValue Field:="ACINCP", Value:=”20001231” a.SetValue Field:="ACBALN", Value:=”20020630” a.SetValue Field:="ACSCHD", Value:=”20020630” a.SetValue Field:="ACFFYE", Value:=”20011231” a.SetValue Field:="ACVALFR", Value:=”AA” a.SetValue Field:="ACACTIV", Value:=”Y” a.SetValue Field:="ACSWEEP", Value:=”Y” 'stage the account block object ab.StageAccount (aMessage()) 'execute the account block in INVEST ONE ab.Execute 'show the user any messages returned from INVEST ONE Debug.Print “+++ First Account Messages For i = 1 To ab.ReplyCount(0)

Debug.Print ab.Reply(0, i) Next I Debug.Print “+++ Second Account Messages For i = 1 To ab.ReplyCount(1)

Debug.Print ab.Reply(1, i) Next i End Sub



112

PROPERTIES AND METHODS AccountCount Description

Returns the number of accounts currently contained within the block.

Syntax

object.AccountCount The AccountCount property syntax has these parts: Part Description object An object expression that evaluates to an IOAccountBlock object


Sets the IOConnection object associated with this IOAccountBlock.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOAccountBlock object. connect An IOConnection object.

Remarks

Changing the properties of the IOConnection object will not affect this object until this property is set again. This method cannot be executed after the Execute method has been executed.



113

Execute Description

Sends the currently staged accounts to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute

The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOAccountBlock object.

Reply Description

Contains informational, warning, and error messages returned from the Investment Accounting (InvestOne) / Engine.

Syntax

object.Reply(account, number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOAccount object. account The position of the account within the block. (The first account is position “0”) number The number of the reply being requested.

Remarks

The AccountCount property can be used to determine the total number of accounts in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for each account.



114


Returns the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for a given executed account.

Syntax

object.ReplyCount(account) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOAccountBlock object. account The position of the account within the block. (The first account is position “0”.)

Remarks


StageAccount Description

Stages a given account message into the block.

Syntax

object.StageAccount(AcctMsg) The StageAccount method syntax has these parts:

Part Description object An object expression that evaluates to an IOAccountBlock object. AcctMsg A string value provided from the Message property of an IOAccount object.

Remarks

The AcctMsg string is actually a formatted FDXAE01 message as specified in the Data Dictionary. While you could format the string without using the IOAccount object, this is not recommended due to release independence.

IO OLE PROGRAMMER’S GUIDE USING IOTRANSACTION


115

12. USING IOTRANSACTION PURPOSE The IOTransaction is used to add, change or delete financial transactions in the Investment Accounting (InvestOne) Engine. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim t As IOTransaction Dim I As Integer 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build Transaction Set t = c.CreateTransaction 'set the desired transaction fields t.SetValue Field:="MODE", Value:="A" t.SetValue Field:="ACCT", Value:=12345 t.SetValue Field:="SCTYNO", Value:=”IBM” t.SetValue Field:="CODE", Value:=”BUY” t.SetValue Field:="EXECDT", Value:=DateSerial(1997.12,31) t.SetValue Field:="PRIN", Value:=1000.01 t.SetValue Field:="UNITS", Value:=42000 t.SetValue Field:="BROKER", Value:=”01” 'execute the transaction in INVEST ONE t.Execute 'show the user any messages returned from INVEST ONE For i = 1 To t.ReplyCount Dubug.Print t.Reply(i) Next i End Sub



116



Syntax

object.Clear The Clear method syntax has these parts: Part Description object An object expression that evaluates to an IOTransaction object.

Remarks


Sets the IOConnection object associated with this IOTransaction. Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOTransaction object. connect An IOConnection object.

Remarks




117

Execute Description

Sends the currently loaded transaction to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute ( [RepairStation] , [Sweep] ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOTransaction object. RepairStation An optional named parameter indicating if the transaction should be eligible for Repair Station

processing in the Investment Accounting (InvestOne) / Engine. Sweep An optional named parameter indicating if the account balances should be affected

immediately by the Investment Accounting (InvestOne) / Engine.

Settings

The settings for RepairStation are: Setting Description N Do not invoke Repair Station processing. Y If the transaction cannot be accepted, send it to the Investment Accounting (InvestOne) /

Engine Repair Station. A Send this transaction to the Investment Accounting (InvestOne) / Engine Repair Station.

The settings for Sweep are: Setting Description N This transaction will not effect the account balances until the account is swept in the

Investment Accounting (InvestOne) / Engine. Y This transaction will immediately effect the account balances upon receipt by the Investment

Accounting (InvestOne) / Engine. 2 Incremental translate will be invoked in addition to a full sweep (like option “Y” above).

Translation date will not be re-set. No need to translate fund. Remarks

If the transaction is not accepted by Investment Accounting (InvestOne) for either normal or Repair Station processing, an error will be raised. The Repair Station is an optional module to the Investment Accounting (InvestOne) engine which allows incomplete trades to be saved for completion by a fund accountant. Access to this processing may be limited by your Investment Accounting (InvestOne) operator settings. Please contact your Investment Accounting (InvestOne) security officer for more information. The default for the RepairStation parameter is “Y”. The default for the Sweep parameter is “Y”.



118



Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOTransaction object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in the Investment Accounting (InvestOne) Software Developer’s Kit. The field names are in the right most column labeled Field. The settings for Occur are dependent upon which field is being requested. If the field is DESC, this may be a value between “1” and “10”. For all other fields this value must be “1” or omitted.

Message Description

Returns a formatted string which the Investment Accounting (InvestOne) / Engine will accept as a streamed transaction.

Syntax

object.Message The Message property syntax has these parts: Part Description object An object expression that evaluates to an IOTransaction object.

Remarks

This method returns a string representing the message which will be sent to the Investment Accounting (InvestOne) / Engine to add this transaction. It is used in conjunction with the StageTrade function in the IOTransactionBlock object.



119

Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOTransaction object. action The type of processing being requested of the Investment Accounting (InvestOne) / Engine.

Settings

The valid settings action parameter are: Setting Description A Add the loaded transaction. C Change the loaded transaction. D Delete the loaded transaction.

Remarks

If the mode is “C” or “D”, either the “TRDORD” or “EXTID” fields must be loaded before the Execute method is invoked.

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOTransaction object. number The number of the reply being requested.

Remarks




120



Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOTransaction object.

Remarks



Sets the value of a specific field within the currently loaded transaction.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOTransaction object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in Section 2.2.1 of the Software Developer’s Kit. The field names are in the right most column labeled Field. The settings for Occur are dependent upon which field is being requested. If the field is DESC, this may be a value between “1” and “10”. For all other fields this value must be “1” or omitted. The Value parameter is a variant which will be dependent on the setting in the Field parameter. The fields themselves will not be edited until the Execute method is invoked.

IO OLE PROGRAMMER’S GUIDE USING IOTRANSACTIONBLOCK


121

13. USING IOTRANSACTIONBLOCK PURPOSE The IOTransactionBlock is used to add, change or delete financial transactions in the Investment Accounting (InvestOne) Engine. When sending multiple transactions, IOTransactionBlock is more efficient then using individual IOTransaction objects. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim t As IOTransaction Dim tb As IOTransactionBlock Dim i As Integer 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create Transaction Block Set tb = c.CreateTransactionBlock ' Create Work Transaction Set t = c.CreateTransaction 'set the desired transaction fields t.SetValue Field:="MODE", Value:="A" t.SetValue Field:="ACCT", Value:=12345 t.SetValue Field:="SCTYNO", Value:=”IBM” t.SetValue Field:="CODE", Value:=”BUY” t.SetValue Field:="EXECDT", Value:=DateSerial(1997.12,31) t.SetValue Field:="PRIN", Value:=1000.01 t.SetValue Field:="UNITS", Value:=42000 t.SetValue Field:="BROKER", Value:=”01” 'stage the trade in the transaction block object tb.StageTrade (t.Message()) 'clear the transaction object for the next trade t.Clear 'set the desired transaction fields t.SetValue Field:="MODE", Value:="A" t.SetValue Field:="ACCT", Value:=54321 t.SetValue Field:="SCTYNO", Value:=”IBM” t.SetValue Field:="CODE", Value:=”BUY” t.SetValue Field:="EXECDT", Value:=DateSerial(1997.12,31) t.SetValue Field:="PRIN", Value:=1000.01



122

t.SetValue Field:="UNITS", Value:=42000 t.SetValue Field:="BROKER", Value:=”01” 'stage the trade in the transaction block object tb.StageTrade (t.Message()) 'execute the transaction block in INVEST ONE tb.Execute 'show the user any messages returned from INVEST ONE Debug.Print “+++ First Trade Messages For i = 1 To tb.ReplyCount(0)

Debug.Print tb.Reply(0, i) Next I Debug.Print “+++ Second Trade Messages For i = 1 To tb.ReplyCount(1)

Debug.Print tb.Reply(1, i) Next i End Sub

PROPERTIES AND METHODS Connection Description

Sets the IOConnection object associated with this IOTransactionBlock.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOTransactionBlock object. connect An IOConnection object.

Remarks




123

Execute Description

Sends the currently staged transactions to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute ( [RepairStation] , [Sweep] )

The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOTransactionBlock object. RepairStation An optional named parameter indicating if the transactions should be eligible for Repair Station

processing in the Investment Accounting (InvestOne) / Engine. Sweep An optional named parameter indicating if the account balances should be affected


Settings

The settings for RepairStation are: Setting Description N Do not invoke Repair Station processing. Y Any transaction that cannot be accepted, should be sent to the Investment Accounting

(InvestOne) / Engine Repair Station. A Send all transactions to the Investment Accounting (InvestOne) / Engine Repair Station. The settings for Sweep are: Setting Description N These transactions will not effect the account balances until the account is swept in the

Investment Accounting (InvestOne) / Engine. Y These transactions will immediately effect the account balances upon receipt by the Investment

Accounting (InvestOne) / Engine.

Remarks

If the transaction is not accepted by Investment Accounting (InvestOne) for either normal or Repair Station processing, an error will be raised. The Repair Station is an optional module to the Investment Accounting (InvestOne) engine which allows incomplete trades to be saved for completion by a fund accountant. Access to this processing may be limited by your Investment Accounting (InvestOne) operator settings. Please contact your Investment Accounting (InvestOne) security officer for more information. The default for the RepairStation parameter is “Y”. The default for the Sweep parameter is “Y”.



124

Reply Description


Syntax

object.Reply(trade, number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOTransaction object. trade The position of the trade within the block. (The first trade is in position “0”.) number The number of the reply being requested.

Remarks

The TradeCount property can be used to determine the total number of trades in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for each trade.


Returns the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for a given executed transaction.

Syntax

object.ReplyCount(trade) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOTransactionBlock object. trade The position of the trade within the block. (The first trade is in position “0”.)

Remarks




125

ReplyEXTID Description

Returns the external memo number related to the given executed transaction.

Syntax

object.ReplyEXTID(trade) The ReplyEXTID property syntax has these parts: Part Description object An object expression that evaluates to an IOTransactionBlock object. trade The position of the trade within the block. (The first trade is in position “0”.)

ReplyTRDORD Description

Returns the Investment Accounting (InvestOne) memo number related to the given executed transaction.

Syntax

object.ReplyTRDORD(trade) The ReplyTRDORD property syntax has these parts: Part Description object An object expression that evaluates to an IOTransactionBlock object. trade The position of the trade within the block. (The first trade is in position “0”.)



126

StageTrade Description

Stages a given transaction message into the block.

Syntax

object.StageTrade(TranMsg) The StageTrade method syntax has these parts:

Part Description object An object expression that evaluates to an IOTransactionBlock object. TranMsg A string value provided from the Message property of an IOTransaction object.

Remarks

The TranMsg string is actually a formatted FDXTS02 message as specified in the Investment Accounting (InvestOne) / SDK manual. While you could format the string without using the IOTransaction object, this is not recommended due to release independence.

TradeCount Description

Returns the number of transactions currently contained within the block.

Syntax

object.TradeCount The TradeCount property syntax has these parts: Part Description object An object expression that evaluates to an IOTransactionBlock object.

IO OLE PROGRAMMER’S GUIDE USING IOSECURITY


127

14. USING IOSECURITY

PURPOSE The IOSecurity is used to add, change or delete security master definitions in the Investment Accounting (InvestOne) Engine. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim t As IOSecurity Dim I As Integer 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build Security Set s = c.CreateSecurity 'set the desired transaction fields s.SetValue Field:="MODE", Value:="A" s.SetValue Field:="SCTYNO", Value:=”IBM”

s.SetValue Field:="MODLNO", Value:=”BOND” 'execute the security in INVEST ONE s.Execute 'show the user any messages returned from INVEST ONE For i = 1 To t.ReplyCount Dubug.Print t.Reply(i) Next i End Sub



128



Syntax

object.Clear The Clear method syntax has these parts: Part Description object An object expression that evaluates to an IOSecurity object.

Remarks

Resets the object, effectively clearing all values set with the SetValue method.


Sets the IOConnection object associated with this IOSecurity.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOSecurity object. connect An IOConnection object.

Remarks




129

Execute Description

Sends the currently loaded Security to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute ( [Sweep] ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOSecurity object. Sweep An optional named parameter indicating if the account balances should be affected

immediately by the Investment Accounting (InvestOne) / Engine. Settings

The settings for Sweep are: Setting Description N This Security will not effect the account balances until the account is swept in the Investment

Accounting (InvestOne) / Engine. Y This Security will immediately effect the account balances upon receipt by the Investment


Remarks

If the Security is not accepted by Investment Accounting (InvestOne) an error will be raised. The default for the Sweep parameter is “Y”.



130


Returns the value of a specific field within the currently loaded Security.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOSecurity object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in Section 2.2.1 of the Software Developer’s Kit. The field names are in the right most column labeled Field. The settings for Occur are dependent upon which field is being requested. If the field is DESC, this may be a value between “1” and “10”. For all other fields this value must be “1” or omitted.

Message Description Returns a formatted string which the Investment Accounting (InvestOne) / Engine will accept as a streamed Security. Syntax object.Message

The Message property syntax has these parts: Part Description object An object expression that evaluates to an IOSecurity object.

Remarks

This method returns a string representing the message which will be sent to the Investment Accounting (InvestOne) / Engine to add this Security. It is used in conjunction with the StageSecurity function in the IOSecurityBlock object.



131

Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOSecurity object. action The type of processing being requested of the Investment Accounting (InvestOne) / Engine.

Settings

The valid settings action parameter are: Setting Description A Add the loaded Security. C Change the loaded Security. D Delete the loaded Security.

Remarks

If the mode is “C” or “D”, the “SCTYNO” fields must be loaded before the Execute method is invoked.

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOSecurity object. number The number of the reply being requested.

Remarks




132



Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOSecurity object.

Remarks



Sets the value of a specific field within the currently loaded Security.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object Object expression that evaluates to an IOSecurity object. Field A string indicating the field for which the value should be returned. Value Value to which the field should be set. Occur Optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in Section 2.2.1 of the Software Developer’s Kit. The field names are in the right most column labeled Field. The settings for Occur are dependent upon which field is being requested. If the field is DESC, this may be a value between “1” and “10”. For all other fields this value must be “1” or omitted. The Value parameter is a variant that will be dependent on the setting in the Field parameter. The fields themselves will not be edited until the Execute method is invoked.

IO OLE PROGRAMMER’S GUIDE USING IOSECURITYBLOCK


133

15. USING IOSECURITYBLOCK PURPOSE The IOSecurityBlock is used to add, change or delete security master definitions in the Investment Accounting (InvestOne) Engine. When sending multiple securities, IOSecurityBlock is more efficient then using individual IOSecurity objects. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim s As IOSecurity Dim sb As IOSecurityBlock Dim i As Integer 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create Security Block Set sb = c.CreateSecurityBlock ' Create Work Security Set s = c.CreateSecurity 'set the desired Security fields s.SetValue Field:="MODE", Value:="A" s.SetValue Field:="SCTYNO", Value:=”IBM” s.SetValue Field:="MODLNO", Value:=”BOND” 'stage the security in the Security block object sb.StageSecurity (s.Message()) 'clear the Security object for the next trade s.Clear 'set the desired Security fields s.SetValue Field:="MODE", Value:="A" s.SetValue Field:="SCTYNO", Value:=”IBM2” s.SetValue Field:="MODLNO", Value:=”BOND” 'stage the trade in the Security block object sb.StageTrade (s.Message()) 'execute the Security block in INVEST ONE sb.Execute '



134

show the user any messages returned from INVEST ONE Debug.Print “+++ First Security Messages” For i = 1 To tb.ReplyCount(0)

Debug.Print tb.Reply(0, i) Next I Debug.Print “+++ Second Security Messages For i = 1 To tb.ReplyCount(1)



Sets the IOConnection object associated with this IOSecurityBlock.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOSecurityBlock object. connect An IOConnection object.

Remarks




135

Execute Description

Sends the currently staged Securities to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute ( [Sweep] ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOSecurityBlock object. Sweep An optional named parameter indicating if the account balances should be affected


Settings

The settings for Sweep are: Setting Description N These Securities will not effect the account balances until the account is swept in the

Investment Accounting (InvestOne) / Engine. Y These Securities will immediately effect the account balances upon receipt by the Investment


Remarks

The default for the Sweep parameter is “Y”.



136

Reply Description


Syntax

object.Reply(security, number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOSecurity object. security The position of the security within the block. (The first security is in position “0”.) number The number of the reply being requested.

Remarks

The SecurityCount property can be used to determine the total number of trades in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for each trade.


Returns the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for a given executed Security.

Syntax

object.ReplyCount(security) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOSecurityBlock object. security The position of the security within the block. (The first security is in position “0”.)

Remarks




137

ReplySCTY Description

Returns the security number related to the given executed Security.

Syntax

object.ReplySCTY(security) The ReplySCTY property syntax has these parts: Part Description object An object expression that evaluates to an IOSecurityBlock object. security The position of the security within the block. (The first security is in position “0”.)

SecurityCount Description

Returns the number of Securities currently contained within the block.

Syntax

object.SecurityCount The SecurityCount property syntax has these parts: Part Description object An object expression that evaluates to an IOSecurityBlock object.



138

StageSecurity Description

Stages a given Security message into the block.

Syntax

object.StageSecurity(SctyMsg) The StageSecurity method syntax has these parts:

Part Description object An object expression that evaluates to an IOSecurityBlock object. SctyMsg A string value provided from the Message property of an IOSecurity object.

Remarks

The SctyMsg string is actually a formatted FDXSD01 message as specified in the Investment Accounting (InvestOne) / SDK manual. While you could format the string without using the IOSecurity object, this is not recommended due to release independence.

IO OLE PROGRAMMER’S GUIDE USING IORELIEF


139

16. USING IORELIEF PURPOSE The IORelief is used to add or delete explicit taxlot reliefs in the Investment Accounting (InvestOne) Engine. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As Object Dim r As Object Dim I As Integer 'Build INVEST ONE Connection Set c = CreateObject("SunGard.IOConnection") c.CommType = "IP" c.HostIP = InputBox("Host IP:") c.Port = InputBox("Port:") c.Operator = InputBox("Operator:") c.Password = InputBox("Password:") 'Build Explicit Taxlot Relief Set r = c.CreateRelief 'set the desired Explicit Taxlot Relief fields r.setvalue Field:="MODE", Value:="A" r.setvalue Field:="TRDORD", Value:=1777 r.setvalue Field:="ENDREL", Value:="Y" r.setvalue Field:="RELFOCR", Value:=2 r.setvalue Field:="RLMEMO", Value:=1775, Occur:=1 r.setvalue Field:="RLUNITS", Value:=1000, Occur:=1 r.setvalue Field:="RLMEMO", Value:=1776, Occur:=2 r.setvalue Field:="RLUNITS", Value:=2000, Occur:=2 'Execute the Explcit Taxlot Relief in INVEST ONE r.Execute 'Show the user any messages returned from INVEST ONE For I = 1 To r.ReplyCount Debug.Print r.Reply(I) Next I MsgBox "Communication complete!", vbExclamation End Sub



140



Syntax

object.Clear The Clear method syntax has these parts:

Part Description object An object expression that evaluates to an IORelief object.

Remarks


Sets the IOConnection object associated with this IORelief.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IORelief object. connect An IOConnection object.

Remarks




141

Execute Description

Sends the currently loaded Explicit Taxlot Relief to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IORelief object.

Remarks

If the Explicit Taxlot Relief is not accepted by Investment Accounting (InvestOne) an error will be raised.


Returns the value of a specific field within the currently loaded Explicit Taxlot Relief.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IORelief object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in the Investment Accounting (InvestOne) Software Developer’s Kit. The field names are in the right most column labeled Field. The settings for Occur are dependent upon which field is being requested. If the field is RLMEMO, RLEXTID or RLUNITS, this may be a value between “1” and “16”. For all other fields this value must be “1” or omitted.



142

Message Description

Returns a formatted string which the Investment Accounting (InvestOne) / Engine will accept as a streamed Explicit Taxlot Relief.

Syntax

object.Message The Message property syntax has these parts: Part Description object An object expression that evaluates to an IORelief object.

Remarks

This method returns a string representing the message which will be sent to the Investment Accounting (InvestOne) / Engine to add this Explicit Taxlot Relief. It is used in conjunction with the StageRelief function in the IOReliefBlock object.

Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IORelief object. action The type of processing being requested of the Investment Accounting (InvestOne) / Engine.

Settings

The valid settings action parameter are: Setting Description A Add the loaded Explcit Taxlot Relief. D Delete all Taxlot Reliefs.

Remarks

The “TRDORD” or “EXTID” fields must be loaded before the Execute method is invoked. If the mode is “D”, the “RELFOCR” field must be blank or zero.



143

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IORelief object. number The number of the reply being requested.

Remarks The ReplyCount property can be used to retrieve the number of reply messages returned from the Investment Accounting (InvestOne) / Engine. ReplyCount Description


Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IORelief object.

Remarks




144


Sets the value of a specific field within the currently loaded Explicit Taxlot Relief.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object Object expression that evaluates to an IORelief object. Field A string indicating the field for which the value should be returned. Value Value to which the field should be set. Occur Optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in Section 2.2.1 of the Software Developer’s Kit. The field names are in the right most column labeled Field. The settings for Occur are dependent upon which field is being requested. If the field is RLMEMO, RLEXTID or RLUNITS, this may be a value between “1” and “16”. For all other fields this value must be “1” or omitted. The Value parameter is a variant that will be dependent on the setting in the Field parameter. The fields themselves will not be edited until the Execute method is invoked.

IO OLE PROGRAMMER’S GUIDE USING IORELIEFBLOCK


145

17. USING IORELIEFBLOCK PURPOSE The IOReliefBlock is used to add or delete explicit taxlot reliefs in the Investment Accounting (InvestOne) Engine. When sending multiple explicit taxlot reliefs, IOReliefBlock is more efficient then using individual IORelief objects. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As Object Dim r As Object Dim rb As Object Dim I As Integer 'Build INVEST ONE Connection Set c = CreateObject("SunGard.IOConnection") c.CommType = "IP" c.HostIP = InputBox("Host IP:") c.Port = InputBox("Port:") c.Operator = InputBox("Operator:") c.Password = InputBox("Password:") 'Build Explicit Taxlot Relief Set r = c.CreateRelief 'Build Explicit Taxlot Relief Block Set rb = c.CreateReliefBlock 'set the desired Explicit Taxlot Relief fields r.setvalue Field:="MODE", Value:="D" r.setvalue Field:="TRDORD", Value:=1777 r.setvalue Field:="ENDREL", Value:="Y" r.setvalue Field:="RELFOCR", Value:=0 'Stage the Relief in the Explicit Taxlot Relief block object rb.StageRelief (r.Message()) 'Clear the Explicit Taxlot Relief object for the next relief r.Clear 'set the desired Explicit Taxlot Relief fields r.setvalue Field:="MODE", Value:="A" r.setvalue Field:="TRDORD", Value:=1777 r.setvalue Field:="ENDREL", Value:="Y" r.setvalue Field:="RELFOCR", Value:=2 r.setvalue Field:="RLMEMO", Value:=1775, Occur:=1



146

r.setvalue Field:="RLUNITS", Value:=1, Occur:=1 r.setvalue Field:="RLMEMO", Value:=1776, Occur:=2 r.setvalue Field:="RLUNITS", Value:=1, Occur:=2 'Stage the Relief in the Explicit Taxlot Relief block object rb.StageRelief (r.Message()) 'Execute the Explcit Taxlot Relief in INVEST ONE rb.Execute 'Show the user any messages returned from INVEST ONE Debug.Print "+++First Relief Messages" For I = 1 To rb.ReplyCount(1) Debug.Print rb.Reply(1, I) Next I Debug.Print "+++Second Relief Messages" For I = 1 To rb.ReplyCount(2) Debug.Print rb.Reply(2, I) Next I MsgBox "Communication complete!", vbExclamation End Sub


Sets the IOConnection object associated with this IOReliefBlock. Syntax

object. Connection [= connect] The Connection method syntax has these parts:

Part Description object An object expression that evaluates to an IOReliefBlock object. connect An IOConnection object.

Remarks




147

Execute Description

Sends the currently staged Explicit Taxlot Relief to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOReliefBlock object.

Reply Description


Syntax

object.Reply(relief, number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IORelief object. security The position of the relief within the block. number The number of the reply being requested.

Remarks

The ReliefCount property can be used to determine the total number of Explcit Taxlot Reliefs in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for each relief.



148


Returns the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for a given executed relief.

Syntax

object.ReplyCount(relief) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOReliefBlock object. security The position of the Explicit Taxlot Relief within the block.

Remarks


ReliefCount Description

Returns the number of reliefs currently contained within the block. Syntax

object.ReliefCount The ReliefCount property syntax has these parts: Part Description object An object expression that evaluates to an IOReliefBlock object.



149

StageRelief Description

Stages a given Explicit Taxlot Relief message into the block.

Syntax

object.StageRelief(RelfMsg) The StageRelief method syntax has these parts: Part Description object An object expression that evaluates to an IOReliefBlock object. RelfMsg A string value provided from the Message property of an IORelief object.

Remarks

The RelfMsg string is actually a formatted “FDXLR01” message as specified in the Investment Accounting (InvestOne) / SDK manual. While you could format the string without using the IORelief object, this is not recommended due to release independence.

IO OLE PROGRAMMER’S GUIDE USING IOHOLDING


150

18. USING IOHOLDING PURPOSE The IOHolding is used to change Holdings Definitions (DAHO) values in the Investment Accounting (InvestOne) Engine. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As Object Dim r As Object Dim I As Integer 'Build INVEST ONE Connection Set c = CreateObject("SunGard.IOConnection") c.CommType = "IP" c.HostIP = InputBox("Host IP:") c.Port = InputBox("Port:") c.Operator = InputBox("Operator:") c.Password = InputBox("Password:") 'Build Holdings Update Set r = c.CreateHolding 'set the desired Holdings Update fields r.setvalue Field:="MODE", Value:="C" r.setvalue Field:="ACCT", Value:=1162002 r.setvalue Field:="SCTYNO", Value:="01162002A" 'r.setvalue Field:="SCTYDT", Value:=0 'r.setvalue Field:="SCTYUNQ", Value:=0 r.setvalue Field:="HLDATE", Value:=20020118 r.setvalue Field:="TRDMARK", Value:=50000 r.setvalue Field:="STLMARK", Value:=50000 'Execute the Holdings Update in INVEST ONE r.Execute 'Show the user any messages returned from INVEST ONE For I = 1 To r.ReplyCount Debug.Print r.Reply(I) Next I MsgBox "Communication complete!", vbExclamation End Sub



151



Syntax


Part Description object An object expression that evaluates to an IOHolding object.

Remarks


Sets the IOConnection object associated with this IOHolding.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOHolding object. connect An IOConnection object.

Remarks




152

Execute Description

Sends the currently loaded Holdings Definition to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOHolding object.

Remarks

If the Holdings Definition update is not accepted by Investment Accounting (InvestOne), an error will be raised.


Returns the value of a specific field within the currently loaded Holdings Definition.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOHolding object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in the Investment Accounting (InvestOne) Software Developer’s Kit. The field names are in the column labeled Field. Currently, no Holdings Definition field requires the Occur parameter.



153

Message Description

Returns a formatted string which the Investment Accounting (InvestOne) / Engine will accept as a streamed Holdings Definition.

Syntax

object.Message The Message property syntax has these parts: Part Description object An object expression that evaluates to an IOHolding object.

Remarks

This method returns a string representing the message which will be sent to the Investment Accounting (InvestOne) / Engine to apply this Holdings Definition. It is used in conjunction with the StageHldg function in the IOHoldingBlock object.

Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOHolding object. action The type of processing being requested of the Investment Accounting (InvestOne) / Engine.

Settings

The valid settings action parameter are: Setting Description C Change the Holdings Definition (DAHO).

Remarks

The MODE, ACCT, SCTYNO, SCTYDT, SCTYUNQ and HLDATE fields are key fields and must be loaded before the Execute method is invoked.



154

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOHolding object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOHolding object.

Remarks




155


Sets the value of a specific field within the currently loaded Holdings Definition.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object Object expression that evaluates to an IOHolding object. Field A string indicating the field for which the value should be returned. Value Value to which the field should be set. Occur Optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in the Software Developer’s Kit. The field names are in the column labeled Field. Currently, no Holdings Definition field requires the Occur parameter. The Value parameter is a variant that will be dependent on the setting in the Field parameter. The fields themselves will not be edited until the Execute method is invoked.

IO OLE PROGRAMMER’S GUIDE USING IOHOLDINGBLOCK


156

19. USING IOHOLDINGBLOCK PURPOSE The IOHoldingBlock is used to change Holdings Definitions (DAHO) values in the Investment Accounting (InvestOne) Engine. When sending multiple Holdings Definitions, IOHoldingBlock is more efficient then using individual IOHolding objects. VISUAL BASIC EXAMPLE

Public Sub MySub() Public Sub MySub() Dim c As Object Dim r As Object Dim rb As Object Dim I As Integer 'Build INVEST ONE Connection Set c = CreateObject("SunGard.IOConnection") c.CommType = "IP" c.HostIP = InputBox("Host IP:") c.Port = InputBox("Port:") c.Operator = InputBox("Operator:") c.Password = InputBox("Password:") 'Build Holdings Update Set r = c.CreateHolding 'Build Holdings Update Block Set rb = c.CreateHoldingBlock 'set the desired Holdings Update fields r.setvalue Field:="MODE", Value:="C" r.setvalue Field:="ACCT", Value:=1162002 r.setvalue Field:="SCTYNO", Value:="01162002A" 'r.setvalue Field:="SCTYDT", Value:=0 'r.setvalue Field:="SCTYUNQ", Value:=0 r.setvalue Field:="HLDATE", Value:=20020119 r.setvalue Field:="TRDMARK", Value:=51000 r.setvalue Field:="STLMARK", Value:=51000 'Stage the Holdings Update in the Holdings Update block object rb.StageHldg (r.Message()) 'Clear the Holdings Update object for the next Holdings Update r.Clear 'set the desired Holdings Update fields r.setvalue Field:="MODE", Value:="C" r.setvalue Field:="ACCT", Value:=1162002 r.setvalue Field:="SCTYNO", Value:="01162002A"



157

'r.setvalue Field:="SCTYDT", Value:=0 'r.setvalue Field:="SCTYUNQ", Value:=0 r.setvalue Field:="HLDATE", Value:=20020120 r.setvalue Field:="TRDMARK", Value:=52000 r.setvalue Field:="STLMARK", Value:=52000 'Stage the Holdings Update in the Holdings Update block object rb.StageHldg (r.Message()) 'Execute the Holdings Updates contained in the block object rb.Execute 'Show the user any messages returned from INVEST ONE Debug.Print "+++First Holdings Definition Messages" For I = 1 To rb.ReplyCount(1) Debug.Print rb.Reply(1, I) Next I Debug.Print "+++Second Holdings Definition Messages" For I = 1 To rb.ReplyCount(2) Debug.Print rb.Reply(2, I) Next I MsgBox "Communication complete!", vbExclamation End Sub


Sets the IOConnection object associated with this IOHoldingBlock. Syntax


Part Description object An object expression that evaluates to an IOHoldingBlock object. connect An IOConnection object.

Remarks




158

Execute Description

Sends the currently staged Holdings Definitions to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOHoldingBlock object.

Reply Description


Syntax

object.Reply(holding, number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOHoldingBlock object. holding The position of the Holding Definition within the block. number The number of the reply being requested.

Remarks

The HldgCount property can be used to determine the total number of Holdings Definitions in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for each Holdings Definition.



159


Returns the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for a given executed Holdings Definition.

Syntax

object.ReplyCount(holding) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOHoldingBlock object. holding The position of the Holdings Definition within the block.

Remarks


HldgCount Description

Returns the number of Holdings Definitions currently contained within the block. Syntax

object.HldgCount The HldgCount property syntax has these parts: Part Description object An object expression that evaluates to an IOHoldingBlock object.



160

StageHldg Description

Stages a given Holdings Definition message into the block.

Syntax

object.StageHldg(HldgMsg) The StageHldg method syntax has these parts: Part Description object An object expression that evaluates to an IOHoldingBlock object. HldgMsg A string value provided from the Message property of an IOHolding object.

Remarks

The HldgMsg string is actually a formatted “FDXHL01” message as specified in the Investment Accounting (InvestOne) / SDK manual. While you could format the string without using the IOHolding object, this is not recommended due to release independence.

IO OLE PROGRAMMER’S GUIDE USING IOTAXLOTADJ


161

20. USING IOTAXLOTADJ PURPOSE The IOTaxlotAdj is used to add, change and delete Taxlot Adjustments (DEXA) values in the Investment Accounting (InvestOne) Engine. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As Object Dim r As Object Dim I As Integer 'Build INVEST ONE Connection Set c = CreateObject("SunGard.IOConnection") c.CommType = "IP" c.HostIP = InputBox("Host IP:") c.Port = InputBox("Port:") c.Operator = InputBox("Operator:") c.Password = InputBox("Password:") 'Build Taxlot Adjustment Update Set r = c.CreateTaxlotAdj 'set the desired Taxlot Adjustment Update fields r.setvalue Field:="MODE", Value:="A" r.setvalue Field:="TRDORD", Value:=2528 r.setvalue Field:="CODE", Value:="TXLCS+" r.setvalue Field:="EXECDT", Value:=20020112 r.setvalue Field:="COSTADJ", Value:=125.5 'Execute the Taxlot Adjustment Update in INVEST ONE r.Execute 'Show the user any messages returned from INVEST ONE For I = 1 To r.ReplyCount Debug.Print r.Reply(I) Next I MsgBox "Communication complete!", vbExclamation End Sub



162



Syntax


Part Description object An object expression that evaluates to an IOTaxlotAdj object.

Remarks


Sets the IOConnection object associated with this IOTaxlotAdj.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOTaxlotAdj object. connect An IOConnection object.

Remarks




163

Execute Description

Sends the currently loaded Taxlot Adjustment to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOTaxlotAdj object.

Remarks

If the Taxlot Adjustment update is not accepted by Investment Accounting (InvestOne), an error will be raised.


Returns the value of a specific field within the currently loaded Taxlot Adjustment.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOTaxlotAdj object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in the Investment Accounting (InvestOne) Software Developer’s Kit. The field names are in the column labeled Field. Currently, no Taxlot Adjustment field requires the Occur parameter.



164

Message Description

Returns a formatted string which the Investment Accounting (InvestOne) / Engine will accept as a streamed Taxlot Adjustment.

Syntax

object.Message The Message property syntax has these parts: Part Description object An object expression that evaluates to an IOTaxlotAdj object.

Remarks This method returns a string representing the message which will be sent to the Investment Accounting (InvestOne) / Engine to apply this Taxlot Adjustment. It is used in conjunction with the StageTxlAdj function in the IOTaxlotAdjBlock object. Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOTaxlotAdj object. action The type of processing being requested of the Investment Accounting (InvestOne) / Engine.

Settings

The valid settings action parameter are: Setting Description A Add a new taxlot adjustment transaction (DEXA). C Change an existing taxlot adjustment transaction (DAXA). D Delete an existing taxlot adjustment transaction (DDXA).



165

Remarks

For add mode, the MODE, TRDORD, CODE and EXECDT fields are key fields and must be loaded before the Execute method is invoked. For change and delete mode, the MODE and TLMEMO fields are key fields and must be loaded before the Execute method is invoked.

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOTaxlotAdj object. number The number of the reply being requested.

Remarks The ReplyCount property can be used to retrieve the number of reply messages returned from the Investment Accounting (InvestOne) / Engine. ReplyCount Description


Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOTaxlotAdj object.

Remarks




166


Sets the value of a specific field within the currently loaded Taxlot Adjustment.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object Object expression that evaluates to an IOTaxlotAdj object. Field A string indicating the field for which the value should be returned. Value Value to which the field should be set. Occur Optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in the Software Developer’s Kit. The field names are in the column labeled Field. Currently, no Taxlot Adjustment field requires the Occur parameter. The Value parameter is a variant that will be dependent on the setting in the Field parameter. The fields themselves will not be edited until the Execute method is invoked.

IO OLE PROGRAMMER’S GUIDE USING IOTAXLOTADJBLOCK


167

21. USING IOTAXLOTADJBLOCK PURPOSE The IOTaxlotAdjBlock is used to add, change and delete Taxlot Adjustments (DEXA) values in the Investment Accounting (InvestOne) Engine. When sending multiple Taxlot Adjustments, IOTaxlotAdjBlock is more efficient then using individual IOTaxlotAdj objects. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As Object Dim r As Object Dim rb As Object Dim I As Integer 'Build INVEST ONE Connection Set c = CreateObject("SunGard.IOConnection") c.CommType = "IP" c.HostIP = InputBox("Host IP:") c.Port = InputBox("Port:") c.Operator = InputBox("Operator:") c.Password = InputBox("Password:") 'Build Taxlot Adjustment Update Set r = c.CreateTaxlotAdj 'Build Taxlot Adjustment Update Block Set rb = c.CreateTaxlotAdjBlock 'set the desired Taxlot Adjustment Update fields r.setvalue Field:="MODE", Value:="A" r.setvalue Field:="TRDORD", Value:=2528 r.setvalue Field:="CODE", Value:="TXLCS+" r.setvalue Field:="EXECDT", Value:=20020112 r.setvalue Field:="COSTADJ", Value:=1000.75 'Stage the Taxlot Adj Update in the Taxlot Adj Update block object rb.StageTxlAdj (r.Message()) 'Clear the Taxlot Adj Update object for the next Taxlot Adj Update r.Clear 'set the desired Taxlot Adjustment Update fields r.setvalue Field:="MODE", Value:="C" r.setvalue Field:="TLMEMO", Value:=2530 r.setvalue Field:="COSTADJ", Value:=75 'Stage the Taxlot Adj Update in the Taxlot Adj Update block object rb.StageTxlAdj (r.Message()) 'Execute the Taxlot Adjustment Updates contained in the block object rb.Execute 'Show the user any messages returned from INVEST ONE



168

Debug.Print "+++First Taxlot Adjustment Messages" For I = 1 To rb.ReplyCount(1) Debug.Print rb.Reply(1, I) Next I Debug.Print "+++Second Taxlot Adjustment Messages" For I = 1 To rb.ReplyCount(2) Debug.Print rb.Reply(2, I) Next I MsgBox "Communication complete!", vbExclamation End Sub


Sets the IOConnection object associated with this IOTaxlotAdjBlock. Syntax


Part Description object An object expression that evaluates to an IOTaxlotAdjBlock object. connect An IOConnection object.

Remarks




169

Execute Description

Sends the currently staged Taxlot Adjustments to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOTaxlotAdjBlock object.

Reply Description


Syntax

object.Reply(adj, number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOTaxlotAdjBlock object. adj The position of the Taxlot Adjustments within the block. number The number of the reply being requested.

Remarks

The TxlAdjCount property can be used to determine the total number of Taxlot Adjustments in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for each Taxlot Adjustment.



170


Returns the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for a given executed Taxlot Adjustment.

Syntax

object.ReplyCount(adj) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOTaxlotAdjBlock object. adj The position of the Taxlot Adjustment within the block.

Remarks


TxlAdjCount Description

Returns the number of Taxlot Adjustments currently contained within the block. Syntax

object.TxlAdjCount The TxlAdjCount property syntax has these parts: Part Description object An object expression that evaluates to an IOTaxlotAdjBlock object.



171

StageTxlAdj Description

Stages a given Taxlot Adjustment message into the block.

Syntax

object.StageTxlAdj(TxlAdjMsg) The StageTxlAdj method syntax has these parts: Part Description object An object expression that evaluates to an IOTaxlotAdjBlock object. TxlAdjMsg A string value provided from the Message property of an IOTaxlotAdj object.

Remarks

The TxlAdjMsg string is actually a formatted “FDXTL01” message as specified in the Investment Accounting (InvestOne) / SDK manual. While you could format the string without using the IOTaxlotAdj object, this is not recommended due to release independence.

IO/OLE PROGRAMMER’S GUIDE USING IOCORPORATEACTION


172

22. USING IOCORPORATEACTION PURPOSE The IOCorporateAction is used to add, change or delete financial Corporate Actions in the Investment Accounting (InvestOne) Engine. As in Security maintenance, Investment Accounting (InvestOne) provides the capability to update Fund Elections on specific Optional Corporate Actions. This inbound interface is processed on a real-time basis for the associated Corporate Action record that can be updated. Note: Corporate Actions or Rates cannot be deleted. By changing the Corporate Action or Rate to zero, no calculation occurs and, in effect, the rate has been deleted. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim t As IOCorporateAction Dim I As Integer 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build CorporateAction Set t = c.CreateCorporateRateAction 'set the desired CorporateAction fields t.SetValue Field:="MODE", Value:="A" t.SetValue Field:="SCTYNO", Value:=”IBM” t.SetValue Field:="TRTYPE", Value:=”STDV” t.SetValue Field:="EXDT", Value:=DateSerial(1997.12,31) t.SetValue Field:="ORDER", Value:=0 t.SetValue Field:="PAYDT", Value:=”01/02/2002” t.SetValue Field:="RATE", Value:=”01” t.SetValue Field:="RECDT", Value:= ”01/02/2002” t.SetValue Field:="DECDT", Value:= ”01/02/2002” t.SetValue Field:="OLDSHRS", Value:= 2 t.SetValue Field:="NEWSHRS", Value:= 4 ‘execute the CorporateAction in INVEST ONE t.Execute 'show the user any messages returned from INVEST ONE For i = 1 To t.ReplyCount Dubug.Print t.Reply(i) Next I Set c = nothing Set t = nothing



173

End Sub



Syntax

object.Clear The Clear method syntax has these parts: Part Description object An object expression that evaluates to an IOCorporateAction object.

Remarks


Sets the IOConnection object associated with this IOCorporateAction. Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOCorporateAction object. connect An IOConnection object.

Remarks




174

Execute Description

Sends the currently loaded CorporateAction to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute () The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOCorporateAction object.

Remarks

If the CorporateAction is not accepted by Investment Accounting (InvestOne) for a normal processing, an error will be raised.


Returns the value of a specific field within the currently loaded CorporateAction message.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOCorporateAction object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in the Investment Accounting (InvestOne) Software Developer’s Kit. The field names are in the right most column labeled Field. OCCUR field itself is an option field which defaults to 1. The settings for Occur are dependent upon which field is being requested. If the field is DESC, this may be a value between “1” and “10”. For all other fields this value must be “1” or omitted.



175

Message Description

Returns a formatted string which the Investment Accounting (InvestOne) / Engine will accept as a streamed CorporateAction message.

Syntax

object.Message() The Message property syntax has these parts: Part Description object An object expression that evaluates to an IOCorporateAction object.

Remarks

This method returns a string representing the message which will be sent to the Investment Accounting (InvestOne) / Engine to add this CorporateAction. It is used in conjunction with the StageCorporateAction function in the IOCorporateActionBlock object.

Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOCorporateAction object. action The type of processing being requested of the Investment Accounting (InvestOne) / Engine.

Settings

The valid settings action parameter are: Setting Description A Add the loaded CorporateAction. C Change the loaded CorporateAction.

Remarks

If the mode is “C”, Corporate action and rate changes are matched by EXDT to determine which entry should be revised for the security.



176

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOCorporateAction object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOCorporateAction object.

Remarks




177


Sets the value of a specific field within the currently loaded CorporateAction.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOCorporateAction object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOCORPORATEACTIONBLOCK


178

23. USING IOCORPORATEACTIONBLOCK PURPOSE The IOCorporateActionBlock is used to add or change financial CorporateActions in the Investment Accounting (InvestOne) Engine. When sending multiple CorporateActions, IOCorporateActionBlock is more efficient than using individual IOCorporateAction objects. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim t As IOCorporateAction Dim tb As IOCorporateActionBlock Dim i As Integer 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create CorporateAction Block Set tb = c.CreateCorporateActionBlock ' Create Work CorporateAction Set t = c.CreateCorporateAction 'set the desired CorporateAction fields t.SetValue Field:="MODE", Value:="A" t.SetValue Field:="SCTYNO", Value:=”IBM” t.SetValue Field:="TRTYPE", Value:=”STDV” t.SetValue Field:="EXDT", Value:=DateSerial(1997.12,31) t.SetValue Field:="ORDER", Value:=0 t.SetValue Field:="PAYDT", Value:=”01/02/2002” t.SetValue Field:="RATE", Value:=”01” t.SetValue Field:="RECDT", Value:= ”01/02/2002” t.SetValue Field:="DECDT", Value:= ”01/02/2002” t.SetValue Field:="OLDSHRS", Value:= 2 t.SetValue Field:="NEWSHRS", Value:= 4 'stage the trade in the CorporateAction block object tb.StageCorporateAction (t.Message()) 'clear the CorporateAction object for the next trade t.Clear 'execute the CorporateAction block in INVEST ONE tb.Execute 'show the user any messages returned from INVEST ONE



179

Debug.Print “+++ First Corporate Action Message” For i = 1 To tb.ReplyCount(0)

Debug.Print tb.Reply(0, i) Next I Debug.Print “+++ Second Corporate Action Message” For i = 1 To tb.ReplyCount(1)



Sets the IOConnection object associated with this IOCorporateActionBlock.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOCorporateActionBlock object. connect An IOConnection object.

Remarks


Execute Description

Sends the currently staged CorporateActions to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute ()

The Execute method syntax has these parts:



180

Part Description object An object expression that evaluates to an IOCorporateActionBlock object.

Settings

The settings for RepairStation are: Setting Description N Do not invoke Repair Station processing.

Remarks

If the CorporateAction is not accepted by Investment Accounting (InvestOne) for normal processing, an error will be raised.

Reply Description


Syntax

object.Reply(CorpAction, number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOCorporateAction object. CorpAction The position of the trade within the block. (The first trade is in position “0”.) number The number of the reply being requested.

Remarks

The CorporateActionRateCount property can be used to determine the total number of corporate actions in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for each corporate action message.


Returns the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for a given executed CorporateAction.



181

Syntax

object.ReplyCount(CorpAction) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOCorporateActionBlock object.

CorpAction The position of the corporate action within the block. (The first corporate action is in position “0”.)

Remarks


StageCorporateAction Description

Stages a given CorporateAction message into the block.

Syntax

object.StageCorporateAction(Msg) The StageCorporateAction method syntax has these parts:

Part Description object An object expression that evaluates to an IOCorporateActionBlock object. Msg A string value provided from the Message property of an IOCorporateAction object.

Remarks

The Msg string is actually a formatted “FDXRT01” message as specified in the Investment Accounting (InvestOne) / SDK manual. While you could format the string without using the IOCorporateAction object, this is not recommended due to release independence.

CorporateActionRateCount Description

Returns the number of Corporate actions currently contained within the block.



182

Syntax

object. CorporateActionRateCount The CorporateActionRateCount property syntax has these parts: Part Description object An object expression that evaluates to an IOCorporateActionBlock object.

IO/OLE PROGRAMMER’S GUIDE USING IOCOMPLEXCOPRACTION


183

24. USING IOCOMPLEXCORPACTION PURPOSE The IOComplexCorpAction is used to add, change or delete Financial Complex Rate Corporate Actions in the Investment Accounting (InvestOne) Engine. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim ca As IOComplexCorpAction Dim I As Integer 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build CorporateAction Set ca = c.createComplexCorpAction 'set the desired CompexCorpAction fields ca.SetValue Field:="MODE", Value:="A" ca.SetValue Field:="SCTYNO", Value:=” 900209802” ca.SetValue Field:="CATYPE", Value:=”MRGT” ca.SetValue Field:="SEQNO", Value:=0 ca.SetValue Field:="EXDT", Value:=” 1/02/2002” ca.SetValue Field:="DECDT", Value:=”01/02/2002” ca.SetValue Field:="RECDT", Value:=”01/02/2002” ca.SetValue Field:="PAYDT", Value:=”01/02/2002” ca.SetValue Field:="EFFDT", Value:=”01/02/2002” ca.SetValue Field:="CSHRATE", Value:=15.00 ca.SetValue Field:="DIVDNO", Value:= 2 ca.SetValue Field:="COSTIND", Value:= “C” ca.SetValue Field:="MPRICE", Value:= 20 ‘execute the ComplexCorpAction in INVEST ONE ca.Execute() 'show the user any messages returned from INVEST ONE For i = 1 To t.ReplyCount Dubug.Print t.Reply(i) Next I Set c = nothing Set ca = nothing End Sub



184



Syntax

object.Clear The Clear method syntax has these parts: Part Description object An object expression that evaluates to an IOComplexCorpAction object.

Remarks


Sets the IOConnection object associated with this IOComplexCorpAction. Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOComplexCorpAction object. connect An IOConnection object.

Remarks




185

Execute Description

Sends the currently loaded Complex Rate Corporate Action to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute () The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOComplexCorpAction object.

Remarks

If IOComplexCorpAction message is not accepted by Investment Accounting (InvestOne) for a normal processing, an error will be raised.


Returns the value of a specific field within the currently loaded CorporateAction message.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOComplexCorpAction object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in the Investment Accounting (InvestOne) Software Developer’s Kit. The field names are in the right most column labeled Field. OCCUR field itself is an option field which defaults to “1”. The settings for Occur are dependent upon which field is being requested. If the field is value between “1” and “10”. For all other fields this value must be “1” or omitted.



186

Message Description

Returns a formatted string which the Investment Accounting (InvestOne) / Engine will accept as a streamed IOComplexCorpAction message.

Syntax

object.Message() The Message property syntax has these parts: Part Description object An object expression that evaluates to an IOComplexCorpAction object.

Remarks

This method returns a string representing the message which will be sent to the Investment Accounting (InvestOne) / Engine to add this Complex Rate Corporate Action. It is used in conjunction with the StageComplexCorpAction function in the IOComplexCorpActionBlock object.

Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOComplexCorpAction object. action The type of processing being requested of the Investment Accounting (InvestOne) / Engine.

Settings

The valid settings action parameter are: Setting Description A Add the loaded Complex Rate Corporate Action. C Change the loaded Complex Rate Corporate Action.

Remarks




187

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOComplexCorpAction object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOComplexCorpAction object.

Remarks




188


Sets the value of a specific field within the currently loaded CorporateAction.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOComplexCorpAction object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in Section 2.2.9 of the Software Developer’s Kit. The field names are in the right most column labeled Field. The settings for Occur are dependent upon which field is being requested. If the field can occur multiple times in the message, this may set to be a value between “1” and “9”. For limitations, please check the Software Developer’s Kit. The Value parameter is a variant which will be dependent on the setting in the Field parameter. The fields themselves will not be edited until the Execute method is invoked.

IO/OLE PROGRAMMER’S GUIDE USING IOCOMPLEXCOPRACTIONBLOCK


189

25. USING IOCOMPLEXCORPACTIONBLOCK PURPOSE The IOComplexCorpActionBlock is used to add or change financial Complex Corporate Actions in the Investment Accounting (InvestOne) Engine. When sending multiple Complex Corporate Actions, IOComplexCorpActionBlock is more efficient than using individual IOComplexCorpAction objects. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim ca As IOComplexCorpAction Dim cb As IOComplexCorpActionBlock Dim i As Integer 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create CompexCorpAction Block Set cb = c. CreateComplexCorpActionBlock ' Create Work ComplexCorpAction Set ca = c.CreateComplexCorpAction 'set the desired CompexCorpAction fields ca.SetValue Field:="MODE", Value:="A" ca.SetValue Field:="SCTYNO", Value:=” 900209802” ca.SetValue Field:="CATYPE", Value:=”MRGT” ca.SetValue Field:="SEQNO", Value:=0 ca.SetValue Field:="EXDT", Value:=” 1/02/2002” ca.SetValue Field:="DECDT", Value:=”01/02/2002” ca.SetValue Field:="RECDT", Value:=”01/02/2002” ca.SetValue Field:="PAYDT", Value:=”01/02/2002” ca.SetValue Field:="EFFDT", Value:=”01/02/2002” ca.SetValue Field:="CSHRATE", Value:=15.00 ca.SetValue Field:="DIVDNO", Value:= 2 ca.SetValue Field:="COSTIND", Value:= “C” ca.SetValue Field:="MPRICE", Value:= 20 'stage the message into the ComplexCorpAction block object cb.StageMessage (t.Message()) 'clear the ComplexCorpAction object for the next trade ca.Clear 'execute the ComplexCorpAction block in INVEST ONE



190

cb.Execute 'show the user any messages returned from INVEST ONE Debug.Print “+++ First Trade Messages” For i = 1 To cb.ReplyCount(0)

Debug.Print cb.Reply(0, i) Next I Debug.Print “+++ Second Trade Messages” For i = 1 To cb.ReplyCount(1)

Debug.Print cb.Reply(1, i) Next i End Sub


Sets the IOConnection object associated with this IOComplexCorpActionBlock.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOComplexCorpActionBlock object. connect An IOConnection object.

Remarks


Execute Description

Sends the currently staged ComplexCorpActions to the Investment Accounting (InvestOne) / Engine for processing.



191

Syntax

object.Execute ()

The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOComplexCorpActionBlock object.

Settings

The settings for RepairStation are: Setting Description N Do not invoke Repair Station processing.

Remarks

If Complex Rate Corporate Action is not accepted by Investment Accounting (InvestOne) for normal processing, an error will be raised.

Reply Description


Syntax

object.Reply(CorpAction, number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOComplexCorpAction object. CorpAction The position of the trade within the block. (The first trade is in position “0”.) number The number of the reply being requested.

Remarks

The ComplexCorporateActionCount property can be used to determine the total number of Complex Corporate Actions in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for each message.



192


Returns the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for a given executed ComplexCorpAction.

Syntax

object.ReplyCount(CorpAction) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOComplexCorpActionBlock object.

CorpAction The position of the corporate action within the block. (The first corporate action is in position “0”.)

Remarks


StageMessage Description

Stages a given ComplexCorpAction message into the block.

Syntax

object. StageMessage (Msg) The StageMessage method syntax has these parts:

Part Description object An object expression that evaluates to an IOComplexCorpActionBlock object. Msg A string value provided from the Message property of an IOComplexCorpAction object.

Remarks

The Msg string is actually a formatted “FDXCA03” message as specified in the Investment Accounting (InvestOne) / SDK manual. While you could format the string without using the IOComplexCorpAction object, this is not recommended due to release independence.



193

ComplexCorporateActionCount Description


Syntax

object. ComplexCorporateActionCount The CorporateActionRateCount property syntax has these parts: Part Description object An object expression that evaluates to an IOComplexCorpActionBlock object.

IO/OLE PROGRAMMER’S GUIDE USING IOPARTELECORPACTION


194

26. USING IOPARTELECORPACTION PURPOSE The IOPartEleCorpAction is used to add, change or delete Partial Election Corporate Actions in the Investment Accounting (InvestOne) Engine. As in Transaction maintenance, Investment Accounting (InvestOne) provides the capability to update Fund Elections on specific Optional Partial Election Corporate Actions. This inbound interface is processed on a real-time basis for the associated Partial Election Corporate Action record that can be updated. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim pc As IOPartEleCorpAction Dim I As Integer 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build PartialElectionCorporateAction Set pc = c. CreatePartialEleCorpAction 'set the desired PartialElectionCorporateAction fields pc.SetValue Field:="MODE", Value:="A" pc.SetValue Field:="SCTYNO", Value:=”IBM” pc.SetValue Field:="TRTYPE", Value:=”STDV” pc.SetValue Field:="EXDT", Value:=DateSerial(1997.12,31) pc.SetValue Field:="ORDER", Value:=0 pc.SetValue Field:="PAYDT", Value:=”01/02/2002” pc.SetValue Field:="RATE", Value:=”01” pc.SetValue Field:="RECDT", Value:= ”01/02/2002” pc.SetValue Field:="DECDT", Value:= ”01/02/2002” pc.SetValue Field:="OLDSHRS", Value:= 2 pc.SetValue Field:="NEWSHRS", Value:= 4 ‘execute the PartialElectionCorporateAction in INVEST ONE pc.Execute 'show the user any messages returned from INVEST ONE For i = 1 To pc.ReplyCount Dubug.Print pc.Reply(i) Next I Set c = nothing Set pc = nothing End Sub



195



Syntax

object.Clear The Clear method syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpAction object.

Remarks


Sets the IOConnection object associated with this IOPartEleCorpAction. Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpAction object. connect An IOConnection object.

Remarks




196

Execute Description

Sends the currently loaded PartialElectionCorporateAction to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute () The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpAction object.

Remarks

If the PartialElectionCorporateAction is not accepted by Investment Accounting (InvestOne) for a normal processing, an error will be raised.


Returns the value of a specific field within the currently loaded PartialElectionCorporateAction message.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpAction object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in the Investment Accounting (InvestOne) Software Developer’s Kit. The field names are in the right most column labeled Field. OCCUR field itself is an option field which defaults to “1”. The settings for Occur are dependent upon which field is being requested. If the field is DESC, this may be a value between “1” and “10”. For all other fields this value must be “1” or omitted.



197

Message Description

Returns a formatted string which the Investment Accounting (InvestOne) / Engine will accept as a streamed PartialElectionCorporateAction message.

Syntax

object.Message() The Message property syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpAction object.

Remarks

This method returns a string representing the message which will be sent to the Investment Accounting (InvestOne) / Engine to add this PartialElectionCorporateAction. It is used in conjunction with the StageCorporateAction function in the IOPartEleCorpActionBlock object.

Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpAction object. action The type of processing being requested of the Investment Accounting (InvestOne) / Engine.

Settings

The valid settings action parameter are: Setting Description A Add the loaded PartialElectionCorporateAction. C Change the loaded PartialElectionCorporateAction.

Remarks




198

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpAction object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpAction object.

Remarks




199


Sets the value of a specific field within the currently loaded PartialElectionCorporateAction.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpAction object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOPARTELECORPACTIONBLOCK


200

27. USING IOPARTELECORPACTIONBLOCK PURPOSE The IOPartEleCorpActionBlock is used to add or change financial CorporateActions in the Investment Accounting (InvestOne) Engine. When sending multiple CorporateActions, IOPartEleCorpActionBlock is more efficient than using individual IOPartEleCorpAction objects. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim pc As IOPartEleCorpAction Dim tb As IOPartEleCorpActionBlock Dim i As Integer 'Build INVEST ONE Connection set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create PartialElectionCorporateAction Block Set tb = c. CreatePartialEleCorpActionBlock ' Create Work PartialElectionCorporateAction Set pc = c. CreatePartialEleCorpAction 'set the desired PartialElectionCorporateAction fields pc.SetValue Field:="MODE", Value:="A" pc.SetValue Field:="SCTYNO", Value:=”IBM” pc.SetValue Field:="TRTYPE", Value:=”STDV” pc.SetValue Field:="EXDT", Value:=DateSerial(1997.12,31) pc.SetValue Field:="ORDER", Value:=0 pc.SetValue Field:="PAYDT", Value:=”01/02/2002” pc.SetValue Field:="RATE", Value:=”01” pc.SetValue Field:="RECDT", Value:= ”01/02/2002” pc.SetValue Field:="DECDT", Value:= ”01/02/2002” pc.SetValue Field:="OLDSHRS", Value:= 2 pc.SetValue Field:="NEWSHRS", Value:= 4 'stage the trade in the PartialElectionCorporateAction block object tb.StageCorporateAction (pc.Message()) 'clear the PartialElectionCorporateAction object for the next trade pc.Clear 'execute the PartialElectionCorporateAction block in INVEST ONE tb.Execute 'show the user any messages returned from INVEST ONE



201

Debug.Print “+++ First Partial Election Corporate Action Message” For i = 1 To tb.ReplyCount(0)

Debug.Print tb.Reply(0, i) Next I Debug.Print “+++ Second Partial Election Corporate Action Message” For i = 1 To tb.ReplyCount(1)



Sets the IOConnection object associated with this IOPartEleCorpActionBlock.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpActionBlock object. connect An IOConnection object.

Remarks


Execute Description

Sends the currently staged CorporateActions to the Investment Accounting (InvestOne) / Engine for processing.



202

Syntax

object.Execute ()

The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpActionBlock object.

Remarks

If the PartialElectionCorporateAction is not accepted by Investment Accounting (InvestOne) for normal processing, an error will be raised.

Reply Description


Syntax

object.Reply(CorpAction, number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpAction object. CorpAction The position of the trade within the block. (The first message is in position “0”.) number The number of the reply being requested.

Remarks

The PElectionCorpActionCount property can be used to determine the total number of corporate actions in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for each corporate action message.


Returns the number of reply messages returned from the Investment Accounting (InvestOne) / Engine for a given executed PartialElectionCorporateAction.



203

Syntax

object.ReplyCount(CorpAction) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpActionBlock object.

CorpAction The position of the partial election corporate action within the block. (The first partial election corporate action is in position “0”.)

Remarks


StagePElectionCorpAction Description

Stages a given PartialElectionCorporateAction message into the block.

Syntax

object.StagePElectionCorpAction (Msg) The StagePElectionCorpAction method syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpActionBlock object. Msg A string value provided from the Message property of an IOPartEleCorpAction object.

Remarks

The Msg string is actually a formatted “FDXCA02” message as specified in the Investment Accounting (InvestOne) / SDK manual. While you could format the string without using the IOPartEleCorpAction object, this is not recommended due to release independence.



204

PElectionCorpActionCount Description


Syntax

object. PElectionCorpActionCount The PElectionCorpActionCount property syntax has these parts: Part Description object An object expression that evaluates to an IOPartEleCorpActionBlock object.

IO/OLE PROGRAMMER’S GUIDE USING IOSUPERMESSAGE


205

28. USING IOSUPERMESSAGE PURPOSE The IOSuperMessage is used to add supermessages in the Investment Accounting (InvestOne) Engine. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As Sungard.IOConnection Dim sm As Sungard.IOSuperMessage Dim I As Integer 'Build INVEST ONE Connection set c = New Sungard.IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build SuperMessage Set sm = c.CreateSuperMessage 'set the desired SuperMessage fields sm.SetValue Field:="ACCT", Value:=14253689 sm.SetValue Field:="EFFTDT", Value:=” 6/15/2001” sm.SetValue Field:="RQSTID", Value:=1 sm.SetValue Field:="MSG2SEQ", Value:=1, Occur:=1 sm.SetValue Field:="MSG2PVR", Value:=”YY********”, Occur:=1 sm.SetValue Field:="MSG2", Value:=” FDSAV01” , Occur:=1 sm.SetValue Field:="MSG2MSG", Value:=”O200106012001062210” , Occur:=1 sm.SetValue Field:="MSG2SEQ", Value:= 2, Occur:=2 sm.SetValue Field:="MSG2PVR", Value:=”YY********”, Occur:=2 sm.SetValue Field:="MSG2", Value:=”FDSCG01” , Occur:=2 sm.SetValue Field:="MSG2MSG",Value:=“2001061620010622******** GUN”, Occur:=2 ‘execute the SuperMessage in INVEST ONE sm.Execute 'show the user any messages returned from INVEST ONE For i = 1 To sm.ReplyCount Dubug.Print sm.Reply(i) Next I Set c = nothing Set sm = nothing End Sub



206



Syntax

object.Clear The Clear method syntax has these parts: Part Description object An object expression that evaluates to an IOSuperMessage object.

Remarks


Sets the IOConnection object associated with this IOSuperMessage. Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOSuperMessage object. connect An IOConnection object.

Remarks




207

Execute Description

Sends the currently loaded SuperMessage to the Investment Accounting (InvestOne) / Engine for processing.

Syntax

object.Execute () The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOSuperMessage object. The settings for RepairStation is “N” meaning as “Do not invoke Repair Station processing”.

Remarks

If the SuperMessage is not accepted by Investment Accounting (InvestOne) for a normal processing, an error will be raised.


Returns the value of a specific field within the currently loaded SuperMessage message.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOSuperMessage object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in the Investment Accounting (InvestOne) Software Developer’s Kit. The field names are in the right most column labeled Field. OCCUR field itself is an option field which defaults to “1”. The settings for Occur are dependent upon which field is being requested. If the field is “msg1seq”, this may be a value between “1” and “8”. Occur value needs to be specified for all the fields. If it is not specified, default value of “1” will be used.



208

Message Description

Returns a formatted string which the Investment Accounting (InvestOne) / Engine will accept as a streamed SuperMessage message.

Syntax

object.Message() The Message property syntax has these parts: Part Description object An object expression that evaluates to an IOSuperMessage object.

Remarks

This method returns a string representing the message which will be sent to the Investment Accounting (InvestOne) / Engine to add this SuperMessage.

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOSuperMessage object. number The number of the reply being requested.

Remarks






209

Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOSuperMessage object.

Remarks



Sets the value of a specific field within the currently loaded SuperMessage.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOSuperMessage object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOMBSPOOLBALANCE


210

29. USING IOMBSPOOLBALANCE PURPOSE The IOMBSPoolBalance is used to add MBS Pool Balance and Factors into Investment Accounting (InvestOne) Engine. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As Sungard.IOConnection Dim mbs As Sungard.IOMBSPoolBalance Dim I As Integer 'Build INVEST ONE Connection set c = New Sungard.IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build MBSPoolBalance Set mbs = c.CreateMBSPoolBalance 'set the desired MBSPoolBalance fields mbs.SetValue Field:="MODE", Value:=”A” mbs.SetValue Field:="SCTYNO", Value:=”IBM” mbs.SetValue Field:="SCTYDT", Value:=”01/01/2003” mbs.SetValue Field:="SETYUNQ", Value:=”1234” mbs.SetValue Field:="PRMM", Value:=1 mbs.SetValue Field:="PRYY", Value:=2001 mbs.SetValue Field:="REMBAL", Value:= 5.0 mbs.SetValue Field:="FACTOR", Value:=1.20002 ‘execute the MBSPoolBalance in INVEST ONE mbs.Execute 'show the user any messages returned from INVEST ONE For i = 1 To sm.ReplyCount Dubug.Print mbs.Reply(i) Next I Set c = nothing Set mbs = nothing End Sub



211



Syntax

object.Clear The Clear method syntax has these parts: Part Description object An object expression that evaluates to an IOMBSPoolBalance object.

Remarks


Sets the IOConnection object associated with this IOMBSPoolBalance. Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOMBSPoolBalance object. connect An IOConnection object.

Remarks


Execute Description

Sends the currently loaded MBSPoolBalance to the Investment Accounting (InvestOne) / Engine for processing.



212

Syntax

object.Execute () The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOMBSPoolBalance object.

The settings for RepairStation is “N” meaning as “Do not invoke Repair Station processing”.

Remarks

If the MBSPoolBalance is not accepted by Investment Accounting (InvestOne) for a normal processing, an error will be raised.


Returns the value of a specific field within the currently loaded MBSPoolBalance message.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOMBSPoolBalance object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks


Message Description

Returns a formatted string which the Investment Accounting (InvestOne) / Engine will accept as a streamed MBSPoolBalance message.



213

Syntax

object.Message() The Message property syntax has these parts: Part Description object An object expression that evaluates to an IOMBSPoolBalance object.

Remarks

This method returns a string representing the message which will be sent to the Investment Accounting (InvestOne) / Engine to add this MBSPoolBalance.

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOMBSPoolBalance object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOMBSPoolBalance object.



214

Remarks



Sets the value of a specific field within the currently loaded MBSPoolBalance.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOMBSPoolBalance object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOVACRNUM


215

30. USING IOVACRNUM PURPOSE The IOVACRNUM is used to renumber account in Investment Accounting (InvestOne) Engine. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As Sungard.IOConnection Dim mbs As Sungard.IOVACRNUM Dim I As Integer 'Build INVEST ONE Connection set c = New Sungard.IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build VACRNUM Set mbs = c.CreateVACRNUM 'set the desired VACRNUM fields mbs.SetValue Field:="ACCTOLD", Value:=”12345” mbs.SetValue Field:="ACCTVW ", Value:=”FA” mbs.SetValue Field:="ACCTNEW", Value:=”23456789” mbs.SetValue Field:="ACCTIND ", Value:=”V” mbs.SetValue Field:="ACCTFA", Value:=13456 ‘execute the VACRNUM in INVEST ONE mbs.Execute 'show the user any messages returned from INVEST ONE For i = 1 To sm.ReplyCount Dubug.Print mbs.Reply(i) Next I Set c = nothing Set mbs = nothing End Sub



216



Syntax

object.Clear The Clear method syntax has these parts: Part Description object An object expression that evaluates to an IOVACRNUM object.

Remarks


Sets the IOConnection object associated with this IOVACRNUM. Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOVACRNUM object. connect An IOConnection object.

Remarks


Execute Description

Sends the currently loaded VACRNUM to the Investment Accounting (InvestOne) / Engine for processing.



217

Syntax

object.Execute () The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOVACRNUM object.


Remarks

If the VACRNUM is not accepted by Investment Accounting (InvestOne) for a normal processing, an error will be raised.


Returns the value of a specific field within the currently loaded VACRNUM message.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOVACRNUM object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to be returned.

Message Description

Returns a formatted string which the Investment Accounting (InvestOne) / Engine will accept as a streamed VACRNUM message.



218

Syntax

object.Message() The Message property syntax has these parts: Part Description object An object expression that evaluates to an IOVACRNUM object.

Remarks

This method returns a string representing the message which will be sent to the Investment Accounting (InvestOne) / Engine to add this VACRNUM.

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOVACRNUM object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOVACRNUM object.



219

Remarks



Sets the value of a specific field within the currently loaded VACRNUM.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOVACRNUM object.

IO/OLE PROGRAMMER’S GUIDE USING IOSECURITYEXTENSION


220

31. USING IOSECURITYEXTENSION PURPOSE The IOSecurityExtension is used to add additional security information to support the European Savings Directive (EUSD) into Investment Accounting (InvestOne) Engine. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As Sungard.IOConnection Dim sec As Sungard. IOSecurityExtension Dim I As Integer 'Build INVEST ONE Connection set c = New Sungard.IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build SecurityExtension Set sec = c. CreateSecurityExtension 'set the desired SecurityExtension fields sec.SetValue Field:="MODE", Value:=”A” sec.SetValue Field:="SCTYNO", Value:=”IBM” sec.SetValue Field:="SCTYDT", Value:=”01/01/2003” sec.SetValue Field:=" SCTYUNQ", Value:=”1234” sec.SetValue Field:="EFFDT", Value:=”01/31/2005” sec.SetValue Field:="VENDID", Value:=”A” sec.SetValue Field:="SCOPEIN", Value:= “B” sec.SetValue Field:="FCCMRK", Value:=”C” ‘execute the SecurityExtension in INVEST ONE sec.Execute 'show the user any messages returned from INVEST ONE For i = 1 To sec.ReplyCount Debug.Print sec.Reply(i) Next I Set c = nothing Set sec = nothing End Sub



221



Syntax

object.Clear The Clear method syntax has these parts: Part Description object An object expression that evaluates to an IOSecurityExtension object.

Remarks


Sets the IOConnection object associated with this IOSecurityExtension. Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOSecurityExtension object. connect An IOConnection object.

Remarks


Execute Description

Sends the currently loaded IOSecurityExtension to the Investment Accounting (InvestOne) / Engine for processing.



222

Syntax

object.Execute () The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOSecurityExtension object.


Remarks

If the IOSecurityExtension is not accepted by Investment Accounting (InvestOne) for a normal processing, an error will be raised.


Returns the value of a specific field within the currently loaded IOSecurityExtension message.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOSecurityExtension object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks

The settings for Field can be found, with their descriptions, in the Investment Accounting (InvestOne) Software Deveoper’s Kit. The field names are in the right most column labeled Field. OCCUR field itself is an option field which defaults to “1”. The settings for Occur are dependent upon which field is being requested. If the field is “msg1seq”, this may be a value between “1” and “8”. Occur value needs to be specified for all the fields. If it is not specified, default value of “1” will be used.

Message Description

Returns a formatted string which the Investment Accounting (InvestOne) / Engine will accept as a streamed IOSecurityExtension message.



223

Syntax

object.Message() The Message property syntax has these parts: Part Description object An object expression that evaluates to an IOSecurityExtension object.

Remarks

This method returns a string representing the message which will be sent to the Investment Accounting (InvestOne) / Engine to add this IOSecurityExtension.

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOSecurityExtension object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOSecurityExtension object.



224

Remarks



Sets the value of a specific field within the currently loaded IOSecurityExtension.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOSecurityExtension object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOEXCHRATES


225

32. USING IOCOLLATERALMAINTENANCE PURPOSE The IOCollateralMaintenance is used to add and update security collaterals into Investment Accounting (InvestOne) Engine. VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As Sungard.IOConnection Dim scol As Sungard. IOCollateralMaintenance Dim I As Integer 'Build INVEST ONE Connection set c = New Sungard.IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Build CollateralMaintenance Set scol = c. CreateCollateralMaintenance 'set the desired CollateralMaintenance fields scol.SetValue Field:="MODE", Value:=”A” scol.SetValue Field:="SCTYNO", Value:=”IBM” scol.SetValue Field:="SCTYDT", Value:=”01/01/2003” scol.SetValue Field:=" SCTYUNQ", Value:=”1234” scol.SetValue Field:="EFFDT", Value:=”01/31/2005” scol.SetValue Field:="VENDID", Value:=”A” scol.SetValue Field:="SCOPEIN", Value:= “B” scol.SetValue Field:="FCCMRK", Value:=”C” ‘execute the CollateralMaintenance in INVEST ONE scol.Execute 'show the user any messages returned from INVEST ONE For i = 1 To scol.ReplyCount Debug.Print scol.Reply(i) Next I Set c = nothing Set scol = nothing End Sub



226



Syntax

object.Clear The Clear method syntax has these parts: Part Description object An object expression that evaluates to an IOCollateralMaintenance object.

Remarks


Sets the IOConnection object associated with this IOCollateralMaintenance. Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOCollateralMaintenance object. connect An IOConnection object.

Remarks


Execute Description

Sends the currently loaded IOCollateralMaintenance to the Investment Accounting (InvestOne) / Engine for processing.



227

Syntax

object.Execute () The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOCollateralMaintenance object.


Remarks

If the IOCollateralMaintenance is not accepted by Investment Accounting (InvestOne) for a normal processing, an error will be raised.


Returns the value of a specific field within the currently loaded IOCollateralMaintenance message.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOCollateralMaintenance object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks


Message Description

Returns a formatted string which the Investment Accounting (InvestOne) / Engine will accept as a streamed IOCollateralMaintenance message.



228

Syntax

object.Message() The Message property syntax has these parts: Part Description object An object expression that evaluates to an IOCollateralMaintenance object.

Remarks

This method returns a string representing the message which will be sent to the Investment Accounting (InvestOne) / Engine to add this IOCollateralMaintenance.

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description object An object expression that evaluates to an IOCollateralMaintenance object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOCollateralMaintenance object.



229

Remarks



Sets the value of a specific field within the currently loaded IOCollateralMaintenance.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOCollateralMaintenance object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOACCTFEEBALANCES


230

33. USING IOACCTFEEBALANCES

PURPOSE The IOAcctFeeBalances object is used to update Account Fee Balances data in the INVEST ONE Engine.

VISUAL BASIC EXAMPLE

Public Sub MySub() Dim c As IOConnection Dim a As IOAcctFeeBalances Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the AcctFeeBalance object Set a = c. CreateAcctFeeBalances 'set the desired account fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: =" VALDT ", Value:= 20081231 a.SetValue Field:=" FEEOP", Value:=”A a.SetValue Field:=" AEDMULT", Value:=”M” a.SetValue Field:=" ACQUL01", Value:=”12” a.SetValue Field:=" ACAMT01", Value:=”200” 'Execute the Account Fee Balance change request in INVEST ONE Engine a.Execute 'show the user any messages returned from INVEST ONE Engine For i = 1 To a.ReplyCount Debug.Print a.Reply(i) Next I End Sub

PROPERTIES AND METHODS

Clear

Description


Syntax



231

object.Clear The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOAcctFeeBalances object.

Remarks



Sets the IOConnection object associated with this IOAcctFeeBalances.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeBalances object. Connect An IOConnection object.

Remarks


Execute

Description

Sends the currently loaded Account Fee Balance change request to the INVEST ONE / Engine for processing.

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeBalances object.



232

Remarks

If the Account Fee Balances update is not accepted by INVEST ONE, an error will raised.



Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeBalances object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks

The settings for Field can be found, with their descriptions, in the INVEST ONE Software Developer’s Kit. The field names are in the right most column labeled Field. The settings for Occur are dependent upon which field is being requested.

Message

Description

Returns a formatted string that represents the complete Account Fee Balance message as defined within the Data Dictionary ‘FDXFB02 Account Fee Balances Message’.

Syntax

object.Message The Message property syntax has these parts: Part Description Object An object expression that evaluates to an IOAcctFeeBalances object.

Mode Description



233

Returns or sets the type of processing being requested of the INVEST ONE / Engine.

Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeBalances object. action The type of processing being requested of the INVEST ONE / Engine

Settings

The valid settings action parameters are: Setting Description C Change the loaded Account Fee Balance

Remarks

Reply

Description

Contains informational and warning messages returned from the INVEST ONE / Engine.

Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOAcctFeeBalances object. number The number of the reply being requested.

Remarks

The ReplyCount property can be used to retrieve the number of reply messages returned from the INVEST ONE / Engine.




234

Returns the number of reply messages returned from the INVEST ONE / Engine.

Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeBalances object.

Remarks

This property is normally used in conjunction with the Reply() property to interrogate responses from the INVESTONE / Engine.



Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeBalances object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks

The settings for Field can be found, with their descriptions, in Software Developer’s Kit. The field names are in the right most column labeled Field. The settings for Occur are dependent upon which field is being requested.

IO/OLE PROGRAMMER’S GUIDE USING IOACCTFEEBALANCESBLOCK


235

34. USING IOACCTFEEBALANCESBLOCK

PURPOSE

The IOAcctFeeBalancesBlock object is used to update a block of Account Fee Balances data in the INVEST ONE Engine. When sending multiple Account Fee Balances update requests, the IOAcctFeeBalancesBlock is more efficient then using individual IOAcctFeeBalances objects.


Public Sub MySub() Dim c As IOConnection Dim a As IOAcctFeeBalances Dim ab As IOAcctFeeBalancesBlock Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the IOAcctFeeBalances object Set a = c. CreateAcctFeeBalances ' Create the IOAcctFeeBalanceBlock object Set ab = c. CreateAcctFeeBalancesBlock 'set the desired account fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: =" VALDT ", Value:= 20081231 a.SetValue Field:=" FEEOP", Value:=”A a.SetValue Field:=" AEDMULT", Value:=”M” a.SetValue Field:=" ACQUL01", Value:=”12” a.SetValue Field:=" ACAMT01", Value:=”200” ab.StageAcctFeeBal (a.Message()) 'clear the IOAcctFeeBalances object for the next account a.Clear 'set the desired account fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12346 a.SetValue Field: =" VALDT ", Value:= 20081231 a.SetValue Field:=" FEEOP", Value:=”A a.SetValue Field:=" AEDMULT", Value:=”M” a.SetValue Field:=" ACQUL01", Value:=”12” a.SetValue Field:=" ACAMT01", Value:=”200”



236

ab.StageAcctFeeBal (a.Message()) 'execute the the block of Account Fee Balances update requests in the INVEST ONE Engine ab.Execute 'show the user any messages returned from INVEST ONE Debug.Print “+++ First Account Fee Balances Update Request Messages For i = 1 To ab.ReplyCount(0) Debug.Print ab.Reply(0, i) Next I Debug.Print “+++ Second Account Fee Balances Update Request Messages For i = 1 To ab.ReplyCount(1) Debug.Print ab.Reply(1, i) Next i End Sub


AcctFeeBalCount

Description

Returns the number of Account Fee Balances update requests currently contained within the block.

Syntax

object.AcctFeeCount The AcctFeeBalCount property syntax has these parts: Part Description Object An object expression that evaluates to an IOAcctFeeBalancesBlock

object.


Sets the IOConnection object associated with this IOAcctFeeBalancesBlock.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeBalancesBlock

object. Connect An IOConnection object.



237

Remarks


Execute

Description

Sends the currently staged Account Fee Balances update requests to the INVEST ONE Engine for processing.

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeBalancesBlock

object.

Reply Description

Contains informational and warning messages returned from the INVEST ONE Engine.

Syntax

object.Reply( account,number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOAcctFeeBalancesBlock

object. Account The position of the account within the block. (The first account is

position 0) number The number of the reply being requested.

Remarks

The AcctFeeBalCount property can be used to determine the total number of Account Fee Balances update requests in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the INVEST ONE Engine for each account. .



238

ReplyCount

Description

Returns the number of reply messages returned from the INVEST ONE Engine for a given executed account. .

Syntax

object.ReplyCount(account) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeBalancesBlock

object. Account The position of the account within the block. (The first Account Fee

Balances update request is position 0)

Remarks

This property is normally used in conjunction with the Reply() property to interrogate responses from the INVEST ONE Engine.

StageAcctFeeBal Description

Stages a given Account Fee Balances update request message into the block.

Syntax

object. StageAcctFeeBal (AcctFeeBalMsg ) The StageAcctFeeBal method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeBalancesBlock

object. AcctMsg A string value provided from the Message property of an

IOAcctFeeBalances object.

Remarks

The AcctFeeBalMsg string is actually a formatted FDXFB02 message as specified in the Data Dictionary. While you could format the string without using the IOAcctFeeBalances object, this is not recommended due to release independence.

IO/OLE PROGRAMMER’S GUIDE USING IOACCTFEESCHEDULE


239

35. USING IOACCTFEESCHEDULE

PURPOSE

The IOAcctFeeSchedule object is used to add, change and delete Fixed Expense Fee Schedule information in the INVEST ONE Engine.


Public Sub MySub() Dim c As IOConnection Dim a As IOAcctFeeSchedule Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the AcctFeeSchedule object Set a = c. CreateAcctFeeSchedule 'set the desired Account Fee Schedule fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: =" SCTYUNQ ", Value:= 100 a.SetValue Field:=" EXECDT ", Value:=” 20081231” a.SetValue Field:=" FETYPE ", Value:=”U” a.SetValue Field:=" FEE01 ", Value:=”100” a.SetValue Field:=" RAT01 ", Value:=”0.95” a.SetValue Field:=" FEE02 ", Value:=”200” a.SetValue Field:=" RAT02 ", Value:=”0.85” a.Execute 'show the user any messages returned from INVEST ONE Engine For i = 1 To a.ReplyCount Dubug.Print a.Reply(i) Next I End Sub


Clear

Description


Syntax



240

object.Clear The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOAcctFeeSchedule object.

Remarks



Sets the IOConnection object associated with this IOAcctFeeSchedule.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeSchedule object. Connect An IOConnection object.

Remarks


Execute

Description

Sends the currently loaded transaction to the INVEST ONE Engine for processing.

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeSchedule object.

Remarks



241

If the Account Fee Schedule update is not accepted by INVEST ONE, an error will be raised.



Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeSchedule object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Message

Description

Returns a formatted string that represents the complete Account Fee Schedule message as defined within the Data Dictionary ‘FDXFS02 Account Fee Schedule Message’.

Syntax

object.Message The Message property syntax has these parts: Part Description Object An object expression that evaluates to an IOAcctFeeSchedule object.

Remarks

This method returns a string representing the message which will be sent to the INVEST ONE Engine to add this transaction.. It is used in conjunction with the StageAcctFeeSched function in the IOAcctFeeScheduleBlock object.



242

Mode Description

Returns or sets the type of processing being requested of the INVEST ONE Engine.

Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeSchedule object. action The type of processing being requested of the INVEST ONE Engine

Settings

The valid settings action parameter are: Setting Description A Use to add a fee schedule for an expense security to an account for the first

time. C Add subsequent fee schedules for the same security for different effective

dates.

Remarks

To delete a fee schedule, place a 'D' in FEE BASIS TYPE while in CHANGE mode. A fee schedule may only be deleted if both the ELIG FOR DELETE DATE and the EFFECTIVE DATE are on the same side of the account's VERIFICATION DATE (either both dates are earlier than the VERIFICATION DATE or both dates are later than the VERIFICATION DATE).

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts:



243

Part Description Object An object expression that evaluates to an IOAcctFeeSchedule object. number The number of the reply being requested.

Remarks

The ReplyCount property can be used to retrieve the number of reply messages returned from the INVEST ONE Engine.


Returns the number of reply messages returned from the INVEST ONE Engine.

Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeSchedule object.

Remarks

This property is normally used in conjunction with the Reply() property to interrogate responses from the INVESTONE Engine.


Sets the value of a specific field within the currently loaded Account Fee Schedule message.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeSchedule object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks



244


IO/OLE PROGRAMMER’S GUIDE USING IOACCTFEESCHEDULEBLOCK


245

36. USING IOACCTFEESCHEDULEBLOCK

PURPOSE The IOAcctFeeScheduleBlock object is used to add, change and delete Fixed Expense Fees Schedule information in the INVEST ONE Engine.


Public Sub MySub() Dim c As IOConnection Dim a As IOAcctFeeSchedule Dim ab As IOAcctFeeScheduleBlock Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the IOAcctFeeSchedule object Set a = c. CreateAcctFeeSchedule ' Create the IOAcctFeeScheduleBlock object Set ab = c. CreateAcctFeeScheduleBlock 'set the desired fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: =" SCTYUNQ ", Value:= 100 a.SetValue Field:=" EXECDT ", Value:=” 20081231” a.SetValue Field:=" FETYPE ", Value:=”U” a.SetValue Field:=" FEE01 ", Value:=”100” a.SetValue Field:=" RAT01 ", Value:=”0.95” a.SetValue Field:=" FEE02 ", Value:=”200” a.SetValue Field:=" RAT02 ", Value:=”0.85” ab. StageAcctFeeSched(a.Message()) a.Clear 'set the desired fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12346 a.SetValue Field: =" SCTYUNQ ", Value:= 100 a.SetValue Field:=" EXECDT ", Value:=” 20081231” a.SetValue Field:=" FETYPE ", Value:=”U” a.SetValue Field:=" FEE01 ", Value:=”100” a.SetValue Field:=" RAT01 ", Value:=”0.95” a.SetValue Field:=" FEE02 ", Value:=”200” a.SetValue Field:=" RAT02 ", Value:=”0.85” ab. StageAcctFeeSched(a.Message()) 'execute the Account Fee Schedule block in INVEST ONE



246

ab.Execute 'show the user any messages returned from INVEST ONE Debug.Print “+++ First Account Messages For i = 1 To ab.ReplyCount(0) Debug.Print ab.Reply(0, i) Next I Debug.Print “+++ Second Account Messages For i = 1 To ab.ReplyCount(1) Debug.Print ab.Reply(1, i) Next i End Sub


AcctFeeSchedCount

Description

Returns the number of Account Fee Schedule update requests currently contained within the block.

Syntax

object.AcctFeeSchedCount The AcctFeeSchedCount property syntax has these parts: Part Description Object An object expression that evaluates to an IOAcctFeeScheduleBlock

object.


Sets the IOConnection object associated with this IOAcctFeeScheduleBlock.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeScheduleBlock


Remarks



247


Execute

Description

Sends the currently staged Account Fee Schedule update requests to the INVEST ONE Engine for processing.

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeScheduleBlock

object.

Reply Description


Syntax

object.Reply( AcctFeeSched, number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOAcctFeeScheduleBlock

object. AcctFeeSched The position of the Account Fee Schedule update request account

within the block. (The first request is position 0) number The number of the reply being requested.

Remarks

The AcctFeeSchedCount property can be used to determine the total number of requests in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the INVEST ONE Engine for each request.



248


Returns the number of reply messages returned from the INVEST ONE Engine for a given request. .

Syntax

object.ReplyCount(account) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeScheduleBlock

object. Account The position of the account within the block. (The first account is

position 0)

Remarks


StageAcctFeeSched Description

Stages a given Account Fee Schedule message into the block.

Syntax

object. StageAcctFeeSched (AcctFeeSchedMsg ) The StageAcctFeeSched method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctFeeScheduleBlock

object. AcctFeeSchedMsg A string value provided from the Message property of an

IOAcctFeeSchedule object.

Remarks



249

The AcctFeeSchedMsg string is actually a formatted FDXFS02 message as specified in the Data Dictionary. While you could format the string without using the IOAcctFeeScheduleBlock object, this is not recommended due to release independence.

IO/OLE PROGRAMMER’S GUIDE USING IOCALENDARSET


250

37. USING IOCALENDARSET

PURPOSE The IOCalendarSet object is used to add, change and delete the calendar set record, with default values for a specified year in the INVEST ONE Engine.


Public Sub MySub() Dim c As IOConnection Dim a As IOCalendarSet Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the IOCalenderSet object Set a = c. CreateCalendarSet 'set the desired account fields a.SetValue Field:="MODE", Value:="A" a.SetValue Field:=" CALSET ", Value:=”UK” a.SetValue Field: =" MODCAL ", Value:= “” a.SetValue Field:=" YEAR ", Value:=” 2007” a.SetValue Field:=" FDOFFST ", Value:=” 0” a.SetValue Field:=" BROCAL ", Value:=”” a.SetValue Field:=" CALPAT ", Value:=”” a.SetValue Field:=" Jan", Value:=”H” a.Execute 'show the user any messages returned from INVEST ONE For i = 1 To t.ReplyCount Dubug.Print t.Reply(i) Next I End Sub


Clear

Description


Syntax

object.Clear



251

The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOCalendarSet object.

Remarks



Sets the IOConnection object associated with this IOCalendarSet.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOCalendarSet object. Connect An IOConnection object.

Remarks


Execute

Description


Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOCalendarSet object.

Remarks



252

If the CalenderSet update is not accepted by the INVEST ONE Engine, an error will be raised..


Returns the value of a specific field within the currently loaded CalendarSet.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOCalendarSet object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks

The settings for Field can be found, with their descriptions, in the INVEST ONE Software Developer’s Kit. The field names are in the right most column labeled Field.The settings for Occur are dependent upon which field is being requested.

Message

Description

Returns a formatted string that represents the complete CalenderSet message as defined within the Data Dictionary ‘FDXCN01 Calender Set message’.

Syntax

object.Message The Message property syntax has these parts: Part Description Object An object expression that evaluates to an IOCalendarSet object.

Remarks

This method returns a string representing the message which be sent to the INVEST ONE /Engine to add this calenderSet. It is used in conjunction with the StageCalendarSet function in the IOCalendarSetBlock object.



253

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOCalendarSet object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOCalendarSet object.

Remarks




Syntax

object.SetValue ( Field , Value, [Occur] )



254

The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOCalendarSet object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks

The settings for Field can be found, with their descriptions, in the Software Developer’s Kit. The field names are in the rightmost column labeled Field. The settings for Occur are dependent upon which field is being requested.

IO/OLE PROGRAMMER’S GUIDE USING IOCALENDARSETBLOCK


255

38. USING IOCALENDARSETBLOCK

PURPOSE The IOCalendarSetBlock object is used to add, change and delete multiple calendar set records, with default values for a specified year in the INVEST ONE Engine. .


Public Sub MySub() Dim c As IOConnection Dim a As IOCalendarSet Dim ab As IOCalendarSetBlock Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the IOCalendarSet object Set a = c. CreateCalendarSet ' Create the IOCalendarSetBlock object Set ab = c. CreateCalendarSetBlock 'set the desired fields a.SetValue Field:="MODE", Value:="A" a.SetValue Field:=" CALSET ", Value:=”UK” a.SetValue Field: =" MODCAL ", Value:= “” a.SetValue Field:=" YEAR ", Value:=” 2007” a.SetValue Field:=" FDOFFST ", Value:=” 0” a.SetValue Field:=" BROCAL ", Value:=”” a.SetValue Field:=" CALPAT ", Value:=”” a.SetValue Field:=" Jan", Value:=”H” ab.StageCalendarSet (a.Message()) a.clear 'set the desired fields a.SetValue Field:="MODE", Value:="A" a.SetValue Field:=" CALSET ", Value:=”US” a.SetValue Field: =" MODCAL ", Value:= “” a.SetValue Field:=" YEAR ", Value:=” 2007” a.SetValue Field:=" FDOFFST ", Value:=” 0” a.SetValue Field:=" BROCAL ", Value:=”” a.SetValue Field:=" CALPAT ", Value:=”” a.SetValue Field:=" Jan", Value:=”H” ab.StageCalendarSet (a.Message()) 'execute the calendar set block in INVEST ONE



256

ab.Execute 'show the user any messages returned from INVEST ONE Debug.Print “+++ First Calendar Set Messages For i = 1 To ab.ReplyCount(0) Debug.Print ab.Reply(0, i) Next I Debug.Print “+++ Second Calendar Set Messages For i = 1 To ab.ReplyCount(1) Debug.Print ab.Reply(1, i) Next i End Sub


CalendarSetCount

Description

Returns the number of Calendar Set objects currently contained within the block.

Syntax

object.CalendarSetCount The CalendarSetCount property syntax has these parts: Part Description Object An object expression that evaluates to an IOCalenderSetBlock object.


Sets the IOConnection object associated with this IOCalenderSetBlock.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOCalenderSetBlock object. Connect An IOConnection object.

Remarks



257


Execute

Description

Sends the currently staged Calendar Set objects to the INVEST ONE Engine for processing.

Syntax

object.Execute () The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOCalendarSetBlock object.

Reply Description


Syntax

object.Reply( calendarset,number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOCalendarSetBlock object. calendarSet The position of the calendarset within the block. (The first calendarset is

position 0) number The number of the reply being requested.

Remarks

The CalendarSetCount property can be used to determine the total number of Calendar Set objects in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the INVEST ONE Engine for each account. .




258

Returns the number of reply messages returned from the INVEST ONE Engine for a given executed account. .

Syntax

object.ReplyCount(calendarSet) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOCalendarSetBlock object. calendarSet The position of the calendarSet within the block. (The first calendarSet is

position 0)

Remarks


StageCalendarSet Description

Stages a given calendar set message into the block.

Syntax

object. StageCalendarSet ( calMsg ) The StageCalendarSet method syntax has these parts: Part Description object An object expression that evaluates to an IOCalendarSetBlock object. calMsg A string value provided from the Message property of an IOCalendarSet

object.

Remarks

The calMsg string is actually a formatted FDXCN01 message as specified in the Data Dictionary. While you could format the string without using the IOCalendarSetBlock object, this is not recommended due to release independence.

IO/OLE PROGRAMMER’S GUIDE USING IOEFFECTIVEYIELD


259

39. USING IOEFFECTIVEYIELD

PURPOSE The IOEffectiveYield object is used to add or change effective yield records for a specified date or a specific memo and specified date via the DEEY screen.


Public Sub MySub() Dim c As IOConnection Dim a As IOEffectiveYield Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ‘Create the IOEffectiveYield object Set a = c. CreateEffectiveYield 'set the desired fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: =" SCTYNO ", Value:= 100 a.SetValue Field:=" SCTYDT ", Value:=” 20081231” a.SetValue Field:=" SCTYUNQ ", Value:=”123456” a.SetValue Field:=" TRDORD ", Value:=”123456” a.SetValue Field:=" EFDTYLD ", Value:=” 20081231” a.SetValue Field:=" EFYLD ", Value:=”9.99” a.Execute 'show the user any messages returned from INVEST ONE For i = 1 To a.ReplyCount Dubug.Print a.Reply(i) Next I End Sub


Clear

Description


Syntax

object.Clear



260

The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOEffectiveYield object.

Remarks



Sets the IOConnection object associated with this IOEffectiveYield.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOEffectiveYield object. Connect An IOConnection object.

Remarks


Execute

Description

Sends the currently loaded Effective Yield object to the INVEST ONE / Engine for processing.

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOEffectiveYield object.

Remarks

If the Effective Yield is not accepted by INVEST ONE an error will be raised.



261

GetValue

Description

Returns the value of a specific field within the currently loaded Effective Yield object.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOEffectiveYield object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Message

Description

Returns a formatted string that represents the complete IOEffectiveYield message as defined within the Data Dictionary ‘FDXEY01 IOEffectiveYield Message’.

Syntax

object.Message The Message property syntax has these parts: Part Description Object An object expression that evaluates to an IOEffectiveYield object.

Remarks

This method returns a string representing the message which will be sent to the INVEST ONE Engine to add this Effective Yield. It is used in conjunction with the StageEffYld function in the IOEffectiveYieldBlock object.

Mode Description



262


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOEffectiveYield object. action The type of processing being requested of the INVEST ONE Engine

Settings

The valid settings action parameter are: Setting Description A Use to add an effective yield for a security to an account for the first time. C Change the effective yield.

Remarks

Effective Yields screen is valid only for strip securities (IO, PO, IOette). The effective yield must be explicitly input by the user as InvestOne Enterprise does not calculate it. The effective date for a taxlot level yield must be a valuation date for that taxlot. Value of 0.00 deletes the current yield in effect.

Reply Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOEffectiveYield object. number The number of the reply being requested.

Remarks



263




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOEffectiveYield object.

Remarks



Sets the value of a specific field within the currently loaded Effective Yield object.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOEffectiveYield object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks

The settings for Field can be found, with their descriptions, in the Software Developer’s Kit. The field names are in the right most column labeled Field. The settings for Occur are dependent upon which field is being requested.

IO/OLE PROGRAMMER’S GUIDE USING IOEFFECTIVEYIELDBLOCK


264

40. USING IOEFFECTIVEYIELDBLOCK

PURPOSE The IOEffectiveYieldBlock object is used to add or change multiple effective yield records for a specified date or a specific memo and specified date.


Public Sub MySub() Dim c As IOConnection Dim a As IOEffectiveYield Dim ab As IOEffectiveYieldBlock Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the IOEffectiveYield object Set a = c. CreateEffectiveYield ' Create the IOEffectiveYield Block object Set ab = c. CreateEffectiveYieldBlock 'set the desired fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: =" SCTYNO ", Value:= 100 a.SetValue Field:=" SCTYDT ", Value:=” 20081231” a.SetValue Field:=" SCTYUNQ ", Value:=”123456” a.SetValue Field:=" TRDORD ", Value:=”123456” a.SetValue Field:=" EFDTYLD ", Value:=” 20081231” a.SetValue Field:=" EFYLD ", Value:=”9.99” ab. StageEffYld(a.Message()) a.Clear 'set the desired fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=123556 a.SetValue Field: =" SCTYNO ", Value:= 100 a.SetValue Field:=" SCTYDT ", Value:=” 20081231” a.SetValue Field:=" SCTYUNQ ", Value:=”123456” a.SetValue Field:=" TRDORD ", Value:=”123456” a.SetValue Field:=" EFDTYLD ", Value:=” 20081231” a.SetValue Field:=" EFYLD ", Value:=”9.99” ab. StageEffYld(a.Message()) ab.Execute 'show the user any messages returned from INVEST ONE



265

Debug.Print “+++ First Request Messages For i = 1 To ab.ReplyCount(0) Debug.Print ab.Reply(0, i) Next I Debug.Print “+++ Second Request Messages For i = 1 To ab.ReplyCount(1) Debug.Print ab.Reply(1, i) Next i End Sub


EffYldCount

Description

Returns the number of Effective Yield objects currently contained within the block.

Syntax

object.EffYldCount The EffYldCount property syntax has these parts: Part Description Object An object expression that evaluates to an IOEffectiveYieldBlock object.


Sets the IOConnection object associated with this IOEffectiveYieldBlock.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOEffectiveYieldBlock object. Connect An IOConnection object.

Remarks



266


Execute

Description

Sends the currently staged Effective Yield objects to the INVEST ONE Engine for processing.

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOEffectiveYieldBlock object.

Reply Description


Syntax

object.Reply(request, number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOEffectiveYieldBlock object. request The position of the request within the block. (The first account is position

0) number The number of the reply being requested.

Remarks

The EffYldCount property can be used to determine the total number of requests in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the INVEST ONE Engine for each request. .

ReplyCount



267

Description

Returns the number of reply messages returned from the INVEST ONE Engine for a given executed request. .

Syntax

object.ReplyCount(account) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOEffectiveYieldBlock object. account The position of the request within the block. (The first request is position

0)

Remarks


StageEffYld Description

Stages a given Effective Yield message into the block.

Syntax

object. StageEffYld (EffYldMsg ) The StageEffYld method syntax has these parts: Part Description object An object expression that evaluates to an IOEffectiveYieldBlock object. EffYldMsg A string value provided from the Message property of an

IOEffectiveYield object.

Remarks

The EffYldMsg string is actually a formatted FDXEY01 message as specified in the Data Dictionary. While you could format the string without using the IOEffectiveYieldBlock object, this is not recommended due to release independence.



268

41. USING IOEXCHRATES

PURPOSE The IOExchRates object is used to add and update exchange rates. An exchange rate can be entered for each currency with a designated source, time, and type. A spot rate and up to nine user designated forward rates can be entered via a variable length input record.


Public Sub MySub() Dim c As IOConnection Dim a As IOExchRates Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the IOExchRates object Set a = c. CreateExchRates 'set the desired account fields a.SetValue Field:="MODE", Value:="U" a.SetValue Field:="BASECC", Value:=”USD” a.SetValue Field: ="CURR", Value:= “AUD” a.SetValue Field:="RDATE", Value:=” 20081231” a.SetValue Field:="PRSRCE", Value:=” VF” a.SetValue Field:="PRTIME", Value:=” 11” a.SetValue Field:="RTIND", Value:=”D” a.SetValue Field:="RTYPE", Value:=”XM” a.SetValue Field:="RLEN", Value:=”0” a.SetValue Field:="RATE", Value:=” 1.36621” a.Execute 'show the user any messages returned from INVEST ONE For i = 1 To a.ReplyCount Debug.Print a.Reply(i) Next I End Sub


Clear

Description


Syntax



269

object.Clear The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOExchRates object.

Remarks



Sets the IOConnection object associated with this IOExchRates object.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOExchRates object. Connect An IOConnection object.

Remarks


Execute

Description


Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOExchRates object.



270

Remarks

If the ExchRates is not accepted by INVEST ONE an error will be raised.


Returns the value of a specific field within the currently loaded Exchange Rates object.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOExchRates object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Message

Description

Returns a formatted string that represents the complete Exchange Rates message as defined within the Data Dictionary ‘FDXUR02 ExchRates message’.

Syntax

object.Message The Message property syntax has these parts: Part Description Object An object expression that evaluates to an IOExchRates object.

Remarks

This method returns a string representing the message which will be sent to the INVEST ONE Engine to add the Exchange Rates. It is used in conjunction with the StageExchRate function in the IOExchRatesBlock object.



271

Mode

Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOExchRates object. action The type of processing being requested of the INVEST ONE Engine

Settings

The valid settings action parameter are: Setting Description A Use to add an exchange rate for the first time. U Use to update an exchange rate.

Remarks

Reply

Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOExchRates object. number The number of the reply being requested.

Remarks



272




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOExchRates object.

Remarks



Sets the value of a specific field within the currently loaded Exchange Rates object.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOExchRates object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOEXCHRATESBLOCK


273

42. USING IOEXCHRATESBLOCK

PURPOSE The IOExchRatesBlock object is used to send a block of Exchange Rates messages to the Invest One Engine.


Public Sub MySub() Dim c As IOConnection Dim a As IOExchRates Dim ab As IOExchRatesBlock Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the IOExchRates object Set a = c. CreateExchRates ' Create the IOExchRatesBlock object Set ab = c. CreateExchRatesBlock 'set the desired fields a.SetValue Field:="MODE", Value:="U" a.SetValue Field:="BASECC", Value:=”USD” a.SetValue Field: ="CURR", Value:= “AUD” a.SetValue Field:="RDATE", Value:=” 20081231” a.SetValue Field:="PRSRCE", Value:=” VF” a.SetValue Field:="PRTIME", Value:=” 11” a.SetValue Field:="RTIND", Value:=”D” a.SetValue Field:="RTYPE", Value:=”XM” a.SetValue Field:="RLEN", Value:=”0” a.SetValue Field:="RATE", Value:=” 1.36621” ab.StageExchRate(a.Message()) a.Clear 'set the desired fields a.SetValue Field:="MODE", Value:="U" a.SetValue Field:="BASECC", Value:=”UK” a.SetValue Field: ="CURR", Value:= “AUD” a.SetValue Field:="RDATE", Value:=” 20081231” a.SetValue Field:="PRSRCE", Value:=” VF” a.SetValue Field:="PRTIME", Value:=” 11” a.SetValue Field:="RTIND", Value:=”D” a.SetValue Field:="RTYPE", Value:=”XM” a.SetValue Field:="RLEN", Value:=”0” a.SetValue Field:="RATE", Value:=” 1.36621” ab. StageExchRate(a.Message())



274

ab.Execute 'show the user any messages returned from INVEST ONE Debug.Print “+++ First Request Messages For i = 1 To ab.ReplyCount(0) Debug.Print ab.Reply(0, i) Next I Debug.Print “+++ Second Request Messages For i = 1 To ab.ReplyCount(1) Debug.Print ab.Reply(1, i) Next i End Sub


ExchRateCount

Description

Returns the number of exchange rates currently contained within the block.

Syntax

object.ExchRateCount The ExchRateCount property syntax has these parts: Part Description Object An object expression that evaluates to an IOExchRatesBlock object.


Sets the IOConnection object associated with this IOExchRatesBlock.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOExchRatesBlock object. Connect An IOConnection object.



275

Remarks


Execute

Description

Sends the currently staged Exchange Rates object to the INVEST ONE Engine for processing.

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOExchRatesBlock object.

Reply Description


Syntax

object.Reply(account,number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOExchRatesBlock object. account The position of the request within the block. (The first request is position

0) number The number of the reply being requested.

Remarks

The ExchRateCount property can be used to determine the total number of requests in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the INVEST ONE Engine for each account. .




276


Syntax

object.ReplyCount(account) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOExchRatesBlock object. account The position of the request within the block. (The first request is position

0)

Remarks


StageExchRate Description

Stages a given IOExchRates message into the block.

Syntax

object.StageExchRate ( ExchRatesMsg ) The StageExchRate method syntax has these parts: Part Description object An object expression that evaluates to an IOExchRatesBlock object. ExchRatesMsg

A string value provided from the Message property of an IOExchRates object.

Remarks

The ExchRatesMsg string is actually a formatted FDXUR02 message as specified in the Data Dictionary. While you could format the string without using the IOExchRatesBlock object, this is not recommended due to release independence.

IO/OLE PROGRAMMER’S GUIDE USING IOFIXEDEXPENSES


277

43. USING IOFIXEDEXPENSES

PURPOSE The IOFixedExpenses object is used to add and change Fixed Expense Fees Schedule information in the INVEST ONE Engine.


Public Sub MySub() Dim c As IOConnection Dim a As IOFixedExpenses Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the IOFixedExpenses object Set a = c. CreateFixedExpenses 'set the desired fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: ="SCTYUNQ ", Value:= 1125 a.SetValue Field:="SCTYDT ", Value:=” 20081231” a.SetValue Field:="FYEDT ", Value:=” 20080731” a.SetValue Field:="EXECDT", Value:=” 20080731” a.SetValue Field:="AMTYP", Value:=”E” a.SetValue Field:="AMT", Value:=”1200” a.Execute 'show the user any messages returned from INVEST ONE For i = 1 To a.ReplyCount Dubug.Print a.Reply(i) Next I End Sub


Clear

Description


Syntax

object.Clear



278

The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOFixedExpenses object.

Remarks



Sets the IOConnection object associated with this IOFixedExpenses.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOFixedExpenses object. Connect An IOConnection object.

Remarks


Execute

Description


Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOFixedExpenses object.

Remarks



279

If the Fixed Expenses request is not accepted by INVEST ONE an error will be raised.


Returns the value of a specific field within the currently loaded Fixed Expenses object.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOFixedExpenses object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Message

Description

Returns a formatted string that represents the complete Fixed Expenses message as defined within the Data Dictionary ‘FDXFE01 Fixed Expenses message’.

Syntax

object.Message The Message property syntax has these parts: Part Description Object An object expression that evaluates to an IOFixedExpenses object.

Remarks

This method returns a string representing the message which will be sent to the INVEST ONE Engine to add the Fixed Expenses. It is used in conjunction with the StageFixedExpenses function in the IOFixedExpensesBlock object.

Mode Description



280


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOFixedExpenses object. action The type of processing being requested of the INVEST ONE Engine

Settings

The valid settings action parameter are: Setting Description A Use to add a fixed expense for an expense security to an account for the

first time. C Add subsequent fixed expenses for the same security.

Remarks

Reply

Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOFixedExpenses object. number The number of the reply being requested.

Remarks




281



Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOFixedExpenses object.

Remarks



Sets the value of a specific field within the currently loaded Fixed Expenses object.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOFixedExpenses object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOFIXEDEXPENSESBLOCK


282

44. USING IOFIXEDEXPENSESBLOCK

PURPOSE The IOFixedExpensesBlock object is used to add and change multiple Fixed Expenses in the INVEST ONE Engine.


Public Sub MySub() Dim c As IOConnection Dim a As IOFixedExpenses Dim ab As IOFixedExpensesBlock Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the IOFixedExpenses object Set a = c. CreateFixedExpenses ' Create the IOFixedExpensesBlock object Set ab = c. CreateFixedExpensesBlock 'set the desired fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: ="SCTYUNQ ", Value:= 1125 a.SetValue Field:="SCTYDT ", Value:=” 20081231” a.SetValue Field:="FYEDT ", Value:=” 20080731” a.SetValue Field:="EXECDT", Value:=” 20080731” a.SetValue Field:="AMTYP", Value:=”E” a.SetValue Field:="AMT", Value:=”1200” ab. StageFixedExpenses(a.Message()) a.Clear 'set the desired account fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12367 a.SetValue Field: ="SCTYUNQ ", Value:= 1125 a.SetValue Field:="SCTYDT ", Value:=” 20081231” a.SetValue Field:="FYEDT ", Value:=” 20080731” a.SetValue Field:="EXECDT", Value:=” 20080731” a.SetValue Field:="AMTYP", Value:=”E” a.SetValue Field:="AMT", Value:=”1200” ab. StageFixedExpenses(a.Message()) ab.Execute



283

'show the user any messages returned from INVEST ONE Debug.Print “+++ First Request Messages For i = 1 To ab.ReplyCount(0) Debug.Print ab.Reply(0, i) Next I Debug.Print “+++ Second Request Messages For i = 1 To ab.ReplyCount(1) Debug.Print ab.Reply(1, i) Next i End Sub


FixedExpensesCount

Description

Returns the number of Fixed Expense objects currently contained within the block.

Syntax

object.FixedExpensesCount The FixedExpensesCount property syntax has these parts: Part Description Object An object expression that evaluates to an IOFixedExpensesBlock

object.


Sets the IOConnection object associated with this IOFixedExpensesBlock.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOFixedExpensesBlock


Remarks



284


Execute

Description

Sends the currently staged Fixed Expenses to the INVEST ONE Engine for processing.

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOFixedExpensesBlock

object.

Reply Description


Syntax

object.Reply(fixedExpense,number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOFixedExpensesBlock

object. fixedExpense

The position of the Fixed Expense request within the block. number The number of the reply being requested.

Remarks

The FixedExpensesCount property can be used to determine the total number of requests in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the INVEST ONE Engine for each request. .

ReplyCount



285

Description


Syntax

object.ReplyCount(fixedExpense) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOFixedExpensesBlock

object. fixedExpense The position of the Fixed Expense request within the block.

Remarks


StageFixedExpenses Description

Stages a given FixedExpenses message into the block.

Syntax

object. StageFixedExpenses ( fixedExpMsg ) The StageFixedExpenses method syntax has these parts: Part Description object An object expression that evaluates to an IOFixedExpensesBlock

object. fixedExpMsg A string value provided from the Message property of an

IOFixedExpenses object.

Remarks

The fixedExpMsg string is actually a formatted FDXFE01 message as specified in the Data Dictionary. While you could format the string without using the IOFixedExpensesBlock object, this is not recommended due to release independence.

IO/OLE PROGRAMMER’S GUIDE USING IOPREPAYRATE


286

45. USING IOPREPAYRATE

PURPOSE

The IOPrepayrate object is used to add, change, and delete prepayment rates information in the INVEST ONE Engine.


Public Sub MySub() Dim c As IOConnection Dim a As IOPrepayrate Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the IOPrepayrate object Set a = c. CreatePrepayRate 'set the desired fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: ="SCTYNO", Value:= 1125 a.SetValue Field:="SCTYDT ", Value:=” 20081231” a.SetValue Field:="SCTYUNQ", Value:=” 20080731” a.SetValue Field:="EFFDT", Value:=” 20080731” a.SetValue Field:="TYPE", Value:=”C” a.SetValue Field:="RATE", Value:=”8.75” a.Execute 'show the user any messages returned from INVEST ONE For i = 1 To a.ReplyCount Dubug.Print a.Reply(i) Next I End Sub


Clear

Description


Syntax

object.Clear



287

The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOPrepayrate object.

Remarks



Sets the IOConnection object associated with this IOPrepayrate.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOPrepayrate object. Connect An IOConnection object.

Remarks


Execute

Description

Sends the currently loaded prepayment rate request to the INVEST ONE Engine for processing.

Syntax

object.Execute ([Sweep] ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOPrepayrate object. Sweep An optional named parameter indicating if the Prepayrates should be

applied immediately by the INVEST ONE Engine

Remarks



288

If the Prepayrate is not accepted by INVEST ONE an error will be raised.


Returns the value of a specific field within the currently loadedrequest.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOPrepayrate object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks

The settings for Field can be found, with their descriptions, in the INVEST ONE Software Developer’s Kit. The field names are in the rightmost column labeled Field. The settings for Occur are dependent upon which field is being requested.

Message

Description

Returns a formatted string that represents the complete Prepayrate message as defined within the Data Dictionary ‘FDXMP01 Prepayrate message’.

Syntax

object.Message The Message property syntax has these parts: Part Description Object An object expression that evaluates to an IOPrepayrate object.

Remarks

This method returns a string representing the message which will be sent to the INVEST ONE Engine to add this Prepayrate..It is used in conjunction with the StagePrepayrate function in the IOPrepayrateBlock object.

Mode



289

Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOPrepayrate object. action The type of processing being requested of the INVEST ONE Engine

Settings

The valid settings action parameter are: Setting Description A Use to add a pre payment rate for the first time. C Add subsequent prepayment rate for the same security. D Deletes the prepayment rate.

Remarks

Reply

Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOPrepayrate object. number The number of the reply being requested.

Remarks




290

ReplyCount

Description


Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOPrepayrate object.

Remarks



Sets the value of a specific field within the currently loaded request.

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOPrepayrate object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOPREPAYRATEBLOCK


291

46. USING IOPREPAYRATEBLOCK

PURPOSE The IOPrepayRateBlock object is used to add, change, and delete multiple prepayment rates in the INVEST ONE Engine.


Public Sub MySub() Dim c As IOConnection Dim a As IOPrepayrate Dim ab As IOPrepayrateBlock Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the IOPrepayrate object Set a = c. CreatePrepayRate ' Create the IOPrepayRateBlock object Set ab = c. CreatePrepayRateBlock 'set the desired fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: ="SCTYNO", Value:= 1125 a.SetValue Field:="SCTYDT ", Value:=” 20081231” a.SetValue Field:="SCTYUNQ", Value:=” 20080731” a.SetValue Field:=" EFFDT", Value:=” 20080731” a.SetValue Field:="TYPE", Value:=”C” a.SetValue Field:="RATE", Value:=”8.75” ab.StagePrepayRate(a.Message()) a.Clear 'set the desired fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12355 a.SetValue Field: ="SCTYNO", Value: = 1125 a.SetValue Field:="SCTYDT ", Value:=” 20081231” a.SetValue Field:="SCTYUNQ", Value:=” 20080731” a.SetValue Field:="EFFDT", Value:=” 20080731” a.SetValue Field:="TYPE", Value:=”C” a.SetValue Field:="RATE", Value:=”8.75” ab.StagePrepayRate(a.Message()) ab.Execute 'show the user any messages returned from INVEST ONE



292

Debug.Print “+++ First Request Messages For i = 1 To ab.ReplyCount(0) Debug.Print ab.Reply(0, i) Next I Debug.Print “+++ Second Request Messages For i = 1 To ab.ReplyCount(1) Debug.Print ab.Reply(1, i) Next i End Sub


PrepayRateCount

Description

Returns the number of Prepayrate requests currently contained within the block.

Syntax

object.PrepayRateCount The PrepayRateCount property syntax has these parts: Part Description Object An object expression that evaluates to an IOPrepayRateBlock object.


Sets the IOConnection object associated with this IOPrepayRateBlock.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOPrepayRateBlock object. Connect An IOConnection object.

Remarks




293

Execute Description

Sends the currently staged Prepayment rate requests to the INVEST ONE Engine for processing.

Syntax

object.Execute ([Sweep] ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOPrepayRateBlock object. Sweep An optional named parameter indicating if the Prepayrates should be

applied immediately by the INVEST ONE Engine

Reply Description


Syntax

object.Reply(Prepayrate,number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOPrepayRateBlock object. Prepayrate

The position of the Prepayment Rate request within the block. number The number of the reply being requested.

Remarks

The PrepayRateCount property can be used to determine the total number of requests in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the INVEST ONE Engine for each request. .




294


Syntax

object.ReplyCount(PrepayRate) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOPrepayRateBlock object. PrepayRate The position of the Prepayment Rate request within the block.

Remarks


StagePrepayRate Description

Stages a given PrepayRate message into the block.

Syntax

object.StagePrepayRate ( PrepayRateMsg ) The StagePrepayRate method syntax has these parts: Part Description object An object expression that evaluates to an IOPrepayRateBlock object. PrepayRateMsg

A string value provided from the Message property of an IOPrepayRate object.

Remarks

The PrepayRAteMsg string is actually a formatted FDXMP01 message as specified in the Data Dictionary. While you could format the string without using the IOPrepayRateBlock object, this is not recommended due to release independence.

IO/OLE PROGRAMMER’S GUIDE USING IOPRICESBLOCK


295

47. USING IOPRICES

PURPOSE The IOPrices object is used to add and update security price data for a designated price source, time and type. The security price data may include the 25-character price comment field.


Public Sub MySub() Dim c As IOConnection Dim a As IOPrices Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the IOPrices object Set a = c. CreatePrices 'set the desired fields a.SetValue Field:="MODE", Value:="A" a.SetValue Field: ="SCTYNO", Value:= 1125 a.SetValue Field:="SCTYDT ", Value:=” 20081231” a.SetValue Field:="SCTYUNQ", Value:=” 20080731” a.SetValue Field:="PRDATE", Value:=” 20080731” a.SetValue Field:="PRSRCE", Value:=” BE” a.SetValue Field:="PRTIME", Value:=”02” a.SetValue Field:="PRIND", Value:=”P” a.SetValue Field:="PRTCNT", Value:=”01” a.SetValue Field:="PRTYPE", Value:=”QM” a.SetValue Field:="PRICE", Value:=”12.50” a.SetValue Field:="NPDAYS", Value:=”05” a.SetValue Field:="EQPROF", Value:=”0.00” a.SetValue Field:="PRSIGN", Value:=”” a.Execute 'show the user any messages returned from INVEST ONE For i = 1 To a.ReplyCount Dubug.Print a.Reply(i) Next I End Sub


Clear

Description



296


Syntax

object.Clear The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOPrices object.

Remarks



Sets the IOConnection object associated with this IOPrices.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOPrices object. Connect An IOConnection object.

Remarks


Execute

Description

Sends the currently loaded IOPrice to the INVEST ONE Engine for processing.

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description



297

object An object expression that evaluates to an IOPrices object.

Remarks

If the IOPrices is not accepted by INVEST ONE an error will be raised.


Returns the value of a specific field within the currently loaded request.

Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOPrices object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Message

Description

Returns a formatted string that represents the complete IOPrices message as defined within the Data Dictionary ‘FDXUP02 IOPrices message’.

Syntax

object.Message The Message property syntax has these parts: Part Description Object An object expression that evaluates to an IOPrices object.

Remarks



298

This method returns a string representing the message which be sent to the INVEST ONE Engine to add the security price data.. It is used in conjunction with the StagePrice function in the IOPricesBlock object.

Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOPrices object. action The type of processing being requested of the INVEST ONE Engine

Settings

The valid settings action parameter are: Setting Description A Use to add a price for the first time. U Use to update the prices the security.

Remarks

Reply

Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOPrices object.



299

number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOPrices object.

Remarks




Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOPrices object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.



300

Remarks




301

48. USING IOPRICESBLOCK

PURPOSE The IOPricesBlock is used to add and update multiple security prices for designated price source, time and type. The security price data may include the 25-character price comment field.


Public Sub MySub() Dim c As IOConnection Dim a As IOPrices Dim ab As IOPricesBlock Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the IOPrices object Set a = c. CreatePrices ' Create the IOPricesBlock object Set ab = c. CreatePricesBlock 'set the desired fields a.SetValue Field:="MODE", Value:="A" a.SetValue Field: ="SCTYNO", Value:= 1125 a.SetValue Field:="SCTYDT ", Value:=” 20081231” a.SetValue Field:="SCTYUNQ", Value:=” 20080731” a.SetValue Field:="PRDATE", Value:=” 20080731” a.SetValue Field:="PRSRCE", Value:=” BE” a.SetValue Field:="PRTIME", Value:=”02” a.SetValue Field:="PRIND", Value:=”P” a.SetValue Field:="PRTCNT", Value:=”01” a.SetValue Field:="PRTYPE", Value:=”QM” a.SetValue Field:="PRICE", Value:=”12.50” a.SetValue Field:="NPDAYS", Value:=”05” a.SetValue Field:="EQPROF", Value:=”0.00” a.SetValue Field:="PRSIGN", Value:=”” ab.StagePrice(a.Message()) a.Clear 'set the desired fields a.SetValue Field:="MODE", Value:="U" a.SetValue Field: ="SCTYNO", Value:= 1126 a.SetValue Field:="SCTYDT ", Value:=” 20081231” a.SetValue Field:="SCTYUNQ", Value:=” 20080731”



302

a.SetValue Field:="PRDATE", Value:=” 20080731” a.SetValue Field:="PRSRCE", Value:=” BE” a.SetValue Field:="PRTIME", Value:=”02” a.SetValue Field:="PRIND", Value:=”P” a.SetValue Field:="PRTCNT", Value:=”01” a.SetValue Field:="PRTYPE", Value:=”QM” a.SetValue Field:="PRICE", Value:=”12.50” a.SetValue Field:="NPDAYS", Value:=”05” a.SetValue Field:="EQPROF", Value:=”0.00” a.SetValue Field:="PRSIGN", Value:=”” ab.StagePrice(a.Message()) ab.Execute 'show the user any messages returned from INVEST ONE Debug.Print “+++ First Request Messages For i = 1 To ab.ReplyCount(0) Debug.Print ab.Reply(0, i) Next I Debug.Print “+++ Second Request Messages For i = 1 To ab.ReplyCount(1) Debug.Print ab.Reply(1, i) Next i End Sub


PriceCount

Description

Returns the number of security price requests currently contained within the block.

Syntax

object. PriceCount The PriceCount property syntax has these parts: Part Description Object An object expression that evaluates to an IOPricesBlock object.


Sets the IOConnection object associated with this IOPricesBlock.

Syntax



303

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOPricesBlock object. Connect An IOConnection object.

Remarks


Execute

Description

Sends the currently staged requests to the INVEST ONE Engine for processing.

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOPricesBlock object.

Reply Description


Syntax

object.Reply(pricet,number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOPricesBlock object. price The position of the request within the block. (The first request is position

0)



304


Remarks

The PrepayRateCount property can be used to determine the total number of requests in the block. The ReplyCount property can be used to retrieve the number of reply messages returned from the INVEST ONE Engine for eachrequest. .


Returns the number of reply messages returned from the INVEST ONE Engine for a given executedrequest. .

Syntax

object.ReplyCount(account) The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOPricesBlock object. account The position of the request within the block. (The first request is position

0)

Remarks


StagePrice Description

Stages a given IOPrices message into the block.

Syntax

object. StagePrice ( PriceMsg ) The StagePrice method syntax has these parts: Part Description



305

object An object expression that evaluates to an IOPricesBlock object. PriceMsg A string value provided from the Message property of an IOPrices

object.

Remarks

The PriceMsg string is actually a formatted FDXUP02 message as specified in the Data Dictionary. While you could format the string without using the IOPricesBlock object, this is not recommended due to release independence.

IO/OLE PROGRAMMER’S GUIDE USING IOACCOUNTDEFINITION


306

49. USING IOACCOUNTDEFINITION

PURPOSE

The IOAccountDefinition object will support add, change and delete modes. Messaging will support input of account definition data equivalent to what can be entered online via the following screens:

• AAAD – Account Definition • AAMF – Account Definition II – More Features • AASA - Account Definition – Separate Accounts • AASP – Account Special Processing Definition • AAPR – Account Preschedule • AARS – Account Report Schedule • AACS – Account Characteristics Screen • AASL – Account Class of Shares • AAMC – Account Multi-Currency NAV • DECTA – Corporate Tax Rates By Account • AADE – Account Description • AAFY – Account Fiscal Year Ends • AAIA – Account/Index Attribution • AAGO – Account/Asset Processing overrides • AAAC – Account Advisor Codes • AAFP – Account Flexible Pricing Definition • AAAS – Group/Rpt Acct Sub-Acct • AAUD – Account User Defined Fields 1 • AAUD2 – Account User Defined fields 2


Public Sub MySub() Dim c As IOConnection Dim a As IOAccountdefinition Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the Accountdefinition object Set a = c. CreateIOAccountDefinition 'set the desired account fields a.SetValue Field:="MSGID", Value:=" FDXAC01" a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: =" ACSDESC ", Value:= “test” a.SetValue Field:=" ACINCP", Value:=” 20081231” a.SetValue Field:=" ACBALN", Value:=” 20081231” a.SetValue Field:=" ACSCHD", Value:=” 20081231”



307

a.SetValue Field:=" ACFISCM", Value:=”12” a.SetValue Field:=" ACTAXLT", Value:=”F” a.SetValue Field:=" ACGNMA", Value:=”Y” a.Execute 'show the user any messages returned from INVEST ONE For i = 1 To t.ReplyCount Debug.Print t.Reply(i) Next I End Sub


Clear

Description


Syntax

object.Clear The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOAccountDefinition object.

Remarks



Sets the IOConnection object associated with this IOAccountDefinition.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOAccountDefinition object. Connect An IOConnection object.

Remarks



308

Changing the properties of the IOConnection object will not effect this object until this property is set again.This method cannot be executed after the Execute method has been executed.

Execute

Description

Sends the currently loaded transaction to the INVEST ONE / Engine for processing.

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOAccountDefinition object.

Remarks

If the Account Definition is not accepted by INVEST ONE an error will be raised.



Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOAccountDefinition object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Mode



309

Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOAccountDefinition object. action The type of processing being requested of the INVEST ONE / Engine

Settings

The valid settings action parameter are: Setting Description A Use to add a Account for the first time. C Change the Account Definition for existing accounts. D Delete an existing account.

Remarks

Reply

Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOAccountDefinition object. number The number of the reply being requested.

Remarks




310

ReplyCount

Description


Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOAccountDefinition object.

Remarks




Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOAccountDefinition object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks

The settings for Field can be found, with their descriptions, in Section 2.2.1 of the Software Developer’s Kit. The field names are in the right most column labeled Field. The settings for Occur are dependent upon which field is being requested.

IO/OLE PROGRAMMER’S GUIDE USING IOACCTASSETPROOVERRIDES


311

50. USING IOACCTASSETPROOVERRIDES

PURPOSE

The IOAcctAssetProOverrides object will support add and change (maintain / delete asset group overrides) modes. Messaging will support input of Asset Group Override equivalent to what can be entered online via the AAGO – Account/Asset Processing overrides screen.


Public Sub MySub() Dim c As IOConnection Dim a As IOAcctAssetProOverrides Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the Asset Group Override object Set a = c. CreateAcctAssetProOverrides 'set the desired Asset Group Override fields a.SetValue Field:="MSGID", Value:=" FDXAG01" a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: =" ACOVAG", Value:= “CU” a.SetValue Field:=" ACOVAM", Value:=2 a.SetValue Field:=" ACOVAC", Value:=0 a.SetValue Field:=" ACOVDM", Value:=” N” a.SetValue Field:=" ACFISCM", Value:=”12” a.SetValue Field:=" ACOVBD", Value:=”0” a.SetValue Field:=" ACTRA0", Value:=”Y” a.Execute 'show the user any messages returned from INVEST ONE For i = 1 To t.ReplyCount Debug.Print t.Reply(i) Next I End Sub


Clear

Description




312

Syntax

object.Clear The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOAcctAssetProOverrides.

Remarks



Sets the IOConnection object associated with this IOAcctAssetProOverrides.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctAssetProOverrides


Remarks


Execute

Description


Syntax




313

object An object expression that evaluates to an IOAcctAssetProOverrides object.

Remarks

If the Asset Group Override is not accepted by INVEST ONE an error will be raised.



Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctAssetProOverrides

object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOAcctAssetProOverrides

object. action The type of processing being requested of the INVEST ONE / Engine



314

Settings

The valid settings action parameter are: Setting Description A Use to add an Asset Group for an Account. C Maintain- Delete the Asset Group Overrides for an Account.

Remarks

Reply

Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOAcctAssetProOverrides

object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description



315


Remarks




Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOAcctAssetProOverrides

object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOADVISORCODES


316

51. USING IOADVISORCODES

PURPOSE The IOAdvisorCodes object will support add, change and delete modes. Messaging will support input of Advisor Codes data equivalent to what can be entered online via the AAAC screen.


Public Sub MySub() Dim c As IOConnection Dim a As IOAdvisorCodes Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the AdvisorCodes object Set a = c. CreateIOAdvisorCodes 'set the desired Advisor Codes fields a.SetValue Field:="MSGID", Value:=" FDXAA01" a.SetValue Field:="MODE", Value:="A" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: ="CNTRY", Value:= “US” a.SetValue Field:="ADVISOR", Value:=” BA” a.Execute 'show the user any messages returned from INVEST ONE For i = 1 To t.ReplyCount Debug.Print t.Reply(i) Next I End Sub


Clear

Description


Syntax

object.Clear The Clear method syntax has these parts: Part Description



317

Object An object expression that evaluates to an IOAdvisorCodesobject.

Remarks



Sets the IOConnection object associated with this IOAdvisorCodes.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOAdvisorCodesobject. Connect An IOConnection object.

Remarks


Execute

Description


Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOAdvisorCodesobject.

Remarks

If the Advisor Codes is not accepted by INVEST ONE an error will be raised.




318


Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOAdvisorCodesobject. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOAdvisorCodesobject. action The type of processing being requested of the INVEST ONE / Engine

Settings

The valid settings action parameter are: Setting Description A Use to add an Advisor Code for the first time. C Change the Advisor Code for existing accounts. D Delete an existing Advisor code.



319

Remarks

Reply

Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOAdvisorCodesobject. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOAdvisorCodesobject.

Remarks






320

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOAdvisorCodesobject. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOFLEXIBLEPRICING


321

52. USING IOFLEXIBLEPRICING

PURPOSE The IOFlexiblePricing object will support add, change and delete modes. Messaging will support input of account definition data equivalent to what can be entered online via the AAFP screen.


Public Sub MySub() Dim c As IOConnection Dim a As IOFlexiblePricing Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the Accountdefinition object Set a = c. CreateIOFlexiblePricing 'set the desired account fields a.SetValue Field:="MSGID", Value:=" FDXFP01" a.SetValue Field:="MODE", Value:="A" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: =" ACFLHP", Value:= “20080101” a.SetValue Field:=" ACFPHO", Value:=” 20080101” a.SetValue Field:=" ACFPSCH", Value:=” 1” a.SetValue Field:=" ACFPGP", Value:=” AP” a.SetValue Field:=" ACFPED", Value:=” 20080101” a.SetValue Field:=" ACFPSC1", Value:=”ML” a.SetValue Field:=" ACFPTM1", Value:=”T3” a.Execute 'show the user any messages returned from INVEST ONE For i = 1 To t.ReplyCount Debug.Print t.Reply(i) Next I End Sub


Clear

Description


Syntax



322

object.Clear The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOFlexiblePricingobject.

Remarks



Sets the IOConnection object associated with this IOFlexiblePricing.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOFlexiblePricingobject. Connect An IOConnection object.

Remarks


Execute

Description


Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOFlexiblePricingobject.

Remarks



323

If the Flexible Pricing is not accepted by INVEST ONE an error will be raised.



Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOFlexiblePricingobject. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOFlexiblePricingobject. action The type of processing being requested of the INVEST ONE / Engine

Settings

The valid settings action parameters are: Setting Description A Use to add Flexible Pricing data to Account for the first time.



324

C Change the Flexible Pricing data for existing accounts. D Delete Flexible Pricing data for existing account.

Remarks

Reply

Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOFlexiblePricingobject. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOFlexiblePricingobject.

Remarks




325



Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOFlexiblePricingobject. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IORPTGRPACCOUNT


326

53. USING IORPTGRPACCOUNT

PURPOSE The IORptGrpAccount object will support add, change and delete modes. Messaging will support input of account definition data equivalent to what can be entered online via the AAAS screen.


Public Sub MySub() Dim c As IOConnection Dim a As IORptGrpAccount Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the Reporting/Group object Set a = c. CreateIORptGrpAccount 'set the desired account fields a.SetValue Field:="MSGID", Value:=" FDXAR01" a.SetValue Field:="MODE", Value:="A" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: =" SACCT ", Value:= “555” a.SetValue Field:=" DELFLGT ", Value:=” Y” a.Execute 'show the user any messages returned from INVEST ONE For i = 1 To t.ReplyCount Debug.Print t.Reply(i) Next I End Sub


Clear

Description


Syntax

object.Clear The Clear method syntax has these parts: Part Description



327

Object An object expression that evaluates to an IORptGrpAccount object.

Remarks



Sets the IOConnection object associated with this IORptGrpAccount.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IORptGrpAccount object. Connect An IOConnection object.

Remarks


Execute

Description


Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IORptGrpAccount object.

Remarks

If the Reporting/Group Account is not accepted by INVEST ONE an error will be raised.




328


Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IORptGrpAccount object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IORptGrpAccount object. action The type of processing being requested of the INVEST ONE / Engine

Settings

The valid settings action parameter are: Setting Description A Use to add a Reporting/Group Account. C CHANGE – DELETE SUB-ACCOUNT field available. D DELETE – deletes entire AAAS definition.



329

Remarks

Reply

Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IORptGrpAccount object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IORptGrpAccount object.

Remarks






330

Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IORptGrpAccount object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks




331

54. USING IOUSERDEFINEDFIELDS

PURPOSE The IOUserDefinedFields object will support add, change and delete modes. Messaging will support input of account definition data equivalent to what can be entered online via the following screens:

• AAUD – Account User Defined Fields 1 • AAUD2 – Account User Defined fields 2


Public Sub MySub() Dim c As IOConnection Dim a As IOUserDefinedFields Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the User defined fields object Set a = c. CreateUserDefinedFields 'set the desired account fields a.SetValue Field:="MSGID", Value:=" FDXAU01" a.SetValue Field:="MODE", Value:="A" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: =" DATE01", Value:= “20081231” a.SetValue Field:=" DATE02", Value:=” 20081231” a.SetValue Field:=" FLAG01", Value:=” Y” a.SetValue Field:=" FLAG02", Value:=” Y” a.SetValue Field:=" NFLD01", Value:=”125655” a.SetValue Field:=" NFLD02", Value:=”343322” a.SetValue Field:=" NFLD03", Value:=”343434” a.Execute 'show the user any messages returned from INVEST ONE For i = 1 To t.ReplyCount Debug.Print t.Reply(i) Next I End Sub


Clear

Description



332


Syntax

object.Clear The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOUserDefinedFields object.

Remarks



Sets the IOConnection object associated with this IOUserDefinedFields.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOUserDefinedFields object. Connect An IOConnection object.

Remarks


Execute

Description


Syntax




333

object An object expression that evaluates to an IOUserDefinedFields object.

Remarks

If the User Defined Fields is not accepted by INVEST ONE an error will be raised.



Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOUserDefinedFields object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOUserDefinedFields object. action The type of processing being requested of the INVEST ONE / Engine

Settings

The valid settings action parameter are:



334

Setting Description A Use to add User defined fields to an Account. C Change the User defined fields. D Delete User defined fields existing account.

Remarks

Reply

Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOUserDefinedFields object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOUserDefinedFields object.

Remarks



335




Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOUserDefinedFields object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOADHOCFAS


336

55. USING IOADHOCFAS

PURPOSE The IOAdHocFAS object is used to update the FAS 157 and FAS 161 data in the INVEST ONE Engine.


Public Sub MySub() Dim c As IOConnection Dim a As IOAdHocFAS Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the AdHocFAS object Set a = c. CreateAdhocFAS 'set the desired fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="TYPE", Value:=”R” a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field:="SCTY", Value:=”ABC” a.SetValue Field:="SCTYUNQ", Value:=0 a.SetValue Field: ="EFFDT ", Value:= 20081231 a.SetValue Field:=" ENDDT", Value:=20090131 a.SetValue Field:=" LEVEL", Value:=1 a.SetValue Field:=" RISKCAT", Value:=”XX” 'Execute the Ad Hoc FAS change request in INVEST ONE Engine a.Execute 'show the user any messages returned from INVEST ONE Engine For i = 1 To a.ReplyCount Debug.Print a.Reply(i) Next I End Sub



337


Clear

Description


Syntax

object.Clear The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOAdHocFAS object.

Remarks



Sets the IOConnection object associated with this IOAdHocFAS object.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOAdHocFAS object. Connect An IOConnection object.

Remarks


Execute

Description

Sends the currently loaded Ad Hoc FAS change request to the INVEST ONE / Engine for processing.



338

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOAdHocFAS object.

Remarks

If the Ad Hoc FAS update is not accepted by INVEST ONE, an error will raised.



Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOAdHocFAS object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Message

Description

Returns a formatted string that represents the complete Ad Hoc FAS message as defined within the Data Dictionary ‘FDXFA01 Ad Hoc FAS Message’.

Syntax

object.Message The Message property syntax has these parts:



339

Part Description Object An object expression that evaluates to an IOAdHocFAS object.

Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOAdHocFAS object. action The type of processing being requested of the INVEST ONE / Engine

Settings

The valid settings action parameters are: Setting Description A - Add a new Ad Hoc FAS item C - Change the Ad Hoc FAS item D - Delete the Ad Hoc FAS item

Remarks

Reply

Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOAdHocFAS object.



340


Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOAdHocFAS object.

Remarks




Syntax

object.SetValue ( Field , Value, [Occur] ) The SetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOAdHocFAS object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOTOLERANCEPROFILE


341

56. USING IOTOLERANCEPROFILE

PURPOSE The IOToleranceProfile object is used to update the Tolerance Profile data in the INVEST ONE Engine.


Public Sub MySub() Dim c As IOConnection Dim a As IOToleranceProfile Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the Tolerance profile object Set a = c. CreateToleranceProfile 'set the desired fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:=" PROFID", Value:=”1S” a.SetValue Field:=" PROFOCR", Value:=1 a.SetValue Field:=" SCLSOCR", Value:=”1” a.SetValue Field:=" MILRT", Value:= 0.12345678901234 a.SetValue Field: =" ONEDAYY", Value:= 1.00 a.SetValue Field:=" N1A1DYY", Value:=1.10 a.SetValue Field:=" SEVNDYY", Value:=7.00 a.SetValue Field:=" N1A7DYY", Value:=7.10 a.SetValue Field:=" RN1A7DY", Value:=7.20 a.SetValue Field: =" TRTYDYY", Value:= 30.00 a.SetValue Field:=" N1A30DY", Value:=30.10 a.SetValue Field:=" RST30DY", Value:=30.20 a.SetValue Field:=" DY1MDSY", Value:=31.00 a.SetValue Field:=" EFTYLD", Value:=31.10 a.SetValue Field:=" N1A7DYY", Value:=31.20 a.SetValue Field: =" N1AGRSY", Value:= 32.00 a.SetValue Field:=" ONEDGSY", Value:=1.12 a.SetValue Field:=" SDISADJ", Value:= 1234567890.12 a.SetValue Field:=" SCLSNBR", Value:=1 a.SetValue Field:=" SSDSADJ", Value:=1234567890.12 a.view = GetView(Range("VIEW")) ‘Set the View possible values are “ “ , “IA” , “A1” 'Execute the Tolerance profile change request in INVEST ONE Engine a.Execute 'show the user any messages returned from INVEST ONE Engine



342

For i = 1 To a.ReplyCount Debug.Print a.Reply(i) Next I End Sub



343


Clear

Description


Syntax

object.Clear The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOTolerance object.

Remarks



Sets the IOConnection object associated with this IOTolerance object.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOTolerance object. Connect An IOConnection object.

Remarks


Execute

Description

Sends the currently loaded Tolerance Profile change request to the INVEST ONE / Engine for processing.



344

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOToleranceProfile object.

Remarks

If the IOToleranceProfile update is not accepted by INVEST ONE, an error will raised.



Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOToleranceProfile object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Message

Description

Returns a formatted string that represents the complete IOToleranceProfile message as defined within the Data Dictionary ‘FDXTP01 IO Tolerance Profile Message’.

Syntax




345

Part Description Object An object expression that evaluates to an IOToleranceProfile object.

Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOToleranceprofile object. action The type of processing being requested of the INVEST ONE / Engine

Settings

The valid settings action parameters are: Setting Description A - Add a new Toerance Profie item C - Change the Tolerance Profile item D - Delete the Tolerance Profile item

Remarks

Reply

Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOToleranceProfile object.



346


Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOToleranceProfile object.

Remarks




Syntax

object.SetValue ( Field , Value, [Occur] ) The SetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOToleranceProfile object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOTAXRATETABLE


347

57. USING IOTAXRATETABLE

PURPOSE The IOTaxRateTable object is used to update the Tax Rates table data in the INVEST ONE Engine.


Public Sub MySub() Dim c As IOConnection Dim a As IOTaxRateTable Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the Tax Rate Table object Set a = c. CreateTaxRateTable 'set the desired fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:=" STCODE", Value:=”R” a.SetValue Field:=" EFTDT", Value:=12345 a.SetValue Field:=" TXRATE", Value:=”ABC” a.view = GetView(Range("VIEW")) ‘Set the View possible values are “ “ , “IA” , “A1” 'Execute the Tolerance profile change request in INVEST ONE Engine a.Execute 'show the user any messages returned from INVEST ONE Engine For i = 1 To a.ReplyCount Debug.Print a.Reply(i) Next I End Sub



348


Clear

Description


Syntax

object.Clear The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOTaxRateTable object.

Remarks



Sets the IOConnection object associated with this IOTaxRateTable object.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOTaxRateTable object. Connect An IOConnection object.

Remarks


Execute

Description

Sends the currently loaded Tax Rate Table change request to the INVEST ONE / Engine for processing.



349

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOTaxRateTable object.

Remarks

If the IOTaxRateTable update is not accepted by INVEST ONE, an error will raised.



Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOTaxRateTable object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Message

Description

Returns a formatted string that represents the complete IOTaxRateTable message as defined within the Data Dictionary ‘FDXST01 IO Tax Rate Table Message’.

Syntax




350

Part Description Object An object expression that evaluates to an IOTaxRateTable object.

Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOTaxRateTable object. action The type of processing being requested of the INVEST ONE / Engine

Settings

The valid settings action parameters are: Setting Description A - Add a new TaxRateTable item C - Change the TaxRate Table item D - Delete the TaxRateTable item

Remarks

Reply

Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOTaxRateTable object.



351


Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOTaxRateTable object.

Remarks




Syntax

object.SetValue ( Field , Value, [Occur] ) The SetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOTaxRateTable object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOPOSITIONLEVELPRICING


352

58. USING IOPOSITIONLEVELPRICING

PURPOSE The IOPositionLevelPricing object is used to update the PositionLevelPricing data in the INVEST ONE Engine.


Public Sub MySub() Dim c As IOConnection Dim a As IOPositionLevelPricing Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the Position Level Pricing object Set a = c. CreatePositionLevelPricing 'set the desired fields a.SetValue Field:="MODE", Value:="C" a.SetValue Field:=" ACCT", Value:=1100 a.SetValue Field:=" SCTYNO", Value:=12345 a.SetValue Field:=" SCTYDT", Value:=01012001 a.SetValue Field:=" SCTYUNQ", Value:=”A1” a.SetValue Field:=" EXECDT", Value:=”01022003” a.SetValue Field:=" PSOURCE", Value:=”ID” a.SetValue Field:=" PTIME", Value:=”1” a.SetValue Field:=" PTYPE", Value:=”PP” a.view = GetView(Range("VIEW")) ‘Set the View possible values are “ “ , “IA” , “A1” 'Execute the Position Level Pricing change request in INVEST ONE Engine a.Execute 'show the user any messages returned from INVEST ONE Engine For i = 1 To a.ReplyCount Debug.Print a.Reply(i) Next I End Sub



353


Clear

Description


Syntax

object.Clear The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an IOPositionLevelPricing

object.

Remarks



Sets the IOConnection object associated with this IOPositionLevelPricing object.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an IOPositionLevelPricing object. Connect An IOConnection object.

Remarks


Execute

Description

Sends the currently loaded PositionLevelPricing change request to the INVEST ONE / Engine for processing.



354

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an IOPositionLevelPricing object.

Remarks

If the IOPositionLevelPricing update is not accepted by INVEST ONE, an error will raised.



Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOPositionLevelPricing object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Message

Description

Returns a formatted string that represents the complete IOPositionLevelPricing message as defined within the Data Dictionary ‘FDXPL01 IO PositionLevelPricing Message’.

Syntax

object.Message



355

The Message property syntax has these parts: Part Description Object An object expression that evaluates to an IOPositionLevelPricing

object.

Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an IOPositionLevelPricing

object. action The type of processing being requested of the INVEST ONE / Engine

Settings

The valid settings action parameters are: Setting Description A - Add a new PositionLevelPricing item C - Change the PositionLevelPricing item D - Delete the PositionLevelPricing item

Remarks

Reply

Description


Syntax

object.Reply(number)



356

The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an IOPositionLevelPricing

object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an IOPositionLevelPricing

object.

Remarks




Syntax

object.SetValue ( Field , Value, [Occur] ) The SetValue method syntax has these parts: Part Description object An object expression that evaluates to an IOPositionLevelPricing

object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set.



357

Occur An optional named parameter indicating the occurrence of the field to be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IORELATEDSECURITESMAINTENANCE


358

59. USING IORELATEDSECURITESMAINTENANCE

PURPOSE The IORelatedSecuritesMaintenance object is used to update the RelatedSecuritesMaintenance data in the INVEST ONE Engine.


Public Sub MySub() Dim c As IOConnection Dim a As IORelatedSecuritesMaintenance Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the Related Securities object Set a = c. CreateRelatedSecuritesMaintenance 'set the desired fields a.SetValue Field:="MODE", Value:="A" a.SetValue Field:=" SCTYNO", Value:=”R” a.SetValue Field:=" RELSCTY", Value:= “BESTOCK” a.SetValue Field:=" RELCONV ", Value:=0.020 a.view = GetView(Range("VIEW")) ‘Set the View possible values are “ “ , “IA” , “A1” 'Execute the Position Level Pricing change request in INVEST ONE Engine a.Execute 'show the user any messages returned from INVEST ONE Engine For i = 1 To a.ReplyCount Debug.Print a.Reply(i) Next I End Sub



359


Clear

Description


Syntax

object.Clear The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an

IORelatedSecuritesMaintenance object.

Remarks



Sets the IOConnection object associated with this IORelatedSecuritesMaintenance object.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an

IORelatedSecuritesMaintenance object. Connect An IOConnection object.

Remarks


Execute

Description



360

Sends the currently loaded RelatedSecuritesMaintenance change request to the INVEST ONE / Engine for processing.

Syntax

object.Execute ( ) The Execute method syntax has these parts: Part Description object An object expression that evaluates to an


Remarks

If the IORelatedSecuritesMaintenance update is not accepted by INVEST ONE, an error will raised.



Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an

IORelatedSecuritesMaintenance object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Message

Description

Returns a formatted string that represents the complete IORelatedSecuritesMaintenance message as defined within the Data Dictionary ‘FDXSB01 IO RelatedSecuritesMaintenanceMessage’.



361

Syntax

object.Message The Message property syntax has these parts: Part Description Object An object expression that evaluates to an


Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an

IORelatedSecuritesMaintenance object. action The type of processing being requested of the INVEST ONE / Engine

Settings

The valid settings action parameters are: Setting Description A - Add a new RelatedSecuritesMaintenance item C - Change the RelatedSecuritesMaintenance item D - Delete the RelatedSecuritesMaintenance item

Remarks

Reply

Description




362

Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an

RelatedSecuritesMaintenance object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description object An object expression that evaluates to an RelatedSecuritesMaintenance

object.

Remarks




Syntax

object.SetValue ( Field , Value, [Occur] ) The SetValue method syntax has these parts: Part Description



363

object An object expression that evaluates to an IORelatedSecuritesMaintenance object.

Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


IO/OLE PROGRAMMER’S GUIDE USING IOINCOMEDISTRIBUTIONGENERATOR


364

60. USING IOINCOMEDISTRIBUTIONGENERATOR

PURPOSE The IOIncomeDistributionGenerator object will support add and change (maintain / delete Income Distriubtion Flags and Calendars) modes. Messaging will support input of Income Distribution Generator equivalent to what can be entered online via the INCDTG – Income Distribution Generator screen.


Public Sub MySub() Dim c As IOConnection Dim a As IOIncomeDistributionGenerator Dim I As Integer 'Instantiate an INVEST ONE Connection object set c = New IOConnection c.UserID = InputBox("User::", "INVEST ONE") c.Password = InputBox("Password:", "INVEST ONE") ' Create the Income Distribution Generator object Set a = c. CreateIncomeDistGenerator 'set the desired Income Distriubtion Generator fields a.SetValue Field:="MSGID", Value:=" FDXDG01" a.SetValue Field:="MODE", Value:="C" a.SetValue Field:="ACCT", Value:=12345 a.SetValue Field: =" ACDGIND", Value:= “Y” a.SetValue Field:=" CLNUM", Value:=2 a.SetValue Field:=" CLMETH", Value:=”DIS a.SetValue Field:=" CLSMOOTH", Value:=” N” a.SetValue Field:=" ASTLEFF", Value:=”06/03/2011” a.SetValue Field:=" ASTLDAT", Value:=”12/31/2011” a.Execute 'show the user any messages returned from INVEST ONE For i = 1 To t.ReplyCount Debug.Print t.Reply(i) Next I End Sub


Clear

Description




365

Syntax

object.Clear The Clear method syntax has these parts: Part Description Object An object expression that evaluates to an

IOIncomeDistributionGenerator.

Remarks



Sets the IOConnection object associated with this IOIncomeDistributionGenerator.

Syntax

object. Connection [= connect] The Connection method syntax has these parts: Part Description object An object expression that evaluates to an

IOIncomeDistributionGenerator object. Connect An IOConnection object.

Remarks


Execute

Description


Syntax




366

object An object expression that evaluates to an IOIncomeDistributionGenerator object.

Remarks

If the Asset Group Override is not accepted by INVEST ONE an error will be raised.



Syntax

object.GetValue ( Field , [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an

IOIncomeDistributionGenerator object. Field A string indicating the field for which the value should be returned. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


Mode Description


Syntax

object.Mode [= action] The Mode property syntax has these parts: Part Description object An object expression that evaluates to an

IOIncomeDistributionGenerator object. action The type of processing being requested of the INVEST ONE / Engine



367

Settings

The valid settings action parameter are: Setting Description A Use to add an Income Distribution flag or calendar for an Account/Class. C Maintain an Income Distribution flag or calendar for an Account/Class.

Remarks

Reply

Description


Syntax

object.Reply(number) The Reply property syntax has these parts: Part Description Object An object expression that evaluates to an

IOIncomeDistributionGenerator object. number The number of the reply being requested.

Remarks




Syntax

object.ReplyCount The ReplyCount property syntax has these parts: Part Description



368


Remarks




Syntax

object.SetValue ( Field , Value, [Occur] ) The GetValue method syntax has these parts: Part Description object An object expression that evaluates to an

IOIncomeDistributionGenerator object. Field A string indicating the field for which the value should be returned. Value The value to which the field should be set. Occur An optional named parameter indicating the occurrence of the field to

be returned.

Remarks


IO OLE PROGRAMMER’S GUIDE APPENDIX A - INSTALLING IP SOCKETS


369

61. APPENDIX A – INSTALLING IP SOCKETS INFORMATION AND TASKS Once IP Sockets are installed, there are two pieces of information that must be known to correctly configure the PC portion of OLE

• The IP address of the CICS region’s LPAR • The port address of the CICS region

Note: Use a TELNET session to verify the above information is valid. Valid information will successfully start a session. Incorrect information will fail to start a session.

You must also ensure: • The IP Sockets default listener task (CSKL, started by the CSKE command) must be running at the

time the OLE transaction is submitted. It can optionally be running at all times or started and stopped as needed.

• The CICS transactions listed below must be defined to the region and by default.

Description CICS Transaction INVEST ONE Command Security Object FDSD FDSD Security Block Object FD8W FDSDB Transaction Object FD8Z FDTS2 Transaction Block Object FD80 FDTSB2 Security Distribution FDS0 FDS0 Transaction Analysis FDS1 FDS1 Fund Trend Analysis FDS2 FDS2

• By default, the region’s default operator must have access to these transactions. Alternatively, an IP

Sockets security exit may be written to handle internal security requirements. See the IBM IP Sockets manuals for more information.

• Set the IP Socket parameters of TRAN TRAN and TRAN USER to “Yes”, when running IP Sockets version 3.2C and newer. In earlier versions these parameters were forced to “Yes”; even if specified. In the 3.2C version they default to yes, if not specified. See the IBM IP Sockets manuals for more information.

IO OLE PROGRAMMER’S GUIDE APPENDIX A - INSTALLING IP SOCKETS


370

INSTALLING ARSIPS - THE CICS IP SECURITY EXIT To change/view the security exit you need to do the following in CICS: 1. Enter: EZAO,STOP,LISTENER

APPLID ====> CICSCATZ APPLID of CICS LISTENER ===> CSKL <<<<< Enter Name of Listener CICS Sockets Interface Listener CSKL IS TERMINATING

2. Enter:EZAC,ALter,LISTENER

APPLID ===> CICSCATZ APPLID of CICS NAME ===> CSKL <<<<< Enter Name of Listener

Enter generates the following info:

OVERTYPE TO ENTER APPLID ===> CICSCATE TRANID ===> CSKL PORT ===> 02600 IMMEDIATE ===> YES BACKLOG ===> 040 NUMSOCK ===> 100 MINMSGL ===> 004 ACCTIME ===> 030 GIVTIME ===> 010 REATIME ===> 300 FASTRD ===> NO TRANTRN ===> YES TRANUSR ===> YES SECEXIT ===> ARSIPS WLM groups ===>

Type in updates and press enter. 3. To start the Listener- enter:EZAO, START, LISTENER(CSKL)

APPLID ====> CICSCATZ APPLID of CICS LISTENER ===> CSKL<<<<<Enter Name of Listener CICS Sockets Interface Listener CSKL is Started

IO OLE Programmer's Guide - SunGarddocs.sungard.com/InvestOne/140Doc/OLE/IO_OLE.pdf · io ole...

Documents

Transcript of IO OLE Programmer's Guide - SunGarddocs.sungard.com/InvestOne/140Doc/OLE/IO_OLE.pdf · io ole...