MainframeMaster

COBOL Tutorial

COBOL INVALID KEY Clause

The INVALID KEY clause represents a critical error handling mechanism within COBOL file processing operations, providing comprehensive exception management for key-related failures in indexed and relative file operations. This clause embodies the principles of robust error handling by supporting graceful failure recovery, detailed error processing, and comprehensive exception management while maintaining program stability, ensuring data integrity, and facilitating reliable file operations across enterprise applications requiring sophisticated error recovery, comprehensive key validation, and resilient data processing with predictable error handling and optimized recovery procedures.

INVALID KEY Syntax and Usage

File Operations with INVALID KEY
cobol
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
*> READ with INVALID KEY READ file-name RECORD KEY IS key-field INVALID KEY imperative-statements NOT INVALID KEY imperative-statements END-READ *> WRITE with INVALID KEY WRITE record-name INVALID KEY imperative-statements NOT INVALID KEY imperative-statements END-WRITE *> REWRITE with INVALID KEY REWRITE record-name INVALID KEY imperative-statements NOT INVALID KEY imperative-statements END-REWRITE *> DELETE with INVALID KEY DELETE file-name RECORD INVALID KEY imperative-statements NOT INVALID KEY imperative-statements END-DELETE *> START with INVALID KEY START file-name KEY IS EQUAL TO key-field INVALID KEY imperative-statements NOT INVALID KEY imperative-statements END-START *> Basic examples 01 WS-FILE-STATUS PIC XX. 88 FILE-OK VALUE "00". 88 RECORD-NOT-FOUND VALUE "23". 88 DUPLICATE-KEY VALUE "22". PROCEDURE DIVISION. *> Read with error handling READ CUSTOMER-FILE KEY IS CUSTOMER-ID INVALID KEY DISPLAY "Customer not found: " CUSTOMER-ID PERFORM ERROR-PROCESSING NOT INVALID KEY PERFORM PROCESS-CUSTOMER-RECORD END-READ *> Write with duplicate key handling WRITE CUSTOMER-RECORD INVALID KEY DISPLAY "Duplicate customer ID: " CUSTOMER-ID PERFORM DUPLICATE-KEY-HANDLING NOT INVALID KEY DISPLAY "Customer record added successfully" END-WRITE
Error Handling
Key Validation
File Operations

Comprehensive INVALID KEY Examples

