Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / %SYS namespace / Config.CommonProperties
Private  Storage   

Config.CommonProperties


class Config.CommonProperties

This class contains properties which are included by classes which manipulate sections in the CPF file.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 6 1


Summary


Properties
CPFFile CPFName Comments Flags Name
SectionHeader

Methods
CPFFileSet

Subclasses
Config.Cluster Config.ComPorts Config.ConfigFile
Config.Conversions Config.Databases Config.Debug
Config.DeviceSubTypes Config.Devices Config.ECP
Config.ECPServers Config.IO Config.Journal
Config.LicenseServers Config.MagTapes Config.MirrorAsyncMemberAuthorizedIDs
Config.MirrorAsyncMemberSources Config.MirrorMember Config.Mirrors
Config.Miscellaneous Config.Monitor Config.Namespaces
Config.SQL Config.Shadows
Config.SqlSysDatatypes Config.SqlUserDatatypes Config.Startup
Config.Telnet Config.config

Parameters


• parameter DOMAIN = "%Utility";
Default Localization Domain

Properties


• property CPFFile as %String(MAXLEN=255,MINLEN=1) [ InitialExpression = $p($zu(86),"*"),Transient ];
CPF file which the object maps to.
• property CPFName as %String(MAXLEN=255,MINLEN=1) [ InitialExpression = ##Class(Config.CPF).GetName($p($zu(86),"*")),Required ];
Internal name of the CPF file.
This property should not be set directly. It is updated when the CPFFile property is set.
When the CPFFile property is set, the CPFFile name dictates what is set here as follows:
c:\abc\cache.cpf ---> CACHE
/abc/cache.cpf ---> cache
dka100:[abc]cache.cpf---> CACHE
• property Comments as list of CommentList;
Embedded comments in the CPF file.
• property Flags as %Integer [ InitialExpression = 7,Transient ];
Flags governing how the object is processed when %Save() is called.
For normal operations, all bits should be set.
Bit $$$CPFSave - Save object to disk.
Bit $$$CPFWrite - Write CPF file from object.
Bit $$$CPFActivate - Activate object into memory if CPFFile is the same as what is currently active.
Bit $$$CPFAvoidBackupDB - Don't Add/Remove the Database to Backup DB list.
• property Name as %String(MAXLEN=64,MINLEN=1) [ Required ];
Name of the object instance.
• property SectionHeader as %String(MAXLEN=255,MINLEN=1) [ Required ];
Set to the name of the class.

Methods


• method CPFFileSet(Val) as %Status
When the CPF file gets set, convert the file to an internal name, and store it as part of the index.
Basically, this strips off the directory specification and the .CPF file extension, and uses the resulting name as part of the index. On windows and VMS, the name is uppercased, on unix it is not. For example:

c:\abc\cache.cpf ---> CACHE
/abc/cache.cpf ---> cache
dka100:[abc]cache.cpf---> CACHE
NOTE: This is the same code which exists in Config.CommonMapProperties