IBM · dennis-behm · Jun 1, 2023 · Oct 17, 2022 · Dec 16, 2022 · Jan 10, 2023
diff --git a/build-conf/README.md b/build-conf/README.md
@@ -38,23 +38,32 @@ Property | Description
 --- | ---
 buildPropFiles | Comma separated list of additional build property files to load. Supports both absolute and relative file paths.  Relative paths assumed to be relative to `zAppBuild/build-conf/`.
 buildListFileExt | File extension that indicates the build file is really a build list.
-languagePropertyQualifiers | List of language script property qualifiers. Each language script property has a unique qualifier to avoid collision with other language script properties.
 applicationConfRootDir | Alternate root directory for application-conf location.  Allows for the deployment of the application-conf directories to a static location.  Defaults to ${workspace}/${application}
+gitRepositoryCompareService | Service URL for the Git provider to record a link to the git provider for a visual comparision of two hashes
 requiredDBBToolkitVersion | Minimum required DBB ToolkitVersion to run this version of zAppBuild.
 requiredBuildProperties | Comma separated list of required build properties for zAppBuild/build.groovy. Build and language scripts will validate that *required* build properties have been set before the script runs.  If any are missing or empty, then a validation error will be thrown.
-formatConsoleOutput | Flag to log output in table views instead of printing raw JSON data
-impactBuildOnBuildPropertyChanges | Boolean property to activate impact builds on changes of build properties within the application repository
-impactBuildOnBuildPropertyList | List of build property lists referencing which language properties should cause an impact build when the given property is changed 
-continueOnScanFailure | Determine the behavior when facing a scanner failure. true (default) to continue scanning. false will terminate the process. 
-createBuildOutputSubfolder | Option to create a subfolder with the build label within the build output dir (outDir). Default: true.
-documentDeleteRecords | Option determine if the build framework should document deletions of outputs in DBB Build Report. Default: false. Requires DBB Toolkit 1.1.3 and higher.
-generateDb2BindInfoRecord | Flag to control the generation of a generic DBB build record for a build file to document the configured db2 bind information (application-conf/bind.properties). Default: false ** Can be overridden by a file property. 
 dbb.file.tagging | Controls compile log and build report file tagging. Default: true.
-dbb.LinkEditScanner.excludeFilter | DBB configuration property used by the link edit scanner to exclude load module entries
 metadataStoreType | DBB MetadataStore Type configuration property. Valid options are 'file' or 'db2'. Default: file
 metadataStoreFileLocation | DBB File MetadataStore location. Default: $USER
 metadataStoreDb2Url | DBB configuration property for Db2 URL.  ***Can be overridden by build.groovy option -url, --url***
 metadataStoreDb2ConnectionConf | DBB configuration property for Db2 configuration properties file. 
+dbb.gateway.type | DBB configuration property to determine which gateway type is used for the build process
+dbb.gateway.procedureName | Interactive gateway Procedure Name  
+dbb.gateway.accountNumber | Interactive gateway Account Number  
+dbb.gateway.groupId | Interactive gateway Group ID  
+dbb.gateway.regionSize | Interactive gateway Region Size    
+dbb.gateway.logLevel | Interactive gateway Log Level    
+dbb.scannerMapping | DBB PropertyMapping specifying the scanner implementation to be used 
+continueOnScanFailure | Determine the behavior when facing a scanner failure. true (default) to continue scanning. false will terminate the process. 
+createBuildOutputSubfolder | Option to create a subfolder with the build label within the build output dir (outDir). Default: true.
+buildOutputTSformat | Defines the build timestamp format for build output subfolder and build label.
+formatConsoleOutput | Flag to log output in table views instead of printing raw JSON data on verbose output
+generateDb2BindInfoRecord | Flag to control the generation of a generic DBB build record for a build file to document the configured db2 bind information (application-conf/bind.properties). Default: false ** Can be overridden by a file property.
+generateDb2BindInfoRecordProperties | Comma-separated list of the bind parameters to be added to the DBB build record.
+impactBuildOnBuildPropertyChanges | Boolean property to activate impact builds on changes of build properties within the application repository
+impactBuildOnBuildPropertyList | List of build property lists referencing which language properties should cause an impact build when the given property is changed 
+documentDeleteRecords | Option determine if the build framework should document deletions of outputs in DBB Build Report. Default: false.
+dbb.LinkEditScanner.excludeFilter | DBB configuration property used by the link edit scanner to exclude load module entries
 
 ### dependencyReport.properties
 Properties used by the impact utilities to generate a report of external impacted files