cobol
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
IDENTIFICATION DIVISION. PROGRAM-ID. INVALID-KEY-DEMO. ENVIRONMENT DIVISION. INPUT-OUTPUT SECTION. FILE-CONTROL. SELECT CUSTOMER-FILE ASSIGN TO "CUSTOMER.DAT" ORGANIZATION IS INDEXED ACCESS MODE IS DYNAMIC RECORD KEY IS CUST-ID ALTERNATE RECORD KEY IS CUST-EMAIL WITH DUPLICATES FILE STATUS IS WS-CUST-STATUS. SELECT PRODUCT-FILE ASSIGN TO "PRODUCT.DAT" ORGANIZATION IS INDEXED ACCESS MODE IS DYNAMIC RECORD KEY IS PROD-ID ALTERNATE RECORD KEY IS PROD-NAME FILE STATUS IS WS-PROD-STATUS. SELECT ORDER-FILE ASSIGN TO "ORDERS.DAT" ORGANIZATION IS RELATIVE ACCESS MODE IS DYNAMIC RELATIVE KEY IS WS-ORDER-KEY FILE STATUS IS WS-ORDER-STATUS. DATA DIVISION. FILE SECTION. FD CUSTOMER-FILE. 01 CUSTOMER-RECORD. 05 CUST-ID PIC X(8). 05 CUST-NAME PIC X(30). 05 CUST-EMAIL PIC X(50). 05 CUST-PHONE PIC X(15). 05 CUST-CREDIT-LIMIT PIC 9(7)V99. 05 CUST-BALANCE PIC S9(7)V99. 05 CUST-STATUS PIC X(10). FD PRODUCT-FILE. 01 PRODUCT-RECORD. 05 PROD-ID PIC X(10). 05 PROD-NAME PIC X(40). 05 PROD-CATEGORY PIC X(20). 05 PROD-PRICE PIC 9(6)V99. 05 PROD-QUANTITY PIC 9(6). 05 PROD-REORDER-LEVEL PIC 9(4). FD ORDER-FILE. 01 ORDER-RECORD. 05 ORDER-ID PIC 9(8). 05 ORDER-CUST-ID PIC X(8). 05 ORDER-DATE PIC 9(8). 05 ORDER-TOTAL PIC 9(8)V99. 05 ORDER-STATUS PIC X(10). WORKING-STORAGE SECTION. 01 WS-FILE-STATUS-FIELDS. 05 WS-CUST-STATUS PIC XX. 88 CUST-OK VALUE "00". 88 CUST-NOT-FOUND VALUE "23". 88 CUST-DUPLICATE VALUE "22". 88 CUST-EOF VALUE "10". 05 WS-PROD-STATUS PIC XX. 88 PROD-OK VALUE "00". 88 PROD-NOT-FOUND VALUE "23". 88 PROD-DUPLICATE VALUE "22". 05 WS-ORDER-STATUS PIC XX. 88 ORDER-OK VALUE "00". 88 ORDER-NOT-FOUND VALUE "23". 01 WS-CONTROL-FIELDS. 05 WS-ORDER-KEY PIC 9(8). 05 WS-OPERATION-TYPE PIC X(10). 05 WS-ERROR-COUNT PIC 9(4) VALUE 0. 05 WS-SUCCESS-COUNT PIC 9(4) VALUE 0. 05 WS-PROCESSING-FLAG PIC X VALUE 'N'. 88 PROCESSING-COMPLETE VALUE 'Y'. 01 WS-SEARCH-FIELDS. 05 WS-SEARCH-CUST-ID PIC X(8). 05 WS-SEARCH-EMAIL PIC X(50). 05 WS-SEARCH-PROD-ID PIC X(10). 05 WS-SEARCH-PROD-NAME PIC X(40). 01 WS-VALIDATION-FIELDS. 05 WS-VALIDATION-RESULT PIC X VALUE 'N'. 88 VALIDATION-PASSED VALUE 'Y'. 88 VALIDATION-FAILED VALUE 'N'. 05 WS-ERROR-MESSAGE PIC X(100). 01 WS-TEST-DATA. 05 WS-TEST-CUSTOMER. 10 WS-TEST-CUST-ID PIC X(8) VALUE "CUST0001". 10 WS-TEST-CUST-NAME PIC X(30) VALUE "JOHN SMITH". 10 WS-TEST-CUST-EMAIL PIC X(50) VALUE "john.smith@email.com". 05 WS-TEST-PRODUCT. 10 WS-TEST-PROD-ID PIC X(10) VALUE "PROD001". 10 WS-TEST-PROD-NAME PIC X(40) VALUE "PREMIUM WIDGET". PROCEDURE DIVISION. MAIN-PROCESSING. PERFORM OPEN-FILES PERFORM DEMONSTRATE-READ-OPERATIONS PERFORM DEMONSTRATE-WRITE-OPERATIONS PERFORM DEMONSTRATE-UPDATE-OPERATIONS PERFORM DEMONSTRATE-DELETE-OPERATIONS PERFORM DEMONSTRATE-START-OPERATIONS PERFORM DEMONSTRATE-ERROR-RECOVERY PERFORM CLOSE-FILES PERFORM DISPLAY-STATISTICS STOP RUN. OPEN-FILES. OPEN I-O CUSTOMER-FILE IF NOT CUST-OK DISPLAY "Error opening customer file: " WS-CUST-STATUS STOP RUN END-IF OPEN I-O PRODUCT-FILE IF NOT PROD-OK DISPLAY "Error opening product file: " WS-PROD-STATUS STOP RUN END-IF OPEN I-O ORDER-FILE IF NOT ORDER-OK DISPLAY "Error opening order file: " WS-ORDER-STATUS STOP RUN END-IF DISPLAY "All files opened successfully". DEMONSTRATE-READ-OPERATIONS. DISPLAY "=== READ OPERATIONS WITH INVALID KEY ===" *> Test reading existing customer MOVE WS-TEST-CUST-ID TO CUST-ID READ CUSTOMER-FILE KEY IS CUST-ID INVALID KEY DISPLAY "Customer not found: " CUST-ID PERFORM CREATE-SAMPLE-CUSTOMER NOT INVALID KEY DISPLAY "Customer found: " CUST-NAME ADD 1 TO WS-SUCCESS-COUNT END-READ *> Test reading non-existent customer MOVE "INVALID1" TO CUST-ID READ CUSTOMER-FILE KEY IS CUST-ID INVALID KEY DISPLAY "Expected: Customer " CUST-ID " not found" ADD 1 TO WS-ERROR-COUNT MOVE "Customer lookup failed" TO WS-ERROR-MESSAGE PERFORM LOG-ERROR NOT INVALID KEY DISPLAY "Unexpected: Found customer " CUST-NAME END-READ *> Test reading by alternate key (email) MOVE WS-TEST-CUST-EMAIL TO CUST-EMAIL READ CUSTOMER-FILE KEY IS CUST-EMAIL INVALID KEY DISPLAY "No customer with email: " CUST-EMAIL ADD 1 TO WS-ERROR-COUNT NOT INVALID KEY DISPLAY "Customer found by email: " CUST-NAME ADD 1 TO WS-SUCCESS-COUNT END-READ DISPLAY SPACES. CREATE-SAMPLE-CUSTOMER. MOVE WS-TEST-CUST-ID TO CUST-ID MOVE WS-TEST-CUST-NAME TO CUST-NAME MOVE WS-TEST-CUST-EMAIL TO CUST-EMAIL MOVE "555-1234" TO CUST-PHONE MOVE 5000.00 TO CUST-CREDIT-LIMIT MOVE 0.00 TO CUST-BALANCE MOVE "ACTIVE" TO CUST-STATUS WRITE CUSTOMER-RECORD INVALID KEY DISPLAY "Error creating sample customer: " CUST-ID ADD 1 TO WS-ERROR-COUNT NOT INVALID KEY DISPLAY "Sample customer created: " CUST-ID ADD 1 TO WS-SUCCESS-COUNT END-WRITE. DEMONSTRATE-WRITE-OPERATIONS. DISPLAY "=== WRITE OPERATIONS WITH INVALID KEY ===" *> Test writing new product MOVE WS-TEST-PROD-ID TO PROD-ID MOVE WS-TEST-PROD-NAME TO PROD-NAME MOVE "ELECTRONICS" TO PROD-CATEGORY MOVE 99.99 TO PROD-PRICE MOVE 100 TO PROD-QUANTITY MOVE 10 TO PROD-REORDER-LEVEL WRITE PRODUCT-RECORD INVALID KEY DISPLAY "Product already exists: " PROD-ID ADD 1 TO WS-ERROR-COUNT PERFORM HANDLE-DUPLICATE-PRODUCT NOT INVALID KEY DISPLAY "Product added successfully: " PROD-ID ADD 1 TO WS-SUCCESS-COUNT END-WRITE *> Test writing duplicate product (should fail) WRITE PRODUCT-RECORD INVALID KEY DISPLAY "Expected: Duplicate product detected: " PROD-ID ADD 1 TO WS-ERROR-COUNT IF PROD-DUPLICATE DISPLAY "Confirmed: Duplicate key error" ELSE DISPLAY "Unexpected error code: " WS-PROD-STATUS END-IF NOT INVALID KEY DISPLAY "Unexpected: Duplicate write succeeded" END-WRITE *> Test writing to relative file MOVE 1 TO WS-ORDER-KEY MOVE 12345678 TO ORDER-ID MOVE WS-TEST-CUST-ID TO ORDER-CUST-ID MOVE FUNCTION CURRENT-DATE(1:8) TO ORDER-DATE MOVE 299.99 TO ORDER-TOTAL MOVE "PENDING" TO ORDER-STATUS WRITE ORDER-RECORD INVALID KEY DISPLAY "Error writing order at position: " WS-ORDER-KEY ADD 1 TO WS-ERROR-COUNT NOT INVALID KEY DISPLAY "Order written successfully at position: " WS-ORDER-KEY ADD 1 TO WS-SUCCESS-COUNT END-WRITE DISPLAY SPACES. HANDLE-DUPLICATE-PRODUCT. DISPLAY "Handling duplicate product scenario..." *> Read existing product to compare READ PRODUCT-FILE KEY IS PROD-ID INVALID KEY DISPLAY "Unexpected: Product not found after duplicate error" NOT INVALID KEY DISPLAY "Existing product: " PROD-NAME DISPLAY "Attempting to add: " WS-TEST-PROD-NAME *> Could offer update option here DISPLAY "Consider using REWRITE to update existing product" END-READ. DEMONSTRATE-UPDATE-OPERATIONS. DISPLAY "=== UPDATE OPERATIONS WITH INVALID KEY ===" *> Test rewriting existing customer MOVE WS-TEST-CUST-ID TO CUST-ID READ CUSTOMER-FILE KEY IS CUST-ID INVALID KEY DISPLAY "Cannot update - customer not found: " CUST-ID ADD 1 TO WS-ERROR-COUNT NOT INVALID KEY *> Update customer information MOVE "JOHN Q. SMITH" TO CUST-NAME MOVE "john.q.smith@email.com" TO CUST-EMAIL ADD 1000.00 TO CUST-CREDIT-LIMIT REWRITE CUSTOMER-RECORD INVALID KEY DISPLAY "Error updating customer: " CUST-ID ADD 1 TO WS-ERROR-COUNT NOT INVALID KEY DISPLAY "Customer updated successfully: " CUST-ID ADD 1 TO WS-SUCCESS-COUNT END-REWRITE END-READ *> Test rewriting non-existent product MOVE "NOEXIST" TO PROD-ID MOVE "NON-EXISTENT PRODUCT" TO PROD-NAME REWRITE PRODUCT-RECORD INVALID KEY DISPLAY "Expected: Cannot rewrite non-existent product" ADD 1 TO WS-ERROR-COUNT NOT INVALID KEY DISPLAY "Unexpected: Rewrite succeeded for non-existent product" END-REWRITE DISPLAY SPACES. DEMONSTRATE-DELETE-OPERATIONS. DISPLAY "=== DELETE OPERATIONS WITH INVALID KEY ===" *> Test deleting existing product MOVE WS-TEST-PROD-ID TO PROD-ID DELETE PRODUCT-FILE INVALID KEY DISPLAY "Cannot delete - product not found: " PROD-ID ADD 1 TO WS-ERROR-COUNT NOT INVALID KEY DISPLAY "Product deleted successfully: " PROD-ID ADD 1 TO WS-SUCCESS-COUNT END-DELETE *> Test deleting non-existent product (should fail) DELETE PRODUCT-FILE INVALID KEY DISPLAY "Expected: Cannot delete non-existent product" ADD 1 TO WS-ERROR-COUNT NOT INVALID KEY DISPLAY "Unexpected: Delete succeeded for non-existent product" END-DELETE *> Test deleting from relative file MOVE 1 TO WS-ORDER-KEY DELETE ORDER-FILE INVALID KEY DISPLAY "Cannot delete order at position: " WS-ORDER-KEY ADD 1 TO WS-ERROR-COUNT NOT INVALID KEY DISPLAY "Order deleted successfully from position: " WS-ORDER-KEY ADD 1 TO WS-SUCCESS-COUNT END-DELETE DISPLAY SPACES. DEMONSTRATE-START-OPERATIONS. DISPLAY "=== START OPERATIONS WITH INVALID KEY ===" *> Test START operation for sequential reading MOVE WS-TEST-CUST-ID TO CUST-ID START CUSTOMER-FILE KEY IS GREATER THAN CUST-ID INVALID KEY DISPLAY "No customers found after: " CUST-ID ADD 1 TO WS-ERROR-COUNT NOT INVALID KEY DISPLAY "Positioned for reading after: " CUST-ID ADD 1 TO WS-SUCCESS-COUNT PERFORM READ-NEXT-CUSTOMERS END-START *> Test START with non-existent key range MOVE "ZZZZZZZZ" TO CUST-ID START CUSTOMER-FILE KEY IS GREATER THAN CUST-ID INVALID KEY DISPLAY "Expected: No customers after " CUST-ID ADD 1 TO WS-ERROR-COUNT NOT INVALID KEY DISPLAY "Unexpected: Found customers after " CUST-ID END-START DISPLAY SPACES. READ-NEXT-CUSTOMERS. PERFORM 3 TIMES READ CUSTOMER-FILE NEXT RECORD AT END DISPLAY "Reached end of customer file" EXIT PERFORM NOT AT END DISPLAY "Next customer: " CUST-ID " - " CUST-NAME END-READ END-PERFORM. DEMONSTRATE-ERROR-RECOVERY. DISPLAY "=== ERROR RECOVERY DEMONSTRATIONS ===" PERFORM ROBUST-CUSTOMER-LOOKUP PERFORM SAFE-PRODUCT-UPDATE PERFORM BATCH-PROCESSING-WITH-ERRORS DISPLAY SPACES. ROBUST-CUSTOMER-LOOKUP. DISPLAY "Robust Customer Lookup with Error Recovery:" MOVE "LOOKUP01" TO WS-SEARCH-CUST-ID MOVE WS-SEARCH-CUST-ID TO CUST-ID READ CUSTOMER-FILE KEY IS CUST-ID INVALID KEY DISPLAY "Primary lookup failed for: " CUST-ID PERFORM ALTERNATIVE-CUSTOMER-SEARCH NOT INVALID KEY DISPLAY "Customer found: " CUST-NAME PERFORM PROCESS-CUSTOMER-DATA END-READ. ALTERNATIVE-CUSTOMER-SEARCH. DISPLAY "Attempting alternative search methods..." *> Try partial key search MOVE WS-SEARCH-CUST-ID(1:4) TO CUST-ID(1:4) MOVE LOW-VALUES TO CUST-ID(5:4) START CUSTOMER-FILE KEY IS GREATER THAN OR EQUAL TO CUST-ID INVALID KEY DISPLAY "No customers found with similar ID pattern" PERFORM CREATE-CUSTOMER-NOT-FOUND-LOG NOT INVALID KEY DISPLAY "Found similar customer ID pattern" PERFORM DISPLAY-SIMILAR-CUSTOMERS END-START. CREATE-CUSTOMER-NOT-FOUND-LOG. DISPLAY "Creating customer not found log entry..." MOVE "CUSTOMER NOT FOUND" TO WS-ERROR-MESSAGE PERFORM LOG-ERROR. DISPLAY-SIMILAR-CUSTOMERS. DISPLAY "Similar customers found:" PERFORM 5 TIMES READ CUSTOMER-FILE NEXT RECORD AT END EXIT PERFORM NOT AT END IF CUST-ID(1:4) = WS-SEARCH-CUST-ID(1:4) DISPLAY " Similar: " CUST-ID " - " CUST-NAME ELSE EXIT PERFORM END-IF END-READ END-PERFORM. SAFE-PRODUCT-UPDATE. DISPLAY "Safe Product Update with Validation:" MOVE "PROD002" TO PROD-ID *> First read to verify existence READ PRODUCT-FILE KEY IS PROD-ID INVALID KEY DISPLAY "Product not found for update: " PROD-ID PERFORM CREATE-NEW-PRODUCT-OPTION NOT INVALID KEY DISPLAY "Product found, proceeding with update" PERFORM VALIDATE-UPDATE-DATA IF VALIDATION-PASSED PERFORM EXECUTE-SAFE-UPDATE ELSE DISPLAY "Update validation failed: " WS-ERROR-MESSAGE END-IF END-READ. CREATE-NEW-PRODUCT-OPTION. DISPLAY "Product doesn't exist - offering creation option" MOVE "NEW PRODUCT" TO PROD-NAME MOVE "GENERAL" TO PROD-CATEGORY MOVE 19.99 TO PROD-PRICE MOVE 50 TO PROD-QUANTITY MOVE 5 TO PROD-REORDER-LEVEL WRITE PRODUCT-RECORD INVALID KEY DISPLAY "Error creating new product: " PROD-ID NOT INVALID KEY DISPLAY "New product created: " PROD-ID END-WRITE. VALIDATE-UPDATE-DATA. SET VALIDATION-PASSED TO TRUE *> Validate price is reasonable IF PROD-PRICE < 0 OR PROD-PRICE > 99999.99 SET VALIDATION-FAILED TO TRUE MOVE "Invalid price range" TO WS-ERROR-MESSAGE END-IF *> Validate quantity is positive IF PROD-QUANTITY < 0 SET VALIDATION-FAILED TO TRUE MOVE "Negative quantity not allowed" TO WS-ERROR-MESSAGE END-IF. EXECUTE-SAFE-UPDATE. *> Make backup of original values (in real application) ADD 10 TO PROD-QUANTITY ADD 5.00 TO PROD-PRICE REWRITE PRODUCT-RECORD INVALID KEY DISPLAY "Update failed for product: " PROD-ID *> Restore original values here NOT INVALID KEY DISPLAY "Product updated successfully: " PROD-ID END-REWRITE. BATCH-PROCESSING-WITH-ERRORS. DISPLAY "Batch Processing with Error Handling:" MOVE 0 TO WS-ERROR-COUNT MOVE 0 TO WS-SUCCESS-COUNT *> Process multiple operations with error tracking PERFORM PROCESS-BATCH-CUSTOMER PERFORM PROCESS-BATCH-PRODUCT PERFORM PROCESS-BATCH-ORDER DISPLAY "Batch processing completed:" DISPLAY " Successful operations: " WS-SUCCESS-COUNT DISPLAY " Failed operations: " WS-ERROR-COUNT. PROCESS-BATCH-CUSTOMER. MOVE "BATCH001" TO CUST-ID MOVE "BATCH CUSTOMER 1" TO CUST-NAME MOVE "batch1@test.com" TO CUST-EMAIL WRITE CUSTOMER-RECORD INVALID KEY ADD 1 TO WS-ERROR-COUNT DISPLAY "Batch customer write failed: " CUST-ID NOT INVALID KEY ADD 1 TO WS-SUCCESS-COUNT END-WRITE. PROCESS-BATCH-PRODUCT. MOVE "BATCH001" TO PROD-ID MOVE "BATCH PRODUCT 1" TO PROD-NAME WRITE PRODUCT-RECORD INVALID KEY ADD 1 TO WS-ERROR-COUNT DISPLAY "Batch product write failed: " PROD-ID NOT INVALID KEY ADD 1 TO WS-SUCCESS-COUNT END-WRITE. PROCESS-BATCH-ORDER. MOVE 2 TO WS-ORDER-KEY MOVE 87654321 TO ORDER-ID WRITE ORDER-RECORD INVALID KEY ADD 1 TO WS-ERROR-COUNT DISPLAY "Batch order write failed at position: " WS-ORDER-KEY NOT INVALID KEY ADD 1 TO WS-SUCCESS-COUNT END-WRITE. PROCESS-CUSTOMER-DATA. DISPLAY "Processing customer: " CUST-NAME DISPLAY "Credit limit: $" CUST-CREDIT-LIMIT DISPLAY "Current balance: $" CUST-BALANCE. LOG-ERROR. DISPLAY "ERROR LOG: " WS-ERROR-MESSAGE *> In real application, write to error log file. CLOSE-FILES. CLOSE CUSTOMER-FILE CLOSE PRODUCT-FILE CLOSE ORDER-FILE DISPLAY "All files closed successfully". DISPLAY-STATISTICS. DISPLAY "=== PROCESSING STATISTICS ===" DISPLAY "Total successful operations: " WS-SUCCESS-COUNT DISPLAY "Total failed operations: " WS-ERROR-COUNT IF WS-ERROR-COUNT > 0 COMPUTE WS-ORDER-KEY = (WS-ERROR-COUNT * 100) / (WS-SUCCESS-COUNT + WS-ERROR-COUNT) DISPLAY "Error rate: " WS-ORDER-KEY "%" ELSE DISPLAY "Error rate: 0%" END-IF. *> Advanced error handling patterns TRANSACTION-ROLLBACK-SIMULATION. DISPLAY "=== TRANSACTION ROLLBACK SIMULATION ===" *> Simulate transaction with multiple operations PERFORM BEGIN-TRANSACTION PERFORM TRANSACTION-OPERATION-1 PERFORM TRANSACTION-OPERATION-2 PERFORM TRANSACTION-OPERATION-3 IF WS-ERROR-COUNT > 0 PERFORM ROLLBACK-TRANSACTION ELSE PERFORM COMMIT-TRANSACTION END-IF. BEGIN-TRANSACTION. DISPLAY "Beginning transaction..." MOVE 0 TO WS-ERROR-COUNT. TRANSACTION-OPERATION-1. MOVE "TRANS001" TO CUST-ID READ CUSTOMER-FILE KEY IS CUST-ID INVALID KEY ADD 1 TO WS-ERROR-COUNT DISPLAY "Transaction failed: Customer not found" END-READ. TRANSACTION-OPERATION-2. MOVE "TPROD001" TO PROD-ID READ PRODUCT-FILE KEY IS PROD-ID INVALID KEY ADD 1 TO WS-ERROR-COUNT DISPLAY "Transaction failed: Product not found" END-READ. TRANSACTION-OPERATION-3. *> Simulate order creation MOVE 3 TO WS-ORDER-KEY WRITE ORDER-RECORD INVALID KEY ADD 1 TO WS-ERROR-COUNT DISPLAY "Transaction failed: Order creation error" END-WRITE. ROLLBACK-TRANSACTION. DISPLAY "Rolling back transaction due to errors..." *> In real application, undo all changes. COMMIT-TRANSACTION. DISPLAY "Committing successful transaction...". COMPREHENSIVE-ERROR-ANALYSIS. DISPLAY "=== COMPREHENSIVE ERROR ANALYSIS ===" *> Analyze different types of invalid key errors PERFORM ANALYZE-FILE-STATUS-CODES PERFORM TEST-BOUNDARY-CONDITIONS PERFORM TEST-CONCURRENT-ACCESS. ANALYZE-FILE-STATUS-CODES. DISPLAY "Analyzing file status codes:" MOVE "ANALYZE1" TO CUST-ID READ CUSTOMER-FILE KEY IS CUST-ID INVALID KEY EVALUATE WS-CUST-STATUS WHEN "23" DISPLAY " Status 23: Record not found" WHEN "22" DISPLAY " Status 22: Duplicate key" WHEN "24" DISPLAY " Status 24: Boundary violation" WHEN OTHER DISPLAY " Other status: " WS-CUST-STATUS END-EVALUATE END-READ. TEST-BOUNDARY-CONDITIONS. DISPLAY "Testing boundary conditions:" *> Test with empty key MOVE SPACES TO CUST-ID READ CUSTOMER-FILE KEY IS CUST-ID INVALID KEY DISPLAY " Empty key handled correctly" END-READ *> Test with high values MOVE HIGH-VALUES TO CUST-ID READ CUSTOMER-FILE KEY IS CUST-ID INVALID KEY DISPLAY " High values key handled correctly" END-READ. TEST-CONCURRENT-ACCESS. DISPLAY "Testing concurrent access scenarios:" *> Simulate record locked by another process MOVE "LOCKED01" TO CUST-ID READ CUSTOMER-FILE KEY IS CUST-ID INVALID KEY IF WS-CUST-STATUS = "9D" DISPLAY " Record locked by another process" ELSE DISPLAY " Other concurrent access issue: " WS-CUST-STATUS END-IF END-READ.

