Configuration Database component
Functions | Variables
fwConfigurationDB.ctl File Reference

Functions

synchronized void fwConfigurationDB_checkInit (dyn_string &exceptionInfo)
 
synchronized void fwConfigurationDB_initialize (string setupName, dyn_string &exceptionInfo)
 
void fwConfigurationDB_getSetups (dyn_string &setupNames, dyn_string &setupDPs, string &defaultSetupName, string &defaultSetupDP, dyn_string &exceptionInfo)
 
void _fwConfigurationDB_printLibraryFileVersions ()
 

Variables

global string _fwConfigurationDB_fileVersion_fwConfigurationDB_ctl ="8.2.1"
 
const float fwConfigurationDB_version = 5.0
 
const float fwConfigurationDB_minimalDBSchemaVersion =3.04
 
const float fwConfigurationDB_minimalRDBAccessVersion =5.00
 
const string fwConfigurationDB_RecipeCacheDpPrefix ="RecipeCache/"
 
const string fwConfigurationDB_RecipeTypeDpPrefix ="RecipeType/"
 
const string fwConfigurationDB_RecipeClassDpPrefix ="RecipeClass/"
 
const string fwConfigurationDB_ConnectionNamePrefix ="DBConnections/"
 
const string fwConfigurationDB_ConfigurationSetupPrefix ="ConfigurationSetups/"
 
const string _GfwConfigurationDB_defaultRecipeType ="default"
 
global float fwConfigurationDB_currentDBSchemaVersion =0.0
 
global float fwConfigurationDB_currentDPSchemaVersion =0.0
 
global string fwConfigurationDB_currentSetupName =""
 
global bool fwConfigurationDB_initialized =FALSE
 
global bool fwConfigurationDB_allowResolveRemote = false
 
global bool fwConfigurationDB_DBConfigured =FALSE
 
global string GfwConfigurationDB_currentRecipeType =""
 
global bool g_fwConfigurationDB_DBConnectionOpen =FALSE
 
global bool fwConfigurationDB_hasDBConnectivity =FALSE
 
global dbConnection g_fwConfigurationDB_DBConnection
 
global string fwConfigurationDB_SchemaPrivs
 
global int g_fwConfigurationDB_DebugSQL =0
 
global int g_fwConfigurationDB_Debug =0
 
global mapping g_fwConfigurationDB_stats
 
global mapping GfwConfigurationDB_RTValues
 
global mapping GfwConfigurationDB_RTAlerts
 
global mapping GfwConfigurationDB_RTDevices
 
global mapping g_fwConfigurationDB_DBHierarchyIDs
 
const int fwConfigurationDB_OPER_DBQuery =1
 
const int fwConfigurationDB_OPER_DBExecuteSQL =2
 
const int fwConfigurationDB_OPER_ResolveHierarchy =3
 
const int fwConfigurationDB_OPER_LoadRecipeFromCache =4
 
const int fwConfigurationDB_OPER_SaveRecipeToCache =5
 
const int fwConfigurationDB_OPER_LoadRecipeFromDB =6
 
const int fwConfigurationDB_OPER_SaveRecipeToDB =7
 
const int fwConfigurationDB_OPER_GetRecipeFromSystem =8
 
const int fwConfigurationDB_OPER_ApplyRecipeToSystem =9
 
const int fwConfigurationDB_OPER_LoadHierachyFromDB =10
 
const int fwConfigurationDB_OPER_SaveHierarchyToDB =11
 
const int fwConfigurationDB_OPER_GetHierachyFromSystem =12
 
const int fwConfigurationDB_OPER_ApplyHierarchyToSystem =13
 
const int fwConfigurationDB_OPER_UpdateDBHierarchyInfo =14
 
const int fwConfigurationDB_OPER_SaveDeviceProperties =15
 
const int fwConfigurationDB_OPER_SaveDevicesAndElements =16
 
const int fwConfigurationDB_OPER_SaveDeviceReferences =17
 
const int fwConfigurationDB_OPER_SaveDeviceMetaData =18
 
const int fwConfigurationDB_OPER_LoadDeviceProperties =19
 
const int fwConfigurationDB_OPER_SaveDevices =20
 
const int fwConfigurationDB_OPER_LoadDevices =21
 
Error Codes in general package

See also Error Codes overview module

const int fwConfigurationDB_ERROR_GENERAL =-1
 
const int fwConfigurationDB_ERROR_DPTNotExist =-2
 