diff --git a/build-conf/build.properties b/build-conf/build.properties
@@ -1,4 +1,15 @@
-# Build properties used by build.groovy
+#######################################################################
+# build.properties configuration to specify
+#
+#  - global build properties for zAppBuild
+#  - global default application properties 
+#
+#######################################################################
+
+
+#######################################################################
+# Global build properties used by zappbuild
+#
 
 #
 # Comma separated list of additional build property files to load
@@ -9,12 +20,6 @@ buildPropFiles=datasets.properties,dependencyReport.properties,Assembler.propert
 # file extension that indicates the build file is really a build list or build list filter
 buildListFileExt=txt
 
-#
-# Service URL for the Git provider to have a visual comparision of two hashes
-# Leveraged as a build result property <props.gitRepositoryURL>/compare/
-# samples: GitHub : /compare/ ; GitLab :  /-/compare/
-gitRepositoryCompareService=/compare/
-
 #
 # Alternate root directory for application-conf locations.  Allows for the deployment of
 # the application-conf directories to an alternate location rather in the application repository.
@@ -42,96 +47,28 @@ gitRepositoryCompareService=/compare/
 # Defaults to ${workspace}
 applicationConfRootDir=
 
+#
+# Service URL for the Git provider to have a visual comparision of two hashes  
+# Leveraged as a build result property <props.gitRepositoryURL>/compare/
+# samples: GitHub : /compare/ ; GitLab :  /-/compare/
+gitRepositoryCompareService=/compare/
+
 #
 # Minimum required DBB ToolkitVersion to run this version of zAppBuild
-#  Build initialization process validates the DBB Toolkit Version in use and matches that against this setting
+#  Build initialization process validates the DBB Toolkit Version in use and matches that against this setting 
 requiredDBBToolkitVersion=2.0.0
 
 #
 # Comma separated list of required build properties for zAppBuild/build.groovy
 requiredBuildProperties=buildOrder,buildListFileExt
 
-#
-# Flag to log output in table views instead of printing raw JSON data
-# default = false
-formatConsoleOutput=false
-
-#
-# impactBuildOnBuildPropertyChanges controls if impact calculation should analyze
-# build property changes for COBOL, PLI, ASM.
-# default = false
-impactBuildOnBuildPropertyChanges=false
-
-#
-# list of build property lists referencing which language properties should cause an impact build when the given property is changed
-# properties need to be managed in property files within the application repository to detect the change; applies only to impact builds
-# general pattern: langPrefix_impactPropertyList, optional: langPrefix_impactPropertyListCICS and langPrefix_impactPropertyListSQL
-impactBuildOnBuildPropertyList=[${assembler_impactPropertyList},${assembler_impactPropertyListCICS},${assembler_impactPropertyListSQL},${bms_impactPropertyList},${cobol_impactPropertyList},${cobol_impactPropertyListCICS},${cobol_impactPropertyListSQL},${dbdgen_impactPropertyList},${linkedit_impactPropertyList},${mfs_impactPropertyList},${pli_impactPropertyList},${pli_impactPropertyListCICS},${pli_impactPropertyListSQL},${psbgen_impactPropertyList}]
-
-# createTestcaseDependency controls if a dependency should be set up between the testcase
-# and the corresponding application program. If this property set to true, a dependency
-# to the program is created for the testcase, which is then impacted by a change
-# of the program. In this case, the testcase is recompiled everytime the program is modified.
-# When set to false, the testcase is not impacted by the change of the program.
-# Default: false
-createTestcaseDependency=false
-
-# generateDb2BindInfoRecord controls if zAppBuild generates a generic DBB build record for a build file
-# to document the configured db2 bind options (application-conf/bind.properties) .
-# This allows to pass the information into the packaging step and on to your deployment manager, like UCD.
-# Implemented in Assembler.groovy, Cobol.groovy and PLI.groovy
-# See also generateDb2BindInfoRecordProperties for the list of properties which are documented
-# Default: false
-generateDb2BindInfoRecord=false
-
-# generateDb2BindInfoRecordProperties is a comma-separated list of existing bind parameters configured to zAppBuild.
-# See application-conf/bind.properties for available properties.
-generateDb2BindInfoRecordProperties=bind_collectionID,bind_packageOwner,bind_qualifier
-
 # dbb.file.tagging controls compile log and build report file tagging. If true, files
 # written as UTF-8 or ASCII are tagged.
 # If the environment variable _BPXK_AUTOCVT is set ALL, file tagging may have an
 # adverse effect if viewing log files and build report via Jenkins.
 # In this case, set dbb.file.tagging to false or comment out the line. Default: true
 dbb.file.tagging=true
 
