Configuration File Keyword Refence
The configuration file is a text file that contains a set of keyword - key value pairs. Several keywords reference other text files that are used to set certain parameters. The configuration file name is the only command line parameter that needs to be provided when you start rtc2ad.bat. A sample configuration file is provided in the sample configuration files folder of the rtc2ad installation folder, along with samples for all other files that are needed to run the tool.
| Keywords | Description |
|---|---|
| AD_ROOT_DIR | Represents the path to the IBM® ADDI project folder where the source is loaded. It must exist and it must already contain the sub folders. All the expected source types must exist in the necessary sub folders. This folder would typically be created by the ADDI user before the source is imported from EWM. The expected source types are designated in the AD_SOURCE_DIR_MAP_FILE. |
| RTC2AD_ROOT_DIR | Represents the root directory that serves as EWM sandbox. The sandbox is a set of directories on the local file system where EWM files and metadata are saved by the EWM CLI scm.exe. It must be separated from the AD_ROOT_DIR. If it does not exist, it needs to be created. |
| RTC_REPOSITORY | Represents the URL of the EWM repository where the zProject files are stored. It is the same URL that is used when a repository connection is created in the EWM Eclipse Client. |
| RTC_USERID | Represents the user ID under which the tool will log on to the EWM repository server. This user ID must have the appropriate access rights to the EWM project area from which the files are retrieved. |
| RTC_PASSWORD_FILE | Represents a text file that contains the password of the user that will log on to the EWM repository server. The password is in clear text, so this file needs to have appropriate access restrictions in place. This file is necessary. Refer to the sample file pwd.txt in the sample configuration files folder. |
| RTC_STREAM_LIST_FILE | Represents the list of EWM streams that the tool needs to process. By default, the tool processes automatically every EWM component within the specified streams that contains z/OS® source. If you need to restrict processing to a subset of the components within a stream, refer to RTC_COMP_LIST_FILE description. This file is required. Refer to the sample file ProcessStreamList.txt in the sample configuration files folder. |
| RTC2AD_CLASSPATH | Represents the directory that contains the two JAR files that are needed by the tool, the files are com.ibm.dmh.scan.classify.jar and com.ibm.rtc2ad.jar. These JAR files are distributed in the jars folder. |
| RTC_INSTALL_PATH | Represents the directory that contains the EWM CLI scm.exe. It is made available as part of the EWM Eclipse installation. It is required by rtc2ad.bat. |
| Java™_HOME | Represents the directory that contains the Java™ SDK or JRE installation. |
| RTC_COMP_LIST_FILE | Represents an extra file that can be used to restrict which EWM components are processed within the streams that are specified in RTC_STREAM_LIST_FILE. Only EWM components that are listed on RTC_COMP_LIST_FILE are processed. If the keyword is omitted, default behavior is to process every component in every stream specified in RTC_STREAM_LIST_FILE. Refer to the sample file ProcessComponentList.txt in the sample configuration files folder. |
| AD_SOURCE_DIR_MAP_FILE | Represents a text file that specifies a mapping between the source type and the ADDI project subfolder name. It must contain all the ADDI subfolder names for different types of source that the tool encounters. This file is required. The sample file that is provided is usually sufficient for most cases. It can be updated as necessary. Refer to the sample file AD_sourceDirMap.txt in the sample configuration files folder. |
| AD_EXT_TYPE_MAP_FILE | Represents a text file that specifies a mapping between a zFile (PDS member) extension and a source type. For example, any zFile with cbl extension can be mapped to COBOL. If the file extensions are reliable indicators, the mapping allows the source classification step to be skipped entirely, saving time. If the file does not have an extension, or the extension is not recognized, the tool attempts to classify the source by calling the Java scanner utility. This file is required. Refer to the sample file AD_extensionTypeMap.txt in the sample configuration files folder. |
| AD_EXT_EXCLUDE_FILE | Represents a text file that contains a list of file extensions that needs to be ignored. When the tool encounters an EWM file that ends with one of these extensions, the file is ignored and it isn't copied to the AD project. This file is required. Refer to the sample file AD_extensionExclude.txt in the sample configuration files folder. This exclusion process can save time by filtering out unusual or proprietary file types, which do not need to be analyzed, or cannot be analyzed by ADDI. |
| CREATED_AFTER_DATE |
Represents an extra keyword. The key value format is YYYY/MM/DD. If set, this keyword causes RTC2AD to run in incremental mode and only import files that are included in EWM change sets for the specified streams after the date specified. It can be used together with CREATED_BEFORE_DATE to define a date range. Only files that are part of an EWM change set delivered during this date range are processed. If both the CREATED_AFTER_DATE and the CREATED_BEFORE_DATE keywords are omitted, then RTC2AD runs in Full Load mode. It means that every source file in the specified streams is retrieved, classified, and copied to the ADDI folders. |
| CREATED_BEFORE_DATE |
Represents an extra keyword. The key value format is YYYY/MM/DD. If set, this keyword causes RTC2AD to run in incremental mode and only import files that are included in EWM change sets for the specified streams before the date specified. It can be used together with CREATED_AFTER_DATE to define a date range. Only files that are part of an EWM change set delivered during this date range are processed. If both the CREATED_AFTER_DATE and the CREATED_BEFORE_DATE keywords are omitted, then RTC2AD runs in Full Load mode. It means that every source file in the specified streams is retrieved, classified, and copied to the ADDI folders. |
| COPY_SOURCE | Represents an extra test flag that has the default value Y. The Y value indicates that all source members that can be classified need to be copied to the appropriate ADDI source type folder. The N value indicates that the file needs to be classified and not copied. The option is useful only in testing the source classification routine. |
| RUN_ONLINE | Represents an extra test flag that has the default value Y. The Y value indicates that the tool needs to connect to the EWM server and download the specified source files into the local EWM sandbox. The N value indicates that no connection needs to be made to the EWM server. The processing needs to be performed by using only the files already stored in the local EWM sandbox. The option is useful only in testing, saving time by not repeating downloads from the EWM server. |
| DELTA_CHECK | Represents an extra test flag that has the default value Y. The Y value indicates that the tool needs to run a file compare between the source file that is processed and the identically named file that is classified and stored in the target ADDI source type folder (assuming it exists). If the files are identical, then no copy is performed. The N value indicates that the file compare step is skipped and the file is unconditionally copied to the appropriate ADDI source type folder. |