Produced by Araxis Merge on 4/11/2019 2:37:04 PM Eastern Daylight Time. See www.araxis.com for information about Merge. This report uses XHTML and CSS2, and is best viewed with a modern standards-compliant browser. For optimum results when printing this report, use landscape orientation and enable printing of background images and colours in your browser.
| # | Location | File | Last Modified |
|---|---|---|---|
| 1 | ES5.6_docs.zip\ESCC | TS - ES Batch Processes.docx | Wed Mar 27 20:26:46 2019 UTC |
| 2 | ES5.6_docs.zip\ESCC | TS - ES Batch Processes.docx | Thu Apr 11 16:33:05 2019 UTC |
| Description | Between Files 1 and 2 |
|
|---|---|---|
| Text Blocks | Lines | |
| Unchanged | 1 | 650 |
| Changed | 0 | 0 |
| Inserted | 0 | 0 |
| Removed | 0 | 0 |
| Whitespace | |
|---|---|
| Character case | Differences in character case are significant |
| Line endings | Differences in line endings (CR and LF characters) are ignored |
| CR/LF characters | Not shown in the comparison detail |
No regular expressions were active.
| 1 | Enrollment System (E S) | |
| 2 | ES Batch P rocesses | |
| 3 | Technical Specificat ion | |
| 4 | ||
| 5 | Department of Vetera ns Affairs | |
| 6 | Office of Informatio n and Tech nology (OI T) | |
| 7 | Product De velopment | |
| 8 | Documentat ion Versio n 1.2 | |
| 9 | ||
| 10 | Revision H istory | |
| 11 | Date | |
| 12 | Revision | |
| 13 | Descriptio n | |
| 14 | Author | |
| 15 | 01/2019 | |
| 16 | 1.2 | |
| 17 | Add VCE Re calculatio n Process | |
| 18 | Dennis Dou ssan | |
| 19 | 06/2018 | |
| 20 | 1.1 | |
| 21 | Add Activa te System Parameters | |
| 22 | Dennis Dou ssan | |
| 23 | 06/2018 | |
| 24 | 1.0 | |
| 25 | Initial do cument | |
| 26 | Trinadh Ka vuri | |
| 27 | ||
| 28 | Table of C ontents | |
| 29 | 1Introduct ion1 | |
| 30 | 1.1Purpose 1 | |
| 31 | 1.2Scope1 | |
| 32 | 2System Co mponents a nd Process es2 | |
| 33 | 2.1CloseAp plicationH istoryProc ess2 | |
| 34 | 2.2Pending Verificat ion Mailin g Confirma tion File for Schedu ledJob.PVC CMailingRe sponseConf irmationFi leProcess4 | |
| 35 | 2.3Pending Verificat ion Mailin g Code 1 R eject File for PVMai lingRespon seCode1Rej ectFilePro cess7 | |
| 36 | 2.4Pending Verificat ion Mailin g USPS Ret urned File for PVMai lingRespon seReturned ByUSPSFile Process10 | |
| 37 | 2.5Pending Verificat ion Mailin g Error Fi le for Sch eduledJob. PVMailingR esponseErr orFileProc ess12 | |
| 38 | 2.6Activat e VCE Syst em Paramet ers14 | |
| 39 | 2.7VCE Par ameters Ch anged Reca lculation Batch Proc ess15 | |
| 40 | ||
| 41 | ||
| 42 | Introducti on | |
| 43 | Purpose | |
| 44 | The purpos e of this document i s to docum ent system component s and proc esses for the Enroll ment Syste m (ES) bat ch process es. | |
| 45 | Scope | |
| 46 | Technical specificat ion descri bes system component s and proc esses that change/ad d/edit the existing batch proc ess or to create a n ew Batch j ob. Each n ew batch j ob added s hould disc uss the tr ansaction boundaries , error/ex ception ha ndling, mu lti-thread ing and lo ad handlin g. | |
| 47 | ||
| 48 | System Com ponents an d Processe s | |
| 49 | CloseAppli cationHist oryProcess | |
| 50 | Descriptio n: Batch p rocess wil l set enro llment app lications to "Closed Applicati on" status and apply an enroll ment end d ate based on a file provided b y the busi ness which contains Integratio n Control Numbers (I CNs) and e nrollment end dates for each a pplication to be clo sed. | |
| 51 | ||
| 52 | Main Class : CloseApp licationHi storyProce ss | |
| 53 | ||
| 54 | Extends: A bstractDat aFileIncre mentalProc ess (Throt tles readi ng to 25 r ecords eac h iteratio n) | |
| 55 | ||
| 56 | Transactio n Boundari es. | |
| 57 | A new tran saction wi ll be star ted for ea ch record by delegat ing the wo rk to | |
| 58 | Eligibilit yEnrollmen tServiceIm pl. proces sCloseEnro llmentHist oryApplica tion(Strin g vpid_va lue, boole an isTrigg erCloseLet ter, Date enrollment EndDate). | |
| 59 | Process st atistics w ill have t heir own t ransaction already c onfigured as part of the frame work. | |
| 60 | ||
| 61 | Exception Handling: Any except ion thrown out by th e service will roll back the t ransaction , incremen t the erro r count an d write th e exceptio n to the e xception f ile. Excep tion file will have the same n ame as inp ut file wi th a .exce ption exte nsion. | |
| 62 | ||
| 63 | Input: | |
| 64 | File namin g pattern: CA_*.txt | |
| 65 | Record For mat: VPID^ EndDate | |
| 66 | Sample Rec ord: 00000 0100879525 1V98696500 0000^20180 607 | |
| 67 | ||
| 68 | ||
| 69 | Figure 1: Close Appl ication Ba tch Proces s List Vie w | |
| 70 | ||
| 71 | Figure 2: Close Appl ication Ba tch Proces s History View | |
| 72 | ||
| 73 | ||
| 74 | Figure 3: Class Diag ram Close Applicatio n Batch Pr ocess | |
| 75 | ||
| 76 | ||
| 77 | Figure 4: Sequence D iagram Clo se Applica tion Batch Process | |
| 78 | ||
| 79 | ||
| 80 | Figure 5: Spring con figuration for trans action bou ndaries | |
| 81 | ||
| 82 | Pending Ve rification Mailing C onfirmatio n File for Scheduled Job.PVCCMa ilingRespo nseConfirm ationFileP rocess | |
| 83 | ||
| 84 | Descriptio n: Batch p rocess wil l import s uccessful mailing re sponses fo r the init ial pendin g letters (742-650/7 42-651) an d the new pre-closur e letter ( 742-655) a nd display in the ES Previousl y Mailed a nd Availab le for Mai ling tabs. | |
| 85 | ||
| 86 | Main Class : PVMailin gResponseC onfirmatio nFileProce ss | |
| 87 | ||
| 88 | Extends: A bstractDat aFileSingl eRowIncrem entProcess (Throttle s reading to 25 reco rds each i teration) | |
| 89 | ||
| 90 | Transactio n Boundari es. | |
| 91 | A new tran saction wi ll be star ted for ea ch record by delegat ing the wo rk to | |
| 92 | commsLogSe rvice.proc essConfDat aRecord(da taRecord, daysToTrig gerClock, daysToTrig gerNotific ationClock , fileName ); | |
| 93 | Process st atistics w ill have t heir own t ransaction which are already c onfigured as part of the frame work. | |
| 94 | ||
| 95 | Exception Handling: Any except ion thrown out by th e service will roll back the t ransaction , incremen t the erro r count an d write th e exceptio n to the e xception f ile. Excep tion file will have the same n ame as inp ut file wi th a .exce ption exte nsion. | |
| 96 | ||
| 97 | Multi-Thre ading: Thi s process run with s even threa ds with a task thres hold of 10 tasks | |
| 98 | ||
| 99 | Input: | |
| 100 | File namin g pattern: PLC_CMS_ confirmati on_file_*. txt | |
| 101 | Record For mat: formN um^uniqueI d^vpid^ful lName^addr essline1^a ddressline 2^city^sta te^zip^dat emailed | |
| 102 | Sample Rec ord: | |
| 103 | Third colu mn unique id is for processing on going letters. | |
| 104 | 742-652A^3 699634862^ 1009146171 V722148^LA URIE L FOR BES^529 MA IN ST^^NEW PORT^VT^05 855-4981^0 8252017 | |
| 105 | Unique id is missing to proces s historic al pre-clo sure lette rs. | |
| 106 | 742-651^^1 008795251V 986965^LAU RIE L FORB ES^529 MAI N ST^^NEWP ORT^VT^058 55-4981^08 252016 | |
| 107 | ||
| 108 | ||
| 109 | Figure 6: Confirmati on File Pr ocess Batc h Process List View | |
| 110 | ||
| 111 | ||
| 112 | Figure 7: Confirmati on File Pr ocess Batc h Process History Vi ew | |
| 113 | ||
| 114 | ||
| 115 | Figure 8: Class Diag ram Confir mation Fil e Batch Pr ocess | |
| 116 | ||
| 117 | ||
| 118 | Figure 9: Sequence D iagram Con firmation File Batch Process | |
| 119 | ||
| 120 | ||
| 121 | Figure 10: Spring co nfiguratio n for tran saction bo undaries | |
| 122 | ||
| 123 | Pending Ve rification Mailing C ode 1 Reje ct File fo r PVMailin gResponseC ode1Reject FileProces s | |
| 124 | Descriptio n: Batch p rocess wil l import C ode1 Rejec t mailing responses for the in itial pend ing letter s (742-650 /742-651) and the ne w pre-clos ure letter (742-655) . | |
| 125 | ||
| 126 | Main Class : PVMailin gResponseC ode1Reject FileProces s | |
| 127 | ||
| 128 | Extends: A bstractDat aFileSingl eRowIncrem entProcess (Throttle s reading to 25 reco rds each i teration) | |
| 129 | ||
| 130 | Transactio n Boundari es. | |
| 131 | A new tran saction wi ll be star ted for ea ch record by delegat ing the wo rk to | |
| 132 | commsLogSe rvice. pro cessCode1R ejectDataR ecord(data Record, fi leName); | |
| 133 | Process st atistics w ill have t heir own t ransaction which are already c onfigured as part of the frame work. | |
| 134 | ||
| 135 | Exception Handling: Any exce ption thro wn out by the servic e will rol l back the transacti on, increm ent the er ror count and write the except ion to the exception file. Exc eption fil e will hav e the same name as i nput file with a .ex ception ex tension. | |
| 136 | ||
| 137 | Multi-Thre ading: Thi s process run with s even threa ds with a task thres hold of 10 tasks. | |
| 138 | ||
| 139 | Input: | |
| 140 | File namin g pattern: PLC_CMS_ USPS_retur ns_*.txt | |
| 141 | Record For mat: formN um^uniqueI d^vpid^ful lName^addr essline1^a ddressline 2^city^sta te^zip^dat emailed^da tereturned | |
| 142 | Sample Rec ord: | |
| 143 | 2nd column unique id is for pr ocessing o n going le tters. | |
| 144 | 742-652^36 99623157^1 017277454V 797544^TES TEREAT CRM TESTEAT^93 71 SIGNAL STATION DR ^^MANASSAS ^VA^20111- 8258^08222 017^082520 17 | |
| 145 | ||
| 146 | Unique id is missing to proces s historic al pre-clo sure lette rs. | |
| 147 | 742-652A^4 0125502958 ^100878231 1V208987^L ETTERTHREE TESTERTOO ^123 TEST TRET^^STER LING^VA^20 167^082201 7^08252017 | |
| 148 | ||
| 149 | ||
| 150 | ||
| 151 | Figure 11: USPS Retu rned File Process Ba tch Proces s List Vie w | |
| 152 | ||
| 153 | ||
| 154 | Figure 12: USPS Retu rned File Process Ba tch Proces s History View | |
| 155 | ||
| 156 | ||
| 157 | Figure 13: Class Dia gram Code1 Reject Fi le Batch P rocess | |
| 158 | ||
| 159 | ||
| 160 | Figure 14: Sequence Diagram Co de1 Reject File Batc h Process | |
| 161 | ||
| 162 | ||
| 163 | Figure 15: Spring co nfiguratio n for tran saction bo undaries | |
| 164 | ||
| 165 | Pending Ve rification Mailing U SPS Return ed File fo r PVMailin gResponseR eturnedByU SPSFilePro cess | |
| 166 | Descriptio n: Batch P rocess wil l import U SPS return ed mailing responses for the i nitial pen ding lette rs (742-65 0/742-651) and the n ew pre-clo sure lette r (742-655 ). | |
| 167 | Main Class : PVMailin gResponseR eturnedByU SPSFilePro cess | |
| 168 | ||
| 169 | Extends: A bstractDat aFileSingl eRowIncrem entProcess (Throttle s reading to 25 reco rds each i teration) | |
| 170 | ||
| 171 | Transactio n Boundari es. | |
| 172 | A new tran saction wi ll be star ted for ea ch record by delegat ing the wo rk to | |
| 173 | commsLogSe rvice. pro cessReturn edByUSPSDa taRecord(f ileName, d ataRecord) ;. | |
| 174 | Process st atistics w ill have t heir own t ransaction which are already c onfigured as part of the frame work. | |
| 175 | ||
| 176 | Exception Handling: Any exce ption thro wn out by the servic e will rol l back the transacti on, increm ent the er ror count and write the except ion to the exception file. Exc eption fil e will hav e the same name as i nput file with a .ex ception ex tension. | |
| 177 | ||
| 178 | Multi-Thre ading: Thi s process run with s even threa ds with a task thres hold of 10 tasks | |
| 179 | ||
| 180 | Input: | |
| 181 | File namin g pattern: PLC_CMS_ USPS_retur ns_ *.txt | |
| 182 | Record For mat: formN um^uniqueI d^vpid^ful lName^addr essline1^a ddressline 2^city^sta te^zip^dat emailed | |
| 183 | Sample Rec ord: | |
| 184 | 2nd column unique id is for pr ocessing o n going le tters. | |
| 185 | 742-652A^3 85984210^1 013006426V 772707^B | |
| 186 | Unique id is missing to proces s historic al pre-clo sure lette rs. | |
| 187 | 742-651^^1 008795251V 986965^B | |
| 188 | ||
| 189 | ||
| 190 | Figure 16: USPS Retu rned File Process Ba tch Proces s List Vie w | |
| 191 | ||
| 192 | ||
| 193 | Figure 17: USPS Retu rned File Process Ba tch Proces s History View | |
| 194 | ||
| 195 | ||
| 196 | Figure 18: Class Dia gram: USPS Returned File Batch Process | |
| 197 | ||
| 198 | ||
| 199 | Figure 19: Sequence Diagram: U SPS Return ed File Ba tch Proces s | |
| 200 | ||
| 201 | ||
| 202 | Figure 20: Spring co nfiguratio n for tran saction bo undaries | |
| 203 | ||
| 204 | Pending Ve rification Mailing E rror File for Schedu ledJob.PVM ailingResp onseErrorF ileProcess | |
| 205 | Descriptio n: Batch P rocess wil l import C MS Errored mailing r esponses f or the ini tial pendi ng letters (742-650/ 742-651) a nd the new pre-closu re letter (742-655). | |
| 206 | ||
| 207 | Main Class : PVMailin gResponseE rrorFilePr ocess | |
| 208 | ||
| 209 | Extends: A bstractDat aFileSingl eRowIncrem entProcess (Throttle s reading to 25 reco rds each i teration) | |
| 210 | ||
| 211 | Transactio n Boundari es. | |
| 212 | A new tran saction wi ll be star ted for ea ch record by delegat ing the wo rk to | |
| 213 | commsLogSe rvice. pro cessErrorD ataRecord( dataRecord , fileName ). | |
| 214 | Process st atistics w ill have t heir own t ransaction which are already c onfigured as part of the frame work. | |
| 215 | ||
| 216 | Exception Handling: Any exce ption thro wn out by the servic e will rol l back the transacti on, increm ent the er ror count and write the except ion to the exception file. Exc eption fil e will hav e the same name as i nput file with a .ex ception ex tension. | |
| 217 | ||
| 218 | Multi-Thre ading: Thi s process run with s even threa ds with a task thres hold of 10 tasks | |
| 219 | ||
| 220 | Input: | |
| 221 | File namin g pattern: PLC_CMS_ error_file _*.txt | |
| 222 | Record For mat: formN um^uniqueI d^vpid^ele ment | |
| 223 | Sample Rec ord: | |
| 224 | 742-652A^4 0125502958 ^100878231 1V208987^L ETTERTHREE TESTERT | |
| 225 | ||
| 226 | ||
| 227 | Figure 21: Error Fil e Process Batch Proc ess List V iew | |
| 228 | ||
| 229 | ||
| 230 | Figure 22: Error Fil e Process Batch Proc ess Histor y View | |
| 231 | ||
| 232 | ||
| 233 | Figure 23: Class Dia gram: Erro r File Bat ch Process | |
| 234 | ||
| 235 | ||
| 236 | Figure 24: Sequence Diagram: E rror File Batch Proc ess | |
| 237 | ||
| 238 | ||
| 239 | Figure 25: Spring co nfiguratio n for tran saction bo undaries | |
| 240 | Activate V CE System Parameters | |
| 241 | Descriptio n: This ba tch proces s implemen ts RTC Sto ry 734218: VCE Param eters: Bat ch Process to Activa te System Parameters . | |
| 242 | A future v alue and e ffective d ate have b een added to the Sys tem Parame ters table to suppor t the VCE Parameters requireme nts. This batch proc ess runs o nce a day and checks the effec tive date of each VC E paramete r [ APP_PA RAMETER.PA RAMETER_EF FECTIVE_DA TE]. If th e effectiv e date is before or equal to t he current day, the parameter is activat ed by: | |
| 243 | Copying th e new valu e [ APP_PA RAMETER.PA RAMETER_NE W_VALUE] t o the curr ent value [ APP_PARA METER.PARA METER_VALU E]. | |
| 244 | Clearing o ut both AP P_PARAMETE R.PARAMETE R_EFFECTIV E_DATE and PARAMETER _FUTURE_VA LUE. | |
| 245 | Sending an email to the config ured email list. | |
| 246 | ||
| 247 | Main Class : Activat eSystemPar ameters | |
| 248 | ||
| 249 | Extends : AbstractDa taProcess | |
| 250 | ||
| 251 | Associated Classes: None need ed, uses e xisting ar chitecture . | |
| 252 | ||
| 253 | Transactio n Boundari es. | |
| 254 | Default tr ansaction boundaries are in ef fect, no n ew transac tions are created. The System Parameter Service i s used to read and u pdate syst em paramet ers. | |
| 255 | Process st atistics w ill have t heir own t ransaction which are already c onfigured as part of the frame work. | |
| 256 | ||
| 257 | Exception Handling: Any excep tion throw n out by t he service will roll back the transactio n, increme nt the err or count a nd write t he excepti on to the log file. | |
| 258 | ||
| 259 | Multi-Thre ading: No threads a re created , it runs single thr eaded. | |
| 260 | ||
| 261 | Configurat ion: | |
| 262 | Currently configured to run ev ery day at 6 am in d eployenv.p roperties | |
| 263 | #### Activ ate System Parameter s, Every 6 :00 am Dai ly | |
| 264 | batchProce ss.Activat eSystemPar ameters.sc hedule=0 0 6 * * ? | |
| 265 | Email noti fication l ist is obt ained from JOB_CONFI G.EMAIL_DI STRIBUTION _LIST | |
| 266 | Spring con figuration is in bat ch_process .xml and s cheduling. xml | |
| 267 | ||
| 268 | UI Support : This bat ch process appears i n the user interface (UI) unde r the desc ription “A ctivate Sy stem Param eters”. F rom the UI you can e xecute it, update th e email di stribution list and review the history u sing the l inks provi ded on the Batch Pro cess Manag ement scre en. | |
| 269 | ||
| 270 | VCE Parame ters Chang ed Recalcu lation Bat ch Process | |
| 271 | ||
| 272 | Descriptio n: These b atch proce sses will recalculat e Veterans Choice El igibility for all ac tive Veter ans. [mul tiple inst ances exis t] | |
| 273 | ||
| 274 | Main Class : VCEPara metersChan gedProcess | |
| 275 | ||
| 276 | Extends : AbstractDa taQueryInc rementalPr ocess | |
| 277 | ||
| 278 | Associated Classes: VCEParame tersChange dSpawnedTh readTask | |
| 279 | Transactio n Boundari es: | |
| 280 | Default tr ansaction boundaries are in ef fect, no n ew transac tions are created. The System Parameter Service i s used to read and u pdate the system par ameters. | |
| 281 | Process st atistics w ill have t heir own t ransaction which are already c onfigured as part of the frame work. | |
| 282 | ||
| 283 | Exception Handling: Any excep tion throw n in the c alculation process w ill increm ent the er ror count and the de tails of t he excepti on will be written t o the appl ication lo g file. | |
| 284 | ||
| 285 | Multi-Thre ading: Th ese proces ses are mu lti-thread ed since i t they wil l recalcul ate VC Eli gibility o n all acti ve Veteran s in the s ystem. [ ~9 million ] | |
| 286 | ||
| 287 | Configurat ion: | |
| 288 | They are n ot schedul ed process es, they m ust be run manually through th e Batch Pr ocess User Interface . | |
| 289 | They do ac cept custo m argument s, discuss ed in the next secti on. | |
| 290 | ||
| 291 | Descriptio n: In the UI, Enroll ment Syste m users wi ll see: | |
| 292 | ||
| 293 | ||
| 294 | There are 5 copies o f this Bat ch Process in the UI . The imp lementatio n is ident ical for e ach but th e data ret urned by t he queries is differ ent for ea ch one. | |
| 295 | ||
| 296 | ScheduledJ ob.VCEPara metersChan ged: | |
| 297 | This proce ss has no restrictio ns on the data, it w ill do all veterans that need to be reca lculated. [ VCELIGI BILITY. VC E_RECALC_R EQUIRED_IN D is not s et to ‘G’ ] | |
| 298 | The defaul t number o f threads is 20. | |
| 299 | The defaul t Fetch Si ze is 10,0 00. | |
| 300 | ||
| 301 | ScheduledJ ob.VCEPara metersChan gedNode1-N ode4: | |
| 302 | These inst ances are restricted to ¼ of t he total r esult set each. The y are desi gned to ru n on diffe rent nodes in the pr oduction e nvironment , for maxi mum throug hput. | |
| 303 | The defaul t number o f threads is 15. | |
| 304 | The defaul t Fetch Si ze is 10,0 00. | |
| 305 | ||
| 306 | Custom Arg uments: | |
| 307 | Each proce ss support s the same custom ar guments, i n this ord er: | |
| 308 | Thread Poo l size (in teger) | |
| 309 | Fetch Size (integer, number of records) | |
| 310 | Job Result Update In terval (in teger, num ber of rec ords) | |
| 311 | Task Count (integer) | |
| 312 | Spawn Retr y period ( millisecon ds) | |
| 313 | The argume nts can be separated by a comm a or space , but not both. | |
| 314 | ||
| 315 | Process Lo gic: | |
| 316 | The proces sing of ea ch record is as foll ows: | |
| 317 | First the person is read from the db usi ng the VPI D returned by the qu ery. | |
| 318 | The VcePar ameterChan geInProces s flag is set on the Person. | |
| 319 | The Person ’s VcEligi bility is read. | |
| 320 | If a recal culation i s necessar y (VceReca lcRequired flag is n ot ‘G’) , then the eligibilit yEnrollmen tService.u pdateVCERe calculatio nForBatchP rocess() m ethod is c alled to i nvoke the business l ogic. | |
| 321 | If VceReca lcRequired is set to ‘G’, the person is already re calculated and is sk ipped by t he process . | |
| 322 | The recalc ulation fl ag is set to ‘G’, to indicate that the r ecalculati on was don e. | |
| 323 | ||
| 324 | Thread Syn chronizati on Points: By design for recor d throughp ut, there are no thr ead synchr onization points cod ed into th ese batch processes. The reaso n is that each proce ss is desi gned to ge t differen t data. Sc heduledJob .VCEParame tersChange d was left in the sy stem to ca tch any po ssible rec ords misse d by the N ode proces ses (for i nstance, i f new reco rds are cr eated whil e the Node batch pro cesses are running). | |
| 325 | Do not run Scheduled Job.VCEPar ametersCha nged while the Node processes are runnin g because that may r esult in c ontention for the sa me data, a nd row loc king db er rors. |
Araxis Merge (but not the data content of this report) is Copyright © 1993-2016 Araxis Ltd (www.araxis.com). All rights reserved.