fwInstallation  8.4.1
Functions | Variables
fwInstallationDBAgent.ctl File Reference

Functions

int fwInstallationDbAgent_terminateOldInstances ()
 Beginning of executable code:
 
int fwInstallationDBAgent_executeProjectPendingReinstallations (int &restartProject)
 
int fwInstallationDBAgent_setSynchronizationLock ()
 
int fwInstallationDBAgent_releaseSynchronizationLock ()
 
int fwInstallationDBAgent_getSynchronizationLock ()
 
int fwInstallationDBAgent_setProjectStatus (string projectName="", string computerName="")
 
bool fwInstallationDBAgent_isSyncProjectFileIssuesEnabled ()
 
void fwInstallationDBAgent_setSyncProjectFileIssues (bool enable)
 
int fwInstallationDBAgent_synchronize (int &restartProject)
 
int fwInstallationDBAgent_checkIntegrity ()
 
int fwInstallationDBAgent_checkProjectPvssInfo (int &status, dyn_mixed &dbPvssInfo, dyn_mixed &pvssPvssInfo)
 
int fwInstallationDBAgent_checkHostPvssInfo (int &status, dyn_string &dbPvssVersions, dyn_string &pvssPvssVersions)
 
int fwInstallationDBAgent_synchronizePvssSetupInfo ()
 
int fwInstallationDBAgent_checkProjectPvssPatchesInfo (int &status, dyn_string &dbPatches, dyn_string &pvssPatches)
 
int fwInstallationDBAgent_checkHostInfo (int &status, dyn_mixed &dbHostInfo, dyn_mixed &pvssHostInfo)
 
int fwInstallationDBAgent_synchronizeHostInfo ()
 
int fwInstallationDBAgent_checkProjectInfo (int &status, dyn_mixed &dbProjectInfo, dyn_mixed &pvssProjectInfo)
 
int fwInstallationDBAgent_checkProjectFileIssues (int &status, dyn_dyn_mixed &dbProjectFileIssues, dyn_dyn_mixed &pvssProjectFileIssues)
 
int fwInstallationDBAgent_synchronizeProjectInfo ()
 
int fwInstallationDBAgent_synchronizeProjectFileIssues ()
 
int fwInstallationDBAgent_checkProjectPathsInfo (int &status, dyn_string &dbPaths, dyn_string &pvssPaths, bool checkRequiredTable=false)
 
int fwInstallationDBAgent_synchronizeProjectPaths ()
 
int fwInstallationDBAgent_checkProjectManagersInfo (int &status, dyn_dyn_mixed &dbManagersInfo, dyn_dyn_string &pvssManagersInfo)
 
int fwInstallationDBAgent_synchronizeProjectManagers ()
 
int fwInstallationDBAgent_checkComponents (int &status, dyn_dyn_mixed &dbComponentsInfo, dyn_dyn_mixed &pvssComponentsInfo)
 
string fwInstallationDBAgent_stringCastRequest (dyn_mixed request)
 
int fwInstallationDBAgent_synchronizeProjectComponents (int &restartProject)
 
int fwInstallationDBAgent_isPostInstallRunning (bool &isRunning)
 
string fwInstallationDBAgent_getComponentFile (string descFile)
 
int fwInstallationDBAgent_executeComponentPendingActions (int &restartProject, dyn_dyn_mixed pvssInstallComponents, dyn_dyn_mixed pvssDeleteComponents)
 
int fwInstallationDBAgent_getComponentPendingActions (int &restartProject, dyn_dyn_mixed &pvssInstallComponents, dyn_dyn_mixed &pvssDeleteComponents, int &reinstalls)
 
int fwInstallationDBAgent_setForceFullSync (bool forceFullSynchronization)
 
bool fwInstallationDBAgent_getForceFullSync ()
 
int fwInstallationDBAgent_setSyncInterval (int interval)
 
int fwInstallationDBAgent_getSyncInterval ()
 
int fwInstallationDBAgent_checkDistPeers (int &status, dyn_string &onlyPvssSystemNames, dyn_string &onlyDbSystemNames, dyn_string &onlyPvssComputerNames, dyn_string &onlyDbComputerNames, dyn_int &onlyPvssSystemNumbers, dyn_int &onlyDbSystemNumbers, bool checkRequiredTable=false)
 
int fwInstallationDBAgent_isDistRestartRequired ()
 
int fwInstallationDBAgent_synchronizeDistPeers ()
 
