fwInstallation  8.4.1
Functions | Variables
fwInstallationDB.ctl File Reference

Functions

int fwInstallationDB_storeInstallationLog ()
 Beginning of executable code:
 
bool fwInstallationDB_isConnected ()
 
int fwInstallationDB_printLibVersions ()
 
int fwInstallationDB_setConnectionTimeout ()
 
int fwInstallationDB_beginTransaction ()
 
int fwInstallationDB_executeTransaction (string sql)
 
int fwInstallationDB_rollbackTransaction ()
 
int fwInstallationDB_commitTransaction ()
 
int fwInstallationDB_execute (string sql, dyn_mixed record, bool clearCache=true)
 
int fwInstallationDB_executeQuery (string sql, dyn_mixed record, dyn_dyn_mixed &data)
 
string fwInstallationDB_fitStringToLength (string data, int maxCharLen, string dataDescription="")
 
int fwInstallationDB_registerReinstallation (string host, string project, string component, string version, string descFile, int restartProject, int overwriteFiles)
 
int fwInstallationDB_unregisterProjectReinstallations (string host, string project)
 
int fwInstallationDB_getProjectReduHosts (string host, string project, string &primaryHost, string &secondaryHost)
 
int fwInstallationDB_isReinstallationRegistered (int project_id, int component_id, int computer_id, int &id)
 
int fwInstallationDB_getProjectPendingReinstallations (string host, string project, dyn_dyn_mixed &reinstallationsInfo)
 
int fwInstallationDB_unregisterProjectReinstallation (string host, string project, string component, string version)
 
int fwInstallationDB_closeDBConnection ()
 
int fwInstallationDB_setupConnection ()
 
int fwInstallationDB_executeDBCommand (string sql, dyn_dyn_mixed data)
 
int fwInstallationDB_executeDBQuery (string sql, dyn_dyn_mixed &data, bool columnWise=FALSE, int maxRecords=0, dyn_int columnTypes=0)
 
bool fwInstallationDB_getInitialized ()
 
int fwInstallationDB_setInitialized (bool value)
 
int fwInstallationDB_deleteConnection ()
 
int fwInstallationDB_tableExists (string tableName, bool &tableExists)
 
int fwInstallationDB_viewExists (string viewName, bool &viewExists)
 
int fwInstallationDB_getSchemaVersion (string &version)
 
bool fwInstallationDB_compareSchemaVersion ()
 
int fwInstallationDB_registerComponentFromXml (string xmlFile)
 
synchronized int fwInstallationDB_connect ()
 
string fwInstallationDB_getSchemaOwner ()
 
synchronized int fwInstallationDB_openDBConnection (string database, string username, string password, string owner, string driver="QOCI8")
 
bool fwInstallationDB_getUseDB ()
 
int fwInstallationDB_setUseDB (bool useDB)
 
int fwInstallationDB_registerProject (string projectName="", string host="", int pmon_port=4999, string pmon_username="", string pmon_password="", string projectDir="", string systemName="", int systemNumber=-1, int dataPortNr=4897, int eventPortNr=4998, int distPort=4777, int centrallyManaged=0, string pvssVersion="", string os="", string reduHost="", string systemComputer="", int deleteFiles=0, int instToolStatus=1, bool askScattered=false, string projectPvssVersion=VERSION_DISP, int reduPort=4899, int splitPort=4778, int installOnlyInSplit=0, int restoreRedundancyAfterInstallation=1)
 
int fwInstallationDB_unregisterInstallationPath (string installationPath, string projectName="", string computerName="")
 
int fwInstallationDB_unregisterRequiredInstallationPath (string installationPath, string projectName="", string computerName="")
 
int fwInstallationDB_deleteAllRequiredProjectPaths (string projectName="", string computerName="")
 
int fwInstallationDB_deleteAllCurrentProjectPaths (string projectName="", string computerName="")
 
int fwInstallationDB_getInstallationPaths (dyn_string &dbInstallationPaths, dyn_string &dbInstallationPathsIds, string projectName="", string computerName="")
 
int fwInstallationDB_getPvssProjects (dyn_string &projectNames, string computerName="", bool onlyActive=true)
 
int fwInstallationDB_registerComponent (string componentName, string componentVersion, int isSubComponent)
 
int fwInstallationDB_isComponentRegistered (string componentName, string componentVersion, int &id)
 
int fwInstallationDB_isProjectRegistered (int &project_id, string projectName="", string computerName="")
 
int fwInstallationDB_registerPC (string host="", dyn_mixed hostInfo="")
 
int fwInstallationDB_deletePC (string host="")
 
int fwInstallationDB_deleteProject (string project="", string host="", bool deleteSystem=false)
 
int fwInstallationDB_deleteSystem (string systemName)
 
int fwInstallationDB_deleteProjectManager (dyn_mixed managerInfo, string project="", string host="")
 
int fwInstallationDB_isPCRegistered (int &id, string host="")
 
int fwInstallationDB_registerSystem (dyn_mixed systemProperties)
 
int fwInstallationDB_registerWCCOAApplication (dyn_mixed wccoaApplication, string project="", string host="")
 
int fwInstallationDB_isWCCOAApplicationRegistered (int &id, string wccoaName, string project="", string host="")
 
int fwInstallationDB_unregisterWCCOAApplication (string wccoaName, string project="", string host="")
 
int fwInstallationDB_getWCCOAApplications (dyn_dyn_mixed &wccoaApplications, string project="", string host="")
 
int fwInstallationDB_isSystemEventOnAnotherProject (int system_id, int &project_id)
 
int fwInstallationDB_isSystemRegistered (int &id, string systemName="")
 
int fwInstallationDB_isInstallationPathRegistered (string installationPath, int &installation_path_id, int &project_id, int &computer_id, string projectName="", string computerName="")
 
int fwInstallationDB_isRequiredInstallationPathRegistered (string installationPath, int &installation_path_id, int &project_id, string projectName="", string computerName="")
 
int fwInstallationDB_registerInstallationPath (string installationPath, int isDefault, string projectName="", string computerName="")
 
int fwInstallationDB_registerRequiredInstallationPath (string installationPath, string projectName="", string computerName="")
 
int fwInstallationDB_getPatchList (string host, string version, string os, dyn_string &patches)
 
int fwInstallationDB_getPvssVersions (string host="", dyn_string &versions, dyn_string &oss)
 
int fwInstallationDB_registerPvssVersion (string version="", string os="")
 
int fwInstallationDB_isPvssVersionRegistered (string version, string os, int &id)
 
int fwInstallationDB_registerPvssPatch (string patch, string version="", string os="")
 
int fwInstallationDB_isPvssPatchRegistered (string patch, string version, string os, int &patch_id, int &pvss_id)
 
int fwInstallationDB_registerPvssBase (string host="", string version="", string os="")
 
int fwInstallationDB_isPvssBaseRegistered (string host, string version, string os, int &base_id, int &pvss_id, int &host_id)
 
int fwInstallationDB_registerPvssSetup (string host="", string version="", string os="", dyn_string patches="")
 
int fwInstallationDB_unregisterSetupPvssPatch (string host, string version, string os, string patch)
 
int fwInstallationDB_isPvssSetupEntryRegistered (int base_id, int patch_id, int &setup_id)
 
int fwInstallationDB_registerProjectPaths ()
 
int fwInstallationDB_registerRequiredProjectPaths ()
 
int fwInstallationDB_isProjectComponentRegistered (string component, string version, string project, string hostname, int &component_id, int &project_id, int &projectComponentId)
 
int fwInstallationDB_registerProjectFwComponents (string project="", string hostname="")
 
int fwInstallationDB_unregisterCurrentProjectComponent (string component, string version, string project="", string host="")
 
int fwInstallationDB_registerProjectManagers ()
 
int fwInstallationDB_executeSqlSimple (string sql)
 
int fwInstallationDB_executeSqlFromFile (string fileName, bool breakOnDbError=TRUE)
 
int fwInstallationDB_getHostsInfo (dyn_dyn_mixed &hostsInfo)
 
int fwInstallationDB_getHosts (dyn_string &hostnames, dyn_string &ips, dyn_string &macs, dyn_string &ips2, dyn_string &macs2, dyn_string &bmc_ips, dyn_string &bmc_ips2)
 
int fwInstallationDB_getPvssSystems (dyn_dyn_mixed &systemsInfo, bool onlyActive=true)
 
int fwInstallationDB_getComponentProperties (string component, string version, int &isSubComponent)
 
int fwInstallationDB_getAllComponents (dyn_dyn_mixed &componentsInfo)
 
int fwInstallationDB_getHostProperties (string hostname, dyn_mixed &hostInfo)
 
int fwInstallationDB_setHostProperties (string hostname, dyn_mixed hostInfo)
 
bool fwInstallationDB_getCentrallyManaged (string project="", string host="")
 
int fwInstallationDB_setNeedsSynchronize (bool needSynchronize, string project="", string hostname="")
 
int fwInstallationDB_setCentrallyManaged (int centrallyManaged, string project="", string hostname="")
 
int fwInstallationDB_getProjectManagementMode (bool &isCentrallyManaged, string project="", string hostname="")
 
int fwInstallationDB_getProjectProperties (string project, string hostname, dyn_mixed &projectProperties, int &projectId)
 
int fwInstallationDB_getReduPair (string hostname, string project, string &reduHost)
 
int fwInstallationDB_getProjectPaths (string project="", string hostname="", dyn_string &projectPaths)
 
int fwInstallationDB_getRequiredProjectPaths (string project="", string hostname="", dyn_string &projectPaths)
 
int fwInstallationDB_setProjectProperties (string project, string hostname, dyn_mixed projectProperties, bool askScattered=false)
 
int fwInstallationDB_setSystemProperties (dyn_mixed systemProperties)
 
int fwInstallationDB_setComponentProperties (string component, string version, int isSubComponent)
 
int fwInstallationDB_addChildSystem (string parentSystem, string childSystem)
 
int fwInstallationDB_removeChildSystem (string systemName)
 
int fwInstallationDB_removeSystemHierarchy ()
 
int fwInstallationDB_getChildSystems (string parentSystem, dyn_dyn_mixed &childSystems)
 
int fwInstallationDB_getSystemHierarchy (dyn_dyn_mixed &hierarchyInfo)
 
int fwInstallationDB_getPvssSystemProperties (string systemName, dyn_mixed &systemInfo)
 
