Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%Installer.Component

class %Installer.Component extends %Library.RegisteredObject, %XML.Adaptor

Component manager class

Property Inventory

Method Inventory

Properties

property Compatibility as list of Component;
Minimum version for other components when installing this component
Property methods: CompatibilityBuildValueArray(), CompatibilityCollectionToDisplay(), CompatibilityCollectionToOdbc(), CompatibilityDisplayToCollection(), CompatibilityGet(), CompatibilityGetObject(), CompatibilityGetObjectId(), CompatibilityGetSwizzled(), CompatibilityIsValid(), CompatibilityOdbcToCollection(), CompatibilitySet(), CompatibilitySetObject(), CompatibilitySetObjectId()
property List as list of Component;
List is used to keep track of a list of components
Property methods: ListBuildValueArray(), ListCollectionToDisplay(), ListCollectionToOdbc(), ListDisplayToCollection(), ListGet(), ListGetObject(), ListGetObjectId(), ListGetSwizzled(), ListIsValid(), ListOdbcToCollection(), ListSet(), ListSetObject(), ListSetObjectId()
property Name as %String;
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Prerequisites as list of Component;
Property methods: PrerequisitesBuildValueArray(), PrerequisitesCollectionToDisplay(), PrerequisitesCollectionToOdbc(), PrerequisitesDisplayToCollection(), PrerequisitesGet(), PrerequisitesGetObject(), PrerequisitesGetObjectId(), PrerequisitesGetSwizzled(), PrerequisitesIsValid(), PrerequisitesOdbcToCollection(), PrerequisitesSet(), PrerequisitesSetObject(), PrerequisitesSetObjectId()
property Version as %String;
Property methods: VersionDisplayToLogical(), VersionGet(), VersionIsValid(), VersionLogicalToDisplay(), VersionLogicalToOdbc(), VersionNormalize(), VersionSet()

Methods

classmethod BuildUpdateINI(pFileName="Component_"_$namespace_".ini")
classmethod ComponentVersion(pDB="", pVersion="") as %Status
Version of the installed Component version
classmethod ConfigureComponent(pDB="", pNamespace="", pVerbose=0, ByRef pVars) as %Status
Add mappings for a Namespace and additional configuration items
classmethod GetXDataAsStreamWithSubstitutions(pXData, ByRef pStream) as %Status
classmethod InstallComponent(pDB="", pVerbose=0, pDev=0) as %Status
Call ##class(Installer.Install).OnInstallComponent in the corresponding database
classmethod InstallUpdateINI(pFileName="Components.ini", pDirectory=$system.Util.InstallDirectory())
classmethod LoadComponentINI(ByRef pList, pFile="Components.ini", pDirectory=$zu(12)_"utils/") as %Status
classmethod UnInstallComponent(pDB="", pVerbose=0) as %Status
Call ##class(Installer.Install).OnUnInstallComponent in the corresponding database
classmethod UnconfigureComponent(pDB="", pNamespace="", pVerbose=0, pPurgeFiles=0, ByRef pVars) as %Status
Remove mappings for a Namespace (to a component)
classmethod UpdateComponentINI(pComponent As Component, pFile="Components.ini", pDirectory=$zu(12)_"utils/", pFromBuild=0) as %Status

Inherited Members

Inherited Methods

FeedbackOpens in a new tab