-# Set filter used to exclude certain information from the link edit scanning.
-# The value contains a comma separated list of patterns.
-# example: A filter of *.SUB1, *.SUB2 will exclude modules SUB1 and SUB2
-#          from any dataset. To exclude member HELLO in PDS TEST.ASM will
-#          be matched by the pattern TEST.ASM.HELLO. The pattern TEST.ASM.*
-#          will match any member in the data set TEST.COBOL.
-# The following filter excludes CICS and LE Library references.
-dbb.LinkEditScanner.excludeFilter = ${SDFHLOAD}.*, ${SCEELKED}.*
-
-#
-# Determine the behavior when facing a scanner failure
-# 'true' proceeds with the build and report the a warning (default)
-# 'false' will terminate the build process
-continueOnScanFailure=true
-
-#
-# Determine if a subfolder with a timestamp should be created in the buildOutDir location.
-# Applies to all build types except userBuild
-# Default: true
-createBuildOutputSubfolder=true
-
-#
-# Build Timestamp Format
-# Applies to all build types except userBuild
-# Default: yyyyMMdd.HHmmss.mmm - See Date format method pattern strings
-buildOutputTSformat=yyyyMMdd.HHmmss.mmm
-
-#
-# Flag to determine if the build framework should document deletions of outputs in DBB Build Report
-# for build files being mapped to language scripts
-#
-# Requires the DBB toolkit 1.1.3 or higher. Backward compatibility of zAppBuild is preserved,
-# when feature is turned off
-#
-# Default : false
-documentDeleteRecords=false
-
 # MetadataStore configuration properties:
 
 # select MetadataStore configuration (either 'file' or 'db2')
@@ -145,12 +82,12 @@ metadataStoreType=file
 #metadataStoreDb2Url=jdbc:db2:<Db2 server location>
 
 # Db2 connection configuration property file
-# Sample is povided at $DBB_HOME/conf/db2Connection.conf
+# Sample is povided at $DBB_HOME/conf/db2Connection.conf 
 #metadataStoreDb2ConnectionConf=
 
 
 # The dbb.gateway.type property determines which gateway type is used for the entire build process
-# Possible values are 'legacy' and 'interactive.  Default if not indicated is 'legacy'
+# Possible values are 'legacy' and 'interactive'.  Default if not indicated is 'legacy'
 dbb.gateway.type=legacy
 
 # Procedure Name - specified with the procname parameter
@@ -173,3 +110,80 @@ dbb.gateway.regionSize=
 # 16 - Log information to the system console
 dbb.gateway.logLevel=2
 
