Class Reference
IRIS for UNIX 2024.1.2
|
Class Reference
IRIS for UNIX 2024.1.2
|
|
|
Private
Storage
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|
|
| Properties | |||
|---|---|---|---|
| ActorPoolSize | Description | Items | LogGeneralTraceEvents |
| ModifiedSettings | Name | Settings | SubProductions |
| TestingEnabled | VirtualSettings | ||
|
|
Extensible override for controlling detection of classname used in production method code. Matched class names will be included in Production Export for Deployment Action. Syntax: Delimiters like Web CSS:Each item indicates rules for detecting classnames for export as production dependency An item consists of a "type" and required "match token" seperated by a colon (":") Types:
- Semi-Colon between each type-expression pair
- Colon between type and expression
Match tokens can be exact or have trailing wild card ("*") Match Token examples: Evaluate any Adapter property assignment of a quoted static string to see if a valid classname
- "0" is the default. This will autodetect the assignment of a static classname string to a variable or property
- Set ..Adapter.WebServiceClientClass = "[Classname]"
- "1" . This will autodetect the static classname string used in both code syntax
- $CLASSMETHOD([Classname],[Method Name],[Parameters...])
- $PARAMETER([Classname],[Parameter Name])
- "2" . This will autodetect the static classname used in code syntax
- ##class([CLassname]).MethodName(...)
Only match for Adapter assignment where property name is exactly WebServiceClientClassParameter DetectClassesInMethodsForExportDeployment="0:..Adapter.*";Export ANY use of ##class([classname]) or $CLASSMETHOD("[classname]") or $PARAMETER("[classname]")Parameter DetectClassesInMethodsForExportDeployment="0:..Adapter.WebServiceClientClass";Parameter DetectClassesInMethodsForExportDeployment="1:*;2:*";
XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).
If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.
If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
|
|
Actor pool size for the production. This is the number of jobs that will be shared by business processes not configured to use a private job pool.
This value can be overridden using System Default Settings.
Overriding by a matching System Default Setting will occur even if this value is defined in the production definition.
Description of the production.
Log trace events that are not associated with any particular config item.
Same format as Settings, You must call PopulateModifiedSettings() to populate this collection The collection contains the list of settings that are either defined in the production, or have default setting overrides.
Production settings
Property SubProductions As list Of Ens.Config.Production(XMLNAME = "SubProduction", XMLPROJECTION = "ELEMENT", XMLREFERENCE = "id");
Enable testing infrastructure for the production.
This value can be overridden using System Default Settings.
Overriding by a matching System Default Setting will occur even if this value is defined in the production definition.
Contains the list of settings, value, value_type, default, default_type and other meta information Must call PopulateVirtualSettings() to populate this collection The format of value of each element is the following $lb(Target,Name,Value,ValueType,Default,DefaultType,Description,Type,MAXLEN,MINVAL,MAXVAL,VALUELIST,DISPLAYLIST,IsRequired)
|
|
This callback method is invoked by the%Delete method to provide notification that the object specified by oid is being deleted.If this method returns an error then the object will not be deleted.
This callback method is invoked by the%New method to provide notification that a new instance of an object is being created.If this method returns an error then the object will not be created.
It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:
Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.
Checksum used in updating production.
Create a HTML document containing the production configuration details. The HTML document appears in InterSystems online documentation style and provide links into the online documentation set in DOCBOOK.
How to use: Invoke this method passing the production name ProductionClass and a flag IncludeIntro to include a terminology introduction chapter (default is true). The method returns a status code. It also returns as output parameters the URL to display the documentation in a browser and the LogFileName to be checked in case an error occurs (if an error status code is returned).
Example:Once the documentation is created, it will be available to be viewed from the Productions page of the Management Portal, or by pointing a browser to the returned URL.Set status = ##class(Ens.Config.Production).CreateDocumentHTML("Demo.Loan.FindRateProduction",1,.URL,.ErrLog)
The document is built by applying a XSL transformation to create a document expressed as DocBook XML, then using the InterSystems' DocBook utilities to load the book.
The documentation may be removed by invokingRemoveDocumentHTML .
Create a PDF file containing the production configuration details. The generated PDF file allows customization of the cover page (logo image, company name and address) and of the colors used for the titles and links.
How to use: Invoke this method passing the production name ProductionClass, a flag IncludeIntro to include a terminology introduction chapter (default is true), the file name PDFFileName on the InterSystems IRIS server where the PDF output should be written to, and an optional array Params of customization parameters in case you wish to override the defaults.
The parameterPDFRenderer is deprecated and is ignored.
The built-in FOP renderer is used.
Examples:Set status = ##class(Ens.Config.Production).CreateDocumentPDF("Demo.Loan.FindRateProduction",1,"C:\Temp\DemoFindRate.pdf",.ErrLog)
Create and save a studio project that contains all the detectable elements of the named Production.
Create and save a studio project that contains all the detectable elements related to the named config item
Locate the config item matching the given config name. It may be a simple name or a fully qualified one as described in ParseConfigName()
The third parameter pForceSwizzle is used to force the call of an internal api if production is running to ensure items swizzled
Locate the first setting with a given name.
For given business class, return an array of business classes it talks to (left to right)
Get an array of all ports in use by the running Production. Value = config id|code|agentInterface Code "o" = TCP Outbound (in listen mode), "i" = TCP Inbound, "L" = Agent Listener Relay port, "C" = Agent Connect Relay port
Return a list of all the common static settings properties for the current Production. Or limit to just the static settings that can be overridden by System Default Settings.
This method loads the production from the XData of a class
Open the config item matching the given config name. It may be a simple name or a fully qualified one as described in ParseConfigName()
Call this method to initialize the ModifiedSettings collection. The collection includes Settings defined in production as well as those ones with default setting overrides.
Populate the VirtualSettings collection
API to convert the numeric production status value in pState into the corresponding text string. By default, the string is localized, but if pLocalize is passed in as 0, the English string is returned irrespective of the user's current language settings.
API to convert the text of a production status in pText into the corresponding state value, which serves as a partial inverse toProductionStateToText (). It only serves as a partial inverse as the status text can depend on the language settings at the time of the original conversion from a state integer to a status text. If the language is known, it can be supplied in pLanguage, otherwise it will default to the current language for the process.
Remove the HTML documentation for a given production in the current namespace. This method may be used in case you wish to remove the HTML documentation that was created for a given production.
Remove the given config item from the production
This method saves the production into the XData of the corresponding class
Wrapper method to ensure that we only increment the production modification counter when pProduction is currently running in this namespace.
This method updates the Settings collection with the data from pArray Settings collection is cleared first, then the entries in pArray is used to update it. The format of pArray is of the following: pArray = total number of entries pArray(i) = $lb(Target, Name, Value)
expandProjectArrayAuxiliary merges all the classes in pProjectItems into pExistingClasses before starting it also updates pExistingClasses with all the new classes it added before exiting
|
|
Selects AlertGroup As%String
Returns an alphabetically sorted list of all non-blank Alert Groups that are used by host items in the identified production.
Selects Category As%String
Returns an alphabetically sorted list of all non-blank category names that are used by host items in the identified production.
Selects Production As%String , ConfigName As%String , ClassName As%String , Comment As%String , Enabled As%Boolean
Enumerate all configuration item names whose underlying class is a subclass of the class specified by ClassName, for the given Production. This is used, for example, to list all business metrics within a given production, to support the DeepSee widget finder. It is more lightweight and faster than EnumerateConfigItems, but returns less data. If the Production string is an empty string ("") list all config item names of a particular class for all productions.
Selects ConfigName As%String , CommentOrClassName As%String , Enabled As%Boolean , BusinessType As%Integer , ClassName As%String , RequestClasses As%String , ResponseClasses As%String , Production As%String , ItemId As%Integer , SeqNum As%String , BusPartner As%String , Categories As%String , AlertGroups As%String
Enumerate all config items in the given Production. Passing ItemType restricts the results to only items of the given type, for example $$$eHostTypeService. Prefixing the type with a minus sign restricts the results to all except those of the given type, for example -$$$eHostTypeService. Passing PrimaryOnly=0 will return multiple items with the same name if any exist. Otherwise only the primary (i.e. enabled) item will be returned.
This is a system provided query that provides a result set containing every instance within this extent.
Selects Production As%String , Status As%String , LastStartTime As%String , LastStopTime As%String , StatusEnum As%String
|
|
|
|
Ensure we update the modified flag after SQL changes.