%SYSTEM.OBJ

Compiles the class or classes specified by the classes argument, which can be a single class name, a comma-separated list of class names, or a multidimensional array of class names. You can also use ? or * wildcards. If you wish to exclude items, pass ' before the item name; this syntax also supports wildcards, e.g. "User.*,'User.T*".

If recurse is true, then do not output the initial 'compiling' message or the compile report as this is being called inside another compile loop.

qspec is a list of flags or qualifiers, which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

By default, the method does not compile classes mapped from another database unless the qualifier '/mapped=1' is provided.

qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

Parameters

Each item on the list is suffixed by the type of item it is, so to compile a class and a routine, you could specify 'class.cls,routine.mac'

The order of compilation is INT, CLS, MAC, CSR, CSP.

qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'. Note that while /mapped=0 qualifier applies to the pattern passed in by only searching the default routine database, however any compile is done in the current namespace. So it is possible a routine/class found with /mapped=0 may not be visible in the current namespace or may be a different version if there are complicated package mappings.

Parameters

Parameters

Delete the definition of the given class or classes, specified by the classes argument from this namespace. This argument can be a single class name, a comma-separated list of class names, or a multidimensional array of class names. You can also use ? or * wildcards. If you wish to exclude items, pass ' before the item name; this syntax also supports wildcards, e.g. "User.*,'User.T*".

If the class to delete is persistent, include the 'e' flag or '/deleteextent' qualifier to delete the extent data and extent metadata. Refer to %ExtentMgr.Util for more information on extent metadata.

Parameters

Parameters

Parameters

Parameters

Write the in-memory state of a object referred to by oref to the console (the current device).

  Set person = ##class(Person).%OpenId(22)
  Do $system.OBJ.Dump(person)
  

Parameters

This method loops through all the classes, exporting them to the file filename. It restricts which classes are exported based on the qspec parameter.

Parameters

This method loops through all the classes, exporting each one as an individual XML file named after the classname to the directory dirname. If you specify a Package, then it exports only this package. If SubDir is true,, the method exports sub-packages as subdirectories.

Parameters

This method loops through all the classes, exporting them to a stream. It restricts the classes that are exported based on the qspec parameter.

Parameters

Export class classname to C++ files in directory dirname.

Export class classname to a Java file in directory dirname.

Search for classes in the package and export them. The search for classes respects the qspec passed. If the package is "*", the method searches for all classes in this namespace.

Export class package to a Java file in directory dirname.

Export class classname to ODL file with file name filename.

Export package package to an XML file with name filename.

Export package package to an XML file with name filename. If stream is passed in, then the data is appended to this stream. If it is "" when called, the method creates a stream and returns this.

If you pass a pattern of '*.cls', the method exports all classes in this namespace. If you pass a pattern of 'a*.mac', the method exports all MAC routines that start with the letter 'a'. If the filename ends in .gz or .gzip, the method automatically compresses the file with gzip.

Parameters

If you pass a pattern of '*.cls', the method exports all classes in this namespace. If you pass a pattern of 'a*.mac', the method exports all MAC routines that start with the letter 'a'.

Parameters

Parameters

Export document itemname to file filename in UDL format.

Search for classes in this namespace and put their names into the multidimensional array items.

qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'. The search for classes respects the qspec passed. It uses the following qualifiers:

• /application=1/0 - Include application classes
• /system=1/0 - Include system classes (ones with class attribute 'system' set to something other than zero)
• /percent=1/0 - Include percent classes
• /mapped=1/0 - Include classes mapped from other databases or just classes in default databases

