Class %IPM.Storage.ModuleTemplate

persistent class %IPM.Storage.ModuleTemplate extends %IPM.Storage.Module

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	2	17

Summary

Properties
AfterInstallMessage	AllVersions	Author	AvailabilityClass
CalculatedResources	Defaults	Dependencies	Deployed
Description	DeveloperMode	DisplayName	ExternalName
GlobalScope	Hash	InstallerClass	Invokes
Keywords	LastModifiedTimestamp	Lifecycle	LifecycleClass
Mappings	ModuleFolder	Name	Origin
OverrideLifecycleClass	Packaging	PlatformVersion	Repository
Resources	Root	SourcesRoot	SystemRequirements
TemplateResources	Version	VersionString

Methods
%%CLASSNAMELogicalToStorage	%%CLASSNAMEStorageToLogical	%AddToSaveSet	%AddToSyncSet
%BMEBuilt	%BuildIndicesAsync	%BuildIndicesAsyncResponse	%CheckConstraints
%CheckConstraintsForExtent	%ClassIsLatestVersion	%ClassName	%CompareTo
%Compile	%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	%JSONExport	%JSONExportToStream
%JSONExportToString	%JSONImport	%JSONNew	%KillExtent
%KillExtentData	%LoadFromMemory	%LockExtent	%LockId
%New	%NormalizeObject	%ObjectIsNull	%ObjectModified
%Oid	%OnBeforeAddToSync	%OnDeleteFinally	%OnDetermineClass
%OnOpenFinally	%OnSaveFinally	%Open	%OpenId
%OriginalNamespace	%PackageName	%PhysicalAddress	%PurgeIndices
%Reload	%RemoveFromSaveSet	%ResolveConcurrencyConflict	%RollBack
%Save	%SaveDirect	%SaveIndices	%SerializeObject
%SetModified	%SortBegin	%SortEnd	%SyncObjectIn
%SyncTransport	%UnlockExtent	%UnlockId	%ValidateIndices
%ValidateObject	%ValidateTable	AddDependant	AddWebApps
BuildDependencyGraph	CalculatedResourcesGet	CheckSystemRequirements	CompareToSkipCondition
CompareWithRelationships	DisplayNameSet	ExecutePhases	Expfilename
ExportOneResource	ExportResources	FindAllSuperClasses	GenerateTemplate
GetCSPApplications	GetDefaultParameters	GetGlobalsList	GetKnownDependencies
GetNamespaceConfig	GetResolvedReferences	GetStudioProject	HaveToDeploy
IgnoreKeywordList	IsLocked	LifecycleGet	LoadDependencies
Lock	NameSet	NewTemplate	OverrideLifecycleClassSet
ProcessResources	ReadFolder	ReadGlobals	ReadResources
SaveFile	SetAuthorProps	SetSourcePathForCSPApp	SetTemplateProps
Uninstall	ValidateStream	VersionStringGet	VersionStringSet
WriteAfterInstallMessage	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType

Parameters

• parameter DEFAULTGLOBAL = "^IPM.Storage.ModuleTemplate";

If a persistent class uses %Storage.Persistent then the DEFAULTGLOBAL parameter is used as the default global root for the values of the storage keywords COUNTERLOCATION, DATALOCATION, IDLOCATION, INDEXLOCATION and STREAMLOCATION in the active storage definition. DEFAULTGLOBAL is only used to generate location keyword values that are not already defined. The location value is constructed by adding a location type to the end of DEFAULTGLOBAL. For example, if DEFAULTGLOBAL = "^GL.Account" the compiler will generate DATALOCATION = ^GL.AccountD.

If USEEXTENTSET is true, then DEFAULTGLOBAL is used as the default extent location.

The location types are:

Location Type
COUNTERLOCATION C

DATALOCATION D

IDLOCATION D

INDEXLOCATION I

STREAMLOCATION S

Location	Type
COUNTERLOCATION	C
DATALOCATION	D
IDLOCATION	D
INDEXLOCATION	I
STREAMLOCATION	S

Properties

• property ModuleFolder as %String(XMLPROJECTION="NONE");

• property TemplateResources [ MultiDimensional ];

Methods

• method AddDependant(pDependant As %String) as %Status

add dependancy

• method AddWebApps(pApps As %String, Output cspapps As %List, curns=$Namespace) as %Status

adds a web application to the temporary array of module resources

• classmethod Expfilename(code, wd)

test.dfi -> /dfi/test.dfi test.cls -> /cls/test.cls testpkg.test.cls -> /cls/testpkg/test.cls

• classmethod ExportOneResource(workdir="", flags, mask="", ignoremask="")

Export different types of modules in different subfolders in UDL (plain) format test.dfi -> /dfi/test.dfi testpkg.test.cls -> /cls/testpkg/test.cls Fork from https://github.com/intersystems-ru/cache-udl d ##class(%IPM.Storage.ModuleTemplate).ExportOneResource("d:\_proj\app","00000","apptools.","apptools.M") byte=1 isGenerated byte=2 isSystem byte=3 isPercented byte=4 isMapped byte=5 isDFI

• classmethod ExportResources(Path As %String = "", ExportList As %String = "") as %Status

Export Resources Example: ExportList="00000,apptools.,apptools.M^00000,apptools.,apptools.M"

• classmethod GenerateTemplate(pPath As %String = "") as %Status

creates a module.xml file with fictional data

• classmethod GetCSPApplications(Output pApplications As %List, currentNamespace=$Namespace) as %Status

returns list of non-system csp applications in the current namespace

• classmethod GetGlobalsList(Output globals As %List) as %Status

• classmethod NewTemplate(pPath, pName, pVersion, pDescription="", pKeywords="") as %Status

• method ProcessResources()

• classmethod ReadFolder(pPath, ByRef files) as %Status

• method ReadGlobals(pSearchString As %String = "") as %Status

pSearchString - a mask, or comma-separated list of masks, to select globals

• method ReadResources(pFolder) as %Status

• method SaveFile(pPath As %String = "") as %Status

• method SetAuthorProps(pPerson As %String = "", pOrg As %String = "", pCopy As %String = "", pLicense As %String = "", pNotes As %String = "") as %Status

• method SetSourcePathForCSPApp(pCSPApp, pPath) as %Status

• method SetTemplateProps() as %Status

Class Reference IRIS for UNIX 2024.1.2
Documentation Search