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

persistent class Config.MapPackages extends %Persistent, Config.CommonMapMethods, Config.CommonMapProperties, %SYSTEM.Help

This class allows you to modify and view class package mappings in the [Map.xxx] section of the CPF file through programatic APIs. While properties are usually modified through the System Management portal, there may be some occasion where modifying them through the API's is best for your system. In all the Config methods, if you do not specify the CPFFile parameter, the currently active CPF file is used. If you wish to modify a CPF file which is not the currently active one, then specify the CPFFile you wish to modify in the method call.
The Flags parameter does not normally need to be specified; the defaults are usually sufficient for most cases.
You can use either the provided API's (Create/Get/Modify/Delete) to modify the properties by passing in the correct parameters, or use Object sytax to open and directly manipulate the config objects (Open() and Exists()). Most objects created here need only to specify the Name of the object, and 1 or 2 properties since the the defaults are what are commonly used for most cases.

EXAMPLE:

; Use class methods to create a package mapping in namespace USER to the SAMPLES database
%SYS>s Namespace="USER"
%SYS>s Name="PackageA"
%SYS>s Properties("Database")="SAMPLES"
%SYS>s Status=##Class(Config.MapPackages).Create(Namespace,Name,.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Use class methods to modify properties
%SYS>s Status=##Class(Config.MapPackages).Get(Namespace,Name,.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
%SYS>zw Properties
Properties("Database")="SAMPLES"
%SYS>s Properties("Database")="TEST"
%SYS>s Status=##Class(Config.MapPackages).Modify(Namespace,Name,.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Now use Objects to modify properties
%SYS>s Obj=##Class(Config.MapPackages).Open(Namespace,Name)
; We could have used i ##Class(Config.MapPackages).Exists(Namespace,Name,.Obj) instead of Open()
%SYS>w Obj.Database
TEST
%SYS>s Obj.Database="SAMPLES"
%SYS>s Status=Obj.%Save()
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Now delete the object we just created
%SYS>s Status=##Class(Config.MapPackages).Delete(Namespace,Name)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 14 3 1


Summary

Properties
CPFFile Comments Database Flags Name
Namespace

Methods
%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 Create
Delete Exists Get GetList
Help ListMapEditsClose ListMapEditsExecute ListMapEditsFetch
Modify Open XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType


Properties

• property Database as %String(MAXLEN=64,MINLEN=1) [ Required ];
Database to map Package to.

Methods

• classmethod ListMapEditsClose(ByRef qHandle As %Binary) as %Status
• classmethod ListMapEditsExecute(ByRef qHandle As %Binary, Namespace As %String) as %Status
• classmethod ListMapEditsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status

Queries

• query List(Namespace As %String, Names As %String = "*", CPFFile As %String = "", Flags As %Integer = 0)
Selects Name As %String, Package As %String, Database As %String
List MapPackages in a CPF file.

Parameters:
Names - Comma separated list of MapPackage names
"*" - All records match
"String,String1" - Any records matching one of these elements
"String*" - Any record starting with "String"
"String,String1*,String2" - Any record matching one of these elements, or starting with "String1"
CPFFile - Name of the CPF file to use. A null string means use the active CPF file.
Flags - Currently ignored.
Format
0 - Standard report list format
1 - ^CONFIG global format
2 - CPF file format format
Note: This query may change in future versions
• query ListMapEdits(Namespace As %String)
Selects Name As %String, Package As %String, Database As %String
List entries in CPFMappingEdit temporary storage
• query ListPackages(Database As %String)
Selects Name As %String
Get a list of all packages in a database.
Parameters:
Database - Database name to get list of packages from.

Indices

•index (CPFNameSectionHeaderNspName on CPFName,SectionHeader,Namespace,Name) [IdKey,Unique];


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