+
+
+#######################################################################
+# Global default application properties used by zappbuild 
+#   if not overridden by settings in the /application-conf directory   
+
+#
+# Determine the behavior when facing a scanner failure
+# 'true' proceeds with the build and report the a warning (default)
+# 'false' will terminate the build process
+continueOnScanFailure=true
+
+#
+# Determine if a subfolder with a timestamp should be created in the buildOutDir location.
+# Applies to all build types except userBuild
+# Default: true
+createBuildOutputSubfolder=true
+
+#
+# Build Timestamp Format
+# Applies to all build types except userBuild
+# Default: yyyyMMdd.HHmmss.mmm - See Date format method pattern strings
+buildOutputTSformat=yyyyMMdd.HHmmss.mmm
+
+#
+# Flag to log output in table views instead of printing raw JSON data
+# default = false
+formatConsoleOutput=false
+
+# createTestcaseDependency controls if a dependency should be set up between the testcase
+# and the corresponding application program. If this property set to true, a dependency
+# to the program is created for the testcase, which is then impacted by a change
+# of the program. In this case, the testcase is recompiled everytime the program is modified.
+# When set to false, the testcase is not impacted by the change of the program.
+# Default: false
+createTestcaseDependency=false
+
+# generateDb2BindInfoRecord controls if zAppBuild generates a generic DBB build record for a build file
+# to document the configured db2 bind options (application-conf/bind.properties) .
+# This allows to pass the information into the packaging step and on to your deployment manager, like UCD.
+# Implemented in Assembler.groovy, Cobol.groovy and PLI.groovy
+# See also generateDb2BindInfoRecordProperties for the list of properties which are documented
+# Default: false
+generateDb2BindInfoRecord=false
+
+# generateDb2BindInfoRecordProperties is a comma-separated list of existing bind parameters configured to zAppBuild.
+# See application-conf/bind.properties for available properties.
+generateDb2BindInfoRecordProperties=bind_collectionID,bind_packageOwner,bind_qualifier
+
+#
+# impactBuildOnBuildPropertyChanges controls if impact calculation should analyze
+# build property changes for COBOL, PLI, ASM.
+# default = false
+impactBuildOnBuildPropertyChanges=false
+
+#
+# list of build property lists referencing which language properties should cause an impact build when the given property is changed
+# properties need to be managed in property files within the application repository to detect the change; applies only to impact builds
+# general pattern: langPrefix_impactPropertyList, optional: langPrefix_impactPropertyListCICS and langPrefix_impactPropertyListSQL
+impactBuildOnBuildPropertyList=[${assembler_impactPropertyList},${assembler_impactPropertyListCICS},${assembler_impactPropertyListSQL},${bms_impactPropertyList},${cobol_impactPropertyList},${cobol_impactPropertyListCICS},${cobol_impactPropertyListSQL},${dbdgen_impactPropertyList},${linkedit_impactPropertyList},${mfs_impactPropertyList},${pli_impactPropertyList},${pli_impactPropertyListCICS},${pli_impactPropertyListSQL},${psbgen_impactPropertyList}]
+
+
+# Set filter used to exclude certain information from the link edit scanning.
+# The value contains a comma separated list of patterns.
+# example: A filter of *.SUB1, *.SUB2 will exclude modules SUB1 and SUB2
+#          from any dataset. To exclude member HELLO in PDS TEST.ASM will
+#          be matched by the pattern TEST.ASM.HELLO. The pattern TEST.ASM.*
+#          will match any member in the data set TEST.COBOL.
+# The following filter excludes CICS and LE Library references.
+dbb.LinkEditScanner.excludeFilter = ${SDFHLOAD}.*, ${SCEELKED}.*
+
+#
+# Flag to determine if the build framework should document deletions of outputs in DBB Build Report
+# for build files being mapped to language scripts
+#
+# Default : false
+documentDeleteRecords=false 
diff --git a/build.groovy b/build.groovy
@@ -18,6 +18,7 @@ import groovy.cli.commons.*
 @Field def buildUtils= loadScript(new File("utilities/BuildUtilities.groovy"))
 @Field def impactUtils= loadScript(new File("utilities/ImpactUtilities.groovy"))
 @Field def filePropUtils= loadScript(new File("utilities/FilePropUtilities.groovy"))