int fwInstallationDB_getSystemConnectivity (string systemName, string computerName, dyn_dyn_mixed &connectedSystemsInfo, bool onlyServers=false)
 
int fwInstallationDB_getSystemRequiredConnectivity (string systemName, dyn_dyn_mixed &connectedSystemsInfo, bool onlyServers=false)
 
int fwInstallationDB_getSystemProjects (string systemName, dyn_dyn_mixed &projectsInfo)
 
int fwInstallationDB_registerProjectManager (dyn_mixed managerInfo, string project="", string hostname="")
 
int fwInstallationDB_setPvssManagerProperties (dyn_mixed managerInfo, string project="", string hostname="")
 
int fwInstallationDB_isProjectManagerRegistered (dyn_mixed managerInfo, string project, string hostname, int &manager_id, int &project_id, int &computer_id)
 
int fwInstallationDB_registerPvssManagerType (dyn_mixed managerTypeInfo)
 
int fwInstallationDB_isPvssManagerTypeRegistered (string managerType, bool &isRegistered)
 
int fwInstallationDB_getProjectManagers (dyn_dyn_mixed &managersInfo, string projectName="", string computerName="")
 
int fwInstallationDB_getProjectComponents (dyn_dyn_mixed &componentsInfo, string projectName="", string computerName="")
 
int fwInstallationDB_addSystemConnection (string peer1Name, string peer2Name, string computerName)
 
int fwInstallationDB_addSystemRequiredConnection (string peer1Name, string peer2Name)
 
int fwInstallationDB_removeSystemRequiredConnection (string peer1Name, string peer2Name)
 
int fwInstallationDB_removeSystemConnection (string peer1Name, string peer2Name, string computerName)
 
int fwInstallationDB_getSystemProjectHost (string systemName, dyn_dyn_mixed &projectSystemHostInfo)
 
int fwInstallationDB_getProjectGroupProperties (string group, dyn_mixed &projectGroupInfo, string projectName="", string computerName="")
 
int fwInstallationDB_getCurrentProjectComponents (dyn_dyn_mixed &componentsInfo, string projectName="", string computerName="")
 
int fwInstallationDB_registerPathMapping (string windowsPath, string linuxPath)
 
int fwInstallationDB_isPathMappingRegistered (int &id, string windowsPath, string linuxPath)
 
int fwInstallationDB_unregisterPathMapping (string windowsPath, string linuxPath)
 
int fwInstallationDB_getMappedPath (string path, string &mappedPath)
 
int fwInstallationDB_getAllMappedPaths (string pattern, dyn_mixed &pathMapping)
 
int fwInstallationDB_getComputerSystems (string computer, dyn_string &systems)
 
int fwInstallationDB_getComponentsIncorrectlyInstalled (dyn_dyn_mixed &componentsInfo)
 
int fwInstallationDB_getSystemName (string sysNumber, string &name, int reduNr=1)
 
int fwInstallationDB_getProjectAutoregistration (int &autoreg_enabled)
 
int fwInstallationDB_setProjectAutoregistration (int autoreg_enabled)
 
int fwInstallationDB_registerProjectFileIssues (dyn_dyn_mixed fileIssues, string project="", string host="")
 
int fwInstallationDB_registerProjectComponentFileIssue (dyn_mixed fileIssue, string project="", string host="")
 
int fwInstallationDB_isIssueTypeRegistered (string issueType, int &issueTypeId)
 
int fwInstallationDB_deleteProjectFileIssues (string project="", string host="")
 
int fwInstallationDB_isProjectComponentFileIssueRegistered (int hostId, int projectId, int componentId, dyn_mixed fileIssue, bool &registered)
 
int fwInstallationDB_getProjectComponentFileIssues (string component, string version, dyn_dyn_mixed &fileIssues, string project="", string host="")
 
int fwInstallationDB_getProjectFileIssues (dyn_dyn_mixed &fileIssues, string project="", string host="")
 
int fwInstallationDB_isProjectRedundant (string projectName, string hostName, bool &isProjectRedundant)
 
int fwInstallationDB_deleteAllRequiredSystemConnections (string systemName="")
 
int fwInstallationDB_deleteAllCurrentSystemConnections (string systemName="", string computerName="")
 
int fwInstallationDB_registerDistConnections ()
 
bool fwInstallationDB_isProjectRegisteredPartially (int projectId)
 
int fwInstallationDB_completeProjectPartialRegistration (int projectId)
 
int fwInstallationDB_registerDevice (string deviceType, string application, dyn_mixed deviceInfo, string project="", string host="")
 
int fwInstallationDB_unregisterDevice (string deviceType, string application, string device, string project="", string host="")
 
int fwInstallationDB_isDeviceRegistered (int &id, string deviceType, string application, string device, string project="", string host="")
 
int fwInstallationDB_getDevices (string deviceType, string application, dyn_dyn_mixed &devices, string project="", string host="")
 
int fwInstallationDB_setDeviceProperties (string deviceType, string application, dyn_mixed deviceInfo, string project="", string host="")
 
int fwInstallationDB_registerDeviceType (string deviceTypeName)
 
int fwInstallationDB_unregisterDeviceType ()
 
int fwInstallationDB_isDeviceTypeRegistered (int &id, string deviceType)
 
int fwInstallationDB_getDeviceTypes (dyn_string &deviceTypes)
 
int fwInstallationDB_setWCCOAApplicationProperties (dyn_mixed applicationInfo, string project="", string host="")
 
int fwInstallationDB_isParamTypeRegistered (int &id, string paramType)
 
int fwInstallationDB_registerParamType (dyn_mixed paramTypeProperties)
 
int fwInstallationDB_removeParamType (string paramType)
 
int fwInstallationDB_getParamTypeProperties (string paramType, dyn_mixed &paramTypeProperties)
 
int fwInstallationDB_isProjectParamRegistered (int &id, string paramName, string project="", string host="")
 
int fwInstallationDB_registerProjectParam (string paramName, string value="", string project="", string host="")
 
int fwInstallationDB_getProjectParamValue (string paramName, string &value, string project="", string host="")
 
int fwInstallationDB_setProjectParamValue (string paramName, string value, string project="", string host="")
 
int fwInstallationDB_removeProjectParam (string paramName, string project="", string host="")
 
int fwInstallationDB_getProjectParamsProperties (dyn_dyn_mixed &projectParamsProperites, string paramKeyword="%", string project="", string host="")
 

Variables

const string csFwInstallationDBLibVersion = "8.4.1"
 
const int FW_INSTALLATION_DB_PROJ_PARAM_TYPE_NAME = 1
 
fwInstallation.ctl: Definition of variables

The following variables are used by the fwInstallationManager.ctl library

const string FW_INSTALLATION_SCHEMA_TBL = "FW_SYS_STAT_SCHEMA"
 
const string FW_INSTALLATION_DB_REQUIRED_SCHEMA_VERSION = "5.1.4"
 
const int FW_INSTALLATION_DB_SYSTEM_NAME = 1
 
const int FW_INSTALLATION_DB_SYSTEM_NUMBER = 2
 
const int FW_INSTALLATION_DB_SYSTEM_DATA_PORT = 3
 
const int FW_INSTALLATION_DB_SYSTEM_EVENT_PORT = 4
 
const int FW_INSTALLATION_DB_SYSTEM_DIST_PORT = 5
 
const int FW_INSTALLATION_DB_SYSTEM_PARENT_SYS_ID = 6
 
const int FW_INSTALLATION_DB_SYSTEM_COMPUTER = 7
 
const int FW_INSTALLATION_DB_SYSTEM_REDU_PORT = 8
 
const int FW_INSTALLATION_DB_SYSTEM_SPLIT_PORT = 9
 
const int FW_INSTALLATION_DB_SYSTEM_PROJECT = 10
 
const int FW_INSTALLATION_DB_SYSTEM_IDX = 11
 
const int FW_INSTALLATION_DB_SYSTEM_REDU_HOST = 12
 
int FW_INSTALLATION_DB_SYSTEM_ID_IDX = 3
 
int FW_INSTALLATION_DB_SYSTEM_PARENT_ID_IDX = 4
 
const int FW_INSTALLATION_DB_PROJECT_NAME = 1
 
const int FW_INSTALLATION_DB_PROJECT_HOST = 2
 
const int FW_INSTALLATION_DB_PROJECT_DIR = 3
 
const int FW_INSTALLATION_DB_PROJECT_SYSTEM_NAME = 4
 
const int FW_INSTALLATION_DB_PROJECT_SYSTEM_NUMBER = 5
 
const int FW_INSTALLATION_DB_PROJECT_PMON_PORT = 6
 
const int FW_INSTALLATION_DB_PROJECT_PMON_USER = 7
 
const int FW_INSTALLATION_DB_PROJECT_PMON_PWD = 8
 
const int FW_INSTALLATION_DB_PROJECT_TOOL_VER = 9
 
const int FW_INSTALLATION_DB_PROJECT_CENTRALLY_MANAGED = 10
 
const int FW_INSTALLATION_DB_PROJECT_PVSS_VER = 11
 
const int FW_INSTALLATION_DB_PROJECT_DATA = 12
 
const int FW_INSTALLATION_DB_PROJECT_EVENT = 13
 
const int FW_INSTALLATION_DB_PROJECT_DIST = 14
 
const int FW_INSTALLATION_DB_PROJECT_OS = 15
 
const int FW_INSTALLATION_DB_PROJECT_PROJECT_OK = 16
 
const int FW_INSTALLATION_DB_PROJECT_PVSS_OK = 17
 
const int FW_INSTALLATION_DB_PROJECT_HOST_OK = 18
 
const int FW_INSTALLATION_DB_PROJECT_PATH_OK = 19
 
const int FW_INSTALLATION_DB_PROJECT_MANAGER_OK = 20
 
const int FW_INSTALLATION_DB_PROJECT_GROUP_OK = 21
 
const int FW_INSTALLATION_DB_PROJECT_COMPONENT_OK = 22
 
const int FW_INSTALLATION_DB_PROJECT_EXT_PROCESS_OK = 23
 
const int FW_INSTALLATION_DB_PROJECT_LAST_CHECK = 24
 
const int FW_INSTALLATION_DB_PROJECT_SYSTEM_OVERVIEW = 25
 
const int FW_INSTALLATION_DB_PROJECT_UPGRADE = 26
 
const int FW_INSTALLATION_DB_PROJECT_REDU_HOST = 27
 