INVALID KEY Error Types

Read Operation Errors
  • • Record not found (status 23)
  • • Invalid key value
  • • Key boundary violations
  • • File positioning errors
  • • Access method conflicts
Write Operation Errors
  • • Duplicate key (status 22)
  • • Key sequence violations
  • • File space limitations
  • • Record size conflicts
  • • Index corruption issues

Interactive Tutorial

Hands-On Exercise: Error Handling Patterns
Practice implementing robust error handling with INVALID KEY clauses

Exercise 1: Safe Record Lookup

cobol
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
01 WS-CUSTOMER-ID PIC X(8). 01 WS-FOUND-FLAG PIC X VALUE 'N'. 88 CUSTOMER-FOUND VALUE 'Y'. PROCEDURE DIVISION. MOVE "CUST0001" TO WS-CUSTOMER-ID MOVE WS-CUSTOMER-ID TO CUST-ID READ CUSTOMER-FILE KEY IS CUST-ID INVALID KEY DISPLAY "Customer not found: " WS-CUSTOMER-ID PERFORM CUSTOMER-NOT-FOUND-PROCESSING NOT INVALID KEY SET CUSTOMER-FOUND TO TRUE PERFORM PROCESS-CUSTOMER-RECORD END-READ.

Exercise 2: Duplicate Key Handling

