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

Expand copybooks and procedures

Recipe IDio.moderne.mainframe.listing.ExpandSource

Artifactio.moderne.recipe:recipes-mainframe

Report every COBOL program and every job line by line as it runs rather than as it was written: each COPY and EXEC SQL INCLUDE replaced by what it brings in with REPLACING applied, each procedure and INCLUDE member exploded between //*+ lines with its DD overrides merged in and its symbols filled in. Every line says which member supplied it, which is what tells a line somebody can change in this file from a line that belongs to a copybook thirty programs share.

Both expansions happened at parse time and nothing is read a second time: a copied word carries the copybook that wrote it and a resolved body is part of the job's tree, so this is a second printing of the same tree. The tree itself is untouched and still prints back byte for byte the way the file was written, which is what makes the two readings comparable rather than a substitute for one another.

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.

Options

1 parameters

1 optional

Parameter	Example	Type	Required
writeExpandedSource	—	Boolean	Optional
Write each expansion beside the file it came from as <name>.expanded. A job is written as a deck that could be submitted; a program is written as a listing, numbered over the expansion with the member each line came from beside the number, since it holds both a COPY statement and what the statement brought in and so was never a deck. Off by default, because a portfolio's expansion is larger than the portfolio.

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 ExpandSource

To also set the recipe's optional settings, add them to the command. The values below are examples, not recommendations; see Options for what each one does.

With optional settings (example values)

mod run . --recipe ExpandSource --recipe-option "writeExpandedSource=true"

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

Expanded source

io.moderne.mainframe.analysis.table.ExpandedSource

A program or job line by line as it runs rather than as it was written: every copybook in place with REPLACING applied, every procedure and INCLUDE member exploded and every symbol filled in, each line saying which member supplied it.

Export after a run

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

Column	Description
Source path	The program or job the expansion is of. A copybook and a procedure are expanded where they are used, so they have rows only when read on their own.
Line	The line within the expanded source, counted from 1. It is not the line of the file: a copybook of thirty lines moves everything after it down by thirty.
Expanded line	The line as it runs. For COBOL that is the card as the compiler reads it, columns and all; for JCL it is the card with its symbols substituted and its DD overrides merged in, less the sequence numbers in columns 73-80, which belong to the member and not to the job.
Provenance	The copybook, procedure or INCLUDE member the line came from, empty for a line the file wrote itself. A copybook that copies another names the inner one, which is the file somebody changing the line would open.

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.