const int FW_INSTALLATION_DB_PROJECT_SYSTEM_COMPUTER = 28
 
const int FW_INSTALLATION_DB_PROJECT_DELETE_FILES = 29
 
const int FW_INSTALLATION_DB_PROJECT_TOOL_STATUS = 30
 
const int FW_INSTALLATION_DB_PROJECT_REDU_PORT = 31
 
const int FW_INSTALLATION_DB_PROJECT_SPLIT_PORT = 32
 
const int FW_INSTALLATION_DB_PROJECT_DIST_PEERS_OK = 33
 
const int FW_INSTALLATION_DB_PROJECT_NEED_SYNCHRONIZE = 34
 
const int FW_INSTALLATION_DB_PROJECT_INSTALL_ONLY_IN_SPLIT = 35
 
const int FW_INSTALLATION_DB_PROJECT_RESTORE_REDUNDANCY_AFTER_INST = 36
 
const int FW_INSTALLATION_DB_PROJECT_RESPONSIBLE = 37
 
const int FW_INSTALLATION_DB_WINDOWS_PATH = 1
 
const int FW_INSTALLATION_DB_LINUX_PATH = 2
 
global bool g_fwInstallationSqlDebug = false
 
global bool g_fwInstallationVerbose = false
 
global dbConnection gFwInstallationDBConn
 
string FW_INSTALLATION_DB_CONNECTION_NAME = "fwInstallationToolConnection"
 
const int FW_INSTALLATION_DB_MANAGER_NAME_IDX = 1
 
const int FW_INSTALLATION_DB_MANAGER_START_IDX = 2
 
const int FW_INSTALLATION_DB_MANAGER_RESTART_IDX = 3
 
const int FW_INSTALLATION_DB_MANAGER_RESETMIN_IDX = 4
 
const int FW_INSTALLATION_DB_MANAGER_SECKILL_IDX = 5
 
const int FW_INSTALLATION_DB_MANAGER_OPTIONS_IDX = 6
 
const int FW_INSTALLATION_DB_MANAGER_TRIGGERS_ALERTS_IDX = 7
 
const int FW_INSTALLATION_DB_MANAGER_TYPE_NAME_IDX = 1
 
const int FW_INSTALLATION_DB_MANAGER_TYPE_DESCRIPTION_IDX = 2
 
const int FW_INSTALLATION_DB_MANAGER_TYPE_GROUP_IDX = 3
 
const int FW_INSTALLATION_DB_COMPUTER_FLAG_IDX = 1
 
const int FW_INSTALLATION_DB_PVSS_FLAG_IDX = 2
 
const int FW_INSTALLATION_DB_PROJECT_FLAG_IDX = 3
 
const int FW_INSTALLATION_DB_MANAGERS_FLAG_IDX = 4
 
const int FW_INSTALLATION_DB_FW_COMPONENTS_FLAG_IDX = 5
 
const int FW_INSTALLATION_DB_EXTERNAL_PROCESSES_FLAG_IDX = 6
 
const int FW_INSTALLATION_DB_DIST_PEERS_FLAG_IDX = 7
 
const int FW_INSTALLATION_DB_COMPONENT_NAME_IDX = 1
 
const int FW_INSTALLATION_DB_COMPONENT_VERSION_IDX = 2
 
const int FW_INSTALLATION_DB_COMPONENT_SUBCOMP_IDX = 3
 
const int FW_INSTALLATION_DB_COMPONENT_DESC_FILE_IDX = 4
 
const int FW_INSTALLATION_DB_COMPONENT_INSTALLATION_NOT_OK_IDX = 5
 
const int FW_INSTALLATION_DB_COMPONENT_DEPENDENCIES_OK_IDX = 6
 
const int FW_INSTALLATION_DB_COMPONENT_PENDING_POSTINSTALLS_IDX = 7
 
const int FW_INSTALLATION_DB_COMPONENT_RESTART_IDX = 8
 
const int FW_INSTALLATION_DB_EXT_PROCESS_NAME_IDX = 1
 
const int FW_INSTALLATION_DB_EXT_PROCESS_PATH_IDX = 2
 
const int FW_INSTALLATION_DB_EXT_PROCESS_OPTIONS_IDX = 3
 
const int FW_INSTALLATION_DB_PROJ_SYS_HOST_PROJ = 1
 
const int FW_INSTALLATION_DB_PROJ_SYS_HOST_SYS_NAME = 2
 
const int FW_INSTALLATION_DB_PROJ_SYS_HOST_SYS_NUMBER = 3
 
const int FW_INSTALLATION_DB_PROJ_SYS_HOST_DISTPORT = 4
 
const int FW_INSTALLATION_DB_PROJ_SYS_HOST_HOST = 5
 
const int FW_INSTALLATION_DB_PROJ_SYS_HOST_REDU_HOST = 6
 
const int FW_INSTALLATION_DB_PROJ_COMP_NAME_IDX = 1
 
const int FW_INSTALLATION_DB_PROJ_COMP_VERSION_IDX = 2
 
const int FW_INSTALLATION_DB_PROJ_COMP_IS_SUBCOMP_IDX = 3
 
const int FW_INSTALLATION_DB_PROJ_COMP_DESCFILE_IDX = 4
 
const int FW_INSTALLATION_DB_PROJ_COMP_OVERWRITE_IDX = 5
 
const int FW_INSTALLATION_DB_PROJ_COMP_FORCE_IDX = 6
 
const int FW_INSTALLATION_DB_PROJ_COMP_IS_SILENT_IDX = 7
 
const int FW_INSTALLATION_DB_PROJ_COMP_IS_PATCH_IDX = 8
 
const int FW_INSTALLATION_DB_PROJ_COMP_RESTART_PROJECT_IDX = 9
 
const int FW_INSTALLATION_DB_PVSS_INFO_VERSION_IDX = 1
 
const int FW_INSTALLATION_DB_PVSS_INFO_OS_IDX = 2
 
const int FW_INSTALLATION_DB_PVSS_INFO_PATCHES_IDX = 3
 
const int FW_INSTALLATION_DB_HOST_NAME_IDX = 1
 
const int FW_INSTALLATION_DB_HOST_IP_1_IDX = 2
 
const int FW_INSTALLATION_DB_HOST_MAC_1_IDX = 3
 
const int FW_INSTALLATION_DB_HOST_IP_2_IDX = 4
 
const int FW_INSTALLATION_DB_HOST_MAC_2_IDX = 5
 
const int FW_INSTALLATION_DB_HOST_BMC_IP_IDX = 6
 
const int FW_INSTALLATION_DB_HOST_BMC_USER_IDX = 7
 
const int FW_INSTALLATION_DB_HOST_BMC_PWD_IDX = 8
 
const int FW_INSTALLATION_DB_HOST_FMC_ENABLE_IPMI_IDX = 9
 
const int FW_INSTALLATION_DB_HOST_FMC_IPMI_DEVICE_NAME_IDX = 10
 
const int FW_INSTALLATION_DB_HOST_FMC_ENABLE_MONITORING_IDX = 11
 
const int FW_INSTALLATION_DB_HOST_FMC_MONITORING_LEVEL_IDX = 12
 
const int FW_INSTALLATION_DB_HOST_FMC_ENABLE_TM_IDX = 13
 
const int FW_INSTALLATION_DB_HOST_FMC_ENABLE_LOGGER_IDX = 14
 
const int FW_INSTALLATION_DB_HOST_DB_IDX = 15
 
const int FW_INSTALLATION_DB_HOST_FMC_ENABLE_PROCESS_IDX = 16
 
const int FW_INSTALLATION_DB_HOST_FMC_WIN_PROCS_CONTROLLER_IDX = 17
 
const int FW_INSTALLATION_DB_HOST_FMC_LOCATION_IDX = 18
 
const int FW_INSTALLATION_DB_HOST_DESCRIPTION_IDX = 19
 
const int FW_INSTALLATION_DB_HOST_FMC_OS_IDX = 20
 
const int FW_INSTALLATION_DB_HOST_FMC_IPMI_MASTER_IDX = 21
 
const int FW_INSTALLATION_DB_HOST_FMC_ARCHIVING_IDX = 22
 
const int FW_INSTALLATION_DB_HOST_FMC_ALARMS_IDX = 23
 
const int FW_INSTALLATION_DB_HOST_WCCOA_INSTALL_PKG_IDX = 24
 
const int FW_INSTALLATION_DB_HOST_CPU_INFO_IDX = 25
 
const int FW_INSTALLATION_DB_HOST_MEM_SIZE_IDX = 26
 
const int FW_INSTALLATION_DB_HOST_FMC_INSTALL_PKG_IDX = 27
 
const int FW_INSTALLATION_DB_COMP_BAD_HOST = 1
 
const int FW_INSTALLATION_DB_COMP_BAD_PROJECT = 2
 
const int FW_INSTALLATION_DB_COMP_BAD_NAME = 3
 
const int FW_INSTALLATION_DB_COMP_BAD_VERSION = 4
 
const int FW_INSTALLATION_DB_CONNECTION_TIMEOUT = 600
 
const int FW_INSTALLATION_DB_MAX_LOG_SIZE = 1000
 
const int FW_INSTALLATION_DB_FILE_ISSUE_COMPONENT = 1
 
const int FW_INSTALLATION_DB_FILE_ISSUE_VERSION = 2
 
const int FW_INSTALLATION_DB_FILE_ISSUE_FILENAME = 3
 
const int FW_INSTALLATION_DB_FILE_ISSUE_TYPE = 4
 
const int FW_INSTALLATION_DB_FILE_ISSUE_MODIFICATION_DATE = 5
 
const string FW_INSTALLATION_DB_PARTIAL_REGISTERED_PROJECT_STATUS = "PARTIAL_REGISTRATION"
 
const string FW_INSTALLATION_DB_FULLY_REGISTERED_PROJECT_STATUS = "CREATED"
 
const int FW_INSTALLATION_DB_WCCOA_APP_NAME = 1
 
const int FW_INSTALLATION_DB_WCCOA_APP_INFO_URL = 2
 
const int FW_INSTALLATION_DB_WCCOA_APP_COMMENT_TEXT = 3
 
const int FW_INSTALLATION_DB_WCCOA_APP_STATUS = 4
 
const int FW_INSTALLATION_DB_WCCOA_APP_RESPONSIBLE = 5
 
const int FW_INSTALLATION_DB_WCCOA_APP_DEFAULT_PANEL = 6
 
