File Name
Syntax
TAM_CheckDependencies(VAL tablesToBeBuilt: LIST OF INTEGER, REF dependencyErrors: LIST OF STRING)
Parameters
tablesToBeBuilt - the app IDs of the products to be built/migrated
dependencyErrors - the returned status of the dependency check
Returns
dependencyError is set to a list of strings stating the missing
dependencies(one dependency in each string), if the tables for this
product cannot be built because of some dependency with another product.
dependencyError is set to $UNKNOWN If there are no dependency problems.
Side Effects
None
Description
This procedure determines whether this product's tables can be built or migrated based on which other product's tables are being built/migrated to the new version.
Dialog Forms Called
None
File Name
Syntax
TAM_GetCurrentTableVersion(VAL applicationID: INTEGER, REF oldVersion: VERSION_REC)
Parameters
applicationID - the integer identification of this application (used to index into the SAI_APP_PARAMS table
oldVersion - the version of the currently built tables (if any)
Returns
An updated oldVersion if the supplied oldVersion is incorrect.
Side Effects
None
Description
This procedure determines if tables are built in the configured database and returns the version of the tables.
Dialog Forms Called
None
File Name
Syntax
TAM_GetGrantScripts(REF scriptsToRun: LIST OF STRING)
Parameters
scriptsToRun - the grant script to be run
Returns
scriptsToRun with the grant script to be run
Side Effects
None
Description
This procedure obtains the grant script to be run for TAM tables based on the database platform that is currently configured.
Dialog Forms Called
None
File Name
Syntax
TAM_GetNextDropScripts(REF currentScript: INTEGER, REF scriptsToRun: LIST OF STRING)
Parameters
currentScript - the index of the current script being executed
scriptsToRun - the list of scripts to be run
Returns
In currentScript, the index of the next set of scripts to be run
and in scriptsToRun, the list of scripts to be run for the configured
platform.
Side Effects
None
Description
Provides a list of file names of the database DROP scripts to be executed. The argument currentScript can be used to keep track of which scripts have run. The value that this routine sets for currentScript is provided to this routine the next time it is called. If the received value of currentScript is $UNKNOWN, the first scripts should be provided. If all scripts have run, currentScript is set to $UNKNOWN. The appropriate list of scripts is determined based on the DBMS name being processed. The global paramRDBMS is used to determine which DBMS has been selected and configured.
Dialog Forms Called
None
File Name
Syntax
TAM_GetNextScripts(VAL buildAction: INTEGER, VAL oldVersion: VERSION_REC, VAL newVersion: VERSION_REC, REF currentScript: INTEGER, REF scriptsToRun: LIST OF STRING)
Parameters
buildAction - determines whether a migration or new build will be run
oldVersion - the old version from which to migrate
newVersion - the new version to which to migrate
currentScript - the index of the current script being executed
scriptsToRun - the list of scripts to be run
Returns
The new value for currentScript and the list of files to be run next
in scriptsToRun.
Side Effects
None
Description
Provides a list of file names of the database scripts to be executed next. The argument currentScript can be used to keep track of which scripts have been run. The value that this routine sets for currentScript is provided to this routine the next time it is called. If the received value of currentScript is $UNKNOWN, the first scripts should be provided. If all scripts have run, currentScript is set to $UNKNOWN. The appropriate list of scripts is determined based on the input parameters. The parameters specify what build action is to be performed and what versions to migrate from and to (if performing a migration). The global paramRDBMS is used to determine what DBMS has been selected and configured.
Dialog Forms Called
None
File Name
Syntax
TAM_GetRevokeScripts(REF scriptsToRun: LIST OF STRING)
Parameters
scriptsToRun - the revoke script to be run
Returns
scriptsToRun with the revoke script to be run
Side Effects
None
Description
This procedure obtains the revoke script to be run for TAM tables, based on the database platform that is currently configured.
Dialog Forms Called
None
File Name
Syntax
TAM_PostScriptExecution(VAL buildAction: INTEGER, VAL oldVersion: VERSION_REC, VAL newVersion: VERSION_REC, VAL currentScript: INTEGER, VAL scriptStatus: BOOLEAN, VAL wHdl: WINDOW, REF actionStatus: INTEGER)
Parameters
buildAction - determines whether a migration or new build has been run
oldVersion - the old version from which to migrate
newVersion - the new version to which to migrate
currentScript - the index of the current script being executed
scriptStatus - the success status of the previously executed script(s)
wHdl - the window handle used to display error messages if errors are encountered
actionStatus - the returned status of the action being performed
Returns
The status of the action performed in TAM_PostScriptExecution (if any)
Side Effects
None
Description
This procedure is a callout that allows product-specific code to be executed after the execution of a list of database scripts. The input parameters are provided to allow this routine to know where, in the build process, this routine is being executed. The values specify what scripts were just executed by the calling routine. The purpose of the output parameter actionStatus is to allow this routine to abort the build process for this product. If actionStatus returns a value of 1, the build continues for this product. If actionStatus returns a value other than 1, the build aborts for this product.
Dialog Forms Called
None
File Name
Syntax
TAM_PreScriptExecution(VAL buildAction: INTEGER, VAL oldVersion: VERSION_REC, VAL newVersion: VERSION_REC, VAL currentScript: INTEGER, VAL wHdl: WINDOW, REF actionStatus: INTEGER)
Parameters
buildAction - determines whether a migration or new build will be run
oldVersion - the old version from which to migrate
newVersion - the new version to which to migrate
currentScript - the index of the current script being executed
wHdl - the window handle used to display error messages if errors are encountered
actionStatus - the returned status of the action being performed
Returns
The status of the action performed in TAM_PreScriptExecution (if any)
Side Effects
None
Description
This procedure is a callout that allows product-specific code to be executed prior to the execution of a list of database scripts. The input parameters are provided to allow this routine to know where, in the build process, this routine is being executed. The values specify what scripts are about to be executed by the calling routine. The purpose of the output parameter actionStatus is to allow this routine to abort the build process for this product. If actionStatus returns a value of 1, the build continues for this product. If actionStatus returns a value other than 1, the build aborts for this product.
Dialog Forms Called
None
File Name
Syntax
TAM_SupportMigration(VAL oldVersion: VERSION_REC, VAL newVersion: VERSION_REC, REF supportMigration: BOOLEAN)
Parameters
oldVersion - the old version from which to migrate
newVersion - the new version to which to migrate
supportMigration - flag to determine whether migration is supported
Returns
supportMigration is set to TRUE if the migration is supported.
Side Effects
None
Description
This procedure determines whether the migration of tables from the specified old version to the specified new version is supported for this product.
Dialog Forms Called
None