ISPF Edit Services API: Programmatic Access to ISPF Editor

The ISPF Edit services API (ISREDIT) provides programmatic access to ISPF editor functions, enabling programs to perform editor operations automatically. REXX scripts can use ISREDIT to open datasets, modify content, search and replace text, and save changes without user interaction. Understanding the Edit services API helps you automate editor operations and build powerful editing tools. This tutorial covers ISREDIT functions, programmatic editor access, REXX integration, and best practices.

ISREDIT enables automation of editor tasks that would otherwise require manual interaction. By programmatically accessing the editor, you can create scripts that modify datasets, perform batch edits, and automate repetitive editing tasks. Learning ISREDIT opens up powerful automation capabilities. This tutorial provides practical guidance for using the Edit services API.

Understanding ISREDIT

ISREDIT is the API for programmatic editor access.

What is ISREDIT?

ISREDIT is:

• The ISPF Edit services API
• Provides programmatic editor access
• Accessible from REXX scripts
• Enables automated editing
• Full editor functionality

ISREDIT Capabilities

ISREDIT provides:

• Dataset opening and editing
• Line manipulation (add, delete, change)
• Search and replace operations
• Text processing
• Editor option control

Using ISREDIT

ISREDIT is used from REXX scripts.

ADDRESS ISREDIT

To use ISREDIT:

• Use ADDRESS ISREDIT in REXX
• Directs commands to editor services
• Enables ISREDIT function calls
• Sets up editor environment

Example:

1
2
3
4
5
6
7
8
9
10
/*REXX*/
address isredit
'DATASET('"'"dsn"'"')'
if rc <> 0 then do
  say 'Error opening dataset'
  exit 8
end
/* Perform edit operations */
'SAVE'
exit 0

Opening Datasets

To open a dataset:

1
2
3
4
5
6
/*REXX*/
parse arg dsn
address isredit
'DATASET('"'"dsn"'"')'
if rc <> 0 then exit 8
exit 0

This opens the dataset for programmatic editing.

Opening PDS Members

To open a PDS member:

1
2
3
4
5
6
/*REXX*/
parse arg dsn member
address isredit
'DATASET('"'"dsn"("member")"'"')'
if rc <> 0 then exit 8
exit 0

ISREDIT Functions

ISREDIT provides many editor functions.

Line Operations

Line manipulation functions:

• (LINE) AFTER n 'text': Add line after line n
• (LINE) BEFORE n 'text': Add line before line n
• (LINE) n DELETE: Delete line n
• (LINE) n 'text': Change line n

Example adding a line:

1
2
3
4
5
6
7
/*REXX*/
address isredit
'DATASET('"'"dsn"'"')'
'(LINE) AFTER 10 "NEW LINE TEXT"'
if rc <> 0 then say 'Error adding line'
'SAVE'
exit 0

Search and Replace

Search and replace functions:

• (FIND) 'pattern': Find text pattern
• (CHANGE) 'old' 'new': Replace text
• (CHANGE) 'old' 'new' ALL: Replace all occurrences

Example search and replace:

1
2
3
4
5
6
7
/*REXX*/
address isredit
'DATASET('"'"dsn"'"')'
'(CHANGE) "OLD TEXT" "NEW TEXT" ALL'
if rc <> 0 then say 'Error in replace'
'SAVE'
exit 0

Line Navigation

Navigation functions:

• (LOCATE) n: Move to line n
• (TOP): Move to top
• (BOTTOM): Move to bottom
• (UP) n: Move up n lines
• (DOWN) n: Move down n lines

Reading Lines

Functions to read line content:

• (LINE) n .ZCSR: Read line n
• (GET_LINE) n: Get line n content
• Line content stored in variables
• Can process line by line

Common ISREDIT Patterns

Common patterns for ISREDIT usage.

Batch Editing Pattern

Pattern for batch editing:

1
2
3
4
5
6
7
8
9
10
/*REXX*/
parse arg dsn
address isredit
'DATASET('"'"dsn"'"')'
if rc <> 0 then exit 8
/* Perform edits */
'(LINE) AFTER 1 "HEADER LINE"'
'(CHANGE) "OLD" "NEW" ALL'
'SAVE'
exit 0

Line-by-Line Processing

Process dataset line by line:

1
2
3
4
5
6
7
8
9
10
11
12
/*REXX*/
parse arg dsn
address isredit
'DATASET('"'"dsn"'"')'
if rc <> 0 then exit 8
do i = 1 to 100
  '(LINE) i .ZCSR'
  if rc <> 0 then leave
  /* Process line content */
end
'SAVE'
exit 0

Conditional Editing

Edit based on conditions:

1
2
3
4
5
6
7
8
9
10
11
12
/*REXX*/
address isredit
'DATASET('"'"dsn"'"')'
do i = 1 to 100
  '(LINE) i .ZCSR'
  if rc <> 0 then leave
  if pos('PATTERN',.zcsr) > 0 then do
    '(LINE) i "REPLACED LINE"'
  end
end
'SAVE'
exit 0

Best Practices

Following best practices improves ISREDIT usage:

• Check Return Codes: Always check RC after ISREDIT calls
• Handle Errors: Provide error handling
• Save Changes: Explicitly save changes when needed
• Test Incrementally: Test ISREDIT operations incrementally
• Use Appropriate Functions: Choose the right ISREDIT function
• Document Operations: Document what ISREDIT operations do
• Verify Results: Verify edits were applied correctly
• Backup Before Editing: Backup datasets before programmatic edits

Explain Like I'm 5: ISREDIT

Think of ISREDIT like a robot that can edit documents for you:

• ISREDIT is like a robot that can edit documents automatically. Instead of you opening a document and making changes yourself, you tell the robot what to do, and it does all the editing for you. It's like having an assistant that can edit documents while you do other things!
• Programmatic Access is like giving the robot instructions. You write down exactly what you want the robot to do - "add this line here," "change this word to that word," "delete this line." The robot follows your instructions and makes all the changes. It's like programming a robot to do your editing!
• Automation is like having the robot do repetitive tasks. If you need to make the same change to 100 documents, you don't do it 100 times - you tell the robot once, and it does all 100 automatically. It's like having a robot that never gets tired of doing the same thing over and over!
• ISREDIT Functions are like the robot's tools. Each function is a different tool - one for adding lines, one for changing text, one for searching. You pick the right tool for each job. It's like having a toolbox full of editing tools that the robot can use!

So ISREDIT is like having a robot assistant that can edit documents automatically by following your programming instructions!

Practice Exercises

Complete these exercises to reinforce your ISREDIT skills:

Exercise 1: Open Dataset

Practice basics: write REXX script that opens dataset with ISREDIT, check return codes, understand ISREDIT basics, and learn dataset opening. Master basic ISREDIT usage.

Exercise 2: Add Lines

Practice lines: write REXX script that adds lines to dataset, use LINE functions, test line addition, and learn line operations. Master line operations.

Exercise 3: Search and Replace

Practice replace: write REXX script that performs search and replace, use CHANGE function, test replacements, and learn search and replace. Master search and replace.

Exercise 4: Process Lines

Practice processing: write REXX script that processes dataset line by line, read lines, modify based on content, and learn line processing. Master line processing.

Exercise 5: Complete Automation

Practice complete: write REXX script that performs complete editing automation, combine multiple ISREDIT operations, test full automation, and learn complete automation. Master ISREDIT automation.

Related Concepts