int fwInstallationDBAgent_checkWCCOAApplications (int &status, dyn_dyn_mixed &dbAppsToAdd, dyn_dyn_mixed &dbAppsToRemove)
 
int fwInstallationDBAgent_synchronizeReduInfo ()
 
int fwInstallationDBAgent_unregisterProjectPaths (string projectName="", string computerName="")
 
int fwInstallationDBAgent_registerProjectPaths (dyn_string paths, string projectName="", string computerName="")
 
int fwInstallationDBAgent_checkDevices (int &status, dyn_mapping &dbDevicesToAdd, dyn_mapping &dbDevicesToRemove)
 
int fwInstallationDBAgent_synchronizeWCCOAApplicationsAndDevices ()
 

Variables

const string gFwInstallationAgentLibVersion = "8.4.1"
 
fwInstallationDB.ctl: Definition of variables

The following variables are used by the fwInstallationDB.ctl library

const int FW_INSTALLATION_DB_PROJECT_OK = 1
 
const int FW_INSTALLATION_DB_PROJECT_MISSMATCH = 0
 
const int FW_INSTALLATION_DB_PROJECT_NEVER_CHECKED = -1
 
const int FW_INSTALLATION_DB_PROJECT_DISABLED = -2
 
const int FW_INSTALLATION_DB_STATUS_PVSS_INFO = 1
 
const int FW_INSTALLATION_DB_STATUS_PVSS_PATCH_INFO = 2
 
const int FW_INSTALLATION_DB_STATUS_HOST_INFO = 3
 
const int FW_INSTALLATION_DB_STATUS_PROJECT_INFO = 4
 
const int FW_INSTALLATION_DB_STATUS_PATH_INFO = 5
 
const int FW_INSTALLATION_DB_STATUS_MANAGER_INFO = 6
 
const int FW_INSTALLATION_DB_STATUS_GROUP_INFO = 7
 
const int FW_INSTALLATION_DB_STATUS_COMPONENT_INFO = 8
 
const int FW_INSTALLATION_DB_STATUS_DIST_PEERS_INFO = 9
 
const int FW_INSTALLATION_DB_STATUS_PROJ_FILE_ISSUES = 10
 
const int FW_INSTALLATION_DB_STATUS_DEV_AND_APPS = 11
 
const string csFwInstallationDBAgentLibVersion = "3.4.2"
 
const int FW_INSTALLATION_DB_PVSS_INSTALL_COMPONENT_IDX = 1
 
const int FW_INSTALLATION_DB_PVSS_INSTALL_VERSION_IDX = 2
 
const int FW_INSTALLATION_DB_PVSS_INSTALL_DESCFILE_IDX = 3
 
const int FW_INSTALLATION_DB_PVSS_INSTALL_SOURCEDIR_IDX = 4
 
const int FW_INSTALLATION_DB_PVSS_INSTALL_SUBCOMP_IDX = 5
 
const int FW_INSTALLATION_DB_PVSS_INSTALL_SUBPATH_IDX = 6
 
const int FW_INSTALLATION_DB_PVSS_INSTALL_FORCE_REQUIRED_IDX = 7
 
const int FW_INSTALLATION_DB_PVSS_INSTALL_OVERWRITE_FILES_IDX = 8
 
const int FW_INSTALLATION_DB_PVSS_INSTALL_SILENT_IDX = 9
 
const int FW_INSTALLATION_DB_PVSS_INSTALL_GROUP_IDX = 10
 
const int FW_INSTALLATION_DB_PVSS_DELETE_NAME_IDX = 1
 
const int FW_INSTALLATION_DB_PVSS_DELETE_VERSION_IDX = 2
 
const int FW_INSTALLATION_DB_DB_DELETE_COMPONENT_NAME_IDX = 1
 
const int FW_INSTALLATION_DB_DB_DELETE_COMPONENT_VERSION_IDX = 2
 
const int FW_INSTALLATION_DB_DB_DELETE_COMPONENT_SUBCOMP_IDX = 3
 
const int FW_INSTALLATION_DB_DB_DELETE_COMPONENT_GROUP_IDX = 4
 
const int FW_INSTALLATION_DB_DB_INSTALL_COMPONENT_NAME_IDX = 1
 
const int FW_INSTALLATION_DB_DB_INSTALL_COMPONENT_VERSION_IDX = 2
 
const int FW_INSTALLATION_DB_DB_INSTALL_COMPONENT_SUBCOMP_IDX = 3
 
const int FW_INSTALLATION_DB_DB_INSTALL_COMPONENT_GROUP_IDX = 4
 