const int FW_INSTALLATION_DB_WCCOA_APP_ALARM_OVERVIEW_PANEL = 7
 
const int FW_INSTALLATION_DB_WCCOA_DEV_NAME = 1
 
const int FW_INSTALLATION_DB_WCCOA_DEV_INFO_URL = 2
 
const int FW_INSTALLATION_DB_WCCOA_DEV_COMMENT = 3
 
const int FW_INSTALLATION_DB_WCCOA_DEV_STATUS = 4
 

Detailed Description

This library contains all functions that serve as interface between the installation tool and a external Oracle DB. The functions in these library are not intended to be called from user scripts

Author
Fernando Varela Rodriguez (IT-CO/BE)
Version
3.3.10
Date
April 2007

Function Documentation

bool fwInstallationDB_isConnected ( )

This function tell if we are correctly connected to the DB or not.

Returns
TRUE if connected. FALSE if not connected.
int fwInstallationDB_printLibVersions ( )

This function prints the versions of the libraries in the current distribution

Returns
0
int fwInstallationDB_setConnectionTimeout ( )

This function sets the idle DB connection timeout to the default value

Returns
0 if OK, -1 if error
int fwInstallationDB_beginTransaction ( )

This function initiates a DB transaction

Returns
0 if OK, -1 if error
int fwInstallationDB_executeTransaction ( string  sql)

This function executes a DB transaction (Deprecated? orphan method in fwi6.0.2)

Parameters
sql(in) sql sentence to be executed
Returns
0 if OK, -1 if error
int fwInstallationDB_rollbackTransaction ( )

This function rolls back a DB transaction

Returns
0 if OK, -1 if error
int fwInstallationDB_commitTransaction ( )

This function commits a DB transaction

Returns
0 if OK, -1 if error
int fwInstallationDB_execute ( string  sql,
dyn_mixed  record,
bool  clearCache = true 
)

This function executes a SQL instruction. This function only executes a SQL query but does not get any results from it as opposed to fwInstallationDB_executeQuery() call

See Also
fwInstallationDB_executeQuery()
Parameters
sql(in) sql sentence to be executed
record(in) bind variables as a dyn_mixed
Returns
0 if OK, -1 if error
int fwInstallationDB_executeQuery ( string  sql,
dyn_mixed  record,
dyn_dyn_mixed &  data 
)

This function executes a SQL query. This function executes a SQL query and gets the result (rows) as opposed to fwInstallationDB_execute() which executes the query but does not return any data from DB (rows).

See Also
fwInstallationDB_execute().
Parameters
sql(in) sql sentence to be executed
record(in) bind variables as a dyn_mixed
data(out) result of the query as a dyn_dyn_mixed
Returns
0 if OK, -1 if error
string fwInstallationDB_fitStringToLength ( string  data,
int  maxCharLen,
string  dataDescription = "" 
)

Ensures that given string it's in the character limit. Characters that exceeds the limit are truncated and the warning is printed to the log.

Parameters
data(in) Data string to be checked
maxCharLen(in) Characters limit
dataDescription(in) Description of the data, displayed in the warning message. Note: when empty (default) then warning is not displayed.
Returns
Data string that fits in the character limit. Additional characters are cut off.
int fwInstallationDB_registerReinstallation ( string  host,
string  project,
string  component,
string  version,
string  descFile,
int  restartProject,
int  overwriteFiles 
)

This function registers in the database a component for reinstallation in a project

Parameters
hostname of the host where the project runs
projectname of the project where the compnent has to be reinstalled
componentname of the component to be reinstalled
versionversion of the component
descFileComponent description XML file
restartProjectflag indicating whether the project has to be restarted after reinstallation
overwriteFilesflag indicating if the component files have to be restarted
Returns
0 if OK, -1 if error
int fwInstallationDB_unregisterProjectReinstallations ( string  host,
string  project 
)

This function unregisters from the database all component reinstallations for a given project

Parameters
hostname of the host where the project runs
projectname of the project
Returns
0 if OK, -1 if error
int fwInstallationDB_getProjectReduHosts ( string  host,
string  project,
string &  primaryHost,
string &  secondaryHost 
)

This function returns the name of the primary and secondary redundant hosts in a redu project

Parameters
hostname of the host to be checked
projectname of the PVSS project
primaryHostname of the host the project was initially registered for in the DB
secondaryHostsecondary redundant host
Returns
0 if OK, -1 if error
int fwInstallationDB_isReinstallationRegistered ( int  project_id,
int  component_id,
int  computer_id,
int &  id 
)

This function checks if a component reinstallation has already been registered in the DB for a given project

Parameters
project_idDB index of the project
component_idDB index of the component
computer_idDB index of the host
idDB index of the reinstallation. -1 means that the reinstallation is not yet registered in the DB
Returns
0 if OK, -1 if error
int fwInstallationDB_getProjectPendingReinstallations ( string  host,
string  project,
dyn_dyn_mixed &  reinstallationsInfo 
)

This function retrieves the list of pending reinstalaltions for a given project

Parameters
hostname of the host where the project runs
projectname of the project
reinstallationsInfolist of reinstallations
Returns
0 if OK, -1 if error
int fwInstallationDB_unregisterProjectReinstallation ( string  host,
string  project,
string  component,
string  version 
)

This function unregisters a particular component reinstallation for a given project

Parameters
hostname of the host where the project runs
projectname of the project
componentname of the component
versionversion of the component
Returns
0 if OK, -1 if error
int fwInstallationDB_closeDBConnection ( )

This function closes the connection to the System Configuration DB

Returns
0 if OK, -1 if error
int fwInstallationDB_setupConnection ( )

This function prompts the user to define the DB connection parameters

Returns
0 if OK, -1 if error
int fwInstallationDB_executeDBCommand ( string  sql,
dyn_dyn_mixed  data 
)

This function executes a DB command (Deprecated? - orphan method in fwi6.0.2)

Parameters
sqlSQL command
dataCommand data as a dyn_dyn_mixed array
Returns
0 if OK, -1 if error
int fwInstallationDB_executeDBQuery ( string  sql,
dyn_dyn_mixed &  data,
bool  columnWise = FALSE,
int  maxRecords = 0,
dyn_int  columnTypes = 0 
)

This function executes a DB query (Deprecated? - method used only in fwInstallationFSMDB.ctl)

Parameters
sqlSQL query to be executed
dataretrieved data
columnWisedefines if the data must be sorted by columns
maxRecordsMaximum number of records allowed in the data
columnTypesdata types of the retrieved columns
Returns
0 if OK, -1 if error
bool fwInstallationDB_getInitialized ( )

This function returns the initialization status of the DB connection

Note
After FWINS-2026 it is no longer needed - this function was used to check if db credentials was loaded from init file. In such case the db configuration pop-up was not displayed at the first start of fwInstallation - now this pop-up is not displayed in any case. Setting this dpe at the first start was left for compatibility reason.
Returns
true if the connection is initialized and false otherwise
int fwInstallationDB_setInitialized ( bool  value)

This function sets the status of the DB connection initialization

Note
After FWINS-2026 it is no longer needed - see note for fwInstallationDB_getInitialized()
Parameters
valueInitialization status
Returns
0 if OK, -1 if error
int fwInstallationDB_deleteConnection ( )

This function deletes a DB connection

Returns
0 if OK, -1 if error
int fwInstallationDB_tableExists ( string  tableName,
bool &  tableExists 
)

This function checks if a DB table exists

Parameters
tableNamename of the table
tableExiststrue if the table exists, otherwise false
Returns
0 if OK, -1 if error
int fwInstallationDB_viewExists ( string  viewName,
bool &  viewExists 
)

This function checks if a DB view exists

Parameters
viewNamename of the DB view
viewExiststrue if the view exists, otherwise false
Returns
0 if OK, -1 if error
int fwInstallationDB_getSchemaVersion ( string &  version)

This function retrieves the current DB schema version

Parameters
versionVersion of the System Configuration DB schema
Returns
0 if OK, -1 if error
bool fwInstallationDB_compareSchemaVersion ( )

This function compares the current and required DB schema versions

Returns
True if the current is equal or newer than the required one, otherwise false
int fwInstallationDB_registerComponentFromXml ( string  xmlFile)

This function registers in the DB a Framework component

Parameters
xmlFileComponent description file
Returns
0 if OK, -1 if error
synchronized int fwInstallationDB_connect ( )

This function establishes a connection to the System Configuration DB

Returns
0 if OK, -1 if error
string fwInstallationDB_getSchemaOwner ( )

This function retrieves the schema owner to be used during the db connection

Returns
schema owner as string
synchronized int fwInstallationDB_openDBConnection ( string  database,
string  username,
string  password,
string  owner,
string  driver = "QOCI8" 
)

This function opens a connection to the System Configuration DB

Parameters
database(in) database server name
username(in) user name
password(in) password
owner(in) schema owner
driver(in) driver to be used. By default "QOCI8".
Returns
0 if OK, -1 if error
bool fwInstallationDB_getUseDB ( )

This function returns whether the DB-agent of the installation tool must access the System Configuration DB or not

Returns
true if the user has chosen to use the System Configuration DB, otherwise false
int fwInstallationDB_setUseDB ( bool  useDB)

This function sets the flag for the DB-agent of the installation tool to use System Configuration DB

Parameters
useDBflag indicating whether the DB must be accessed or not
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerProject ( string  projectName = "",
string  host = "",
int  pmon_port = 4999,
string  pmon_username = "",
string  pmon_password = "",
string  projectDir = "",
string  systemName = "",
int  systemNumber = -1,
int  dataPortNr = 4897,
int  eventPortNr = 4998,
int  distPort = 4777,
int  centrallyManaged = 0,
string  pvssVersion = "",
string  os = "",
string  reduHost = "",
string  systemComputer = "",
int  deleteFiles = 0,
int  instToolStatus = 1,
bool  askScattered = false,
string  projectPvssVersion = VERSION_DISP,
int  reduPort = 4899,
int  splitPort = 4778,
int  installOnlyInSplit = 0,
int  restoreRedundancyAfterInstallation = 1 
)

This function registers a PVSS project in the System Configuration DB

