In order to scan source code into repository, the source code must be collected into a subdirectory under the scanning directory on the scanning server. In addition, a manifest file must be created in order to describe the source code.

The subdirectory under which the source code is placed may have any name, but it must appear immediately under scanning directory that is specified in the configuration. All source code which should be scanned in a single batch should be placed under this subdirectory. 

The manifest file may be a standard properties file, called app.properties, that is recognized by the source code scanner itself and is described below. Alternatively, it may be a custom manifest file that is loaded and parsed by a plugin (see CM Meta Analytics Plugins for more information.)

Creating app.properties

After all source files have been loaded into the subdirectory, the next step is to create a properties file called app.properties in the subdirectory. The format of app.properties is as follows:

2. #  SSI.application
3. #
4. #  Descriptive name of application that will be displayed in the GUI.
5. #
6. SSI.application = My Application
7. 
   
8. #
9. #  SSI.system
10. #
11. #  System name of programs scanned.
12. #
13. SSI.system = SYS
14. 
    
15. #
16. #  SSI.subsys
17. #
18. #  Subsystem name of programs scanned.
19. #
20. SSI.subsys = SUBSYS
21. 
    
22. #
23. # SSI.serverName
24. #
25. # Server name for tables scanned.
26. #
27. SSI.serverName = GAP1
28. 
    
29. #
30. #  SSI.creator
31. #
32. #  Creator name for tables scanned.
33. #
34. SSI.creator = PT18
35. 
    
36. #
37. #  SSI.ALL.encoding
38. #
39. #  Character set encoding of all input files, unless otherwise specified.
40. #
41. SSI.ALL.encoding=CP-037+R80
42. 
    
43. #
44. #  SSI.ALL.panvaletIncludePath
45. #
46. #  Path to search for files included using the Panvalet inclusion directive (++INCLUDE).
47. #  Multiple paths may specified delimited by a semicolon. Paths are relative to the application root.
48. #
49. SSI.ALL.panvaletIncludePath=
50. 
    
51. #
52. # SSI.COBOL.sourcePath
53. #
54. # Path of a directory (relative to the application root) that contains all COBOL source
55. # to be processed. Any files found under this path using a recursive directory walk are
56. # passed to the COBOL scanner.
57. #
58. SSI.COBOL.sourcePath=
59. 
    
60. #
61. # SSI.COBOL.copyLibPath
62. #
63. # Paths to search for files included with the COBOL COPY statement.
64. # Multiple paths may specified delimited by a semicolon. Paths are relative to the application root.
65. #
66. SSI.COBOL.copyLibPath=
67. 
    
68. #
69. # SSI.COBOL.copySystemLibPath
70. #
71. # Paths to search for files included with the COBOL COPY ... FROM statement. The paths will be
72. # searched for a directory matching the name of the system library in the FROM clause of the
73. # statement.
74. #
75. # Multiple paths may specified delimited by a semicolon. Paths are relative to the application root.
76. #
77. SSI.COBOL.copySystemLibPath=
78. 
    
79. #
80. # SSI.JCL.sourcePath
81. #
82. # Path of a directory (relative to the application root) that contains all JCL source
83. # to be processed. Any files found under this path using a recursive directory walk are # passed to the JCL scanner.
84. #
85. SSI.JCL.sourcePath=
86. 
    
87. #
88. # SSI.JCL.procPath
89. #
90. # Path of a directory (relative to the application root) that contains a
91. # a directory containing include files and procedures.
92. #
93. SSI.JCL.procPath=VALPROC
94. 
    
95. #
96. # SSI.ALC.sourcePath
97. #
98. # Path of a directory (relative to the application root) that contains all ALC non-
99. # copybook, non-macro source files to be processed. Any files found under this path
100. # using a recursive directory walk are passed to the ALC scanner.
101. #
102. SSI.ALC.sourcePath=
103. 
     
104. #
105. # SSI.ALC.copyPath
106. #
107. # Path of a directory (relative to the application root) that contains all ALC
108. # copybook or macro source files to be processed. Any files found under this path
109. # using a recursive directory walk are passed to the ALC scanner.
110. #
111. SSI.ALC.copyPath=
112. 
     
113. #
114. # SSI.JAVA.sourcePath
115. #
116. # List of absolute paths of source directories for the Java projects. Each
117. # source directory should be separated by a semicolon. The absolute path of
118. # each directory must be used.
119. #
120. SSI.JAVA.sourcePath=d:/path/to/java/src
121. 
     
122. #
123. # SSI.JAVA.classPath
124. #
125. # List of absolute paths of source directories for libraries that should be
126. # on the Java classpath. Each source directory should be separated by a
127. # semicolon. The absolute path of each directory must be used.
128. #
129. SSI.JAVA.classPath=d:/path/to/classpath/src

If the files are encoding in mainframe EBCDIC with fixed 80-column lines, then the property SSI.ALL.encoding should be set to CP-037+R80. Otherwise, it should be set to the Java name of the character set that is in use.

Note: When generating app.properties from an external process, ensure that it is created after all source code files have been transferred to the scanning server.

Preparing the Work Tables

The work tables on the server should be cleared before starting the scanner. The scanner will use work units that begin with the prefix CS. These can be cleared using the following DB2 statements:

DELETE FROM DBXRELXX.PRMXML_OI WHERE WORK_UNIT LIKE 'CS%';
DELETE FROM DBXRELXX.PRMXML_AI WHERE WORK_UNIT LIKE 'CS%';
DELETE FROM DBXRELXX.PRMXM