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 references to a name

Recipe IDio.moderne.mainframe.analysis.FindReferences

Artifactio.moderne.recipe:recipes-mainframe

Report every place a data name, program, copybook, data set, DD name or paragraph is declared or referred to, with the file and line, and mark each one in the source. A search over the text finds the name wherever its letters appear; this finds the thing: a CALL through a field whose VALUE names the program, a condition name standing for the item it qualifies, a declaration copied in from a copybook, the DD a SELECT binds and the step that allocates it. What the rest of the portfolio knows about the name — what a program does with a field and where it reaches, who calls a program, who copies a copybook — is written beside its declaration.

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

2 parameters

1 required1 optional

Parameter	Example	Type	Required
searchTerm	CA-CUSTOMER-NUM	String	Required
The name to find every reference to, matched against the whole name without regard to case. Accepts a regular expression.
kind	—	String	Optional
What the name is: DATA_NAME, PROGRAM, COPYBOOK, DATA_SET, DD_NAME or PARAGRAPH. Defaults to every kind, since one name can be a program to COBOL and a PGM= to JCL, or a DD to both.

Usage

Run this recipe

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

shell

mod run . --recipe FindReferences --recipe-option "searchTerm=CA-CUSTOMER-NUM"

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

References

io.moderne.mainframe.analysis.table.References

Every place a named data item, program, copybook, data set, DD name or paragraph is declared or referred to, with the line it is on.

Export after a run

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

Column	Description
Kind	What the name is: DATA_NAME, PROGRAM, COPYBOOK, DATA_SET, DD_NAME or PARAGRAPH.
Name	The name, as written where it was found.
Program	The COBOL program or JCL member the reference is in. For a declaration copied in from a copybook, the program it is copied into.
Source path	The file the reference is in. For a declaration copied in from a copybook, the copybook.
Line	The line within the source path, counted from 1, or 0 where nothing was written at a line of its own.
Reference kind	definition where the name is declared. For a data name, usage wherever it is read, written or tested, a condition name standing for the item it qualifies. For a program, call, link, xctl and cancel as the statement says, and exec for the job step that runs it. copy for a copybook, assign for a DD name the program's SELECT binds and usage for one a later DD refers back to, allocate for the DD naming a data set, and perform, goto and alter for a paragraph.
Context	The source line the reference is on, or every line of a COPY, INCLUDE or EXEC that spans several. On a declaration, what the rest of the portfolio says about the name follows it: whether the program reads or writes a field and what it reaches, which programs CALL a program, which programs copy a copybook.

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.