Parameters
projectNameproject name
hosthostname
pmon_portpmon port
pmon_usernamepmon username
pmon_passwordpmon password
projectDirproject directory
systemNamesystem name
systemNumbersystem number
dataPortNrdata port
eventPortNrevent manager port
distPortdistributed port
centrallyManagedflag indicating whether project is centrally or locally managed
pvssVersionversion of PVSS
osoperating system {Windows or Linux}
reduHostname of the host where the redundant peer runs
systemComputername of the host where the pair DB and event manager runs
deleteFilesflag indicating whether component files are deleted after the deletion of a component
askScatteredif set to true and called from a UI, it informs the user that a scattered project will be registered as the system already exists.
Returns
0 if OK, -1 if errors
int fwInstallationDB_unregisterInstallationPath ( string  installationPath,
string  projectName = "",
string  computerName = "" 
)

This function unregisters a project path from the System Configuration DB

Parameters
installationPathproject path to be unregistered
projectNameproject name
computerNamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_unregisterRequiredInstallationPath ( string  installationPath,
string  projectName = "",
string  computerName = "" 
)

This function unregisters a required project path from the System Configuration DB

Parameters
installationPathprojec path to be unregistered
projectNameproject name
computerNamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_deleteAllRequiredProjectPaths ( string  projectName = "",
string  computerName = "" 
)

This function unregisters all required project paths at once from the System Configuration DB

Parameters
projectNameproject name
computerNamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_deleteAllCurrentProjectPaths ( string  projectName = "",
string  computerName = "" 
)

This function unregisters all current project paths at once from the System Configuration DB

Parameters
projectNameproject name
computerNamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_getInstallationPaths ( dyn_string &  dbInstallationPaths,
dyn_string &  dbInstallationPathsIds,
string  projectName = "",
string  computerName = "" 
)

This function retrieves all registered project paths from the System Configuration DB

Parameters
dbInstallationPathslist of project paths
dbInstallationPathsIdslist of DB indices of the different project paths
projectNameproject name
computerNamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_getPvssProjects ( dyn_string &  projectNames,
string  computerName = "",
bool  onlyActive = true 
)

This function retrieves all PVSS project registered in the System Configuration DB

Parameters
projectNameslist of project names
computerNamehostname
onlyActiveif true ignores the history of projects
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerComponent ( string  componentName,
string  componentVersion,
int  isSubComponent 
)

This function registers a component in the System Configuration DB

Parameters
componentNamecomponent name
componentVersioncomponent version
isSubComponentflag indicating if the component is a subcomponent
Returns
0 if OK, -1 if errors
int fwInstallationDB_isComponentRegistered ( string  componentName,
string  componentVersion,
int &  id 
)

This function checks if a component is registered in the System Configuration DB

Parameters
componentNamecomponent name
componentVersioncomponent version
idDB index. -1 if the compnent is not registered in the DB
Returns
0 if OK, -1 if errors
int fwInstallationDB_isProjectRegistered ( int &  project_id,
string  projectName = "",
string  computerName = "" 
)

This function checks if a project is registered in the System Configuration DB

Parameters
project_idDB index of the project. -1 if the project is not registered in the DB.
projectNameproject name
computerNamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerPC ( string  host = "",
dyn_mixed  hostInfo = "" 
)

This function registers a host in the System Configuration DB

Parameters
hosthostname
hostInfohost properties
Returns
0 if OK, -1 if errors
int fwInstallationDB_deletePC ( string  host = "")

This function deletes a host from the System Configuration DB

Parameters
hosthost to be deleted
Returns
0 if OK, -1 if errors
int fwInstallationDB_deleteProject ( string  project = "",
string  host = "",
bool  deleteSystem = false 
)

This function deletes a project from the System Configuration DB

Parameters
projectproject name
hosthostname
deleteSystemflag indicating if the PVSS system must also be deleted
Returns
0 if OK, -1 if errors
int fwInstallationDB_deleteSystem ( string  systemName)

This function deletes a PVSS system from the System Configuration DB

Parameters
systemNamesystem name
Returns
0 if OK, -1 if errors
int fwInstallationDB_deleteProjectManager ( dyn_mixed  managerInfo,
string  project = "",
string  host = "" 
)

This function deletes a project manager from the System Configuration DB

Parameters
managerInfomanager information as a dyn_mixed
projectproject name
hosthostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_isPCRegistered ( int &  id,
string  host = "" 
)

This function checks if a host is registered in the System Configuration DB

Parameters
idDB index of the host. -1 if the host is not registered in the DB.
hosthostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerSystem ( dyn_mixed  systemProperties)

This function registers a PVSS system in the System Configuration DB

Parameters
systemPropertiesInformation about the PVSS system as a dyn_mixed array
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerWCCOAApplication ( dyn_mixed  wccoaApplication,
string  project = "",
string  host = "" 
)

This function registers a WinCC OA (UNICOS) application.

Parameters
wccoaApplicationInformation about the WinCC OA (UNICOS) application as a dyn_mixed array.
projectProject name, by default empty, in that case local project it taken.
hostHostname, by default empty, in that case local host it taken.
Returns
0 on success, -1 on errors.
int fwInstallationDB_isWCCOAApplicationRegistered ( int &  id,
string  wccoaName,
string  project = "",
string  host = "" 
)

This function checks if a WinCC OA (UNICOS) application is registered in the System Configuration DB.

Parameters
idDB index of the WinCC OA application. -1 if the application is not registered in the DB.
wccoaNameWinCC OA application name.
projectProject name, by default empty, in that case local project it taken.
hostHostname, by default empty, in that case local host it taken.
Returns
0 on success, -1 if error occured.
int fwInstallationDB_unregisterWCCOAApplication ( string  wccoaName,
string  project = "",
string  host = "" 
)

Unregister/invalidate WinCC OA application from database.

Parameters
wccoaNameName of WinCC OA application.
projectProject name, by default empty, in that case local project it taken.
hostHostname, by default empty, in that case local host it taken.
Returns
0 on success, -1 on error.
int fwInstallationDB_getWCCOAApplications ( dyn_dyn_mixed &  wccoaApplications,
string  project = "",
string  host = "" 
)

This function gets all WinCC OA (UNICOS) applications for a given project.

Parameters
wccoaApplications(out) All issues for the project.
projectProject name, by default empty, in that case local project it taken.
hostHostname, by default empty, in that case local host it taken.
Returns
0 on success, -1 on error.
int fwInstallationDB_isSystemEventOnAnotherProject ( int  system_id,
int &  project_id 
)

This function checks if there is already a project in System Configuration DB with the same system that has an event manager

Parameters
idDB index of the system.
project_idThe id of the project, -1 when there is no such a project
Returns
0 if OK, -1 if errors
int fwInstallationDB_isSystemRegistered ( int &  id,
string  systemName = "" 
)

This function checks if a PVSS system is registered in the System Configuration DB

Parameters
idDB index of the system. -1 if the system is not registered in the DB.
systemNamesystem name
Returns
0 if OK, -1 if errors
int fwInstallationDB_isInstallationPathRegistered ( string  installationPath,
int &  installation_path_id,
int &  project_id,
int &  computer_id,
string  projectName = "",
string  computerName = "" 
)

This function checks if a project path is registered in the System Configuration DB

Parameters
installationPathProject path
installation_path_idDB index of the project path. -1 if the project path is not yet registered in the DB.
project_idDB index of the project. -1 if the project is not yet registered in the DB.
projectNameproject name
computerNamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_isRequiredInstallationPathRegistered ( string  installationPath,
int &  installation_path_id,
int &  project_id,
string  projectName = "",
string  computerName = "" 
)

This function checks if a reqiured project path is registered in the System Configuration DB

Parameters
installationPathProject path
installation_path_idDB index of the project path. -1 if the project path is not yet registered in the DB.
project_idDB index of the project. -1 if the project is not yet registered in the DB.
projectNameproject name
computerNamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerInstallationPath ( string  installationPath,
int  isDefault,
string  projectName = "",
string  computerName = "" 
)

This function registers a project path in the System Configuration DB

Parameters
installationPathProject path
isDefaultflag indicating if this path is the default installation path
projectNameproject name
computerNamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerRequiredInstallationPath ( string  installationPath,
string  projectName = "",
string  computerName = "" 
)

This function registers a reqiured project path in the System Configuration DB

Parameters
installationPathProject path
projectNameproject name
computerNamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_getPatchList ( string  host,
string  version,
string  os,
dyn_string &  patches 
)

This function retrieves the list of patches applied to a PVSS installation

Parameters
hosthostname
versionPVSS version to check the patches for
oshost operating system
patcheslist of applied patches
Returns
0 if OK, -1 if errors
int fwInstallationDB_getPvssVersions ( string  host = "",
dyn_string &  versions,
dyn_string &  oss 
)

This function retrieves the list of PVSS versions registered for a host in the System Configuration DB

Parameters
hosthostname
versionsPVSS versions installed
osslist of OS for different PVSS versions installed
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerPvssVersion ( string  version = "",
string  os = "" 
)

This function registers a PVSS version in the System Configuration DB

Parameters
versionPVSS version string, "" means the version of the local project
osOperating System, "" means the OS of the local project
Returns
0 if OK, -1 if errors
int fwInstallationDB_isPvssVersionRegistered ( string  version,
string  os,
int &  id 
)

This function checks if a PVSS version is registered in the System Configuration DB

Parameters
versionname of the PVSS version to be checked
osoperating system type {WINDOWS, LINUX}
idDB index of the PVSS version. -1 means that the PVSS version is not registered in the DB.
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerPvssPatch ( string  patch,
string  version = "",
string  os = "" 
)

This function registers a PVSS patch in the System Configuration DB

Parameters
patchpatch name
versionPVSS version name
osoperating sytem type {WINDOWS, LINUX}
Returns
0 if OK, -1 if errors
int fwInstallationDB_isPvssPatchRegistered ( string  patch,
string  version,
string  os,
int &  patch_id,
int &  pvss_id 
)

This function registers a PVSS patch for a given PVSS version in the System Configuration DB

Parameters
patchPVSS patch name
versionPVSS version name
osoperating sytem type {WINDOWS, LINUX}
patch_idDB index of the patch once registered.
pvss_idDB index of the PVSS version
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerPvssBase ( string  host = "",
string  version = "",
string  os = "" 
)

This function registers a base PVSS version (i.e. a version of PVSS in a host) in the System Configuration DB

Parameters
hosthostname
versionPVSS version name
osOperating System {WINDOWS, LINUX}
Returns
0 if OK, -1 if errors
int fwInstallationDB_isPvssBaseRegistered ( string  host,
string  version,
string  os,
int &  base_id,
int &  pvss_id,
int &  host_id 
)

