This file contains various SuperCHANNEL preferences. The location of config.txt will depend on where you installed SuperCHANNEL. By default, it is located in C:\ProgramData\STR\SuperCHANNEL\bin.
If you make changes to this file, then you must ensure you save the file in UTF-8 encoding without a Byte Order Mark (BOM). Some text editing applications (including Windows Notepad) will automatically add a BOM to the file. If this happens then SuperCHANNEL will fail to start with the error "java.lang.NoClassDefFoundError: str/channel/engine/DriverManager"
To resolve this issue, use a text editor that allows you to specify the file encoding, such as Notepad++, and choose Encoding > Encode in UTF-8 without BOM before saving the file.
Within the file:
- Lines prefixed by the '#' character are comments and will be ignored by SuperCHANNEL.
- The parameters
$(SNU_DATA_HOME)used in the file refer to the locations of the SuperCHANNEL Program Files and ProgramData directories. In a default installation, these are located in C:\Program Files\STR\SuperCHANNEL and C:\ProgramData\STR\SuperCHANNEL.
It is also possible to edit the SuperCHANNEL parameters using the Preferences tool in the SuperCHANNEL GUI. However, using the GUI option will cause all the lines in the file to be resorted into alphabetical order (meaning that the descriptive comments will no longer appear next to the properties that they refer to). For this reason, Space-Time Research recommends you make any required changes by editing the configuration file directly, rather than using the SuperCHANNEL GUI.
The locations of class files for all drivers. Each location is separated by a semicolon.
This property is commented out as it is no longer used.
The library paths for additional libraries required by drivers.
The class names of the JDBC drivers required for connection. The entries are case sensitive, and separated by colons.
There are some drivers listed by default, such as the SXV4 driver (str.jdbc.sxv4.Driver). You will need to add the class names of the JDBC drivers for connecting to your RDBMS.
The database table types visible in SuperCHANNEL, separated by colons.
The default settings are TABLE and VIEW:
You may need to add other types depending on the JDBC driver you are using to connect to your database. Refer to the JDBC driver documentation for more information.
If you are using Oracle synonyms with SuperCHANNEL, you will need to update this property as follows:
To use synonyms with Oracle you will also need to set the
The number of rows to be returned from the database in a result set. By default, this is set to:
This setting means that the number of rows is determined by the driver being used.
This can be changed to any positive integer that is below the maximum value supported by the database connection.
This property is commented out as it is no longer used.
The SuperCHANNEL data path directory. Do not change.
The SuperCHANNEL program home directory. Do not change.
This property enables the SQL data type
The path to the SXV4 driver. Do not change.
The path to the directory where the DDI driver will generate output XML files. This property applies to the DDI driver only.
Whether to use multi-threading for fact table data:
Whether to use multi-threading for classification data:
The output stream for standard output. The default is
The output stream for error output. The default setting is
Whether to display columns in the Source View when connected to an Oracle database. This property is an Oracle JDBC driver property.
Use of this feature carries a performance penalty. If you do not need views, disable this feature by setting the flag to
If you are using Oracle synonyms, you will also need to modify the
The directory for storing build logs.
During a build, SuperCHANNEL saves a temporary copy of the project file as well as the error and output build logs (see Build Logs for more information).
This property is commented out by default, which means that the build output will be written to the SuperCHANNEL scripts directory. If you installed to the default location, this will be C:\ProgramData\STR\SuperCHANNEL\scripts.
You may need to change the log output directory. For example, if your user account does not have permission to write to the SuperCHANNEL scripts directory you will see the following error when trying to build your project:
To change the directory, remove the comment at the start of the line and set the value of the property to the directory where you want to store the temporary build output. You can use environment variables, such as
On Windows 7, this setting would cause SuperCHANNEL to write the temporary log output to C:\Users\<username>\AppData\Local\Temp\scripts
SuperCHANNEL also writes a general log, scgui.log, to the scripts directory. If your user account does not have permission to write to the scripts directory, then you will also need to change the location of this file. See Build Logs for more details.
The maximum Java Virtual Machine (JVM) heap size, in megabytes, for the SuperCHANNEL GUI. This memory allocation is used when connecting to a data source via a JDBC driver. It must be a positive integer value and greater than or equal to the
The minimum JVM heap size, in megabytes, for the SuperCHANNEL GUI. This memory allocation is used when connecting to a data source via a JDBC driver. It must be a positive integer value and less than or equal to the
Whether to use batch mode processing.
The number of buffers used in batch mode insert processing. You are not recommended to modify this value.
The default value is 10.
Whether to print messages about cleansing actions during batch mode processing.
The size of the queue used for single row insert mode.
Whether to preprend the schema name specified at login time when referring to database objects by name.
This can be useful in cases where you log in as one user but you need to channel from tables in another user's schema.
For example, in DB2 if the table is not prefixed with a schema it assumes the schema name is the same as the user name. If the schema and the user name are not the same then the tables cannot be accessed. Therefore SuperCHANNEL cannot read the registry tables and display or build the database correctly.
For example, if you are logged in as user FRANK and accessing table EMPLOYEE in schema ROBERT and have the property set as follows (this specifies that
Then SuperCHANNEL sets the actual SQL object name sent to the source database to
How often to report progress during channelling.
By default, a message is printed for every 100 rows inserted.
Whether to use performance monitoring and, if so which monitoring tool to use.
The maximum setting for the graphical display y-axis of the performance monitor Row Rate chart. This setting can be used to change scale to make the graph more readable.
The refresh rate for the performance monitor in milliseconds (i.e. how often the monitor should write out results).
Whether the DDI driver should do XML schema validation when it opens a DDI Document.
The setting is ignored if the data source is not DDI.
Whether the DDI driver should run its schematron validation rules when it opens a DDI document.
This setting is ignored if the data source is not DDI.
By default, this setting is commented out, and validation will not be carried out. If you want to activate validation you will need to uncomment the setting and set it to
Whether to log a warning about inconsistent EOL (end of line) characters in Textual Definition Documents (TDDs).
The setting is ignored if the data source is not a TDD.
The file encoding to use when channelling text based source data in TDD format.
By default, this setting is commented out, and the TDD driver will use the current system codepage (e.g. Windows 1252).
If you are channelling data that contains characters that are not supported by the current codepage, you should uncomment this setting.
The name of the SuperCHANNEL root registry table.
The default is
The location of the SuperCHANNEL temporary work file.
This file is created in the SuperCHANNEL bin folder by default.
If you want to change the location (for example because you do not have permission to write to this location), then you can add this parameter. For example:
You must forward slashes / not backward slashes \ to specify the path.
Whether to use demand loading (lazy loading).
Lazy loading means that on connection to the source database SuperCHANNEL only loads the information it needs to display the initial source tree (such as the database information, the list of tables and any registry tables). When SuperCHANNEL needs additional information (for example because you expanded one of the tables in the Source View), it queries the database for the additional information required (such as the columns in the table and the primary key information).
This can be more efficient than loading the entire database structure into memory.
By default, lazy loading is enabled.
If you want to turn it off (so that SuperCHANNEL will load the entire database structure into memory when it connects), you can do so by adding the following parameter to config.txt:
This parameter does not appear in the configuration file by default, so you only need to add the parameter if you want to turn lazy loading off. To turn it back on again, remove the parameter from the configuration file.
|The mode to use for processing multi-response questions in SPSS survey data. This parameter does not appear in config.txt by default; it only needs to be added if you want to change from the default mode. See Multi-Response Questions in Survey Data for more information.