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

Migrate a Db2 unload job to the base UNLOAD utility

Recipe IDio.moderne.mainframe.db2.MigrateHpuToBaseUnload

Artifactio.moderne.recipe:recipes-mainframe

Rewrite an unload job that runs on the High Performance Unload product so that it runs on the base Db2 UNLOAD utility instead, by IBM's own option table read backwards: OUTDDN becomes UNLDDN, LOADDDN becomes PUNCHDDN, SELECT ... FROM becomes FROM TABLE, WHERE becomes WHEN, OUTMAXROWS becomes LIMIT, OUTFREQROWS becomes SAMPLE, PARALLELISM becomes PARALLEL, and the LOCK and QUIESCE pair becomes the one SHRLEVEL the base utility has for it. The EXEC card is rewritten to PGM=DSNUTILB with it, because the two programs read different dialects and a job with one rewritten and not the other fails on its first card.

Only a step that FindHpuUsage buckets MAPS_KEYWORD_FOR_KEYWORD and whose execution path resolves completely is touched. A step that leaves what it writes to the site parmlib is never rewritten, because the file it writes today is not decided in the source. A procedure or a control card member that several jobs share is rewritten only when every one of those jobs qualifies, and otherwise nothing that job set touches changes at all. Every step visited gets a row saying what was rewritten keyword by keyword, or which of those rules stopped it — including the keywords that were dropped because the base utility has nothing to write them as, which is where the file a downstream reader gets changes shape.

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 MigrateHpuToBaseUnload

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

Db2 unload migrations

io.moderne.mainframe.analysis.table.Db2UnloadMigrations

Every unload step a migration to the base Db2 utility visited: what was rewritten, keyword by keyword, and for a step that was left alone, what stopped it.

Export after a run

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

Column	Description
Job	The job name, empty for a member with no JOB card.
Member	The JCL member the job was read from.
Source path	The file the job was read from.
Line	The one-based line of that file the EXEC card is written on. A step a procedure supplies has no line in the job, so it is the calling card that is given.
Step	The step name, qualified by the step that called its procedure — UNLHST.UNL.
Deck	The control card member the unload is written in, or the JCL member for a deck written in a job stream.
Deck path	The file that deck was read from, which is the file the cards were rewritten in.
Procedure	The procedure the step's EXEC card is written in, empty where the job writes it itself. That card is the one that names the program, so a procedure two jobs call is rewritten only when both of them qualify.
Rewritten	Whether the step now runs on the base utility. False means nothing about the step was changed at all — not the deck, not the EXEC card.
Migration	What FindHpuUsage makes of the deck: MAPS_KEYWORD_FOR_KEYWORD is the only one that is rewritten, ALREADY_THE_TARGET needs nothing, and NEEDS_REDESIGN and NOT_DECIDABLE are for somebody to decide.
Verdict	How far the step reads: RESOLVED, INHERITED where a keyword comes from the site parmlib, UNRESOLVED where a name was not followed. Only RESOLVED is rewritten.
Changed	What was rewritten, keyword by keyword, separated by ; — what each became, and what was dropped because the base utility has nothing to write it as. Empty for a step that was left alone.
Blocked by	Why the step was left alone: the bucket, the verdict, a keyword nothing here translates, or the job whose disagreement stops a procedure or a deck they share. Empty for a step that was rewritten.

Findings

io.moderne.mainframe.analysis.table.Findings

Everything the mainframe analyses found wrong, ranked, with the evidence for each and the line it is on. Sort on priority.

Export after a run

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

Column	Description
Priority	1 for CRITICAL down to 4 for LOW, so the table sorts.
Severity	CRITICAL for code that cannot do what it was written to do, HIGH for what will break a migration if not decided deliberately, MEDIUM for what is worth knowing first, LOW for cleanup.
Category	What kind of problem it is, which is what groups the report into sections: DEAD_RULE, UNREACHABLE_CODE, COPYBOOK_DRIFT, MIGRATION_BLOCKER, RANGE_PATHOLOGY, DEAD_DATA, COMPLEXITY, LAYOUT_DRIFT, IMS_PCB_MISMATCH, IMS_SEGMENT_NOT_SENSITIVE, IMS_IO_AREA_MISMATCH, MFS_MESSAGE_LENGTH, SCREEN_ITEM_UNREACHED, SCREEN_FIELD_UNREACHED, PARSE_FAILURE, UNDOCUMENTED, STALE_DOCUMENTATION, STALE_REFERENCE, UNENFORCED_BUILD_ORDER, UNSCHEDULED_JOB, AUTOCALL_RESOLVED_REFERENCE, UNRESOLVED_EXECUTION_PATH, INHERITED_SETTING, UNLOAD_NEEDS_REDESIGN, UNLOAD_ACCESS_MODE, UNLOAD_CONSISTENCY, UNLOAD_OUTPUT_WIRING, MIXED_SUBSTITUTION.
Program	The COBOL program, or the copybook where the finding is about one.
Summary	The finding in one sentence, written to be read on its own.
Evidence	Why this is claimed — the conditions that conflict, the two declarations that differ, the caller that made the paragraph unreachable. A finding nobody can check is a finding nobody will act on.
Where	The paragraph, section or data item the finding is in.
Source path	The file, so the finding can be opened.

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.