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

Analyze how the portfolio reaches its data

Recipe IDio.moderne.mainframe.prethink.AnalyzeDataAccess
Artifactio.moderne.recipe:recipes-mainframe

Record which programs create, read, update and delete which files, queues, DB2 tables and IMS segments, the job steps that bind those files to real data sets, and the CICS commands and DL/I calls the matrix was derived from. FindResourceCrud, FindBatchCrud, FindCicsResources and FindImsDliCalls answer the same questions and mark what they found 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 AnalyzeDataAccess

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​

Resource CRUD matrix
io.moderne.mainframe.analysis.table.ResourceCrud

Which programs create, read, update and delete which files, queues, DB2 tables and IMS segments, across CICS, DL/I, SQL and native file I/O.

Export after a run
mod study . --last-recipe-run \
--data-table io.moderne.mainframe.analysis.table.ResourceCrud
ColumnDescription
ProgramThe COBOL program.
ParagraphThe paragraph or section containing the statement.
Resource kindWhether the store is a file, a temporary storage or transient data queue, a DB2 table or an IMS segment.
ResourceThe resource as the program names it.
External nameWhat the resource is called outside the program — the ASSIGN name for a native file. This is the column two programs have to agree on before they can be said to share a store.
CRUDCREATE, READ, UPDATE or DELETE.
OperationThe statement as written. Two accesses that agree on CRUD can still differ in ways worth seeing.
DynamicWhether the resource name came from a data item rather than a literal.
Batch CRUD matrix
io.moderne.mainframe.analysis.table.BatchCrud

Which job step runs which program against which data set, and what the program does with it.

Export after a run
mod study . --last-recipe-run \
--data-table io.moderne.mainframe.analysis.table.BatchCrud
ColumnDescription
JobThe job name, empty for a member with no JOB card.
MemberThe JCL member.
StepThe step name. An unnamed step is empty, and cannot be referred to by a later step or by a scheduler.
Step programThe program the step names on PGM=.
ProgramThe program that names the file. Not always the step's program: a subprogram opens the DDs of the step that runs its caller.
DD nameThe DD name, which is the only word the JCL and the program both contain.
FileThe file as the program names it, from SELECT.
Written inThe member that asked for the DD, where the program's own text does not — a SAS %INCLUDE reads another member in where the statement stands, so what that member needs the step has to allocate. Empty for a DD the program names itself.
Data setThe data set as the installation knows it, with any member.
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.
DispositionThe DISP operand as written. The status is what says whether the step expects the data set to exist.
CRUDCREATE, READ, UPDATE or DELETE, empty where nothing is bound.
OperationsThe statements the CRUD was read from.
BindingHow far the DD name and the ASSIGN clause got towards meeting. Anything other than BOUND is a gap between the JCL and the program, or a limit of what the sources read can say.
CICS resource usages
io.moderne.mainframe.analysis.table.CicsResourceUsages

Which CICS resources each program touches, and how.

Export after a run
mod study . --last-recipe-run \
--data-table io.moderne.mainframe.analysis.table.CicsResourceUsages
ColumnDescription
ProgramThe COBOL program touching the resource.
ParagraphThe paragraph or section containing the command.
Resource kindWhether the resource is a file, a queue, a program, a transaction or a map.
ResourceThe resource name. For a dynamic reference this is the resolved name where one literal reaches the operand, and otherwise the data name supplying it.
AccessWhat the command does to the resource.
DynamicWhether the resource name came from a data item rather than a literal. Dynamic references are the ones an automated migration has to leave to a person.
CommandThe CICS command that produced this access.
IMS DL/I calls
io.moderne.mainframe.analysis.table.ImsDliCalls

Every DL/I database and message call, however it was written.

Export after a run
mod study . --last-recipe-run \
--data-table io.moderne.mainframe.analysis.table.ImsDliCalls
ColumnDescription
ProgramThe COBOL program making the call.
ParagraphThe paragraph or section containing the call.
InterfaceThe DL/I language interface: CBLTDLI, AIBTDLI, CEETDLI, PLITDLI, or EXEC DLI.
FunctionThe DL/I function, such as GU, GN, ISRT, REPL or DLET. Empty when the function code is supplied by a data item that more than one literal reaches.
Function operandThe argument the function code was passed in, whether or not it resolved.
PCBThe PCB the call was issued against.
PCB positionThe PCB's position in the PSB, counting from zero, or -1 when the program does not declare it at its entry point. The PSB has to be joined on this position to name the database, because nothing in the COBOL does.
Message callWhether the call is against the I/O PCB, making it a message queue read or write rather than a database call.
AccessWhat the call does: READ, CREATE, UPDATE, DELETE, CHECKPOINT or SYSTEM.
SegmentsSegment names the call is qualified by, where they could be resolved.
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.