+@Field def depScannerUtils= loadScript(new File("utilities/DependencyScannerUtilities.groovy"))
 @Field String hashPrefix = ':githash:'
 @Field String giturlPrefix = ':giturl:'
 @Field String gitchangedfilesPrefix = ':gitchangedfiles:'
@@ -202,6 +203,10 @@ def initializeBuildProcess(String[] args) {
 
 	// verify/create/clone the collections for this build
 	impactUtils.verifyCollections()
+
+	// loading the scanner mapping to fill the DependencyScannerRegistry  
+	depScannerUtils.populateDependencyScannerRegistry()
+
 }
 
 /*

diff --git a/samples/MortgageApplication/application-conf/README.md b/samples/MortgageApplication/application-conf/README.md
@@ -30,7 +30,7 @@ Location of file properties, script mappings and file level property overrides.
 Property | Description 
 --- | --- 
 dbb.scriptMapping | DBB configuration file properties association build files to language scripts
-dbb.scannerMapping | DBB scanner mapping to overwrite the file scanner. File property
+dbb.scannerMapping | zAppBuild configuration to map files extensions to DBB dependency scanner configurations
 cobol_testcase | File property to indicate a generated zUnit cobol test case to use a different set of source and output libraries
 
 ### BMS.properties

diff --git a/samples/MortgageApplication/application-conf/file.properties b/samples/MortgageApplication/application-conf/file.properties
@@ -8,6 +8,26 @@ dbb.scriptMapping = Cobol.groovy :: **/*.cbl
 dbb.scriptMapping = LinkEdit.groovy :: **/*.lnk
 dbb.scriptMapping = PLI.groovy :: **/*.pli
 
+#
+# dbb.scannerMapping to map files extensions to DBB dependency scanner configurations
+#
+#  this maps file extensions to scanner configuration for the DBB dependency scanners
+#  also see:
+#  https://www.ibm.com/docs/api/v1/content/SS6T76_2.0.0/javadoc/com/ibm/dbb/dependency/DependencyScannerRegistry.html
+#
+#  Schema
+#  {"scannerClass":"ScannerImplementation" : "languageHint":"DBBScannerHint" } :: comma separated list of file extensions
+#
+#  Note - if an extension of a build file is not specified in the mapping, 
+#   zAppBuild will skip scanning the file and only record a LogicalFile without capturing dependencies.
+#    
+dbb.scannerMapping = {"scannerClass":"DependencyScanner", "languageHint":"COB"} :: cbl,cpy,cob
+dbb.scannerMapping = {"scannerClass":"DependencyScanner", "languageHint":"C"} :: c, h
+dbb.scannerMapping = {"scannerClass":"DependencyScanner", "languageHint":"ASM"} :: asm, mac
+dbb.scannerMapping = {"scannerClass":"DependencyScanner", "languageHint":"CPP"} :: cpp, hpp
+dbb.scannerMapping = {"scannerClass":"DependencyScanner", "languageHint":"PLI"} :: pli, inc
+dbb.scannerMapping = {"scannerClass":"ZUnitConfigScanner", "languageHint":""} :: bzucfg
+
 #
 # Need to build epsnbrvl.cbl first during cobol builds
 cobol_fileBuildRank = 1 :: **/cobol/epsnbrvl.cbl

diff --git a/samples/application-conf/README.md b/samples/application-conf/README.md
@@ -39,7 +39,7 @@ Location of file properties, script mappings and file-level property overrides.
 Property | Description
 --- | ---
 dbb.scriptMapping | DBB configuration file properties association build files to language scripts
-dbb.scannerMapping | DBB scanner mapping to overwrite the file scanner. File property
+dbb.scannerMapping | zAppBuild configuration to map files extensions to DBB dependency scanner configurations
 isSQL | File property overwrite to indicate that a file requires to include SQL parameters
 isCICS | File property overwrite to indicate that a file requires to include CICS parameters
 isMQ | File property overwrite to indicate that a file requires to include MQ parameters