RPG - 3.4

Extension ID

com.castsoftware.rpg

What’s new?

See RPG 3.4 - Release Notes.

Description

This extension provides support for applications written using RPG languages and/or CL languages.

Supported languages

• RPG III (also known as GAP 3)
• RPG IV (fixed-form and free format)
• CL

Function Point, Quality and Sizing support

This extension provides the following support:

• Function Points (transactions): a green tick indicates that OMG Function Point counting and Transaction Risk Index are supported
• Quality and Sizing: a green tick indicates that CAST can measure size and that a minimum set of Quality Rules exist

Compatibility

Download and installation instructions

The extension will be automatically downloaded and installed in CAST Console when at least one RPG type file is delivered for analysis. You can manage the extension using the Application - Extensions interface.

Prepare and deliver the source code

When the extension is downloaded and installed, you can now package your source code and run an analysis. The process of preparing and delivering your source code is described below:

Source code preparation

Before the RPG source code can be delivered and then analyzed, it needs to be collected from the proper iSeries libraries and transferred to the designated location. During this operation, each artifact (program, CL, DSPF) must be put into a single file only. This will result in a single artifact per file. Furthermore, the type of source code must be expressed using the extension to the file. The appropriate file extensions are listed in the following table.

Source code is kept in a member of a file. The file is kept in a library. Each file can have many members. Each member is the source code for a program. The source code files can have any name but conventionally the names start with Q and end with SRC, for source.

The RPG Analyzer is able to autodetect RPG III versus RPG IV, so there is no difference in using *.rpg or *.rpgle. What is very important is to distinguish between Display, Printer, Logical and Physical files using the specific file extensions listed in above table.

What about IBM Db2 for i source code?

In previous releases of the RPG Analyzer extension, when IBM Db2 for i source code was delivered, a dedicated extraction process was launched within the RPG Analyzer to transform this source code into a format that could be analyzed. Starting in release ≥ 3.1.x, the RPG Analyzer is no longer responsible for analyzing source code from IBM DB2 for i. Instead, this task is undertaken by the com.castsoftware.sqlanalyzer (release ≥ 3.5.4 is required).

There is no change to source code delivery process when using AIP Console - the IBM DB2 for i source code should be delivered together with the RPG source code and AIP Console will be able to detect this type of source code and create the necessary Analysis Units. For those using legacy CAST Management Studio/Delivery Manager Tool, the source code delivery process has changed and is explained below.

IBM Db2 for i is also known as DB400.

Deliver the source code

Using CAST Imaging Console

RPG is supported in CAST Console ≥ 1.22.

Note about using RPG ≥ 3.1.0 with AIP Console 1.22, 1.23, 1.24 and 1.25

RPG ≥ 3.1.0 does not function correctly with CAST Imaging Console 1.22, 1.23, 1.24 and 1.25, however, a workaround exists. Before delivering your source code, locate the following file on the Node that will be performing the analysis:

%PROGRAMDATA%\CAST\AipConsole\AipNode\code-scanner-config.xml

Edit the file and remove or comment out the following section:

<package packageType="dmtdb400techno.DB400Package"
   extractorType="dmtdb400extractor.DB400Extractor"
   deliveryFile=".lf;.pf;.sqli;.sqlt;.sqlv;.sqlu;.sqlp"
   deliveryData="COE"/>

Save the file and restart the Node.

CAST Imaging Console expects either a ZIP/archive file or source code located in a folder configured in Console. You should include in the ZIP/source code folder all RPG and IBM DB2 for i (if present) source code. CAST highly recommends placing the files in a folder dedicated to RPG. If you are using a ZIP/archive file, zip the folders in the “temp” folder - but do not zip the “temp” folder itself, nor create any intermediary folders:

D:\temp
    |-----RPG
    |-----OtherTechno1
    |-----OtherTechno2

When the source code has been delivered, CAST Imaging Console will create an Analysis Unit for:

• IBM Db2 for i (if present)
• RPG

Analysis configuration

Add a dependency between the RPG Analysis Unit as Source and SQL Universal Analysis Unit as the target:

Starting from CAST Imaging Console 1.26, this dependency will be automatically added and no manual intervention is required. You should still check that the dependency is present, however.

Configuring Technical Size measures for RPG in the CAST Health Dashboard

Technical Size measures can be displayed for RPG analysis results in the CAST Health Dashboard by manually editing the following file:

1.x WAR file: %CATALINA_HOME%\webapps\<dashboard>\portal\resources\app.json
2.x WAR file: %CATALINA_HOME%\webapps\<dashboard>\WEB-INF\classes\config\hd\app.json
2.x ZIP file: com.castsoftware.aip.dashboard.2.0.0\config\hd\app.json

Add the following entries into the existing section “TechnicalSizeMeasures”:

"TechnicalSizeMeasures": {
...
      {
        "id": 1008000,
        "label": "Number of RPG400 Program(RPG400)"
      },
      {
        "id": 1008001,
        "label": "Number of RPG400 Subroutine(RPG400)"
      },
      {
        "id": 1008002,
        "label": "Number of RPG400 Procedure(RPG400)"
      },
      {
        "id": 1008003,
        "label": "Number of RPG IV Copy Member(RPG400)"
      },
      {
        "id": 1009000,
        "label": "Number of RPG300 Program(RPG300)"
      },
      {
        "id": 1009001,
        "label": "Number of RPG300 Subroutine(RPG300)"
      },
      {
        "id": 1009003,
        "label": "Number of RPG300 Copy Member(RPG300)"
      }
} 

Following any changes you make, save the app.json file and then restart your application server so that the changes are taken into account.

What results can you expect?

Transaction Sample

C     SCRLVL        CHAIN     PACCLVS
C                   IF        %FOUND
C                   DELETE    RACCLV
C                   ENDIF

CALL       PGM(&EXTLIB/&EXTPGM)

CL language

See CL Language for more information.

RPG Language

See RPG Language for more information.

Objects

CL400

Icon	Object Name
	CL Program
	CL Project
	CL Subroutine
	CL Call to Generic Program
	CL EXEC SQL
	CL Call to Sql File
	CL Data Queue Publisher
	CL Data Queue Receiver
	CL Data Unknown Queue Publisher
	CL Data Unknown Queue Receiver
	CL IBM MQ Queue Publisher
	CL IBM MQ Queue Receiver
	CL IBM MQ Unknown Queue Publisher
	CL IBM MQ Unknown Queue Receiver
	CL Disk File
	CL File Display
	CL Missing File Disk
	CL Missing Display File

DDS400

Icon	Object Name
	DDS Project
	DDS Section
	DDS Printer File
	DDS Display File
	DDS Join Structure
	DDS Logical File
	DDS Physical File
	DDS Record Structure LF
	DDS Record Structure PF

RPG 300

Icon	Object Name
	RPG III Project
	RPG III Program
	RPG III MainSubroutine
	RPG III Subroutine
	RPG III File Printer
	RPG III File Disk
	RPG III File Workstn
	RPG III File Special
	RPG III File Seq
	RPG III Copy Member
	RPG III SQL Statement/Structure
	RPG III Procedure
	RPG III Call to Generic Program
	RPG III EXEC SQL
	RPG III Missing Copy Member
	RPG III Missing Physical/Logical File
	RPG III Missing Display File
	RPG III Missing Printer File
	RPG III Data Queue Publisher
	RPG III Data Queue Receiver
	RPG III Data Unknown Queue Publisher
	RPG III Data Unknown Queue Receiver
	RPG III IBM MQ Queue Publisher
	RPG III IBM MQ Queue Receiver
	RPG III IBM MQ Unknown Queue Publisher
	RPG III IBM MQ Unknown Queue Receiver

RPG 400

Icon	Object Name
	RPG IV Project
	RPG IV Program
	RPG IV MainSubroutine
	RPG IV Subroutine
	RPG IV File Printer
	RPG IV File Disk
	RPG IV File Workstn
	RPG IV File Special
	RPG IV File Seq
	RPG IV Procedure
	RPG IV Procedure Prototype
	RPG IV Copy Member
	RPG IV Call to Generic Program
	RPG IV EXEC SQL
	RPG IV Module
	RPG IV Missing Copy Member
	RPG IV Missing Physical/Logical File
	RPG IV Missing Display File
	RPG IV Missing Printer File
	RPG IV Missing Procedure
	RPG IV Data Queue Publisher
	RPG IV Data Queue Receiver
	RPG IV Data Unknown Queue Publisher
	RPG IV Data Unknown Queue Receiver
	RPG IV IBM MQ Queue Publisher
	RPG IV IBM MQ Queue Receiver
	RPG IV IBM MQ Unknown Queue Publisher
	RPG IV IBM MQ Unknown Queue Receiver
	RPG IV Get Resource Service
	RPG IV Post Resource Service
	RPG IV Put Resource Service
	RPG IV Delete Resource Service

Analysis messages

RPG-001

RPG-002

RPG-003

Note: RPG-003 had been expanded to also include the same warning from CL analyser in version of com.castsoftware.rpg ≥ 3.4.0-beta1.

RPG-004

Structural Rules

The following structural rules are provided:

Known limitations

• SOAP services are not supported
• In RPG
  • Dynamic calls are not supported
  • Dynamic SQL is partially supported since 3.3.0-alpha2 (’prepare’ and ‘execute immediate’ with variables are resolved when encountered in RPG IV free format; the support for RPG IV fixed format and CL is available since 3.3.0-alpha3)