Home > Class Reference > HSLIB namespace > Installer.Install

Installer.Install

class Installer.Install extends %ZHSLIB.HealthShareMgr, %ZHSLIB.AbstractInstaller

Method Inventory

Parameters

parameter MaintenanceVersion;
parameter Version;

Methods

classmethod BuildAndMapHSCUSTOM() as %Status [ Language = objectscript ]
classmethod BuildAndMapHSSYS(pDB) as %Status [ Language = objectscript ]
classmethod CleanupJournalPurge() as %Status [ Language = objectscript ]
Remove deprecated journal-file purge code
classmethod ConfigureZenReports() as %Status [ Language = objectscript ]
classmethod CreateFoundationResources(ByRef pVars, pLogLevel As %Integer, pInstaller As %Installer.Installer) as %Status [ Language = objectscript ]
classmethod CreateResources() [ Language = objectscript ]
Create or modify a list of Resources
classmethod CreateRoles() [ Language = objectscript ]
Create or modify a list of roles
classmethod DeleteResource(pResource) as %Status [ Language = objectscript ]
Delete a Resource
classmethod DeleteRole(pRole) as %Status [ Language = objectscript ]
Delete a Role
classmethod DisablePublicCSP(pVerbose) as %Status [ Language = objectscript ]
classmethod FixSysHealthShare(Output pNsHSSYS, Output pDoMaps) as %Status [ Language = objectscript ]
pNsHSSYS is the directory reference for the HSSYS namespace pDoMaps is output as 1 if we need to redo the mappings for the various HS namespaces The whole collation thing is needed because the %SYS database is always collation 5,but other databases, including HSSYS, get a default collation based on some system environment stuff. Because we're mapping ^%SYS("HealthShare") to HSSYS, and the rest is in %SYS, it must also use collation 5. This code handles the transition from older systems, moving data from %SYS into HSSYS. It also handles some intermediate problem installations where %SYS data was loaded into HSSYS, but with a bad collation.
classmethod GetResources(ByRef pArray As %String) [ Language = objectscript ]
Decide which Resources are needed on each server Can be overridden in a subclass, if needed Returns pArray(n)=Name^Description
classmethod GetRoles(ByRef pArray As %String) [ Language = objectscript ]
Decide which Roles are needed on each server Can be overridden in a subclass, if needed Returns pArray(n)=Name^Resources^Roles
classmethod GetSystemDefaultCSPSessionEventsClass() [ Language = objectscript ]
classmethod ImportSDA3Schema() as %Status [ Language = objectscript ]
classmethod InstallFoundationSecurity(pIsPrimary As %Boolean = 1, pVerbose As %Boolean = 0) as %Status [ Language = objectscript ]
Method to create Foundation Resources
classmethod MarkConfigurationsInactive(pVerbose) as %Status [ Language = objectscript ]
Mark all instances as inactive - disabling for foundation
classmethod OnComponentMaintenanceVersion(Output pMinorVersion As %String) as %Status [ Language = objectscript ]
Inherited description: Callback to return the minor version of the component. This implementation uses the MaintenanceVersion, which must by implemented by the installer subclass (or else the subclass must override this method using some other approach). If not overridden, and the Version parameter is not populated, this method will throw an exception (not merely return an error status). pMinorVersion is generally set to the value of a product-level macro which defines the minor version, e.g. $$$HSLIBminorVersion for HealthShare Core.
classmethod OnComponentUpgrade(pPreviousVersion As %String = "", pVerbose As %Boolean = 0) as %Status [ Language = objectscript ]
classmethod OnComponentVersion(Output pMajorVersion As %Integer) as %Status [ Language = objectscript ]
Inherited description: Callback to return the major version of the component. This implementation uses the Version, which must by implemented by the installer subclass (or else the subclass must override this method using some other approach). If not overridden, and the Version parameter is not populated, this method will throw an exception (not merely return an error status). pMajorVersion is generally set to the value of a product-level macro which defines the major version, e.g. $$$HSLIBmajorVersion for HealthShare Core.
classmethod OnConfigureComponent(pTargetNS As %Library.String = $namespace, pVerbose As %Library.Boolean = 0, ByRef pVars As %Library.String) as %Status [ Language = objectscript ]
Inherited description:

Callback that is invoked during namespace (re)activation. Subclasses SHOULD override this method.

pVars is an array of miscellaneous information, populated by the calling code in the installation/configuration framework (mainly HS.Util.Installer). Subscripts appearing in pVars include:

  • Production - set to (namespace)_"PKG.FoundationProduction"
  • LogFile - current log file for install operation
  • Upgrade - boolean, indicating whether the current operation is an upgrade
  • Type - hardcoded to "Foundation"
  • Component - current component name
classmethod OnInstallComponent(pDB As %String, pVerbose As %Boolean = 0, pDev As %Boolean = 0, pIsUpgrade As %Boolean = 0) as %Status [ Language = objectscript ]
Inherited description: Callback that is invoked during product installation to allow for system-level changes to be performed. Common examples of such changes include:
  • Definition of resources and roles
  • Definition/configuration of the product library database
  • Import of localized messages for the product
Subclasses SHOULD override this method.
classmethod OnResetComponent(pNamespace As %String = "", pVerbose As %Boolean = 0) as %Status [ Language = objectscript ]
classmethod OnUnInstallComponent(pDatabase As %String = "", pVerbose As %Boolean = 0) as %Status [ Language = objectscript ]
Inherited description: Callback that is invoked when removing a product.
classmethod OnValidateComponent(pVerbose As %Boolean = 0) as %Status [ Language = objectscript ]
classmethod UpdateHSLIBRoles() as %Status [ Language = objectscript ]
classmethod ValidateHealthShare(pHSLib As %String = ..#HSLIB, pVerbose As %Boolean = 0) as %Status [ Language = objectscript ]
Validate a HealthShare installation in ENSLIB
classmethod moveHSSiteDefaultFiles(pDirectory=$system.Util.InstallDirectory()) as %Status [ Language = objectscript ]
Site Default XSLT files for SDA to CCD and back - pDirectory allows providing the source control directory

Inherited Members

Inherited Methods

FeedbackOpens in a new window