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

Config.LicenseServers

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

SQL Table Name: Config.LicenseServers

This class allows you to modify and view the [LicenseServers] 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="LOCAL1"
%SYS>s Properties("Address")="127.0.0.1"
%SYS>s Status=##Class(Config.LicenseServers).Create(Name,.Properties)
%SYS>i Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Use class methods to modify properties
%SYS>s Status=##Class(Config.LicenseServers).Get(Name,.Properties)
%SYS>i Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
%SYS>zw Properties
Properties("Address")="127.0.0.1"
Properties("Port")=4002
%SYS>s Properties("Port")=4003
%SYS>s Status=##Class(Config.LicenseServers).Modify(Name,.Properties)
%SYS>i Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Now use Objects to modify properties
%SYS>s Obj=##Class(Config.LicenseServers).Open(Name)
; We could have used i ##Class(Config.LicenseServers).Exists(Name,.Obj) instead of Open()
%SYS>w Obj.Port
4002
%SYS>s Obj.Port=4003
%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.LicenseServers).Delete(Name)
%SYS>i Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)

Property Inventory

Parameters

parameter CAPITALNAME = 1;
License server names are all caps.

Properties

property Address as Config.Host (MAXLEN = 256, MINLEN = 0) [ InitialExpression = "127.0.0.1" , Required ];
IP Address of the license server.
Property methods: AddressDisplayToLogical(), AddressGet(), AddressGetStored(), AddressIsValid(), AddressLogicalToDisplay(), AddressLogicalToOdbc(), AddressNormalize(), AddressSet()
property KeyDirectory as %String (MAXLEN = 256);
Directory used to load license keys for distribution. At startup of a local License Server, the system will attempt to load license keys from all *.key files in this directory. These keys can then be requested by other Instances using this License Server.
Property methods: KeyDirectoryDisplayToLogical(), KeyDirectoryGet(), KeyDirectoryGetStored(), KeyDirectoryIsValid(), KeyDirectoryLogicalToDisplay(), KeyDirectoryLogicalToOdbc(), KeyDirectoryNormalize(), KeyDirectorySet()
property Port as %Integer [ InitialExpression = 4002 , Required ];
IP Port of the license server.
Property methods: PortDisplayToLogical(), PortGet(), PortGetStored(), PortIsValid(), PortLogicalToDisplay(), PortNormalize(), PortSet(), PortXSDToLogical()

Inherited Methods

Queries

query List(Names As %String = "*", CPFFile As %String = "", Flags As %Integer = 0, Format As %Integer = 0)
Selects Name As %String, Address As %String, Port As %Integer, KeyDirectory As %String
List LicenseServers in a CPF file.

Parameters:
Names - Comma separated list of LicenseServer 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

Indexes

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

Storage

Storage Model: Storage (Config.LicenseServers)

^|"^^"_$ZU(12)|SYS("CONFIG")(ID)
=
%%CLASSNAME
Address
Description
Port
Comments
KeyDirectory