Skip to main content
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

List each job step and the data sets it allocates

Recipe IDio.moderne.mainframe.batch.AnalyzeJclStepDetail
Artifactio.moderne.recipe:recipes-mainframe

Record each job step in the order it runs and every DD it allocates: the data set, whether it is a generation, its disposition, and the record format, record length, block size, space and unit it is allocated with. Read with the procedure library supplied, the steps are the ones the job actually runs — a step that calls a procedure is replaced by the procedure's own steps, each naming the procedure it came from, with the job's DD overrides applied and its symbols filled in. FindJclStepDetail answers the same question and marks the DD cards in the source; this one produces the table 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 AnalyzeJclStepDetail

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.

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

Data tables​

JCL step detail
io.moderne.mainframe.analysis.table.JclStepDetail

Every data set each job step allocates, with the procedure the step came from and the attributes the data set is allocated with.

Export after a run
mod study . --last-recipe-run \
--data-table io.moderne.mainframe.analysis.table.JclStepDetail
ColumnDescription
JobThe job name, empty for a member with no JOB card.
MemberThe JCL member the job was read from.
Source pathThe file the job was read from, which is the file to open at the line below.
LineThe one-based line the step's EXEC card is on. 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. The procedure is read on its own as well, and its steps carry their own lines there.
Step numberWhere the step falls in the job as it runs, procedures expanded, counting from one. Ordering by it is what makes the rows a step-by-step listing rather than a pile.
ProcedureThe 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 one case where the step below it cannot be read.
StepThe step name, qualified by the step that called its procedure — EXTRACT.RUN — which is how a listing names it and how a DD override refers to it.
ProgramThe program the step loads, symbols filled in. A DL/I or BMP region names itself on PGM= and the program it loads in its PARM, and it is that program which is reported.
PSBThe PSB an IMS region step runs under, from its PARM. Empty for anything that is not one.
DD nameThe DD name, which is the only word the JCL and the program both contain.
Data setThe data set as the installation knows it, with any member. A DD that concatenates several is one row each, because only the data set name joins one job to another.
Data set kindWhether the DD names a catalogued data set, a generation, a library member, something temporary, in-stream data, DUMMY, SYSOUT, or a data set passed by an earlier step.
GenerationThe relative generation of a generation data group, +1 for the one this step creates and 0 or -1 for one it reads. Empty for everything else.
DispositionThe DISP operand as written. The status is what says whether the step expects the data set to exist.
Record formatRECFM, from the keyword or from within DCB.
Record lengthLRECL, from the keyword or from within DCB. 0 is written on purpose and is not the same as absent, so an omitted one is left empty.
Block sizeBLKSIZE, from the keyword or from within DCB. 0 asks the system to choose one.
SpaceThe SPACE operand without its outer parentheses, CYL,(10,5),RLSE. Only a step that creates a data set writes one.
UnitThe UNIT operand, the device or esoteric group the data set is allocated on.
CRUDThe letters of everything the step's programs do to the data set — C, R, U, D, in that order. Empty where nothing in the run unit assigns the DD, or where the program was not among the sources read.
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
ColumnDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA 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 changesIn 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 changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe 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
ColumnDescription
Source path of search result before the runThe source path of the file with the search result markers present.
Source path of search result after run the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
ResultThe trimmed printed tree of the LST element that the marker is attached to.
DescriptionThe content of the description of the marker.
Recipe that added the search markerThe 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
ColumnDescription
Source pathThe file that failed to parse.
Recipe that made changesThe specific recipe that made a change.
Stack traceThe 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
ColumnDescription
The recipeThe recipe whose stats are being measured both individually and cumulatively.
Source file countThe number of source files the recipe ran over.
Source file changed countThe 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.