const int FW_INSTALLATION_DB_DB_INSTALL_COMPONENT_DESCFILE_IDX = 5
 
const int FW_INSTALLATION_DB_REINSTALL_COMPONENT_NAME_IDX = 1
 
const int FW_INSTALLATION_DB_REINSTALL_COMPONENT_VERSION_IDX = 2
 
const int FW_INSTALLATION_DB_REINSTALL_COMPONENT_SUBCOMP_IDX = 3
 
const int FW_INSTALLATION_DB_REINSTALL_COMPONENT_DESCFILE_IDX = 4
 
const int FW_INSTALLATION_DB_REINSTALL_RESTART_PROJECT_IDX = 5
 
const int FW_INSTALLATION_DB_REINSTALL_OVERWRITE_FILES_IDX = 6
 
const int FW_INSTALLATION_DB_AGENT_SYNC_PROJ_PATHS = 1
 
const int FW_INSTALLATION_DB_AGENT_SYNC_PROJ_MANAGERS = 2
 
const int FW_INSTALLATION_DB_AGENT_SYNC_DIST_PEERS = 3
 
const int FW_INSTALLATION_DB_AGENT_SYNC_COMP_FILE_ISSUES = 4
 
const int FW_INSTALLATION_DB_AGENT_SYNC_REDU_CONF = 5
 
const int FW_INSTALLATION_DB_AGENT_SYNC_DEV_AND_APPS = 6
 
const int FW_INSTALLATION_DB_AGENT_SYNC_COMPONENTS_LEN = 6
 
const string FW_INSTALLATION_DB_AGENT_SYNC_COMPONENTS_DPE = ".synchronizedComponents"
 
const string FW_INSTALLATION_DB_AGENT_SYNC_COMPONENTS_LOCAL_DPE = FW_INSTALLATION_DB_AGENT_SYNC_COMPONENTS_DPE + ".enabledInLocal"
 
const string FW_INSTALLATION_DB_AGENT_SYNC_COMPONENTS_CENTRAL_DPE = FW_INSTALLATION_DB_AGENT_SYNC_COMPONENTS_DPE + ".enabledInCentral"
 
const string FW_INSTALLATION_DB_AGENT_WMIC_CMD = "%SystemRoot%/system32/wbem/wmic"
 

Detailed Description

This library contains builds on top of fwInstallation.ctl and fwInstallationDB.ctl and it contains the functions called by the DB-Agent of the FW Comonent Installation Tool for the synchronization of the contents of the local project and of the System Configuration DB. The functions in this library are not intended to be called from user scripts

Author
Fernando Varela Rodriguez (EN-ICE)
Version
3.3.10
Date
April 2007

Function Documentation

int fwInstallationDBAgent_executeProjectPendingReinstallations ( int &  restartProject)

This function executes all pending reinstallation actions for the project

Parameters
restartProjectflag indicating if project restart is required. Possible values are:

0: project restart is not required

1: project restart required

2: project restart not required but post-installation scripts must be run

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

This function sets the synchronization lock, i.e. a kind of semaphore to ensure that not concurrent installation are performed by the agent and the main panel of the installation tool.

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

This function releases the synchronization lock.

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

This function returns the current value of the synchronization lock

Returns
1 if the lock is set, 0 if unset
int fwInstallationDBAgent_setProjectStatus ( string  projectName = "",
string  computerName = "" 
)

This function writes to the System Configuration DB result of the synchronization process

Parameters
statusarray of flags indicating the result of each of the steps performed during the synchronization process
projectNameName of the project
computerNamehostname
Returns
0 if OK, -1 if errors
bool fwInstallationDBAgent_isSyncProjectFileIssuesEnabled ( )

Check if project files issues synchronization/checking is enabled. This is done by reading a proper data point.

Returns
True if file issue synchronization is enabled, false if not.
void fwInstallationDBAgent_setSyncProjectFileIssues ( bool  enable)

Sets synchronization of files issues. This is done by writing a boolean value to a datapoint.

Parameters
enablewhat value should be written to datapoint, false - file issue synchronization is disabled, true - file issue synchronization is enabled.
int fwInstallationDBAgent_synchronize ( int &  restartProject)

This function synchronizes the contents of the System Configuration DB and of the local project

Parameters
restartProjectflag indicating if project restart is required. Possible values are:

0: project restart is not required

1: project restart required

2: project restart not required but post-installation scripts must be run

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

This function retrieves from the System Configuration DB the current status of the syncrhonization process

