Home > Class Reference > %SYS namespace > Config.Namespaces

Config.Namespaces

persistent class Config.Namespaces extends %Library.Persistent, Config.CommonMultipleMethods, Config.CommonProperties, %SYSTEM.Help

SQL Table Name: Config.Namespaces

This class allows you to modify and view the [Namespaces] 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 an instance
%SYS>s Name="ABC"
%SYS>s Properties("Globals")="USER"
%SYS>s Status=##Class(Config.Namespaces).Create(Name,.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Use class methods to modify properties
%SYS>s Status=##Class(Config.Namespaces).Get(Name,.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
%SYS>zw Properties
Properties("Globals")="USER"
Properties("Library")="IRISLIB"
Properties("Routines")="USER"
Properties("SysGlobals")="IRISSYS"
Properties("SysRoutines")="IRISSYS"
Properties("TempGlobals")="IRISTEMP"
%SYS>s Properties("Globals")="SAMPLES"
%SYS>s Status=##Class(Config.Namespaces).Modify(Name,.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Now use Objects to modify properties
%SYS>s Obj=##Class(Config.Namespaces).Open(Name)
; We could have used i ##Class(Config.Namespaces).Exists(Name,.Obj) instead of Open()
%SYS>w Obj.Globals
SAMPLES
%SYS>s Obj.Routines="USER"
%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.Namespaces).Delete(Name)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)

Property Inventory

Parameters

parameter CAPITALNAME = 1;
Namespace name is always capitalized.

Properties

property Globals as %String (MAXLEN = 64, MINLEN = 1) [ Required ];
Default database for globals.
Property methods: GlobalsDisplayToLogical(), GlobalsGet(), GlobalsGetStored(), GlobalsIsValid(), GlobalsLogicalToDisplay(), GlobalsLogicalToOdbc(), GlobalsNormalize(), GlobalsSet()
property Routines as %String (MAXLEN = 64, MINLEN = 1) [ Required ];
Default database for routines.
Property methods: RoutinesDisplayToLogical(), RoutinesGet(), RoutinesGetStored(), RoutinesIsValid(), RoutinesLogicalToDisplay(), RoutinesLogicalToOdbc(), RoutinesNormalize(), RoutinesSet()
property TempGlobals as %String (MAXLEN = 64, MINLEN = 1) [ InitialExpression = "IRISTEMP" , Required ];
Default database for temporary globals.
Property methods: TempGlobalsDisplayToLogical(), TempGlobalsGet(), TempGlobalsGetStored(), TempGlobalsIsValid(), TempGlobalsLogicalToDisplay(), TempGlobalsLogicalToOdbc(), TempGlobalsNormalize(), TempGlobalsSet()

Queries

query List(Names As %String = "*", CPFFile As %String = "", Flags As %Integer = 0, Format As %Integer = 0)
Selects Namespace As %String, Globals As %String, Routines As %String, System Globals As %String, System Routines As %String, Library As %String, Temp Storage As %String
List Namespaces in a CPF file.

Parameters:
Names - Comma separated list of Namespace 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 ListFilter(Filter As %String = "", CPFFile As %String = "", Flags As %Integer = 0, Format As %Integer = 0)
Selects Namespace As %String, Globals As %String, Routines As %String, System Globals As %String, System Routines As %String, Library As %String, Temp Storage As %String
List Namespaces in a CPF file.

Parameters:
Filter - Filter to select columns
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

Indexes

index (CPFNameSectionHeaderName on CPFName,SectionHeader,Name) [IdKey, Type = key, Unique];
Index methods: CPFNameSectionHeaderNameCheck(), CPFNameSectionHeaderNameDelete(), CPFNameSectionHeaderNameExists(), CPFNameSectionHeaderNameOpen(), CPFNameSectionHeaderNameSQLCheckUnique(), CPFNameSectionHeaderNameSQLExists(), CPFNameSectionHeaderNameSQLFindPKeyByConstraint(), CPFNameSectionHeaderNameSQLFindRowIDByConstraint()

Inherited Members

Inherited Properties

Inherited Methods

Storage

Storage Model: Storage (Config.Namespaces)

^|"^^"_$ZU(12)|SYS("CONFIG")(ID)
=
%%CLASSNAME
Comments
Globals
Library
Routines
SysGlobals
SysRoutines
TempGlobals