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

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 4 4


Summary

Properties
Compile CompileAfter Directory DirectoryDefined
ExportFlags FilenameExtension FilenameTranslateAssociator FilenameTranslateIdentifier
Flags Format 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 DESCRIPTION = "Standard resource processor for packages of classes included in a module.";
Description of resource processor class (shown in UI)
• parameter EXTENSION = "CLS";
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)
• parameter NAMEPOSTFIX = ".";
When a module is loaded in developer mode, this is appended to the resource name in ^Sources - e.g., ^Sources(..Extension, _..#NAMEPOSTFIX) The only expected use case at this point is class packages (.PKG, but Extension will be .CLS)

Properties

• property Directory as %String(MAXLEN="") [ InitialExpression = "cls" ];
Directory relative to module root containing the exported resource. Defaults to the resource's extension (lower-case) if unspecified.
• property FilenameExtension as %String;
Extension for individual filename(s) that comprise this resource
• property Format as %String(VALUELIST=",UDL,XML");
Export format
• property LoadAsDirectory as %Boolean [ InitialExpression = 1 ];
If true (default is false), the resource is loaded as a directory.

Methods

• method OnConfigureMappings(ByRef pParams) as %Status
Subclasses may override to customize mapping behavior at the beginning of the Reload phase.
• method OnExportItem(pFullExportPath As %String, pItemName As %String, ByRef pItemParams, ByRef pParams, Output pItemHandled As %Boolean = 0) as %Status
• method OnItemRelativePath(pItemName As %String, pIsUnitTest As %Boolean = 0) as %String
Returns the path relative to the module root for item pItemName within this resource.
• 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.