Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [Inventory] >  [Scan]
Private  Storage   

persistent class Inventory.Scan extends %Persistent, %XML.Adaptor

Scan objects represent the results of scanning the installation and examining its components. Different types of component (e.g., routines, databases, files) are represented by different subclasses of the Component class. Components can contain subcomponents. Components are scanned recursively, and the result is a tree of objects.

The tree is rooted in the RootComponent property of the scan.

Scan objects also record the start and end times of the scan, as well as a text description, which is not requried to be unique.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 2 3


Description EndTimeStamp RootComponent StartTimeStamp

%AddToSaveSet %AddToSyncSet %BMEBuilt %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetLock %GetParameter %GetSwizzleObject %Id
%InsertBatch %IsA %IsModified %IsNull
%KillExtent %KillExtentData %LoadFromMemory %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync %OnDetermineClass
%Open %OpenId %OriginalNamespace %PackageName
%PhysicalAddress %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SaveIndices %SerializeObject %SetModified %SortBegin
%SortEnd %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %ValidateIndices %ValidateObject OpenByDescription
WriteToFile XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace


• property Description as %String(MAXLEN=512);
A description of the circumstances of this scan
• property EndTimeStamp as %TimeStamp;
The end time of this scan.
• property RootComponent as Component;
The Component that served as the origin of the scan.
• property StartTimeStamp as %TimeStamp;
The start time of this scan.


• classmethod OpenByDescription(description As %String) as Scan
Opens a previously saved Scan object with a Description of description.

If more than one Scan has the given description, returns the first one found.

Returns "" if no Scan found.

• method WriteToFile(filename As %String) as %Status
Writes the content of this scan to filename in %XML.Export format. Note that an existing file will be overwritten.


•index (EndTimeStampIndex on EndTimeStamp);
•index (RootComponentIndex on RootComponent);
•index (StartTimeStampIndex on StartTimeStamp);

Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.