------------------------------------------------------------------------------- Method: GetMPPOption Definition: This method returns the current value for the specified Macro Pre-Processor (MPP) Configuration Settings 'optionName' Options: The following is a list of currently supported Macro Pre-Processor Configuration Settings Options: optionName Description ------------------------- ----------------------------------- MPPParsingMode - The MPP's Parsing Mode {1 | 2} MacroMaxRecursionNoArg - The maximum allowed sub-string repetitions between $$$MACRO references (without arguments) of the same name {3...n} MacroMaxRecursionGotArg - The maximum allowed sub-string repetitions between $$$MACRO(...) references (with arguments) of the same name {10...n} ALL Get all 'optionName' values Notes: - See the 'SetMPPOption(...)' method for specific details about each of the 'optionName' values Invocation: This method can be invoked in the following ways: ObjectScript: $SYSTEM.OBJ.GetMPPOption(...) SQL: N/A Examples: The following examples shows the use of this method: #1 Get the current value for the 'MPPParsingMode' option of the Macro Pre-Processor Configuration Settings set optVal=$SYSTEM.OBJ.GetMPPOption("MPPParsingMode",.tSC) Data Storage: ^%SYS("MPP","Parsing") & ^%SYS("MPP","MacroRecursion") Parameters: optionName - The Pre-Processor (MPP) Configuration Settings 'option' name. The following is a list of currently supported Macro Pre-Processor Configuration Settings Options: - MPPParsingMode - MacroMaxRecursionNoArg - MacroMaxRecursionGotArg - ALL (Get all 'optionName' values) tSC - A Pass By Reference (PBR) parameter which returns the status from the invocation of this method getGloValue - 0 = Don't retrieve the value from the System-Global [DEFAULT] 1 = Retrieve the value from the System-Global NOTE: This parameter should be used for internal purposes only! RETURN Value: The current value of the specified Macro Pre-Processor (MPP) Configuration Settings 'optionName'. NOTE: If 'optionName' is passed the value "ALL", then return a $LIST(...) of a $LIST(...) of the following values for each of the valid 'optionName' values: $LIST($LIST(optionName,optionValue,tSC),...) -------------------------------------------------------------------------------

Search for classes in the package and put their names into the local array items. If the package is "*", then the method returns all classes in this namespace.

The method uses the qualifier in qspec /includesubpackages to determine if it searches inside a package to subpackages or not. qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

This imports all files found in a directory using the Load() method so it should be able to detect most common formats. If you pass it the compile flag ('c'), after loading it also compiles all these items. The other flags are the same as found in Load() except for the dir which is the directory to load and the recurse which determines if this looks into subdirectories or not.
You can limit the items it imports by specifying a wildcards value. For example '*.xml' imports only files that end in XML.

qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

• 0 - Check timestamps on class, so even if a description was modified this shows the class as out of date.
• 1 - Ignore changes to descriptions in checking up to date status, this is the default and is what the class compiler typically uses.
• 2 - Ignore changes to descriptions and method code in checking up-to-date status, this is useful to see if the class has 'structurally' changed in a way that would require a class referencing this via SQL to be recompiled

Load, and optionally compile (if 'c' flag is present), class definitions, CSP pages, routines, or globals from the file file. file may be a list of files to load separated with '*' symbols.

You can import files exported in XML format, %RO format, CDL format, UDL format, %GOF, and CSR/CSP files.

A comma-separated list of the items it loaded is returned in loadedlist. If the list is too long to fit in the variable, it is terminated with '...'. Items loaded are always returned as subscripts of the multidimensional loadedlist array.

If you pass listonly as true, the method does not import anything, but instead just lists the items that exist in file.

If selecteditems is defined, then this must contain either a comma-separated list of items to import or a multidimensional array. The method imports only items that are in this list from the file provided, so this provides a way to limit which items get imported.

qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

When loading a %RO file, the description variable is filled in with the description from the %RO file, if there is one present.

errorlog is a multidimensional array of the %Status return values from this call.

The displayname is normally not provided. If present, it changes the 'load file XYZ' name from the filename to the displayname. This is useful when loading a stream where the stream filename is not the name of the file the user knows from a client system and we want to present a meaningful name. If the filename ends in .gzip or .gz, the method uses ungzip to decompress this file before loading it.

Load and optionally compile (if 'c' flag is present) all class definitions within directory dir, this includes all .XML files. If the recurse is true, then it includes subdirectories. Returns a comma-separated list of the items it loaded in loadedlist and the same data also as loadedlist(name)="" in case the comma list is more than 32k. Note that this method compiles only *classes* found in these XML files and no other types. If you want to be able to compile anything, instead use the ImportDir().

qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

Load and, optionally compile (if 'c' flag is present), class definitions, CSP pages, routines or globals from the stream stream. Returns, by reference, a multidimensional array of the items it loaded in loadedlist. If you pass listonly as true, then it does not import anything but instead just lists the items that exist in the stream that you supply.
If selecteditems is defined, then this must contain a comma-separated list of items to import (or a multidimensional array). It imports only items that are in this list from the stream provided, so this provides a way to limit which items get imported.

qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

If fulldeploy is true, the method attempts to remove pretty much the entire class definition, leaving just the minimum so the class is runnable. This does not work on persistent, serial, datatype, or XML-enabled classes as these require access to the class definition at runtime in order to function.

Note that for a class to be deployed, it must be compiled; if you try to deploy a class which is not compiled it will report an error.

Create a new object instance of type ClassName and return a reference (OREF) to it.

Using this method, you can dynamically create objects, that is you can determine what type of object to create at run-time.

For example:

  Set obj = $System.OBJ.New("Person")
  

Load a persistent object instance of type ClassName and with OID value oid from disk and return a reference (OREF) to it.

For example:

  Set person = $System.OBJ.Open("Person",oid)
  

Load a persistent object instance of type ClassName and with ID value id from disk and return a reference (OREF) to it.

For example:

  Set person = $System.OBJ.OpenId("Person",22)
  

The Extent Index is an index on all persistent classes that are runnable in the current namespace. It is currently used by %BuildIndices, %KillExtent, and the %FindGUID utility method in %Library.GUID. Other uses may be added at a later time.

The index is maintained in the globals database in the current namespace. If the globals database in the current namespace is readonly, then an error is returned. The class compiler automatically maintains this index for classes compiled in the namespace. Classes mapped from other namespaces are not automatically added to or removed from the index when mapping changes or changes to the class runtime occur in the original namespace. Such changes must be updated in the local namespace's extent index by running a utility method. There are two methods: this method rebuilds the index completely and RebuildExtentIndexOne() rebuilds the index entries for only the specified class.

This method returns a status value indicating success or failure.

Parameters

This method updates the extent index for the specified class in the current namespace. If the globals database in the current namespace is readonly, then an error is returned. Call this method to rebuild the extent index for a single class in the current namespace. Refer to RebuildExtentIndex() for more information.

This method returns a status value indicating success or failure.

Parameters

If system is true, this method sets the default flags for this system; otherwise it sets the default flags for the current namespace. If flags are set for this namespace, these override any set for the system. These flags are combined with the built-in defaults to create the defaults used.

This method returns the new defaults after this change.

------------------------------------------------------------------------------- Method: SetMPPOption Definition: This method sets the specified Macro Pre-Processor (MPP) Configuration Settings 'optionName' to the specified 'optionValue'. This method also returns the original value via the PBR 'oldValue' parameter, along with the invocation status via the method's return value. Options: The following is a list of currently supported Macro Pre-Processor Configuration Settings Options: optionName/optionValue Description ------------------------- ----------------------------------- MPPParsingMode - The MPP's Parsing Mode {1 | 2} 1 - Standard Macro Pre-Processor Parsing [$$$MPPParsingModeStandard] 2 - Enhanced Macro Pre-Processor Parsing [$$$MPPParsingModeEnhanced] This mode supports $$$MACRO[(args)] Recursion Parsing [DEFAULT: 1 = $$$MPPParsingModeDefault] MacroMaxRecursionNoArg - The maximum allowed sub-string repetitions between $$$MACRO references (without arguments) of the same name {3...n} 3 - The minimum number to determine $$$MACRO Recursive Referencing or Self-Referencing n - This number can be increased, but should never need to be for $$$MACRO references without arguments [DEFAULT: 3 = $$$MacroMaxRecursionNoArgDefault] MacroMaxRecursionGotArg - The maximum allowed sub-string repetitions between $$$MACRO(...) references (with arguments) of the same name {10...n} 10 - The minimum number to determine $$$MACRO(...) Recursive Referencing or Self-Referencing n - This number can be increased for $$$MACRO(...) references (with arguments) that may exceed 10 nesting levels, but this should be very rare Example: $$$A($$$A($$$A(...))) [DEFAULT: 10 $$$MacroMaxRecursionGotArgDefault] Restriction: You must have the "USE" permission on the %Admin Manage Resource in order to change this MPP Configuration Setting. Notes: - Changing this MPP Configuration Setting affects all processes immediately. - This is a system-wide setting. Invocation: This method can be invoked in the following ways: ObjectScript: $SYSTEM.OBJ.SetMPPOption(...) SQL: N/A Examples: The following examples shows the use of this method: #1 Set the 'MPPParsingMode' option of the Macro Pre-Processor to the value two (2), which specifies the use of the Enhanced Parsing to check for $$$MACRO[(args)] Recursion: set tSC=$SYSTEM.OBJ.SetMPPOption("MPPParsingMode",2,.oldVal) Data Storage: ^%SYS("MPP","Parsing") & ^%SYS("MPP","MacroRecursion") Parameters: optionName - The Pre-Processor (MPP) Configuration Settings 'option' name. The following is a list of currently supported Macro Pre-Processor Configuration Settings Options: - MPPParsingMode - MacroMaxRecursionNoArg - MacroMaxRecursionGotArg optionValue - The value to set for the specified 'optionName' oldValue - A Pass By Reference (PBR) parameter which returns the old MPP Configuration Setting value RETURN Value: The status from the invocation of this method -------------------------------------------------------------------------------