This function checks if a PVSS base version is registed in the System Configuration DB

Parameters
hosthostname
versionPVSS version name
osoperating system type
base_idDB index of the PVSS base version. -1 if not registered in the DB.
pvss_idDB index of the PVSS version
host_idDB index of the host
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerPvssSetup ( string  host = "",
string  version = "",
string  os = "",
dyn_string  patches = "" 
)

This function registers a PVSS setup (i.e. host + pvss base versio + list of patches) in the System Configuration DB

Parameters
hosthostname
versionPVSS version
osoperating system type
patcheslist of applied patches
Returns
0 if OK, -1 if errors
int fwInstallationDB_unregisterSetupPvssPatch ( string  host,
string  version,
string  os,
string  patch 
)

This function unregisters a patch from a PVSS setup in the System Configuration DB

Parameters
hosthostname
versionPVSS version name
osoperating system type
patchpatch name
Returns
0 if OK, -1 if errors
int fwInstallationDB_isPvssSetupEntryRegistered ( int  base_id,
int  patch_id,
int &  setup_id 
)

This function checks if a patch is for a PVSS version in a host is registered in the System Configuration DB

Parameters
base_idDB index corresponding to the base PVSS version
patch_idDB index identifying a patch
setup_idDB index of the PVSS setup where the patch is registered. -1 if the patch is not registered in the PVSS setup
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerProjectPaths ( )

This function registers all paths of the local project in the System Configuration DB

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

This function registers all paths of the local project in the System Configuration DB as required

Returns
0 if OK, -1 if errors
int fwInstallationDB_isProjectComponentRegistered ( string  component,
string  version,
string  project,
string  hostname,
int &  component_id,
int &  project_id,
int &  projectComponentId 
)

This function checks if a component is registered in the System Configuration DB

Parameters
componentName of the component
versionVersion of the component
projectProject name
hostnamehostname
component_idDB index identifying the component
project_idDB index identifying the project
projectComponentIdDB index identifying the component in a project. -1 if the component is not registered in the project
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerProjectFwComponents ( string  project = "",
string  hostname = "" 
)

This function registers all components installed in a project in the System Configuration DB

Parameters
projectproject name
hostnamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_unregisterCurrentProjectComponent ( string  component,
string  version,
string  project = "",
string  host = "" 
)

This function unregisters a component in a project from the System Configuration DB

Parameters
componentname of the component
versionversion of the component
projectproject name
hosthostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerProjectManagers ( )

This function registers all managers of the local project in the System Configuration DB

Returns
0 if OK, -1 if errors
int fwInstallationDB_executeSqlSimple ( string  sql)

This function executes a simple SQL sentence (Deprecated? - orphan method in fwi6.0.2)

Parameters
sqlSQL command to be executed
Returns
0 if OK, -1 if errors
int fwInstallationDB_executeSqlFromFile ( string  fileName,
bool  breakOnDbError = TRUE 
)

executes SQL statements stored in a file (Deprecated? orphan method in fwi6.0.2)

Note that the all commands in the file should be terminated by the semicolon (;) character, which should be the last characted in the line. The comments (lines starting with "-" character) and white-spaces are a also automatically removed.

Parameters
fileNamethe name of the file, where the SQL statements are stored. The file needs to be in the "config" directory of the project.
breakOnDbError(optional, default is TRUE) determines if the function should return terminate with an exception upon first encountered error, or it should rather try to finish the remaining commands (the errors encountered in a meantime will be reported at the end).
int fwInstallationDB_getHostsInfo ( dyn_dyn_mixed &  hostsInfo)

This function retrieves all hosts information from the System Configuration DB

Parameters
hostsInfoinformation for all hosts registered in the DB as a dyn_dyn_mixed matrix
Returns
0 if OK, -1 if errors
int fwInstallationDB_getHosts ( dyn_string &  hostnames,
dyn_string &  ips,
dyn_string &  macs,
dyn_string &  ips2,
dyn_string &  macs2,
dyn_string &  bmc_ips,
dyn_string &  bmc_ips2 
)

This function retrives the hosts properties from the DB

Parameters
hostnameslist of hostnames
ipslist of IP addresses
macslist of MAC addresses
ips2list of second IP addresses
macs2list of second MAC addresses
bmc_ipslist of IP addresses of the BMC (IPMI)
bmc_ips2list of second IP addresses of the BMC (IPMI)
Returns
0 if OK, -1 if errors
int fwInstallationDB_getPvssSystems ( dyn_dyn_mixed &  systemsInfo,
bool  onlyActive = true 
)

This function retrieves the list of PVSS systems registered in the System Configuration DB

Parameters
systemsInfoinformation about all PVSS systems as a dyn_dyn_mixed
onlyActiveif true, ignores all history
Returns
0 if OK, -1 if errors
int fwInstallationDB_getComponentProperties ( string  component,
string  version,
int &  isSubComponent 
)

This function checks if a component has be registered as a subcomponent in the System Configuration DB

Parameters
componentname of the component
versionversion of the component
isSubComponentif 1 the component is a subcomponent
Returns
0 if OK, -1 if errors
int fwInstallationDB_getAllComponents ( dyn_dyn_mixed &  componentsInfo)

This function retrieves the information about all components registered in the System Configuration DB

Parameters
componentsInfocomponents information as a dyn_dyn_mixed
Returns
0 if OK, -1 if errors
int fwInstallationDB_getHostProperties ( string  hostname,
dyn_mixed &  hostInfo 
)

This function retrieves the properties of a host from the System Configuration DB

Parameters
hostnamename of the host
hostInfohost properties as a dyn_mixed
Returns
0 if OK, -1 if errors
int fwInstallationDB_setHostProperties ( string  hostname,
dyn_mixed  hostInfo 
)

This function sets the properties of a host in the System Configuration DB

Parameters
hostnameName of the host
hostInfoHost properties as a dyn_mixed array
Returns
0 if OK, -1 if errors
bool fwInstallationDB_getCentrallyManaged ( string  project = "",
string  host = "" 
)

This function checks if a project is centrally managed from the System Configuration DB

Returns
TRUE if centrally managed, FALSE if locally managed
int fwInstallationDB_setNeedsSynchronize ( bool  needSynchronize,
string  project = "",
string  hostname = "" 
)

This function sets the centrally managed property of a project in the System Configuration DB

Parameters
centrallyManaged1 if the project is centrally managed. 0 if locally managed
projectproject name
hostnamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_setCentrallyManaged ( int  centrallyManaged,
string  project = "",
string  hostname = "" 
)

This function sets the centrally managed property of a project in the System Configuration DB

Parameters
centrallyManaged1 if the project is centrally managed. 0 if locally managed
projectproject name
hostnamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_getProjectManagementMode ( bool &  isCentrallyManaged,
string  project = "",
string  hostname = "" 
)

This function retrieves the project management mode

Parameters
isCentrallyManagedflag indicating if the project is centrally managed (1). 0 if locally managed
projectproject name
hostnamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_getProjectProperties ( string  project,
string  hostname,
dyn_mixed &  projectProperties,
int &  projectId 
)

This function retrieves the project properties from the System Configuration DB

Parameters
projectproject name
hostnamename of the host
projectPropertiesProject properties as a dyn_mixed array
projectIdDB index of the project
Returns
0 if OK, -1 if errors
int fwInstallationDB_getReduPair ( string  hostname,
string  project,
string &  reduHost 
)

This function retrieves redundant pair of a projec registered in the System Configuration DB

Parameters
hostnamename of the host
projectname of the project
reduHostname of the host where the redundant pair runs
Returns
0 if OK, -1 if errors
int fwInstallationDB_getProjectPaths ( string  project = "",
string  hostname = "",
dyn_string &  projectPaths 
)

This function retrieves list of paths registered in the System Configuration DB for a project

Parameters
projectproject name
hostnamehostname
projectPathslist of project paths
Returns
0 if OK, -1 if errors

Project paths:

int fwInstallationDB_getRequiredProjectPaths ( string  project = "",
string  hostname = "",
dyn_string &  projectPaths 
)

This function retrieves list of required paths registered in the System Configuration DB for a project

Parameters
projectproject name
hostnamehostname
projectPathslist of project paths
Returns
0 if OK, -1 if errors

Project paths:

int fwInstallationDB_setProjectProperties ( string  project,
string  hostname,
dyn_mixed  projectProperties,
bool  askScattered = false 
)

This function sets the project properties in the system configuration DB

Parameters
projectproject name
hostnamehostname
projectPropertiesproject properties as a dyn_mixed array
askScatteredif true, it asks the user whether this is an scattered project as the system already exists
Returns
0 if OK, -1 if errors
int fwInstallationDB_setSystemProperties ( dyn_mixed  systemProperties)

This function sets the system properties in the system configuration DB

Parameters
systemPropertiesPVSS system properties as a dyn_mixed array
Returns
0 if OK, -1 if errors
int fwInstallationDB_setComponentProperties ( string  component,
string  version,
int  isSubComponent 
)

This function sets the isSubComonponent flag of a component in the system configuration DB

Parameters
componentname of the component
versionversion of the comoponent
isSubComponent1 if the component is a subcomponent
Returns
0 if OK, -1 if errors
int fwInstallationDB_addChildSystem ( string  parentSystem,
string  childSystem 
)

This function defines a child system for a particular PVSS system

Parameters
parentSystemName of the parent PVSS system
childSystemName of the child PVSS system
Returns
0 if OK, -1 if errors
int fwInstallationDB_removeChildSystem ( string  systemName)

This function removes a child from its parent in the system configuration DB

Parameters
systemNameName of the child PVSS system to be removed
Returns
0 if OK, -1 if errors
int fwInstallationDB_removeSystemHierarchy ( )

This function removes from the system configuration DB the system hierarchy tree

Returns
0 if OK, -1 if errors
int fwInstallationDB_getChildSystems ( string  parentSystem,
dyn_dyn_mixed &  childSystems 
)

This function retrieves the list of child systems of a particular parent as defined in the system configuration DB

Parameters
parentSystemName of the parent PVSS system
childSystemsChildren properties as a dyn_dyn_mixed matrix
Returns
0 if OK, -1 if errors
int fwInstallationDB_getSystemHierarchy ( dyn_dyn_mixed &  hierarchyInfo)

This function retrieves the information about the hierarchy of PVSS systems defined in the system configuration DB

