PDE TDGSSCONFIG Help


NAME

tdgssconfig - TDGSS configuration tool


SYNOPSIS

Used to generate the TDGSS binary configuration file


USAGE

In the TeraGSS package:

     tdgssconfig B<LibXMLFile UserXMLFile OutputBinFile>

In the TDGSS package:

     tdgssconfig B<LibXMLFile UserXMLFile>


DESCRIPTION

This tool is used to generate the TDGSS binary configuration file. This file is derived from the TdgssUserConfigFile.xml and the TdgssLibraryConfigFile.xml files. It is necessary to generate this file whenever changes to the TdgssUserConfigFile.xml file are made. The changes become effective the next time the TDGSS Library is started. On the Teradata Server, this would be at the next Database reset. For Clients systems, this would be the next time a connection program is started. It is important that the user only change the contents of the TdgssUserConfigFile.xml file, as other changes will be lost during version switches.

However it is strongly recommended to use the run_tdgssconfig tool which does not require any parameters and takes care of any additional steps that the tdgssconfig tool may require the user to do.

In the TeraGSS package, the tool is run with three arguments, which are TdgssLibraryConfigFile.xml, TdgssUserConfigFile.xml and tdgssconfig.bin. The first two arguments are read and the results written to the file specified in the third argument.

The TDGSS package is run with the first two arguments only. This is because on the Teradata Server, the binary configuration file resides in the TDGSSCONFIG GDO. This guarantees that the binary configuration file is always the same on all nodes of the system. For backwards compatibility, a third argument on tdgssconfig in the TDGSS package will produce a warning, but will still write to the TDGSSCONFIG GDO.

This command is available in the following platforms.

Client Platforms (TeraGSS package): MPRAS, HP-UX, Solaris, AIX, Windows, LINUX

Server Platforms (TDGSS package): Windows, MPRAS, LINUX.


EXAMPLES

EXAMPLE 1, TeraGSS package, User Selectable Directory This is a new feature, where the TeraGSS package can be located in a custom user selected directory. Say the location is <user_root>. The <short_version> refers to the short version, eg: 16.00.

For Windows platforms, the following commands need to be run in order to update the file.

If there is already a TdgssUserConfigFile.xml at <user_root>\Teradata\client\etc\site, then we recommend that a backup copy be created first.

Then copy over the TdgssUserConfigFile.xml from <user_root>\Teradata\client\<short_version>\teragss\etc to the above location at <user_root>\Teradata\client\etc\site as shown in the following commands.

cd <user_root>\Teradata\client\<short_version>\teragss\etc

copy TdgssUserConfigFile.xml <user_root>\Teradata\client\etc\site\TdgssUserConfigFile.xml

If there is already a tdgssconfig.bin file, we recommend that a backup copy be created first.

cd <user_root>\Teradata\client\<short_version>\bin

Then run the tdgssconfig tool as follows:

tdgssconfig.exe ..\teragss\etc\TdgssLibraryConfigFile.xml ..\teragss\etc\TdgssUserConfigFile.xml ..\teragss\etc\tdgssconfig.bin

 Output has been written to Binary file "tdgssconfig.bin"

If the tdgssconfig.bin file is not generated successfully due to an error, then the backup copy of the TdgssUserConfigFile.xml at <user_root>\Teradata\client\etc\site as well as that of tdgssconfig.bin at <user_root>\Teradata\client\<short_version>\teragss\etc should be restored, making sure that the order of copy (that is TdgssUserConfigFile.xml followed by tdgssconfig.bin) is preserved.

The backup files can be appropriately removed.

EXAMPLE 2, TeraGSS package, User Selectable Directory

For Unix platforms, the following commands need to be run in order to update the file.

If there is already a TdgssUserConfigFile.xml at <user_root>/teradata/client/etc/site, then we recommend that a backup copy be created first.

Then copy over the TdgssUserConfigFile.xml from <user_root>/teradata/client/<short_version>/etc to the above location at <user_root>/teradata/client/etc/site as shown in the following commands.

cd <user_root>/teradata/client/<short_version>/etc

cp TdgssUserConfigFile.xml <user_root>/teradata/client/etc/site/TdgssUserConfigFile.xml

If there is already a tdgssconfig.bin file, we recommend that a backup copy be created first.

cd <user_root>/teradata/client/<short_version>/bin

Then run the tdgssconfig tool as follows:

tdgssconfig ../etc/TdgssLibraryConfigFile.xml ../etc/TdgssUserConfigFile.xml ../etc/tdgssconfig.bin

 Output has been written to Binary file "tdgssconfig.bin"

If the tdgssconfig.bin file is not generated successfully due to an error, then the backup copy of the TdgssUserConfigFile.xml at <user_root>/teradata/client/etc/site as well as that of tdgssconfig.bin at <user_root>/teradata/client/<short_version>/etc should be restored, making sure that the order of copy (that is TdgssUserConfigFile.xml followed by tdgssconfig.bin) is preserved.

The backup files can be appropriately removed.

EXAMPLE 3, TDGSS package

F:\Program Files\Teradata\Tdat\TDGSS\16.00.00.00\etc> ..\bin\tdgssconfig TdgssLibraryConfigFile.xml ..\..\site\TdgssUserConfigFile.xml

 Output has been written to the TDGSSCONFIG GDO.

The output above indicates that tdgssconfig was successful.


COMMON ERRORS

When the user does not give the correct path of the files or wrong case while specifying file name (on a Unix system) we are likely to get the following:

File not opened properly

 PDE TDGSSCONFIG Help