Parameters
syncStepsStatusarray of flags indicating the result of each of the steps performed during the synchronization process
Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_checkProjectPvssInfo ( int &  status,
dyn_mixed &  dbPvssInfo,
dyn_mixed &  pvssPvssInfo 
)

This function checks the consistency between the current project and the contents of the System Configuration DB for the PVSS setup information

Parameters
status1 if DB and local project information is in sync, 0 when not
dbPvssInfoPVSS information in the system configuration DB as a dyn_mixed array
pvssPvssInfoPVSS information from the local project
Returns
0 if OK, -1 if errors

TODO: Check with FV if this is supposed to remain. Activating for now, commented out on last version.

int fwInstallationDBAgent_checkHostPvssInfo ( int &  status,
dyn_string &  dbPvssVersions,
dyn_string &  pvssPvssVersions 
)

This function checks the consistency of the PVSS version information

Parameters
status1 if DB and local project information is in sync, 0 when not
dbPvssVersionsPVSS information in the system configuration DB as a dyn_string array
pvssPvssVersionsPVSS information from the local host
Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_synchronizePvssSetupInfo ( )

This function updates the contents of the System Configuration DB for the PVSS setup information

Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_checkProjectPvssPatchesInfo ( int &  status,
dyn_string &  dbPatches,
dyn_string &  pvssPatches 
)

This function checks the consistency between the current project and the contents of the System Configuration DB for the PVSS patches information

Parameters
status1 if DB and local project information is in sync for patches, 0 when not
dbPatchesPVSS information in the system configuration DB as a dyn_mixed array
pvssPatchesPVSS information from the local project
Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_checkHostInfo ( int &  status,
dyn_mixed &  dbHostInfo,
dyn_mixed &  pvssHostInfo 
)

This function checks the consistency between the current project and the contents of the System Configuration DB for the host information

Parameters
status1 if DB and local project information is in sync for patches, 0 when not
dbHostInfoPVSS information in the system configuration DB as a dyn_mixed array
pvssHostInfoPVSS information from the local project
Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_synchronizeHostInfo ( )

This function updates the contents of the System Configuration DB for the host information

Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_checkProjectInfo ( int &  status,
dyn_mixed &  dbProjectInfo,
dyn_mixed &  pvssProjectInfo 
)

This function checks the consistency between the current project and the contents of the System Configuration DB for the project information

Parameters
status1 if DB and local project information is in sync for patches, 0 when not
dbProjectInfoPVSS information in the system configuration DB as a dyn_mixed array
pvssProjectInfoPVSS information from the local project
Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_checkProjectFileIssues ( int &  status,
dyn_dyn_mixed &  dbProjectFileIssues,
dyn_dyn_mixed &  pvssProjectFileIssues 
)

This function checks the consistency between the current project file issues and the contents of the System Configuration DB for the project file issues

Parameters
status1 if DB and local project file issues information is in sync, 0 when not, -2 when synchronization is disabled
dbProjectFileIssuesFile issues information in the system configuration DB as a dyn_dyn_mixed array
pvssProjectFileIssuesFile issues information from the local project
Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_synchronizeProjectInfo ( )

This function updates the contents of the System Configuration DB for the project information

Returns
0 if OK, -1 if errorsfwInstallationDB_registerSystem
int fwInstallationDBAgent_synchronizeProjectFileIssues ( )

This function updates the contents of the System Configuration DB for the file issues

Returns
0 if OK, -1 if error, -2 when synchronization is disabled
int fwInstallationDBAgent_checkProjectPathsInfo ( int &  status,
dyn_string &  dbPaths,
dyn_string &  pvssPaths,
bool  checkRequiredTable = false 
)

This function checks the consistency between the current project and the contents of the System Configuration DB for the project paths

Parameters
status1 if DB and local project information is in sync for patches, 0 when not, -2 when synchronization is disabled
dbPathsPVSS information in the system configuration DB as a dyn_mixed array
pvssPathsPVSS information from the local project
checkRequiredTableWhen true read from fw_sys_stat_inst_path, otherwise from fw_sys_stat_current_inst_path
Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_synchronizeProjectPaths ( )

This function synchronizes the list of project paths in the current project and in the System Configuration. The synchronization depends on the management mode of the project:

  • if the project is locally managed, the contents of the system confiuguration db are updated with the list of project paths currently defined in the project.
  • if the project is centrally managed, the DB-Agent of the installation tool modifies the list of project paths defined in the local project to reflect the contents of the system configuration DB.
