fwInstallation  8.4.1
Functions | Variables
fwInstallationInit.ctl File Reference

Functions

int fwInstallationInit_execute (bool runPostInstall=true, string installationPath="")
 
 fwInstallationInit_consolidationCleanup ()
 
 fwInstallationInit_notifyUserAndStopManager (string uiMessage, string logMessage, string messageType="INFO", int exitCode=0)
 
bool fwInstallationInit_isCleanupNeeded ()
 
int fwInstallationInit_addLibToConfig ()
 
 fwInstallationInit_createDataPointTypes (bool create, int &result)
 
int fwInstallationInit_createPendingActionsDataPointType ()
 
int fwInstallationInit_updateDPT ()
 
 fwInstallationInit_updateComponentDps ()
 
bool fwInstallationInit_isAgentInstalled ()
 
int fwInstallationInit_installAgent ()
 
int fwInstallationInit_updateToolVersionInDp ()
 
int fwInstallationInit_loadInitFile ()
 
int fwInstallationInit_runInitScript ()
 
int fwInstallationInit_updatePendingInstallationActions ()
 
int fwInstallationInit_createAgentDataPointType (string type, bool create)
 

Variables

const string csFwInstallationInitLibVersion = "8.4.1"
 
const string gFwInstallationInitScript = "fwInstallationInitScript.ctl"
 

Detailed Description

This file contains functions to perform actions needed to initialize installation tool. They initialize necessary global variables as well as perform upgrade of internal datapoints if needed.

Function Documentation

int fwInstallationInit_execute ( bool  runPostInstall = true,
string  installationPath = "" 
)

This function needs to be called before the first use of the installation library and after each installation.

Parameters
runPostInstall(in) this variable specifies whether pending post-install scripts, if any, must be run during initialization
Returns
0 if OK, -1 if errors
fwInstallationInit_consolidationCleanup ( )

This function provides the migration path from the fwInstallation versions < 8.4.0 to the latest ones. It updates the fwInstallation LoadCtrlLibs config entries, removes obsolete files and restarts manager. When it is called in UI manager, user has to confirm the actions. Note: Due to the changes in the library locations, this function has to be called before fwInstallation script/panel checks the consistency of the library versions. It is because the existing old versions of libraries are already loaded via LoadCtrlLibs entry in the config file, and the new libraries, which were not present in the previous version are loaded with #uses statement.

fwInstallationInit_notifyUserAndStopManager ( string  uiMessage,
string  logMessage,
string  messageType = "INFO",
int  exitCode = 0 
)

Prints message to the log and in UI manager displays pop-up informing about necessity to stop manager. Then terminates the manager with given exit code.

bool fwInstallationInit_isCleanupNeeded ( )

This function checks whether a migration procedure has to be perfomed to upgrade fwInstallation from versions < 8.4.0 to the latest ones.

int fwInstallationInit_addLibToConfig ( )

This function adds the main libraries of the installation tool to the config file of the project

fwInstallationInit_createDataPointTypes ( bool  create,
int &  result 
)
This function creates the Installation Component DPT and DP
Parameters
create(in) flag to indicate if an existing dp-type has to be overwritten (obsolete, legacy)
result(out) result of the operation, 0 if OK, -1 if error
Author
M.Sliwinski, adapted by S. Schmeling and F. Varela.
int fwInstallationInit_createPendingActionsDataPointType ( )
This function creates the internal dp-types of the installtation tool pending actions
Returns
result 0 if OK, -1 otherwise
int fwInstallationInit_updateDPT ( )

This function updates the main dp-type (FwInstallationInformation) of the installation tool from previous versions

Returns
0 if OK, -1 if errors
fwInstallationInit_updateComponentDps ( )

This function updates the internal dp-type used by the installation tool for the components

bool fwInstallationInit_isAgentInstalled ( )

This function checks if the DB-agent of the installation tool is installed in the current project

Returns
true if the agent is installed, false otherwise
int fwInstallationInit_installAgent ( )

This function installs the DB-Agent of the FW Component Installation Tool

Returns
0 if OK, -1 if errors
int fwInstallationInit_updateToolVersionInDp ( )

This function updates the version of the installation tool in the internal datapoint. Tool version is taken from the fwInstallation.ctl library.

Returns
0 if datapoint was updated successfully, -1 if update failed.
int fwInstallationInit_loadInitFile ( )
This function loads the init file for the installation tool
Returns
0 if OK, -1 if error
int fwInstallationInit_runInitScript ( )
This function loads the init file for the installation tool
Returns
0 if OK, -1 if error
int fwInstallationInit_updatePendingInstallationActions ( )

Moves pending actions dpes to separate datapoint. Called when upgrading fwInstallation from version < 7.0.0. Note that version 7.0.0 was released in Aug 2013.

Note
This function can be marked as obsolete. It is required only when upgrading installation tool from version released before Aug 2013.
int fwInstallationInit_createAgentDataPointType ( string  type,
bool  create 
)
This function creates the internal dp-types of the installtation tool
Parameters
typename of the dp-type to be created
createflag to indicated if the dp-type has to be overwritten (obsolete, legacy)
Returns
result 0 if OK, -1 otherwise

Variable Documentation

const string csFwInstallationInitLibVersion = "8.4.1"

Version of this library. Used to determine the coherency of all libraries of the installation tool Please do not edit it manually

const string gFwInstallationInitScript = "fwInstallationInitScript.ctl"

Name of the init file loaded at start up of the tool.