HS.HC.Util.Installer

class HS.HC.Util.Installer

Method Inventory (Including Private)

Methods

classmethod ActivateConfiguration(pDummy, pNS=$namespace) [ Language = objectscript ]
Export and Activate a configuration first argument is no longer used
classmethod AddClassMappings(pDummy, pNamespace As %String, pAddList As %String, pFrom As %String) as %Status [ Language = objectscript ]
Add a list of class/package mappings Adds them to the current configuration, but does not activate pNamespace is the current namespace being configured, where the classes are to be used pAddList is a comma-list of package specs, like "HS*,web*,..." pFrom is the database containing the package The mappings are assumed to not exist, use DeleteClassMappings to remove them first (to get correct order!) The first argument is no longer used
classmethod AddGlobalMappings(pDummy, pNamespace As %String, pAddList As %String, pFrom As %String, pSetCollation As %Boolean = 0) [ Language = objectscript ]
Add a list of global mappings of specified type Adds them to the current configuration, but does not activate pNamespace is the current namespace being configured, where the globals are to be used pAddList is a comma-list of global specs, like "A,B:(""sub"")",C" pFrom is the database containing the globals The mappings are assumed to not exist, use DeleteGlobalMappings to remove them first The first argument is no longer used pSetCollation is set to force Collation of the mapping to use the new global collation for the pFrom database This is needed for some SLM (Subscript Level Mapping) cases, such as ^OBJ.DSTIME
classmethod AddRoutineMappings(pDummy, pNamespace As %String, pAddList As %String, pType As %String = "ALL", pFrom As %String) as %Status [ Language = objectscript ]
Add a list of routine mappings of specified type ("ALL", "INC", etc) Adds them to the current configuration, but does not activate pNamespace is the current namespace being configured, where the routines are to be used pAddList is a comma-list of routine specs, like "A*,BA*,..." pType is the type to map, "ALL" or "INC" pFrom is the database containing the routines The mappings are assumed to not exist, use DeleteRoutineMappings to remove them first The first argument is no longer used
classmethod ApplySettings(pTargetNS As %String, pProductionName As %String, ByRef pSettings, ByRef pResults) [ Language = objectscript ]
Apply a bag of Settings to the production
classmethod CheckGetKey() as %Integer [ Language = objectscript ]
classmethod CompileXMLExtensions(pNamespace As %String = $namespace, Output pClassList, pExcludeEns As %Boolean = 1, pExcludeZen As %Boolean = 0) as %Status [ Language = objectscript ]
Build a list of classes in HSLIB which need to populate ^oddXML instead of ^oddCOM due to ^oddCOM being read-only for some classes, then change to the specified namespace and recompile those classes to ensure that they are correctly listed as extensions in ^oddXML in the target namespace.
classmethod CopyClass(pNamespace As %String, pSrc As %String, pTarget As %String) as %Integer [ Language = objectscript ]
Copy a class and Compile it Return 1 if copied/replaced, 0 if not
classmethod CreateDataDirectory(pNamespace As %String, pProduction As %String, pComponent As %String, pDirectory As %String) as %Integer [ Language = objectscript ]
If any item in pComponent exists in pProduction in pNamespace then create pDirectory, if not already there Returns 1 if created, -1 if already there, 0 if failed, -2 if not needed Deprecated - do not use. Use CreateDataDirectoryNew instead
classmethod CreateDataDirectoryNew(pNamespace As %String, pProduction As %String, pComponent As %String, pDirectory As %String) as %Status [ Language = objectscript ]
If any item in pComponent exists in pProduction in pNamespace then create pDirectory, if not already there pDirectory is relative to the system installation directory
classmethod DeleteClassMappings(pDummy, pNamespace As %String, pDeleteList As %String = "") as %Status [ Language = objectscript ]
Remove a list of class/package mappings for the selected Namespace The first argument is no longer used
classmethod DeleteGlobalMappings(pDummy, pNamespace As %String, pDeleteList As %String = "") [ Language = objectscript ]
Remove a list of global mappings The first argument is no longer used
classmethod DeleteResource(pResource, pDatabase As %String = "%") [ Language = objectscript ]
Delete a resource if it exists
classmethod DeleteRoutineMappings(pDummy, pNamespace As %String, pDeleteList As %String = "", pType As %String = "ALL") [ Language = objectscript ]
Remove a list of routine mappings of specified type ("ALL", "INC", etc) The first argument is no longer used
classmethod DeleteTasks(pNamespace) [ Language = objectscript ]
Delete all Tasks for the namespace
classmethod EnableEnsemble(pDummy, pNamespace As %String, pDummy2, pEnsPortalSuffix As %String = "ensemble", pEnsPortalPrefix As %String = "healthshare", pCookiePath As %String = "/csp/healthshare", pAuthMethods As %Integer = 36, ByRef pLogFile As %String) [ Language = objectscript ]
Ensemble enable a namespace the first and third arguments are no longer used
classmethod GetConfigObject() as %RegisteredObject [ Language = objectscript ]
Open and read the current config file and set up a Config.Configuration object (2208) Just return "" (2009+)
classmethod Import(pNamespace As %String, pTarget As %String, pWildCards As %String = "*.*", pFlags As %String = "", pIgnoreErrors As %Integer = 0) [ Language = objectscript ]
Import a file (or directory)
classmethod InstallFoundation(pNamespace As %String, ByRef pVars) as %Status [ Language = objectscript ]
Install/Update (activate) a Foundation in pNamespace pVars allows you to override/change configuration parameters, which will be updated in the HS.Util.Installer.ConfigItem database
classmethod LoadPage(pNamespace As %String, pName As %String, pDir As %String, pFlags As %String) [ Language = objectscript ]
Load CSR rules then CSP pages
classmethod Log(ByRef pLogFile As %File, pClass As %String, pMethod As %String, pText As %String) [ Language = objectscript ]
Log a message to the InstallLogFile and/or to the Terminal pLogFile - file to write log into undefined = not open, try to open $$$InstallLogFile "" = do not log 0 = log only to terminal oref = open logfile (append mode) pClass = 0 means close log
classmethod MapHSCUSTOMForNamespace(pNS, pActivate=0) as %Status [ Language = objectscript ]
classmethod MapHSSYSForNamespace(pNS, pActivate=0) as %Status [ Language = objectscript ]
classmethod MergeConfigItems(pNamespace As %String, pFromName As %String, pToName As %String) as %Status [ Language = objectscript ]
Add configuration items from one production into an existing production, and save the new production
classmethod NamespaceExists(pNamespace) as %Boolean [ Language = objectscript ]
classmethod SetCredential(pNamespace As %String, pName As %String, pUsername As %String, pPassword As %String, pOverwrite As %Boolean = 0) as %Status [ Language = objectscript ]
Classmethod to create a new credential This code is copied from %EnsembleMgr.SetCredentials and Ens.Config.Credentials and modified to not return an error if the Credential exists and pOverwrite is not set
classmethod SetupPermissions(pNamespace As %String = $namespace, pRole As %String) as %Status [ Language = objectscript ]
Setup permissions ...
classmethod StandardGlobalMapping() [ Language = objectscript ]
classmethod StartProduction(pNamespace As %String, pProductionName, ByRef pState As %Integer) as %Status [ Language = objectscript ]
Try to start pProduction in pNamespace (if it is stopped) Result can be: failure, returns %Status success, returns pState=1 ($$$eProductionStateRunning) pState=2 ($$$eProductionStateStopped) pState=3 ($$$eProductionStateSuspended) pState=4 ($$$eProductionStateTroubled) pState=5 ($$$eProductionStateNetworkStopped)
classmethod StopProduction(pNamespace As %String, pTimeout As %Numeric = 30, ByRef pInitialState As %Integer, ByRef pState As %Integer, pForce As %Boolean = 0) as %Status [ Language = objectscript ]
Try to stop the Production in pNamespace (if not already stopped) (we assume only one Production per namespace !) Result can be: failure, returns %Status success, returns pState=1 ($$$eProductionStateRunning) pState=2 ($$$eProductionStateStopped) pState=3 ($$$eProductionStateSuspended) pState=4 ($$$eProductionStateTroubled) pState=5 ($$$eProductionStateNetworkStopped)
classmethod findHSLib() as %String [ Language = objectscript ]
deprecated - leftover from ancient history - we have only ever supported HSLIB as the library namespace

Subclasses

Feedback