Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.Contact Sales

Find how far each job step can be read

Recipe IDio.moderne.mainframe.batch.FindExecutionPaths

Artifactio.moderne.recipe:recipes-mainframe

Report every job step with the program it runs, the procedure it came through, what its PARM passes position by position, where the control cards it is handed are written, and a verdict on whether all of that could be read from the source supplied — marking each EXEC card with the verdict its step reached. A step is a chain of names: the EXEC names a procedure, the procedure's cards name symbols, a symbol names the member a DD reads, and that member holds the cards the program really runs. RESOLVED says every link held and everything the step does is written in what was read; INHERITED says every link held and part of what it does is a setting written outside the application libraries; UNRESOLVED says a name was not followed at all. Only RESOLVED is safe to rewrite without asking anyone anything, which is what makes this the gate any change to a job has to pass first. AnalyzeExecutionPaths answers the same question and changes nothing.

Single recipeOpenRewriteModerne Proprietary License

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Usage

Run this recipe

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe FindExecutionPaths

If the recipe is not available locally, then you can install it using:

RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.

RELEASE

mod config recipes jar install io.moderne.recipe:recipes-mainframe:RELEASE

LATEST

mod config recipes jar install io.moderne.recipe:recipes-mainframe:LATEST

Pinned version

mod config recipes jar install io.moderne.recipe:recipes-mainframe:0.1.0

Data tables

Execution paths

io.moderne.mainframe.analysis.table.ExecutionPaths

Every job step with the program it runs, the procedure it came through, what its PARM passes, where its control cards are written, and the verdict on whether all of that could be read from the source supplied.

Export after a run

mod study . --last-recipe-run \
  --data-table io.moderne.mainframe.analysis.table.ExecutionPaths

Column	Description
Job	The job name, empty for a member with no JOB card.
Member	The JCL member the job was read from.
Source path	The file the job was read from, which is the file to open at the line below.
Line	The one-based line of the EXEC card the path starts at. A step a procedure supplies is written in that procedure and has no line in the job, so it is the calling EXEC card that is given — the line the job's reader has, and the card a transformation would be applied to.
Step number	Where the step falls in the job as it runs, procedures expanded, counting from one.
Procedure	The procedure the step is written in. Empty for a step written in the job itself; filled in with the procedure it calls when that procedure was not supplied, which is the case where nothing below can be read.
Step	The step name, qualified by the step that called its procedure — UNLHST.UNL. This is the name the reasons below are written against.
Program	The program the step names on PGM=, with its symbols filled in. What that program then loads is its own business and is usually in the PARM beside it: an IMS region names itself here, and a utility names an engine that reads its real instructions off the control cards.
PARM	What PARM= passes the program, symbols filled in and the apostrophes that carried it taken off. Empty where the step passes none.
PARM positions	The same PARM split into the positions the program reads it as, separated by | , with a group left whole — ssid,uid,HIDDEN(user,pswd) is three positions and not four. A utility reads its parameters by position, so this is where the subsystem a step runs against is written.
DD name	The DD that hands the step a deck of control cards. Empty for a step handed none; a step handed several has a row each, since the cards rather than the JCL are what such a step really runs.
Cards	Where those cards are written: IN_STREAM in this member's own job stream, PROCEDURE in the stream of the procedure the step calls, MEMBER in the library member the DD names. Empty where the step is handed no cards.
Cards member	The data set and member the DD names, CLM.PROD.CTLCARD(UNLCLM01). Empty for cards written in a stream. Where the member name is itself a symbol the job passed, this is what it resolved to — which for a job whose deck is named only on DECK= is the one line that says what the job does.
Verdict	RESOLVED where every name was followed and everything the step does is written in what was read, INHERITED where every name was followed and part of what it does is a setting written outside the application libraries, UNRESOLVED where a name was not followed at all. Only RESOLVED is safe to rewrite without asking anyone anything. The verdict is the whole path's, so the rows of one path all carry it.
Reasons	Every reason the verdict is not RESOLVED, separated by ; , each written as the kind, the step and DD it was found under, and its subject — KEYWORD_INHERITED UNLPOL.UNL.SYSIN FORMAT. Empty for a resolved path. One row per reason, with the kinds counted, is ExecutionPathGaps.

