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

Trace field lineage across programs

Recipe IDio.moderne.mainframe.lineage.FindCrossProgramLineage
Artifactio.moderne.recipe:recipes-mainframe

Follow a field out of the program that declares it, through every CALL that passes it, into the files, queues, maps and IMS segments it reaches in the programs it is passed to. COBOL binds arguments to parameters by position and carries no names across the boundary, so this is the join no repository scan or regular expression can make. Each answer carries the chain of programs and argument positions it was derived from, so it can be checked rather than trusted.

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
ParameterExampleTypeRequired
fieldNameWS-ACCT-IDStringRequired
The field to trace, matched against the declared name. Accepts a regular expression, so a family of fields can be traced at once.
maximumDepth—IntegerOptional
How many CALL boundaries to cross. Defaults to 10, which is past the depth of any call chain worth reading as a single answer.

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 FindCrossProgramLineage --recipe-option "fieldName=WS-ACCT-ID"

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​

Cross program lineage
io.moderne.mainframe.analysis.table.CrossProgramLineage

Where a field's value goes once it leaves the program that declares it, followed through CALL boundaries into every program it reaches.

Export after a run
mod study . --last-recipe-run \
--data-table io.moderne.mainframe.analysis.table.CrossProgramLineage
ColumnDescription
Origin programThe program the trace started from.
Origin fieldThe field the trace started from, as declared in the origin program.
ProgramThe program this row reports on, which is the origin program at depth zero and a called program below that.
FieldWhat the value is called here. A called program names its own parameters, so the name changes at every boundary even though the storage does not.
DepthHow many CALL boundaries were crossed to get here. Zero is the origin.
Call chainThe programs crossed to reach this one, with the argument position bound at each step. Position is all COBOL passes, so it is the whole of the evidence that these two fields are the same storage.
Endpoint kindWhat the value crosses this program's boundary through: a file, a queue, a map, an IMS segment, the terminal, or a further called program. Empty when the value arrives here but goes no further.
EndpointThe resource name, where the statement names one.
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.