Returns
0 if OK, -1 if errors, -2 when synchronization is disabled
int fwInstallationDBAgent_checkProjectManagersInfo ( int &  status,
dyn_dyn_mixed &  dbManagersInfo,
dyn_dyn_string &  pvssManagersInfo 
)

This function checks the consistency between the list of project managers in the current project and those registered in the System Configuration DB

Parameters
statusoverall result of the consistency check
dbManagersInfomanagers information from the database
pvssManagersInfomanagers information from the local project
Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_synchronizeProjectManagers ( )

This function updates the contents of the System Configuration DB for the project managers

Returns
0 if OK, -1 if errors, -2 when synchronization is disabled
int fwInstallationDBAgent_checkComponents ( int &  status,
dyn_dyn_mixed &  dbComponentsInfo,
dyn_dyn_mixed &  pvssComponentsInfo 
)

This function checks the consistency between the list of components currently installed in the local project and those registered in the System Configuration DB

Parameters
statusoverall result of the consistency check
dbComponentsInfocomponents information in the DB
pvssComponentsInfocomponents information from the local project
Returns
0 if OK, -1 if errors
string fwInstallationDBAgent_stringCastRequest ( dyn_mixed  request)

This function cast a dyn_mixed to an string where the different elements are separated by "|";

Parameters
requestdyn_mixed to be casted
Returns
result of the casting operation as string
int fwInstallationDBAgent_synchronizeProjectComponents ( int &  restartProject)

This function synchronizes the list of components in the current project and in the System Configuration and exports the current list of components installed in the project to the DB. The synchronization depends on the management mode of the project:

  • if the project is locally managed, no synchronization is done. Only the current list of components in the System Configuration DB is updated with the list of components in the local project.
  • if the project is centrally managed, the DB-Agent of the installation tool uninstalls and/or uninstalls all components such that the list of components installed in the project reflects the contents of the system configuration DB.
Parameters
restartProjectflag indicating if project restart is required. Possible values are:

0: project restart is not required

1: project restart required

2: project restart not required but post-installation scripts must be run

Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_isPostInstallRunning ( bool &  isRunning)

This function checks if the post-installation scripts are still running

Parameters
isRunningTRUE if post-install scripts are still being executed
Returns
0 if OK, -1 if errors
string fwInstallationDBAgent_getComponentFile ( string  descFile)

This function returns the path to a description file where any Windows-Linux path mapping is resolved, e.g. from /afs/cern.ch/myComponent.xml -> P:/myComponent.xml

Parameters
descFileoriginal description file of the component including path
Returns
new path to the component description file where possible path mappings have been resolved
int fwInstallationDBAgent_executeComponentPendingActions ( int &  restartProject,
dyn_dyn_mixed  pvssInstallComponents,
dyn_dyn_mixed  pvssDeleteComponents 
)

This function executes all pending installation/uninstallatio of components

Parameters
restartProject(in/out) flag indicating if project restart is required. Possible values are:

0: project restart is not required

1: project restart required

2: project restart not required but post-installation scripts must be run

Parameters
pvssInstallComponents(in) list of components to be installed in the project
pvssDeleteComponents(in) list of components to be delete from the project
Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_getComponentPendingActions ( int &  restartProject,
dyn_dyn_mixed &  pvssInstallComponents,
dyn_dyn_mixed &  pvssDeleteComponents,
int &  reinstalls 
)

This function retrieves the list of pending installation/uninstallatio of components

Parameters
restartProject(out) flag indicating if project restart is required. Possible values are:

0: project restart is not required

1: project restart required

2: project restart not required but post-installation scripts must be run

Parameters
pvssInstallComponents(out) list of components to be installed in the project
pvssDeleteComponents(out) list of components to be delete from the project
reinstalls(out) if not 0 means that there are pending reinstallation actions
Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_setForceFullSync ( bool  forceFullSynchronization)

This function sets the synchronization method

Parameters
bool,:either true (force full synchronize on the client) or false (use server flag)
Returns
0 if OK, -1 if errors
bool fwInstallationDBAgent_getForceFullSync ( )

This function reads the synchronization method

Returns
true if full synchronize is intended false for synchronize on server trigger only.
int fwInstallationDBAgent_setSyncInterval ( int  interval)

This function sets the synchronization interval

Parameters
intervaltime in seconds between two consecutive synchronizations
Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_getSyncInterval ( )

This function reads the synchronization interval