cobol
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
PROCEDURE DIVISION. *> Attempt to create new customer WRITE CUSTOMER-RECORD INVALID KEY IF WS-FILE-STATUS = "22" DISPLAY "Customer already exists: " CUST-ID PERFORM HANDLE-EXISTING-CUSTOMER ELSE DISPLAY "Write error: " WS-FILE-STATUS PERFORM HANDLE-WRITE-ERROR END-IF NOT INVALID KEY DISPLAY "Customer created successfully: " CUST-ID ADD 1 TO WS-CUSTOMERS-CREATED END-WRITE.

Best Practices

Knowledge Check

Test Your Understanding

Question 1: When to Use

When should you use the INVALID KEY clause?

Answer: Use INVALID KEY with indexed and relative file operations (READ, WRITE, REWRITE, DELETE, START) to handle key-related errors like record not found, duplicate keys, or invalid key values.

Question 2: File Status Integration

How does INVALID KEY relate to file status codes?

Answer: INVALID KEY triggers when file operations fail (file status not "00"). You can check specific file status codes within the INVALID KEY clause to determine the exact error type (23=not found, 22=duplicate, etc.).

Question 3: Recovery Patterns

What are effective recovery patterns for INVALID KEY scenarios?

Answer: Effective patterns include alternative searches for not found records, update operations for duplicate keys, logging for audit trails, retry mechanisms for transient errors, and graceful degradation for continued processing.

Common Error Scenarios

Record Not Found
cobol
1
2
3
4
5
6
7
8
READ CUSTOMER-FILE KEY IS CUST-ID INVALID KEY DISPLAY "Customer not found: " CUST-ID PERFORM SEARCH-ALTERNATIVES NOT INVALID KEY PERFORM PROCESS-CUSTOMER END-READ
Duplicate Key Error
cobol
1
2
3
4
5
6
7
8
9
WRITE CUSTOMER-RECORD INVALID KEY IF FILE-STATUS = "22" DISPLAY "Duplicate customer: " CUST-ID PERFORM UPDATE-EXISTING-CUSTOMER END-IF NOT INVALID KEY DISPLAY "Customer added: " CUST-ID END-WRITE