Skip to main content

Installer.Install

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

Method Inventory

Parameters

parameter MaintenanceVersion;
parameter Version;

Methods

classmethod AddSecureBreakRole()
This is a temporary workaround Helper method to add %SecureBreak role to /csp/sys/oauth2 app during installation TODO: remove this when IRIS adds the equivalent step
classmethod AddUpdateMappingsForHSCUSTOM(pDB As %String, pVerbose As %Boolean, pIsUpgrade As %Boolean)
classmethod BuildHSCUSTOM(pVerbose As %Boolean)
classmethod CreateProjectionsForRESTModelClassesForHSSYS()
Wrapper around method in HS.Util.Installer.ConfigItem with no arguments (so can be queued up).
classmethod CreateWebApplicationsForHSSYS(pNamespace As %String = "HSSYS")
classmethod DeprecateSSLHostMacro()
Kill deprecated macro $$$HSSecureHostName's global node
classmethod DisableFederationOAuthDuringKitInstall()
Wrapper around method in HS.UniversalLogin.Installer.
classmethod OnComponentMaintenanceVersion(Output pMinorVersion As %String) as %Status
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
classmethod OnComponentVersion(Output pMajorVersion As %Integer) as %Status
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
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
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
classmethod OnUnInstallComponent(pDatabase As %String = "", pVerbose As %Boolean = 0) as %Status
Inherited description: Callback that is invoked when removing a product.
classmethod OnValidateComponent(pVerbose As %Boolean = 0) as %Status
classmethod SetInstancewideSSLConfig()
If SSL is activated, the instance needs to have a SSLConfig set to $$$HSSecureSSLConfig macro, to be used for handling incoming requests securely Use a dummy one with name $$$HSDemoSSLConfigName to set the macro

Inherited Members

Inherited Methods

FeedbackOpens in a new tab