File Name
Syntax
DisableAllMenus(VAL w: WINDOW, REF menuItemList: LIST OF MENU_REC, REF doNotCloseWindow: BOOLEAN)
Parameters
w - handle of dialog box
menuItemList - menu items on the toolbar
doNotCloseWindow - flag that allows user to close dialog box
Returns
None
Side Effects
None
Description
Disables all menu items on the toolbar.
Dialog Forms Called
None
File Name
Syntax
EnableMenuItem(VAL w: WINDOW, VAL listIndex: INTEGER, VAL enable: BOOLEAN, REF menuItemList: LIST OF MENU_REC)
Parameters
w - handle of dialog box
listIndex - number returned from menu selection
enable - True or False to enable or disable a menu item
menuItemList - menu items on the toolbar
Returns
None
Side Effects
None
Description
Enables or disables a menu item on the toolbar.
Dialog Forms Called
None
File Name
Syntax
ExecutePrepList(VAL w: WINDOW, REF menuItemList: LIST OF MENU_REC, REF doNotCloseWindow: BOOLEAN)
Parameters
w - handle of the dialog box
menuItemList - menu items on the toolbar
doNotCloseWindow - flag to allow close of the dialog box
Returns
None
Side Effects
None
Description
Drops and creates the sai_systables view. The view is needed before the build starts so that it can determine which TSD tables are installed, if any.
Dialog Forms Called
None
File Name
Syntax
ExitProc: Boolean
Parameters
None
Returns
TRUE
Side Effects
None
Description
Performs exit processing for application.
Dialog Forms Called
None
File Name
Syntax
FindParmValue (VAL ParmName: String, VAL App_Id: Integer): STRING
Parameters
ParmName - name of parameter in sai_app_params table
App_Id - integer identifier for application
Returns
ParmValue
Side Effects
None
Description
This function returns the parmvalue for the given application ID, a sectionname of 'INSTALLATION', and parmname in the sai_app_params table.
Dialog Forms Called
None
File Name
Syntax
GetScriptExt: STRING
Parameters
None
Returns
The standard extension for the database platform configured
Side Effects
None
Description
Returns the standard file extension for scripts based on the database platform that is configured in TSD Build.
Dialog Forms Called
None
File Name
Syntax
InsertProductData(VAL filename: STRING)
Parameters
filename - file that contains the products data
Returns
None
Side Effects
None
Description
Reads the data from the provided file name and inserts (if it doesn't exist) or updates it in the database. If the file name is not known, a prompt is provided. The data that is in the .ini file must be of a particular format. The data that is processed are for the following tables: system_actions, entity (action groups), entity_action (the association between system actions and action groups), profile, profile_entity (the association between profiles and action groups), ddviews and user_ddviews. This data is placed here instead of in the .dat file because the opaque ID is needed for other inserts or updates. For example, system actions need to be associated to an action group. Until the system action is inserted, the opaque ID is not known so that the association can be made.
Dialog Forms Called
None
File Name
Syntax
Old_RightMigration(VAL w: WINDOW, VAL oldRightName: String, VAL newRightName: String)
Parameters
w - window handle of the calling dialog box
oldRightName - name of the old right name being updated
newRightName - new name for the right
Returns
None
Side Effects
None
Description
There are 30 rights that are installed with the application. None can be added. Initially, each right is named or called a Custom Right. This procedure takes one of the previously used rights and updates it to the new right name. If the old right is not there, it updates a Custom Right to the new right name. Also, the modify_datetime field is updated to 1 to signify that the right has been renamed/used. This procedure should only be used for a migration when a new right name is being added.
Dialog Forms Called
None
File Name
Syntax
ResetAllMenus(VAL w: WINDOW, REF menuItemList: LIST OF MENU_REC, REF doNotCloseWindow: BOOLEAN)
Parameters
w - handle of dialog box
menuItemList - menu items on the toolbar
doNotCloseWindow - flag that allows user to close dialog box
Returns
None
Side Effects
None
Description
Resets all the menu items on the toolbar.
Dialog Forms Called
None
File Name
Syntax
RightMigration(VAL w: WINDOW, VAL right_name: String, VAL right_error: String)
Parameters
w - window handle of the calling dialog
right_name - name of the right being installed
right_error - error message written to the dialog box if failed to install right
Returns
None
Side Effects
None
Description
There are 30 rights that are installed with the application. None can be added. Initially, each right is named or called a Custom Right. This procedure takes one of the custom rights and renames it to the new right name provided. Also, the modify_datetime field is updated to 1 to signify that the right has been renamed/used. This procedure should only be used for a migration when a new right name is being added.
Dialog Forms Called
None
File Name
Syntax
UpdateCounters( VAL counterName: STRING, VAL CounterIncrement: INTEGER, REF Next_Number: INTEGER ): INTEGER
Parameters
CounterName - name of counter
CounterIncrement - number of increments to retrieve
Next_Number - return of counter value
Returns
Return code from database transaction
Side Effects
Updates the COUNTERS table to one more than the next number returned for the counter name provided.
Description
Performs a search for the next counter.
Dialog Forms Called
None
File Name
Syntax
UpdateSaiApp( VAL application_id: INTEGER, VAL application_name: STRING ): INTEGER
Parameters
application_id - integer identifier for the application
application_name - name of the application
Returns
Return code from update or insert
Side Effects
None
Description
Inserts a record into the sai_applications table for the application if it doesn't exist or updates the name of the application based on the application_id.
Dialog Forms Called
None
File Name
Syntax
UpdateSaiParams( VAL application_id: INTEGER, VAL sectionName: STRING, VAL paramName: STRING, VAL paramValue: STRING): INTEGER
Parameters
application_id - integer identifier for the application
sectionName - name of section in sai_app_params for application
paramName - name of the parameter
paramValue - value of the parameter
Returns
Return code from update or insert
Side Effects
None
Description
Inserts a record into the sai_app_params table for the application if it doesn't exist or updates the value based on the application_id, sectionName, and paramName. This table is similar in structure to an ini file.
Dialog Forms Called
None