const int fwConfigurationDB_ERROR_OperationAborted =-3
 
const int fwConfigurationDB_ERROR_SeparatorCharInStringList =-4
 

Detailed Description

This package contains general functions of the Configuration Database tool

Author
Piotr Golonka (BE/ICS-FD)
Date
March 2018 (c) Copyright CERN, All Rights Reserved

Function Documentation

void fwConfigurationDB_getSetups ( dyn_string &  setupNames,
dyn_string &  setupDPs,
string &  defaultSetupName,
string &  defaultSetupDP,
dyn_string &  exceptionInfo 
)
void _fwConfigurationDB_printLibraryFileVersions ( )

Variable Documentation

global string _fwConfigurationDB_fileVersion_fwConfigurationDB_ctl ="8.2.1"
const float fwConfigurationDB_minimalRDBAccessVersion =5.00
const string fwConfigurationDB_RecipeCacheDpPrefix ="RecipeCache/"
const string fwConfigurationDB_RecipeTypeDpPrefix ="RecipeType/"
const string fwConfigurationDB_RecipeClassDpPrefix ="RecipeClass/"
const string fwConfigurationDB_ConnectionNamePrefix ="DBConnections/"
const string fwConfigurationDB_ConfigurationSetupPrefix ="ConfigurationSetups/"
const string _GfwConfigurationDB_defaultRecipeType ="default"
global float fwConfigurationDB_currentDBSchemaVersion =0.0
global float fwConfigurationDB_currentDPSchemaVersion =0.0
global bool fwConfigurationDB_allowResolveRemote = false

Determines if it should be tried to resolve aliases on remote systems.

Note that by default it is set to false, yet it is reinitialized in checkInit(), and if unRecipe component is installed, then it is reset to true;

global string fwConfigurationDB_SchemaPrivs
What privileges on the schema do one has:
@li "OWNER" - schema owner
@li "WRITER" - writer rights
@li "READER" - reader rights
@li "" (empt) - no ConfDB rights on the current schema

Note! The privileges need to be granted through the DB ROLE that is created together with the schema!

global int g_fwConfigurationDB_DebugSQL =0
Debug level for SQL statements (bitmask)

The actual debug level is the sum of the following: 1 - print SQL selects 2 - print SQL statements 4 - print num of results in SQL select (summary info) 8 - print the complete results of SQL select

global int g_fwConfigurationDB_Debug =0
Debug level (bitmask)

The actual debug level is the sum of the following: 1 - print function name on entry 2 - print timing information on exit 4 - print info on entry to functional parts of routines 8 - massive debug info

global mapping g_fwConfigurationDB_stats

Statistics-gathering variable

global mapping GfwConfigurationDB_RTValues
global mapping GfwConfigurationDB_RTAlerts
global mapping GfwConfigurationDB_RTDevices
global mapping g_fwConfigurationDB_DBHierarchyIDs
const int fwConfigurationDB_OPER_DBQuery =1
const int fwConfigurationDB_OPER_DBExecuteSQL =2
const int fwConfigurationDB_OPER_ResolveHierarchy =3
const int fwConfigurationDB_OPER_LoadRecipeFromCache =4
const int fwConfigurationDB_OPER_SaveRecipeToCache =5
const int fwConfigurationDB_OPER_LoadRecipeFromDB =6
const int fwConfigurationDB_OPER_SaveRecipeToDB =7
const int fwConfigurationDB_OPER_GetRecipeFromSystem =8
const int fwConfigurationDB_OPER_ApplyRecipeToSystem =9
const int fwConfigurationDB_OPER_LoadHierachyFromDB =10
const int fwConfigurationDB_OPER_SaveHierarchyToDB =11
const int fwConfigurationDB_OPER_GetHierachyFromSystem =12
const int fwConfigurationDB_OPER_ApplyHierarchyToSystem =13
const int fwConfigurationDB_OPER_UpdateDBHierarchyInfo =14
const int fwConfigurationDB_OPER_SaveDeviceProperties =15
const int fwConfigurationDB_OPER_SaveDevicesAndElements =16
const int fwConfigurationDB_OPER_SaveDeviceReferences =17
const int fwConfigurationDB_OPER_SaveDeviceMetaData =18
const int fwConfigurationDB_OPER_LoadDeviceProperties =19
const int fwConfigurationDB_OPER_SaveDevices =20
const int fwConfigurationDB_OPER_LoadDevices =21