The optional qspec argument is a qualifier string containing any of the following options:

For example:

  Do $System.OBJ.ShowClasses("/detail")
  

The optional qspec argument is a string containing any of the following characters:

For example:

  Do $System.OBJ.ShowObjects("/detail=1")
  

If chkObj is 1, the properties of any varibles that contain an object reference are also searched and displayed. Otherwise only non-object variables are searched.

The list has the base $STACK level of the variable, the internal stack level (as shown by the %STACK utility), and the variable name.

classes can be a single class, a comma-separated list, a multidimensional array of class names. You can also use ? or * wildcards. If you wish to exclude items, pass ' before the item name; this syntax also supports wildcard, e.g. "User.*,'User.T*".

qspec is a list of flags or qualifiers which can be displayed with 'Do $system.OBJ.ShowQualifiers()' and 'Do $system.OBJ.ShowFlags()'.

If you have defined a parameter in the classname which is specified as 'CONFIGVALUE' in the type keyword then this method allows this to be updated from the original value to a new value.

Note that this should be a rare event and not be used for any value that needs to be updated a lot, a global should be used for a rapidly updating value. The advantage of using a class parameter for a configuration value is that a very large number of processes can access this value using 'Set val=##class(ClassName).#ParamName' faster than access to a global.

classname

Name of the persistent class to validate indices for.

idxList

Optional. "" to check all indices, or specify a $list of index names to check. Default=""

autoCorrect

Optional. If true, correct any errors found. Default=0

lockOption

Optional. Default = 1 0 - No locking is performed at all 1 - Shared locking as each row is checked 2 - exclusive lock on entire table for duration of the run

multiProcess

Optional. If true, parts of %ValidateIndices() use parallel processing when possible. Default=0

verbose

Optional. If true, display output to the current device. Default=1. When called for a sharded class, verbose is force to 0.

errors

Optional. Passed by reference. Returns a multidimensional array of errors found in the index(es) validated. If autoCorrect=1, this is a multidimensional array of issues corrected.

Returns:

Example:

Note::
Indices may also be validated by calling the class method ##class(classname).%ValidateIndices(idxList,autoCorrect,lockOption,verbose).
There is one main difference between validating indices through $SYSTEM.OBJ.ValidateIndices() and ##class(classname).%ValidateIndices().
$SYSTEM.OBJ.ValidateIndices() validates the indices for a table, and also validates any indices in collection child tables for that table.
When using ##class(classname).%ValidateIndices(), collection child table indices must be checked with separate calls.
Also, when calling $SYSTEM.OBJ.ValidateIndices(), multiProcess default is 0. When calling ##class(classname).%ValidateIndices(), multiProcess default is 1.