Parameters
hierarchyInfoHierarchy information as a dyn_dyn_mixed matrix
Returns
0 if OK, -1 if errors
int fwInstallationDB_getPvssSystemProperties ( string  systemName,
dyn_mixed &  systemInfo 
)

This function retrievesthe properties of a PVSS system from the System Configuration DB

Parameters
systemNameName of the PVSS system
systemInfoSystem properties as a dyn_mixed array
Returns
0 if OK, -1 if errors
int fwInstallationDB_getSystemConnectivity ( string  systemName,
string  computerName,
dyn_dyn_mixed &  connectedSystemsInfo,
bool  onlyServers = false 
)

This function retrieves the list of dist peers of a system as defined in the system configuration DB

Parameters
systemNameName of the PVSS system to retrieve the list of dist-peers for
connectedSystemsInfoDist-peers properties as a dyn_mixed array
onlyServersif set to true, the direction of the connection is taken into account, i.e. the list of connected systems will only contains those the local system initiates the connection to.
Returns
0 if OK, -1 if errors
int fwInstallationDB_getSystemRequiredConnectivity ( string  systemName,
dyn_dyn_mixed &  connectedSystemsInfo,
bool  onlyServers = false 
)

This function retrieves the list of required dist peers of a system as defined in the system configuration DB

Parameters
systemNameName of the PVSS system to retrieve the list of dist-peers for
connectedSystemsInfoDist-peers properties as a dyn_mixed array
onlyServersif set to true, the direction of the connection is taken into account, i.e. the list of connected systems will only contains those the local system initiates the connection to.
Returns
0 if OK, -1 if errors
int fwInstallationDB_getSystemProjects ( string  systemName,
dyn_dyn_mixed &  projectsInfo 
)

This function retrieves the list of projects pointing to a single system (scattered projects)

Parameters
systemNameName of the parent PVSS system
projectsInfoProjects' properties as a dyn_dyn_mixed matrix
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerProjectManager ( dyn_mixed  managerInfo,
string  project = "",
string  hostname = "" 
)

This function registers a manager in a project in the system configuration DB

Parameters
managerInfomanager properties
projectproject name
hostnamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_setPvssManagerProperties ( dyn_mixed  managerInfo,
string  project = "",
string  hostname = "" 
)

This function sets the properties of a manager in a project in the system configuration DB

Parameters
managerInfomanager properties
projectproject name
hostnamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_isProjectManagerRegistered ( dyn_mixed  managerInfo,
string  project,
string  hostname,
int &  manager_id,
int &  project_id,
int &  computer_id 
)

This function checks if a manager is registered in a project in the system configuration DB

Parameters
managerInfomanager properties
projectproject name
hostnamehostname
manager_idDB index of the manager
project_idDB index of the project
computer_idDB index of the computer name
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerPvssManagerType ( dyn_mixed  managerTypeInfo)

This function registers a manager type in the system configuration DB

Parameters
managerTypeInfoManager type properties as a dyn_mixed
Returns
0 if OK, -1 if errors
int fwInstallationDB_isPvssManagerTypeRegistered ( string  managerType,
bool &  isRegistered 
)

This function checks if a manager type is registered in the System Configuration DB

Parameters
managerTypeManager type properties as a dyn_mixed
isRegisteredtrue if the manager type is registered
Returns
0 if OK, -1 if errors
int fwInstallationDB_getProjectManagers ( dyn_dyn_mixed &  managersInfo,
string  projectName = "",
string  computerName = "" 
)

This function retrieves the list of managers in a project registered in the System Configuration DB

Parameters
managersInfoManager properties as a dyn_dyn_mixed
projectNameproject name
computerNamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_getProjectComponents ( dyn_dyn_mixed &  componentsInfo,
string  projectName = "",
string  computerName = "" 
)

This function retrieves list of components installed in a project registered in the System Configuration DB

Parameters
componentsInfoComponents' properties as a dyn_dyn_mixed
projectNameproject name
computerNamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_addSystemConnection ( string  peer1Name,
string  peer2Name,
string  computerName 
)

This function registers in the System Configuration DB the connection between two dist-peers

Parameters
peer1NameName of the first peer
peer2NameName of the second peer
Returns
0 if OK, -1 if errors
int fwInstallationDB_addSystemRequiredConnection ( string  peer1Name,
string  peer2Name 
)

This function registers in the System Configuration DB that connection between two dist-peers is required

Parameters
peer1NameName of the first peer
peer2NameName of the second peer
Returns
0 if OK, -1 if errors
int fwInstallationDB_removeSystemRequiredConnection ( string  peer1Name,
string  peer2Name 
)

This function unregisters from the System Configuration DB that connection between two dist-peers is required

Parameters
peer1NameName of the first peer
peer2NameName of the second peer
Returns
0 if OK, -1 if errors
int fwInstallationDB_removeSystemConnection ( string  peer1Name,
string  peer2Name,
string  computerName 
)

This function unregisters from the System Configuration DB the connection between two dist-peers

Parameters
peer1NameName of the first peer
peer2NameName of the second peer
Returns
0 if OK, -1 if errors
int fwInstallationDB_getSystemProjectHost ( string  systemName,
dyn_dyn_mixed &  projectSystemHostInfo 
)

This function reads from the System Configuration DB the project and host properties for a PVSS system

Parameters
systemNameName of the PVSS system
projectSystemHostInfoprojects and hosts properties as a dyn_dyn_mixed matrix
Returns
0 if OK, -1 if errors
int fwInstallationDB_getProjectGroupProperties ( string  group,
dyn_mixed &  projectGroupInfo,
string  projectName = "",
string  computerName = "" 
)

This function reads from the System Configuration DB the groups of components registered in a project

Parameters
groupName of the group of components
projectGroupInfogroup properties
projectNameproject name
computerNamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_getCurrentProjectComponents ( dyn_dyn_mixed &  componentsInfo,
string  projectName = "",
string  computerName = "" 
)

This function reads from the System Configuration DB the current list of components installed in a project

Parameters
componentsInfocomponents' properties
projectNameproject name
computerNamehostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerPathMapping ( string  windowsPath,
string  linuxPath 
)

This function registers in the System Configuration DB the mapping between Windows and Linux paths, e.g. /afs/cern.ch - p:

Parameters
windowsPathWindows path
linuxPathLinux path
Returns
0 if OK, -1 if errors
int fwInstallationDB_isPathMappingRegistered ( int &  id,
string  windowsPath,
string  linuxPath 
)

This function check from the System Configuration DB if a path mapping is registered

Parameters
idDB index of the path mapping
windowsPathWindows path, e.g. P:
linuxPathLinux path, e.g. /afs/cern.ch
Returns
0 if OK, -1 if errors
int fwInstallationDB_unregisterPathMapping ( string  windowsPath,
string  linuxPath 
)

This function unregisters from the System Configuration DB a path mapping

Parameters
windowsPathWindows path, e.g. P:
linuxPathLinux path, e.g. /afs/cern.ch
Returns
0 if OK, -1 if errors
int fwInstallationDB_getMappedPath ( string  path,
string &  mappedPath 
)

This function reads from the System Configuration DB the path mapped to a particular path in a different operating system

Parameters
pathpath, e.g. P: or /afs/cern.ch
mappedPathmapped path in the other operating system, e.g. /afs/cern.ch or P:
Returns
0 if OK, -1 if errors
int fwInstallationDB_getAllMappedPaths ( string  pattern,
dyn_mixed &  pathMapping 
)

This function reads from the System Configuration DB all path mappings defined

Parameters
patternsearch string pattern
pathMappingarray of path mappings a dyn_mixed
Returns
0 if OK, -1 if errors
int fwInstallationDB_getComputerSystems ( string  computer,
dyn_string &  systems 
)

This function reads from the System Configuration DB all PVSS systems in a computer

Parameters
computerhostname
systemslist of PVSS systems found
Returns
0 if OK, -1 if errors
int fwInstallationDB_getComponentsIncorrectlyInstalled ( dyn_dyn_mixed &  componentsInfo)

This function reads from the System Configuration DB the properties of the components wrongly installed all projects

Parameters
componentsInfocomponent properties
Returns
0 if OK, -1 if errors
int fwInstallationDB_getSystemName ( string  sysNumber,
string &  name,
int  reduNr = 1 
)

This function reads from the System Configuration DB name of a systems with a particular number

Parameters
sysNumberPVSS system number
namePVSS system name
reduNrredundancy number (not used. Obsolete, legacy)
Returns
0 if OK, -1 if errors
int fwInstallationDB_getProjectAutoregistration ( int &  autoreg_enabled)

This function checks if the project autoregistration is enabled

Parameters
autoreg_enabledAutomatic registration enabled.
Returns
0 if OK, -1 if errors
int fwInstallationDB_setProjectAutoregistration ( int  autoreg_enabled)

This function sets the projects autoregistration

Parameters
autoreg_enabledAutomatic registration enabled.
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerProjectFileIssues ( dyn_dyn_mixed  fileIssues,
string  project = "",
string  host = "" 
)

This function registers all file issues for a project on a host

Parameters
fileIssuesContains all file issues for a project - componentName, componentVersion, name fo the file, type of the issue(overparameterized, hash, etc.)
projectproject name
hosthostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerProjectComponentFileIssue ( dyn_mixed  fileIssue,
string  project = "",
string  host = "" 
)

This function registers a file issue for a particular component version

Parameters
fileIssueContains details for the issue - componentName, componentVersion, name fo the file, type of the issue(overparameterized, hash, etc.)
projectproject name
hosthostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_isIssueTypeRegistered ( string  issueType,
int &  issueTypeId 
)

This function checks whether an issueType string is registered in the DB

Parameters
issueTypetype of the issue
issueTypeId(out) the id in the DB for this issueType
Returns
0 if OK, -1 if errors
int fwInstallationDB_deleteProjectFileIssues ( string  project = "",
string  host = "" 
)

This function deletes all file issues for a project

Parameters
projectProject name
hostHostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_isProjectComponentFileIssueRegistered ( int  hostId,
int  projectId,
int  componentId,
dyn_mixed  fileIssue,
bool &  registered 
)

This function checks whether a file issue is already regestered in the DB

