Class Reference
%IPM.ResourceProcessor.Default.DeepSeeItem
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%IPM] >  [ResourceProcessor] >  [Default] >  [DeepSeeItem]
Private  Storage

class %IPM.ResourceProcessor.Default.DeepSeeItem extends %IPM.ResourceProcessor.Default.Document

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 6 5


Summary

Properties
Compile CompileAfter Directory DirectoryDefined
ExportFlags FilenameExtension FilenameTranslateAssociator FilenameTranslateIdentifier
Flags Format Keywords LoadAsDirectory
Params

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
ApplyDefaults DirectorySet GetAttributeMetadata GetDescription
GetSourceControlInfo OnAfterPhase OnBeforeArtifact OnBeforePhase
OnConfigureMappings OnExportDeployedItem OnExportItem OnGetStudioProject
OnGetUniqueName OnItemRelativePath OnLoad OnLoadDeployed
OnPhase OnResolveChildren ResourceIsMappedToDefaultDB SatisfiesCondition
SetParams


Parameters

• parameter ATTRIBUTES = "Directory,Keywords,FilenameTranslateIdentifier,FilenameTranslateAssociator";
Comma-separated list of resource attribute names that this processor uses
• parameter EXTENSION = ".DFI";
May be set to determine the value of Extension based on a static value rather than based on the resource name. The only expected use case at this point is class packages (.PKG, but Extension will be .CLS)

Properties

• property Directory as %String(MAXLEN="") [ InitialExpression = "dfi" ];
Directory relative to module root containing the exported resource. Defaults to the resource's extension (lower-case) if unspecified.
• property FilenameExtension as %String [ InitialExpression = "xml" ];
Extension for individual filename(s) that comprise this resource
• property FilenameTranslateAssociator as %String [ InitialExpression = "/_____" ];
Characters in the filename to use as the associator in $translate when determining the resource's filename on disk The default behavior is to replace "." with "/" and ignore "%"
• property FilenameTranslateIdentifier as %String [ InitialExpression = "-% ,("")" ];
Characters in the filename to use as the identifier in $translate when determining the resource's filename on disk The default behavior is to replace "." with "/" and ignore "%"
• property Format as %String;
Export format
• property Keywords as %String;

Methods

• method OnExportItem(pFullExportPath As %String, pItemName As %String, ByRef pItemParams, ByRef pParams, Output pItemHandled As %Boolean = 0) as %Status
• method OnGetUniqueName(Output pUniqueName)
Returns a unique name for this resource. Default implementation, leaving pUniqueName undefined, reverts to default behavior. An empty string indicates guaranteed uniqueness (useful for folders relative to module root)
• method OnPhase(pPhase As %String, ByRef pParams, Output pResourceHandled As %Boolean = 0) as %Status
Called as phase pPhase is executed for the resource. If pResourceHandled is set to true, then the default behavior for that resource will be bypassed in the current phase. Currently, this is only used in the Verify phase, because of different handling of intermediate error statuses. TODO: Implement for standard database resources (.INC, .CLS, etc.)
• method OnResolveChildren(ByRef pResourceArray) as %Status
Enumerate all documents contained in the resource being processed.
@Argument pResourceArray ByRef: array of the following format: pResourceArray() = pResourceArray(, ) = value of resource reference property for given document


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