User Scripts Parameters

The following parameters are included in the [params] section of the DATABridge Client configuration file. The parameters listed in this section affect what the DATABridge Client does with user scripts.

Note: It is highly recommended that you set these parameters. As long as you have made sure that each user script includes all of the changes for the specified data set, the user scripts ensure that the DATABridge Client can handle DMSII reorganization changes.

check_user_scripts

Default: False
Range: True or False

Set this parameter to True to let the DATABridge Client inform you if a user script for a table is missing. In this case, the DATABridge Client returns the following message:

ERROR: Unable to open script file filename

This parameter is especially useful if you have created data table creation user scripts and index creation user scripts for every table in your relational database. The DATABridge Client runs these scripts immediately after it completes its own scripts for creating tables and table indexes.

Note: This parameter does not apply to data set selection user scripts and data table customization scripts.

user_script_dir

Default: "scripts"
Range: Any valid directory (except the DATABridge Client working directory)
Related command-line option: -n

Use this parameter to tell the DATABridge Client where your user scripts are located. You can place them in any valid directory; however, it is highly recommended that you place them in the scripts subdirectory in the data source's working directory. When you upgrade from an earlier version to 6.1 or later, the migrate utility copies your scripts to the scripts directory. Similarly, when you add a data source using the service, the service creates a scripts subdirectory and sets this parameter to point to that directory.

You must use the double quotation marks. Also use two consecutive back slashes (\\) to represent one back slash. For the directory C:\DBRIDGE\CUSTDB\SCRIPTS, you would enter the following:

user_script_dir = "C:\\DBRIDGE\\CUSTDB\\SCRIPTS"

Store the following user scripts in this directory:

  • script.user.session
  • script.user_datasets.datasource
  • script.user_datatables.datasource
  • script.user_layout.primary_table_name
  • script.user_define.primary_table_name
  • script.user_create.tablename
  • script.user_index.tablename
  • script.user_cleanup.tablename

Note: You can temporarily override this parameter via the -n option when you run the dbutility runscript command.

user_script_bu_dir

Default: “”

(The default backup directory is located within the user script directory.)

The createscript command copies all of the user script files that apply to the define/redefine command from the user script directory to a new sub-directory created under this directory.

If you create many backups, it's important to manage these directories to prevent scripts from accumulating.