This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

Config.MirrorAsyncMemberSources

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

SQL Table Name: Config.MirrorAsyncMemberSources

This class allows you to modify and view the [MirrorAsyncMemberSources] 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

Property Inventory

Method Inventory

Parameters

parameter CAPITALNAME = 1;
Server name is always capitalized.

Properties

property AgentAddress as Config.Host [ Required ];
Property methods: AgentAddressDisplayToLogical(), AgentAddressGet(), AgentAddressGetStored(), AgentAddressIsValid(), AgentAddressLogicalToDisplay(), AgentAddressLogicalToOdbc(), AgentAddressNormalize(), AgentAddressSet()
property AgentPort as %Integer [ Required ];
Property methods: AgentPortDisplayToLogical(), AgentPortGet(), AgentPortGetStored(), AgentPortIsValid(), AgentPortLogicalToDisplay(), AgentPortNormalize(), AgentPortSet(), AgentPortXSDToLogical()
property AsyncMemberType as %Integer (MAXVAL = 1, MINVAL = 0) [ InitialExpression = 0 , Required ];
Property methods: AsyncMemberTypeDisplayToLogical(), AsyncMemberTypeGet(), AsyncMemberTypeGetStored(), AsyncMemberTypeIsValid(), AsyncMemberTypeLogicalToDisplay(), AsyncMemberTypeNormalize(), AsyncMemberTypeSet(), AsyncMemberTypeXSDToLogical()
property InstanceDirectory as %SysPath;
Property methods: InstanceDirectoryDisplayToLogical(), InstanceDirectoryGet(), InstanceDirectoryGetStored(), InstanceDirectoryIsValid(), InstanceDirectoryLogicalToDisplay(), InstanceDirectoryLogicalToOdbc(), InstanceDirectoryNormalize(), InstanceDirectorySet()

Methods

classmethod Delete(Name As %String, ByRef CPFFile As %String = "", Flags As %Integer = $$$CPFSave+$$$CPFWrite+$$$CPFActivate, Clean As %Integer = 1) as %Status
Delete a section instance from a CPF file.

Parameters:
Name - Name of the instance to delete.
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file.
Flags - Bit string of options to perform. See the Create() method for values.

Return values:
CPFFile (byref) - Name of the CPF file the modification was made in.

Queries

query List(Names As %String, CPFFile As %String = "", Flags As %Integer = 0, Format As %Integer = 0)
Selects Name As %String, AgentAddress As %String, AgentPort As %Integer, InstanceDirectory As %String, AsyncMemberType As %Integer
List MirrorAsyncMemberSources in a CPF file.

Parameters:
Names - Comma separated list of MirrorAsyncMemberSources names
"*" - All records match
"String,String1" - Any records matching one of these elements
"String*" - Any record starting with "String"
"String,String1*,String2" - Any record mathing 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()

Inherited Members

Inherited Properties

Inherited Methods

Storage

Storage Model: CacheStorage (Config.MirrorAsyncMemberSources)

^|"^^"_$ZU(12)|SYS("CONFIG")(ID)
=
Comments
AgentAddress
AgentPort
AsyncMemberType
InstanceDirectory
Feedback