Question - Using a "heredoc" format for properties files

[FALLAI-Denis]

Hi,

Is there a way to define properties in a "heredoc" type format, in order to manage multi-line texts?
Not necessarily compatible with DBB but at least compatible with zAppbuild.

Generally, is there a reference document (zAppbuild or DBB) that describes how to code properties files and gives all possible syntaxes for DBB 2.x.x (DBB 3.x.x uses YAML files)?

If yes, with what syntax?
If not, is this a possible evolution?

Thank you.

[FALLAI-Denis]

PS :

After searching, I finally found this information in the DBB 2.0.x documentation, but it remains quite succinct:

Build properties class

Properties and properties files are fairly common and most scripting languages have native support for them. Groovy, as a Java scripting language, uses the java.util.Properties class to read properties files. This class is perfectly adequate to support what has been discussed so far; however, DBB does provide the com.ibm.dbb.build.BuildProperties class as well. The BuildProperties class has much of the same functionality as the Java Properties class but it also provides three additional useful features:

There is a single static BuildProperties instance. Therefore, the BuildProperties is always available to all scripts without being passed from one script to another.

BuildProperties values can reference other build properties. Property references are evaluated dynamically at run time.

It introduces a new concept called file properties. File properties are properties that are associated to a set of files or even a single file.

[dennis-behm]

Hi @FALLAI-Denis ,

typically, (and) as outlined in the documentation build properties follow the same rules, like java property files.

The common multiline character is \ .

dbb-zappbuild/build-conf/build.properties

Lines 19 to 23 in db9fb09

	buildPropFiles=${systemDatasets},GlobalOptions.properties,dependencyReport.properties,\
	Assembler.properties,BMS.properties,Cobol.properties,Transfer.properties,\
	MFS.properties,PSBgen.properties,DBDgen.properties,ACBgen.properties,\
	LinkEdit.properties,PLI.properties,REXX.properties,TazUnitTest.properties,\
	CRB.properties,zCEE3.properties,zCEE2.properties,Easytrieve.properties

If you want to pass a line break into a property itself, it is \n .

dbb-zappbuild/samples/application-conf/Cobol.properties

Lines 51 to 53 in db9fb09

	# If using a debug exit for IBM Debug tool, provide the SYSIN instream DD which is appended to SYSIN
	# Samp: cobol_linkDebugExit= INCLUDE SYSLIB(EQAD3CXT) \n
	cobol_linkDebugExit=

I understand the heredoc deriving from shell scripts. However, DBB and JAVA use existing rules to define properties.

[FALLAI-Denis]

Hi @dennis-behm,

For your information, we needed to create and submit a JCL from zAppbuild.
This is easily done with an ISPF template.
We wanted to manage the JCL template with zAppbuild properties.

What we did:

# Les variables doivent etre entre double @ comme ceci: @@VARIABLE@@       
# Les fins de lignes doivent toujours contenir \n\                         
# A l'exception de la derniere ligne qui ne doit contenir que \n           
                                                                                     
# Carte JOB - En début de job                                                        
# Paramètres :                                                                       
# - userJCL : code de l'utilisateur soumettant le job                                
jclJOB=\                                                                             
//@@userJCL@@D JOB (12),'GENDIR ULD',\n\                                             
//             MSGLEVEL=(1,1),MSGCLASS=X,CLASS=A\n\                                  
/*JOBPARM SYSAFF=*\n\                                                                
//*\n\                                                                               
//******************************************************************\n\              
//* CEF24 - CER37 - ADM - skel - STGGNFIN\n\                                         
//*\n\                                                                               
//* PROCEDURE DE DEPLOIEMENT DES OBJETS METIER\n\                                    
//* DANS LES ENVIRONNEMENTS\n\                                                       
//******************************************************************\n\              
//*\n\                                                                               
//         JCLLIB ORDER=(SYS5.EGW.MPRD.PROCLIB)\n                                    
                                                                                     
# Step IEBCOPY - A chaque rupture sur système + type, avant de traiter les éléments  
# Paramètres :                                                                       
# - system  : système (SIRS, HUB, PCOM, ADMG, ADME, ...)                             
# - type    : type de composant (LOADBT, LOADTP, DBRM, COBSRCE, LISTING, ...)        
# - stepnum : numéro de step, à partir de 001, incrément de 1                       
# - pdstemp : dsname du PDS temporaire utilisé pour le build                        
# - pdssas  : dsname du PDS sas à alimenter                                         
jclIEBCOPY=\                                                                        
//*\n\                                                                              
//* SYSTEM=@@system@@, TYPE=@@type@@\n\                                             
//*\n\                                                                              
//S@@stepnum@@ EXEC PGM=IEBCOPY\n\                                                  
//SYSUT1   DD  DSN=@@pdstemp@@,\n\                                                  
//         DISP=SHR\n\                                                              
//SYSUT2   DD  DSN=@@pdssas@@,\n\                                                   
//         DISP=SHR\n\                                                              
//SYSPRINT DD  SYSOUT=*\n\                                                          
//SYSIN    DD  *\n                                                                  
                                                                                    
# Sysin IEBCOPY - Avant de traiter les éléments, pour tous les types sauf les LOAD* 
jclCOPY=\                                                                           
\u0020COPY INDD=SYSUT1,OUTDD=SYSUT2\n                                               
                                                                                    
# Sysin IEBCOPY - Avant de traiter les éléments, uniquement tous les types LOAD*    
jclCOPYMOD=\                                                                        
\u0020COPYMOD INDD=SYSUT1,OUTDD=SYSUT2\n                                            
                                                                                    
# Sysin MEMBER - Pour chaque élément                                                                  
# Paramètres :                                                                                        
# - member : nom du composant à copier                                                                
jclMEMBER=\                                                                                           
\u0020S M=((@@member@@,,R))\n                                                                         
                                                                                                      
# Step GENDIR - En fin de job                                                                         
# Paramètes :                                                                                         
# - env      : lettre environnement cible                                                             
# - randomId : id du fichier pilote préparé dans                                                      
# - userJCL  : code de l'utilisateur soumettant le job                                                
# - admMode  : flag indicateur d'un environnement cible "outillage ADM" (valeur 1, sinon valeur 0)    
jclGENDIR=\                                                                                           
//*\n\                                                                                                
//ISCOPYOK IF (RC >= 04) THEN\n\                                                                      
//*\n\                                                                                                
//COPYISKO EXEC PGM=IDCAMS\n\                                                                         
//SYSPRINT DD SYSOUT=*\n\                                                                             
//SYSIN    DD *\n\                                                                                    
\u0020\u0020\u0020SET MAXCC = 16\n\                                                                   
/*\n\                                                                                                 
//*\n\                                                                                                
//ISCOPYOK ELSE\n\                                                                                    
//*\n\                                                                             
//GENDIR   EXEC PROC=GIT2EGEN,\n\                                                  
//         LETTRE=@@env@@,RDM=@@randomId@@,MODEEGEN=PRD,USER=@@userJCL@@,\n\       
//         ADM=@@admMode@@\n\                                                      
//*\n\                                                                             
//ISCOPYOK ENDIF\n\                                                                
//\n                                                                        

Note that we had to escape the spaces at the beginning of the line with \u0020 so that they were preserved.

Thanks.