Returns
time in seconds between two consecutive synchronizations
int fwInstallationDBAgent_checkDistPeers ( int &  status,
dyn_string &  onlyPvssSystemNames,
dyn_string &  onlyDbSystemNames,
dyn_string &  onlyPvssComputerNames,
dyn_string &  onlyDbComputerNames,
dyn_int &  onlyPvssSystemNumbers,
dyn_int &  onlyDbSystemNumbers,
bool  checkRequiredTable = false 
)

This function checks the consistency between the list of dist peers defined in the local project and in the System Configuration DB

Parameters
statusoverall result of the consistency check
onlyPvssSystemNamesPVSS system names correspoding to peers defined only in the config file of the local project, i.e. missing in the DB
onlyDbSystemNamesPVSS system names correspoding to peers defined only in the DB, i.e. missing in the config file of the local project
onlyPvssComputerNamesHostnames correspoding to peers defined only in the config file of the local project, i.e. missing in the DB
onlyDbComputerNamesHostnames correspoding to peers defined only in the DB, i.e. missing in the config file of the local project.
onlyPvssSystemNumbersPVSS system numbers correspoding to peers defined only in the config file of the local project, i.e. missing in the DB
onlyDbSystemNumbersPVSS system numbers correspoding to peers defined only in the DB, i.e. missing in the config file of the local project.
checkRequiredTableWhen true read from fw_sys_stat_system_connect, otherwise from fw_sys_stat_sys_curr_connect
Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_isDistRestartRequired ( )

This function returns whether the distribution manager has to be restarted during the synchronization process

Returns
1 if the dist manager has to be restarted, otherwise 0.
int fwInstallationDBAgent_synchronizeDistPeers ( )

This function synchronizes the list of dist peers in the current project and in the System Configuration. The synchronization depends on the management mode of the project:

  • if the project is locally managed, the contents of the system confiuguration db are updated with the list of dist peers currently defined in the project.
  • if the project is centrally managed, the DB-Agent of the installation tool modifies the list of dist-peers defined in the local project to reflect the contents of the system configuration DB.
    Returns
    0 if OK, -1 if errors, -2 when synchronization is disabled
int fwInstallationDBAgent_checkWCCOAApplications ( int &  status,
dyn_dyn_mixed &  dbAppsToAdd,
dyn_dyn_mixed &  dbAppsToRemove 
)

Check consistency of WinCC OA (UNICOS) applications between configuration DB and current state.

Parameters
statusresult of consistency check: 0 - not consistent, 1 - consistent, -2 - disabled
dbAppsToAddarray of applications that should be added or updated in database.
dbAppsToRemovearray of applications that should be unregistered from database.
Returns
0 on success, -1 on error.
int fwInstallationDBAgent_synchronizeReduInfo ( )

This function synchronizes the project redundant information with the System Configuration. The synchronization steps depend on the management mode of the project:

  • if the project is locally managed, the contents of the system configuration db
  • if the project is centrally managed, the DB-Agent of the installation tool modifies the contents of the local project config file and adds the necessary managers to the project console to reflect the contents of the system configuration DB.
    Returns
    0 if OK, -1 if errors
int fwInstallationDBAgent_unregisterProjectPaths ( string  projectName = "",
string  computerName = "" 
)

This function unregisters all project paths from the System Configuration DB for a particular project

Parameters
projectNamename of the PVSS project
computerNamehostaname where the project runs
Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_registerProjectPaths ( dyn_string  paths,
string  projectName = "",
string  computerName = "" 
)

This function registers all project paths in the System Configuration DB for a particular project

Parameters
pathslist of project paths
projectNamename of the PVSS project
computerNamehostaname where the project runs
Returns
0 if OK, -1 if errors
int fwInstallationDBAgent_checkDevices ( int &  status,
dyn_mapping &  dbDevicesToAdd,
dyn_mapping &  dbDevicesToRemove 
)

Check consistency of devices between configuration DB and current state.

Parameters
statusresult of consistency check: 0 - not consistent, 1 - consistent, -2 - disabled.
dbDevicesToAddmapping with device types, applications and information about devices that should be added or updated in database.
dbDevicesToRemovemapping with device types, applications and information about devices that should be unregistered from database.
Returns
0 on success, -1 on error.
int fwInstallationDBAgent_synchronizeWCCOAApplicationsAndDevices ( )

Synchronize UNICOS application and devices on this project with the System Configuration. Applications are read from _UnApplication datapoint type.

Returns
0 on success, -1 on error, -2 when synchronization is disabled

Variable Documentation

const string gFwInstallationAgentLibVersion = "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