Parameters
hostIdId of the host in fw_sys_stat_computer table
projectIdId of the project in fw_sys_stat_pvss_project table
componentIdId of the component from fw_sys_stat_component_table
fileIssueDetails for the file issue
registered(out) The issue is registered in the DB
Returns
0 if OK, -1 if errors
int fwInstallationDB_getProjectComponentFileIssues ( string  component,
string  version,
dyn_dyn_mixed &  fileIssues,
string  project = "",
string  host = "" 
)

This function gets all file issues for a component

Parameters
componentName of the component
versionVersion of the component
fileIssues(out) All issues for this project and for this component version
projectProject name
hostHostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_getProjectFileIssues ( dyn_dyn_mixed &  fileIssues,
string  project = "",
string  host = "" 
)

This function gets all file issues for a project

Parameters
fileIssues(out) All issues for the project
projectProject name
hostHostname
Returns
0 if OK, -1 if errors
int fwInstallationDB_isProjectRedundant ( string  projectName,
string  hostName,
bool &  isProjectRedundant 
)

Checks whether a project is registered as redundant int the DB

Parameters
projectNameProject name
hostNameHostname
isProjectRedundant(out) True if the project is redundant
Returns
0 if OK, -1 if errors
int fwInstallationDB_deleteAllRequiredSystemConnections ( string  systemName = "")

This function unregisters all distributed connections for a system from System Configuration DB

Parameters
systemNameSystem name
Returns
0 if OK, -1 if errors
int fwInstallationDB_deleteAllCurrentSystemConnections ( string  systemName = "",
string  computerName = "" 
)

This function unregisters all current distributed connections for a system from System Configuration DB

Parameters
systemNameSystem name
Returns
0 if OK, -1 if errors
int fwInstallationDB_registerDistConnections ( )

This function registers all distributed connections of the local project in the System Configuration DB

Returns
0 if OK, -1 if errors
bool fwInstallationDB_isProjectRegisteredPartially ( int  projectId)

Checks if the project is partially registered (e.g. when created with automated script)

Parameters
projectIdProject ID to be checked
Returns
true if the project is partially registered, false otherwise
int fwInstallationDB_completeProjectPartialRegistration ( int  projectId)

Completes registration for partially registered project

Parameters
projectIdProject ID to be updated
Returns
0 if OK, -1 otherwise
int fwInstallationDB_registerDevice ( string  deviceType,
string  application,
dyn_mixed  deviceInfo,
string  project = "",
string  host = "" 
)

This function registers a device.

Parameters
deviceTypeThe type of the device.
applicationName of the application where the device is used.
deviceInfoInformation about the device as a dyn_mixed array.
projectProject name, by default empty, in that case local project it taken.
hostHostname, by default empty, in that case local host it taken.
Returns
0 on success, -1 on errors.
int fwInstallationDB_unregisterDevice ( string  deviceType,
string  application,
string  device,
string  project = "",
string  host = "" 
)

Unregister/invalidate device from database.

Parameters
deviceTypeThe type of the device.
applicationName of WinCC OA (UNICOS) application.
deviceName of device.
projectProject name, by default empty, in that case local project it taken.
hostHostname, by default empty, in that case local host it taken.
Returns
0 on success, -1 on error.
int fwInstallationDB_isDeviceRegistered ( int &  id,
string  deviceType,
string  application,
string  device,
string  project = "",
string  host = "" 
)

This function checks if a device is registered in the System Configuration DB.

Parameters
idDB index of the device. -1 if the device is not registered in the DB.
deviceTypeThe type of the device.
applicationWinCC OA (UNICOS) application name.
devicedevice name.
projectProject name, by default empty, in that case local project it taken.
hostHostname, by default empty, in that case local host it taken.
Returns
0 on success, -1 if error occured.
int fwInstallationDB_getDevices ( string  deviceType,
string  application,
dyn_dyn_mixed &  devices,
string  project = "",
string  host = "" 
)

This function gets all devices of a given type in a given application and given project.

Parameters
deviceTypeDevice type name.
applicationWinCC OA (UNICOS) application name
devices(out) Information about all devices in an array.
projectProject name, by default empty, in that case local project it taken.
hostHostname, by default empty, in that case local host it taken.
Returns
0 on success, -1 on error.
int fwInstallationDB_setDeviceProperties ( string  deviceType,
string  application,
dyn_mixed  deviceInfo,
string  project = "",
string  host = "" 
)

This function sets the device properties in the system configuration DB. If device is not registered in DB yet, then it will be added to DB.

Parameters
deviceTypeDevice type name.
applicationWinCC OA (UNICOS) application name
deviceInfoInformation about the device as a dyn_mixed array.
projectProject name, by default empty, in that case local project it taken.
hostHostname, by default empty, in that case local host it taken.
Returns
0 on success, -1 on error.
int fwInstallationDB_registerDeviceType ( string  deviceTypeName)

This function registers a device type.

Parameters
deviceTypeNameName of device type.
Returns
0 on success, -1 on errors.
int fwInstallationDB_unregisterDeviceType ( )

This function is not implemented yet.

Returns
-1.
int fwInstallationDB_isDeviceTypeRegistered ( int &  id,
string  deviceType 
)

This function checks if a device type is registered in the System Configuration DB.

Parameters
idDB index of the device type. -1 if the device is not registered in the DB.
deviceTypedevice type name.
Returns
0 on success, -1 if error occured.
int fwInstallationDB_getDeviceTypes ( dyn_string &  deviceTypes)

This function gets all devices types registered in DB.

Parameters
deviceTypes(out) Information about all device typess in an array.
Returns
0 on success, -1 on error.
int fwInstallationDB_setWCCOAApplicationProperties ( dyn_mixed  applicationInfo,
string  project = "",
string  host = "" 
)

This function sets the WinCC OA application properties in the system configuration DB. If WinCC OA application is not registered in DB it will be added.

Parameters
applicationInfoInformation about the WinCC OA (UNICOS) application as a dyn_mixed array.
projectProject name, by default empty, in that case local project it taken.
hostHostname, by default empty, in that case local host it taken.
Returns
0 on success, -1 on error.
int fwInstallationDB_isParamTypeRegistered ( int &  id,
string  paramType 
)

This function checks if given project parameter type is registered in DB.

Parameters
id(out) ID of given project parameter type, -1 if it does not exist in DB
paramType(in) Name of the project parameter type
Returns
0 on success, -1 on errors (failed to execute sql query)
int fwInstallationDB_registerParamType ( dyn_mixed  paramTypeProperties)

Registers new project parameter type in DB. If a parameter with given name already exists in DB the function does nothing.

Parameters
paramTypeProperties(in) Array of project parameter properties
Returns
0 on success, -1 on errors (insufficient data in array, failed to execute sql command)
int fwInstallationDB_removeParamType ( string  paramType)

TODO: write function and doxygen documentation

int fwInstallationDB_getParamTypeProperties ( string  paramType,
dyn_mixed &  paramTypeProperties 
)

Don't allow update/setting properties of parameter type - change of name or datatype will break the backwards compatibility, description or family could be allowed but is there any usecase? int fwInstallationDB_updateParamTypeProperties(dyn_mixed paramTypeProperties)//_setParamTypeProperties? { return -1; } Gets properties of given project parameter type from DB.

Parameters
paramType(in) Name of the project parameter type.
paramTypeProperties(out) Array of project parameter type properties
Returns
0 on success, -1 on errors (parameter type not exists, failed to execute sql query)
int fwInstallationDB_isProjectParamRegistered ( int &  id,
string  paramName,
string  project = "",
string  host = "" 
)

This function checks if specified project parameter is registered for given project

Parameters
id(out) ID of given project parameter, -1 if project parameter does not exist for given project
paramName(in) Name of project parameter type
project(in) Name of the project, if it is empty (default value) then current project is used
host(in) Name of the host, if it is empty (default value) then current host is used
Returns
0 on success, -1 on errors (project and/or parameter type are not registered in DB, failed to execute sql query)
int fwInstallationDB_registerProjectParam ( string  paramName,
string  value = "",
string  project = "",
string  host = "" 
)

Registers new project parameter in DB. If project parameter already exists in DB the function does nothing.

Parameters
paramName(in) Name of the project parameter type
value(in) Project parameter value
project(in) Name of the project, if it is empty (default value) then current project is used
host(in) Name of the host, if it is empty (default value) then current host is used
Returns
0 on success, -1 on errors (project and/or parameter type are not registered in DB, failed to execute sql command)
int fwInstallationDB_getProjectParamValue ( string  paramName,
string &  value,
string  project = "",
string  host = "" 
)

Gets from DB the value of specified project parameter type of given project.

Parameters
paramName(in) Name of the project parameter type
value(out) Value of the project parameter
project(in) Name of the project, if it is empty (default value) then current project is used
host(in) Name of the host, if it is empty (default value) then current host is used
Returns
0 on success, -1 on errors (project parameter is not registered in DB, failed to execute sql query)
int fwInstallationDB_setProjectParamValue ( string  paramName,
string  value,
string  project = "",
string  host = "" 
)

Sets in DB the value of specified project parameter type of given project.

Parameters
paramName(in) Name of the project parameter type
value(in) Value of project parameter
project(in) Name of the project, if it is empty (default value) then current project is used
host(in) Name of the host, if it is empty (default value) then current host is used
Returns
0 on success, -1 on errors (failed to register project param if it was not in DB yet, failed to execute sql command)
int fwInstallationDB_removeProjectParam ( string  paramName,
string  project = "",
string  host = "" 
)

Removes from DB the value of specified project parameter type of given project.

Parameters
paramName(in) Name of the project parameter type
project(in) Name of the project, if it is empty (default value) then current project is used
host(in) Name of the host, if it is empty (default value) then current host is used
Returns
0 on success, -1 on errors (project parameter is not registered in DB, failed to execute sql command)
int fwInstallationDB_getProjectParamsProperties ( dyn_dyn_mixed &  projectParamsProperites,
string  paramKeyword = "%",
string  project = "",
string  host = "" 
)

This function gets properties of project parameters for given project and specified parameter type pattern.

Parameters
projectParamsProperites(out) Array of project parameters properties
paramKeyword(in) Pattern of name of the project parameter type
project(in) Name of the project, if it is empty (default value) then current project is used
host(in) Name of the host, if it is empty (default value) then current host is used
Returns
0 on success, -1 on errors (project not registered in DB, failed to execute sql query)

Variable Documentation

const string csFwInstallationDBLibVersion = "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 int FW_INSTALLATION_DB_PROJ_PARAM_TYPE_NAME = 1

Project parameters in DB