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

Say what each control card deck is and what it defines

Recipe IDio.moderne.mainframe.controlcard.AnalyzeControlCards

Artifactio.moderne.recipe:recipes-mainframe

Record what kind of deck each control card member holds — DFSORT or ICETOOL statements, IDCAMS commands, Db2 utility control statements, a DSN command deck, or cards no grammar here reads yet — with the steps that read it, the member each SYSIN resolves to, and the data sets an IDCAMS DEFINE creates. A deck written in a job stream is typed the same way and reported under the job it is written in. FindControlCards answers the same question and marks each statement in the source; this one produces the tables 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 AnalyzeControlCards

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

Control card kinds

io.moderne.mainframe.analysis.table.ControlCardKind

What each control card deck is, and which steps read it. A control card library holds sort cards, IDCAMS cards, DSN command decks and parm cards side by side, and nothing in a member's name says which is which — the kind here is read off the deck's first statement. A deck written in a job stream is here too, under the job it is written in, where what it says types it.

Export after a run

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

Column	Description
Member	The control card member, or the job a deck written in the stream is written in. A member two libraries hold has a row for each, which is how an environment's copy is told from the application's own.
Source path	The file the cards are in.
DD	The DD a deck written in the stream arrives on, empty for a member of its own. Which DD it is depends on the utility: DFSORT reads SYSIN, DFSPARM or a xxxxCNTL an ICETOOL USING names.
Line	The one-based line of that file the deck begins on, which is 1 for a member of its own.
Kind	DFSORT, IDCAMS, DSN, DB2_UTILITY or PLAIN, judged by the first statement the deck writes. A member is not typed by its name: the shops that call them SRTxxxxx and DEFxxxxx are following a convention, not a rule.
Statements	How many control statements the deck holds. 0 where no grammar has read it: a PLAIN or DSN deck, and a deck that reached the analysis as plain text because the ingestion did not run the parser that types it.
References	How many job steps read this member. 0 for a member nothing supplied here reads, which is either a deck run by hand or a job that was not supplied; 1 for a deck written in the stream, which is read by the step it is written in.
Referenced by	The steps that read it, as JOB.STEP(DD), joined with commas. A step reaching the deck through a procedure names the DD as it was written on the override, RUN.SYSTSIN.

COBOL relationships

org.openrewrite.mainframe.cobol.table.CobolRelationships

Relationships between different COBOL resources.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.mainframe.cobol.table.CobolRelationships

Column	Description
Dependent	The resource that defines the relationship.
Dependent type	The resource type of the resource that defines the relationship.
Action	The action that links the dependent and dependency.
Dependency	The resource that is exercised or linked to.
Dependency type	The resource type of the resource that is exercised or linked to.
Dependency missing	Indicates whether the dependency is a known resource.
Action metadata	Additional data about the action.
Dependent path	The source file the dependent's statement was written in, or null when the dependent is a name that has no source here.
Dependent line	The one-based line the dependent's statement was written on, or null when it has no source here.
Dependency path	The source file the dependency was written in, or null when the dependency is a name that has no source here, such as a vendor copybook.
Dependency line	The one-based line the dependency's statement was written on, or null when the dependency is a whole file rather than a statement within 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

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.