Execution path gaps

io.moderne.mainframe.analysis.table.ExecutionPathGaps

One row per reason a job step's execution path is not fully determined by the source supplied: the kind of gap, the step and DD it was found under, and what it is about.

Export after a run

mod study . --last-recipe-run \
  --data-table io.moderne.mainframe.analysis.table.ExecutionPathGaps

Column	Description
Job	The job name, empty for a member with no JOB card.
Member	The JCL member the job was read from.
Source path	The file the job was read from.
Line	The one-based line of the EXEC card whose path this reason belongs to, which is the line of this file a reader opens. With the member it is the key back to the ExecutionPaths rows of the same path.
Step	The step the reason was found in, qualified by the step that called its procedure — a keyword left uncoded in a deck the procedure's SYSIN names is found in UNLHST.UNL and belongs to the path of UNLHST.
Kind	PROCEDURE_MISSING for a procedure that was not in the library supplied, SYMBOL_UNDEFINED for a symbol nothing sets, MEMBER_MISSING for a library member a DD names and nobody supplied, CARDS_NOT_READ for a deck that opens a statement of a language read here and could not be read as one, KEYWORD_INHERITED for a keyword a deck leaves to a setting written outside the application libraries.
DD name	The DD the reason was found under. Empty where it was not found under one — a missing procedure, or a symbol on the EXEC card itself.
Name	What the reason is about: the procedure, the symbol without its &, the member, or the keyword. Empty for CARDS_NOT_READ, where the DD is itself the subject.
Verdict	The verdict this kind of reason carries a path to: UNRESOLVED for a name that was not followed, INHERITED for behaviour that is a site setting. A path's own verdict is the worst its reasons carry.

Findings

io.moderne.mainframe.analysis.table.Findings

Everything the mainframe analyses found wrong, ranked, with the evidence for each and the line it is on. Sort on priority.

Export after a run

mod study . --last-recipe-run \
  --data-table io.moderne.mainframe.analysis.table.Findings

Column	Description
Priority	1 for CRITICAL down to 4 for LOW, so the table sorts.
Severity	CRITICAL for code that cannot do what it was written to do, HIGH for what will break a migration if not decided deliberately, MEDIUM for what is worth knowing first, LOW for cleanup.
Category	What kind of problem it is, which is what groups the report into sections: DEAD_RULE, UNREACHABLE_CODE, COPYBOOK_DRIFT, MIGRATION_BLOCKER, RANGE_PATHOLOGY, DEAD_DATA, COMPLEXITY, LAYOUT_DRIFT, IMS_PCB_MISMATCH, IMS_SEGMENT_NOT_SENSITIVE, IMS_IO_AREA_MISMATCH, MFS_MESSAGE_LENGTH, SCREEN_ITEM_UNREACHED, SCREEN_FIELD_UNREACHED, PARSE_FAILURE, UNDOCUMENTED, STALE_DOCUMENTATION, STALE_REFERENCE, UNENFORCED_BUILD_ORDER, UNSCHEDULED_JOB, AUTOCALL_RESOLVED_REFERENCE, UNRESOLVED_EXECUTION_PATH, INHERITED_SETTING, UNLOAD_NEEDS_REDESIGN, UNLOAD_ACCESS_MODE, UNLOAD_CONSISTENCY, UNLOAD_OUTPUT_WIRING, MIXED_SUBSTITUTION.
Program	The COBOL program, or the copybook where the finding is about one.
Summary	The finding in one sentence, written to be read on its own.
Evidence	Why this is claimed — the conditions that conflict, the two declarations that differ, the caller that made the paragraph unreachable. A finding nobody can check is a finding nobody will act on.
Where	The paragraph, section or data item the finding is in.
Source path	The file, so the finding can be opened.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SourcesFileResults

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SearchResults

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SourcesFileErrors

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.RecipeRunStats

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.