Skip to main content

%Api.InteropEditors.v8.impl

class %Api.InteropEditors.v8.impl extends %Api.InteropEditors.v7.impl

Interoperability Editor API for InterSystems IRIS
Business logic class defined by OpenAPI in %Api.InteropEditors.v8.spec
Updated Oct 20, 2026 10:56:07

Method Inventory

Parameters

parameter ExposeServerExceptions = 0;
If ExposeServerExceptions is true, then details of internal errors will be exposed.

Methods

classmethod AddSchema(namespace As %String, schema As %String, newName As %String, baseCategory As %String, newDesc As %DynamicObject) as %DynamicObject
Add a schema category.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
newName, New category name
baseCategory, Category to base new category name
newDesc, New category description
classmethod AssignWorkflowTask(namespace As %String, taskId As %String, requestBody As %DynamicObject) as %DynamicObject
(%Ens_WorkflowConfig:WRITE) Assign or reassign a workflow task to a user
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
taskId
requestBody
classmethod CancelSearch(namespace As %String, searchID As %String) as %DynamicObject
Modify existing search
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
searchID, Search id of search
classmethod CancelWorkflowTask(namespace As %String, taskId As %String) as %DynamicObject
(%Ens_WorkflowConfig:WRITE) Cancel a workflow task
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
taskId
classmethod CompileBPL(namespace As %String, bplClass As %String) as %DynamicObject
Compile this BPL class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
bplClass, Name of the ObjectScript class in which this BPL is defined.
classmethod CompileDTL(namespace As %String, dtlClass As %String) as %DynamicObject
Compile this DTL class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dtlClass, Name of the ObjectScript class in which this DTL is defined.
classmethod CompileRule(namespace As %String, ruleClass As %String) as %DynamicObject
Compile this rule class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
classmethod DeleteBusinessPartner(namespace As %String, name As %String) as %DynamicObject
(%Ens_ProductionConfig:W) Delete a business partner
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
name
classmethod DeleteCodeTableElements(namespace As %String, schema As %String, category As %String, table As %String) as %DynamicObject
(%Ens_EDISchema:WRITE) Delete a code table
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name code table is under.
table, code table name to get elements for.
classmethod DeleteDataStructureElements(namespace As %String, schema As %String, category As %String, data As %String) as %DynamicObject
(%Ens_EDISchema:WRITE) Delete a data structure
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name data structure is under.
data, data structure name to get elements for.
classmethod DeleteDefaultSetting(namespace As %String, id As %String) as %DynamicObject
Delete a system default setting.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
id, The composite ID of the default setting (ProductionName||ItemName||HostClassName||SettingName)
classmethod DeleteDocTypeStructureTree(namespace As %String, schema As %String, category As %String, docType As %String) as %DynamicObject
(%Ens_EDISchema:WRITE) Delete a document structure
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name document structure is under.
docType, document structure name to get details for.
classmethod DeleteEnterpriseSystem(namespace As %String, name As %String) as %DynamicObject
(%Ens_MsgBank:W) Delete an enterprise system client connection
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
name
classmethod DeleteLookupTable(namespace As %String, lookupTableName As %String) as %DynamicObject
Delete this lookup table.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
lookupTableName, Name of the lookup table.
classmethod DeleteMessageTypeStructure(namespace As %String, schema As %String, category As %String, docType As %String) as %DynamicObject
(%Ens_EDISchema:WRITE) Delete a message type
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name message type is under.
docType, message type name to get details for.
classmethod DeleteSavedMessageSearch(namespace As %String, searchName As %String) as %DynamicObject
Delete Saved Message Search
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
searchName, Name of message search.
classmethod DeleteSchedule(namespace As %String, name As %String) as %DynamicObject
(%Ens_ProductionConfig:W) Delete a schedule
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
name
classmethod DeleteSchema(namespace As %String, schema As %String, category As %String) as %DynamicObject
Delete a schema category.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category to delete
classmethod DeleteSegmentElements(namespace As %String, schema As %String, category As %String, segment As %String) as %DynamicObject
(%Ens_EDISchema:WRITE) Delete a segment
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name segment is under.
segment, segment name to get elements for.
classmethod DeleteWorkflowRole(namespace As %String, role As %String) as %DynamicObject
(%Ens_WorkflowConfig:W) Delete a workflow role
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
role
classmethod DeleteWorkflowRoleUser(namespace As %String, role As %String, user As %String) as %DynamicObject
(%Ens_WorkflowConfig:W) Remove a user's membership in this role
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
role
user
classmethod DeleteWorkflowUser(namespace As %String, user As %String) as %DynamicObject
(%Ens_WorkflowConfig:W) Delete a workflow user
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
user
classmethod DispatchPlugin(namespace As %String, pluginPath As %String) as %Stream.Object
Dispatch to plugin endpoint.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
pluginPath, Path of the plugin endpoint to hit.
classmethod ExportLookupTable(namespace As %String, FileExportInfo As %DynamicObject, ignoreConflict As %Boolean) as %DynamicObject
Export lookup table on the server
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
FileExportInfo, JSON object containing the class name and server target file path where the export should go
ignoreConflict, Overwrite this class if it exists, ignoring conflicts.
classmethod GenerateDTLExplanation(namespace As %String, dtlClass As %String) as %DynamicObject
Generate an explanation for a given DTL class
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dtlClass, Name of the ObjectScript class in which this DTL is defined.
classmethod GetAllConnections(namespace As %String, productionClass As %String) as %DynamicObject
Get a list of all connections for this production
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
classmethod GetAllConnectionsById(namespace As %String, productionClass As %String, hostID As %String, hostName As %String, inbound As %Boolean, outbound As %Boolean) as %DynamicObject
Get a list of connections for this production and host id.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostID, Id of the host of production
hostName, Host name to get connections for.
inbound, Flag to get inbound connections
outbound, Flag to get outbound connections.
classmethod GetAutoStart(namespace As %String) as %DynamicObject
(%Ens_ProductionConfig:R) View the auto start settings in this namespace
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetAutoStartList(namespace As %String) as %DynamicObject
(%Ens_ProductionConfig:R) View the productions set to auto-start across namespaces
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetBPL(namespace As %String, bplClass As %String) as %DynamicObject
Get this BPL class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
bplClass, Name of the ObjectScript class in which this BPL is defined.
classmethod GetBPLContextDataTypes(namespace As %String) as %DynamicObject
Get all the BPL context property data types grouped into local, persistent, system and dataType groups
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetBPLContextMetadata(namespace As %String, dataType As %String) as %DynamicObject
Get additional metadata on a specific context data type
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dataType, The data type whose meta data we want.
classmethod GetBPLContextSuperclasses(namespace As %String) as %DynamicObject
Get a list of all the BPL context superclasses available in a given namespace
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetBPLHosts(namespace As %String, productionClass As %String) as %DynamicObject
Get all the operations, processes and components of a given production
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
classmethod GetBPLMessageClasses(namespace As %String, production As %String, host As %String) as %DynamicObject
Get a list of all the message classes available in a given namespace or for a particular host in a production
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
production, The production that contains the host in question
host, The host whose message classes we want to find
classmethod GetBPLPreferences(namespace As %String) as %DynamicObject
Get the current user's BPL preferences
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetBPLSegments(namespace As %String, modes As %String, classes As %String, docTypes As %String, extraDetails As %Boolean) as %DynamicObject
Get all the segments and fields for a list of field names
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
modes, A comma-delimited list of the top field names
classes, A comma-delimited list of the class names of each top field name
docTypes, A comma-delimited list of the doc types of each class
extraDetails, Whether to include extra schema details eg description, valuelist, optional
classmethod GetBusinessClassList(namespace As %String, classNameType As %String) as %DynamicObject
Get a list of business classes by type
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classNameType, Business classname type.
classmethod GetBusinessPartner(namespace As %String, name As %String) as %DynamicObject
(%Ens_ProductionConfig:R) Get a business partner
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
name
classmethod GetBusinessPartners(namespace As %String) as %DynamicObject
Get a list of business partners.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetCategories(namespace As %String, productionClass As %String) as %DynamicObject
Get a list of user-defined categories for this production.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
classmethod GetClassPackages(namespace As %String) as %DynamicObject
Get a list of all class packages in the hierarchy
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetClassSummaries(namespace As %String) as %DynamicObject
Get summaries of non-hidden classes in this namespace.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetCodeTableElements(namespace As %String, schema As %String, category As %String, table As %String) as %DynamicObject
Get elements of given code table in given schema category
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name code table is under.
table, code table name to get elements for.
classmethod GetComplexTypeStructure(namespace As %String, schema As %String, category As %String, structure As %String) as %DynamicObject
Get complex types of a structure in given schema category
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name complex type is under.
structure, complex type structure name to get elements for.
classmethod GetCompositeStructureElements(namespace As %String, schema As %String, category As %String, structure As %String) as %DynamicObject
Get elements of given composite data structure in given schema category
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name composite data structure is under.
structure, composite data structure name to get elements for.
classmethod GetConstraintOptions(namespace As %String, assistClass As %String, constraints As %DynamicArray) as %DynamicObject
Get a list of constraint options for this rule type.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
assistClass, Rule type, in the form of an assist class.
constraints, Constraints to get options for.
classmethod GetContextInputs(namespace As %String, contextClass As %String) as %DynamicObject
Get information on this context class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
contextClass, Name of the ObjectScript class used as a context class for a rule.
classmethod GetContextSearchOptions(namespace As %String, option As %String, searchParameters As %DynamicObject) as %DynamicObject
Get a list of all options by context search function
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
option, The function for context search to return options.
searchParameters, Parameters for context search function.
classmethod GetContextTypes(namespace As %String, contextClass As %String) as %DynamicObject
Get list of context types
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
contextClass, Name of the ObjectScript class used as a context class for a rule.
classmethod GetDTL(namespace As %String, dtlClass As %String) as %DynamicObject
Get this DTL class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dtlClass, Name of the ObjectScript class in which this DTL is defined.
classmethod GetDTLFunctions(namespace As %String) as %DynamicObject
Get the DTL functions
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetDTLSegments(namespace As %String, extraDetails As %Boolean) as %DynamicObject
Get all the segments and fields for source and target classes
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
extraDetails, Whether to include extra schema details eg description, valuelist, optional
classmethod GetDTLSourceTargetClasses(namespace As %String) as %DynamicObject
Get a list of all classes that could be used as DTL source/target in the groups Message, Virtual Documents, Persistent, Non-System
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetDTLTestInfo(namespace As %String, dtlClass As %String) as %DynamicObject
Get test-related information for this user on this DTL class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dtlClass, Name of the ObjectScript class in which this DTL is defined.
classmethod GetDataStructureElements(namespace As %String, schema As %String, category As %String, data As %String) as %DynamicObject
Get elements of given data structure in given schema category
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name data structure is under.
data, data structure name to get elements for.
classmethod GetDefaultDir(namespace As %String) as %DynamicObject
Get the user's default directory
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetDefaultSetting(namespace As %String, id As %String) as %DynamicObject
Get a specific system default setting by ID.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
id, The composite ID of the default setting (ProductionName||ItemName||HostClassName||SettingName)
classmethod GetDefaultSettings(namespace As %String, productionName As %String, itemName As %String, hostClassName As %String, settingName As %String) as %DynamicObject
Get a list of system default settings.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionName, Filter by production name (supports wildcards)
itemName, Filter by item name (supports wildcards)
hostClassName, Filter by host class name (supports wildcards)
settingName, Filter by setting name (supports wildcards)
classmethod GetDocTypeStructureTree(namespace As %String, schema As %String, category As %String, docType As %String) as %DynamicObject
Get structure of a given doc type in given schema category
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name document structure is under.
docType, document structure name to get details for.
classmethod GetDocTypeValidationStructure(namespace As %String, schema As %String, category As %String, docType As %String) as %DynamicObject
Get validation structure of a given doc type in given schema category
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name document structure is under.
docType, document structure name to get validation structure for.
classmethod GetDocTypeValidationStructureGetChildren(Output children, response, numChild As %Integer, qStart As %String, nestLevel As %Integer)
classmethod GetDocTypes(namespace As %String, assistClassName As %String) as %DynamicObject
Get a list of doctype names and categories for specified assist class
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
assistClassName, Rule type in the form of an assist class name.
classmethod GetDocTypesForClass(namespace As %String, messageClass As %String) as %DynamicObject
Get a list of all the document types that are available for a given message class grouped by version/type
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
messageClass, Name of a message class
classmethod GetEnterpriseSystem(namespace As %String, name As %String) as %DynamicObject
(%Ens_MsgBank:R) Get an enterprise system client connection
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
name
classmethod GetExpiry() as %DynamicObject
Get the expiry of the current session
classmethod GetFoldersInPath(namespace As %String, dir As %DynamicObject) as %DynamicObject
Get files within a given path
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dir, Path to retrieve files from.
classmethod GetGroupStructure(namespace As %String, schema As %String, category As %String, structure As %String) as %DynamicObject
Get group structures of a structure in given schema category
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name group structure is under.
structure, group structure name to get elements for.
classmethod GetHostSettings(namespace As %String, productionClass As %String, hostType As %String, className As %String, hostName As %String) as %DynamicObject
Get a list of settings for this host includng defaults.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostType, Type of host, Service Process Operation
className, Classname of host
hostName, Optional host name.
classmethod GetHostSettingsOptions(namespace As %String, hostName As %String) as %DynamicObject
Get a list of host settings for specific host.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
hostName, Name of a host
classmethod GetHostsWithDefaultSetting(namespace As %String, settingName As %String, productionClass As %String) as %DynamicObject
Get list of hosts with defaultSetting.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
settingName, SettingName
productionClass, Name of the ObjectScript class in which this production definition is defined.
classmethod GetInputPluginsList(namespace As %String) as %DynamicObject
Get list of input plugins.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetJobs(namespace As %String, productionClass As %String, hostName As %String) as %DynamicObject
Get jobs for host or production
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostName, Name of a host
classmethod GetLanguage() as %DynamicObject
Get the language for this session
classmethod GetLog(namespace As %String, productionClass As %String, hostName As %String) as %DynamicObject
Get log for host or production
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostName, Name of a host
classmethod GetLookupTable(namespace As %String, lookupTableName As %String) as %DynamicObject
Get this lookup table.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
lookupTableName, Name of the lookup table.
classmethod GetLookupTables(namespace As %String, includeMetadata As %Boolean) as %DynamicObject
Get a list of lookup tables in this namespace.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
includeMetadata, Whether to include metadata
classmethod GetMessage(namespace As %String, headerID As %String) as %DynamicObject
Get Message
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
headerID, Header ID of message.
(%Ens_MsgBankConfig:R) View the Message Bank Link
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetMessageSourceTargets(namespace As %String) as %DynamicObject
Get targets and sources for messages
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetMessageTypeStructure(namespace As %String, schema As %String, category As %String, docType As %String) as %DynamicObject
Get message type of a given doc type in given schema category
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name message type is under.
docType, message type name to get details for.
classmethod GetMessages(namespace As %String, productionClass As %String, hostName As %String) as %DynamicObject
Get messages for host or production
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostName, Name of a host
classmethod GetMgmtUrl(namespace As %String) as %DynamicObject
Get the 'path' portion of the Interoperability management URL for a given namespace.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetPackages(namespace As %String) as %DynamicObject
Get a list of defined packages.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetPermissions(type As %ListOfDataTypes(ELEMENTTYPE="%String")) as %DynamicObject
Get a list of permissions for the current user and namespaces they can access eg /%SYS/permissions?type=dtl&type=rule
The method arguments hold values for:
type, The kind of permissions (optional) eg dtl, rule
classmethod GetProcesses(namespace As %String, mode As %String) as %DynamicObject
Get a list of business processes in the namespace
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
mode, The mode of processes to fetch (optional).Supported value is bpl
classmethod GetProduction(namespace As %String, productionClass As %String) as %DynamicObject
Get this production class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
classmethod GetProductionConfigItems(namespace As %String, production As %String, targets As %Boolean) as %DynamicObject
Get a list of production configuration items.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
production, Get the configuration items for only this production.
targets, Only get the configuration items of type 'target'.
classmethod GetProductionHost(namespace As %String, productionClass As %String, hostName As %String) as %DynamicObject
Get existing host for production by host name.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostName, Name of a host
classmethod GetProductionItems(namespace As %String) as %DynamicObject
Get a list of production items in rule.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetProductionStatus(namespace As %String) as %DynamicObject
Get production status.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetProductions(namespace As %String) as %DynamicObject
Get a list of productions.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetPropertyList(namespace As %String, assistClassName As %String, searchProperties As %DynamicArray) as %DynamicObject
Get the property list for this rule type.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
assistClassName, Rule type in the form of an assist class name.
searchProperties, Search context and key for property list
classmethod GetPurgeDataSettings(namespace As %String) as %DynamicObject
(%Ens_PurgeSettings:R) View the current purge data settings
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetQueue(namespace As %String, productionClass As %String, hostName As %String) as %DynamicObject
Get queue for host or production
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostName, Name of a host
classmethod GetRecommendedAutoStartPriority(namespace As %String, production As %String) as %DynamicObject
(%Ens_ProductionConfig:R) Get the recommended auto-start priority for a production in this namespace
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
production, The production to get the recommended auto-start priority for
classmethod GetRule(namespace As %String, ruleClass As %String) as %DynamicObject
Get this rule class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
classmethod GetRuleTypeSchema(namespace As %String, assistClassName As %String) as %DynamicObject
Get the schema for this rule type.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
assistClassName, Rule type in the form of an assist class name.
classmethod GetRuleTypes(namespace As %String) as %DynamicObject
Get a list of rule types available on the server.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetRules(namespace As %String) as %DynamicObject
Get a list of rule classes available on the server.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod GetSchedule(namespace As %String, name As %String) as %DynamicObject
(%Ens_ProductionConfig:R) Get a schedule
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
name
classmethod GetSchemaCategories(namespace As %String, schema As %String) as %DynamicObject
Get a list of categories and their structure names and descriptions for schema.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
classmethod GetSearchResults(namespace As %String, searchID As %String, offset As %String, limit As %String) as %DynamicObject
Get messages for in progress message search.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
searchID, Search id to get search results
offset, Number of records to skip to begin search
limit, Number of records to return
classmethod GetSegmentElements(namespace As %String, schema As %String, category As %String, segment As %String) as %DynamicObject
Get elements of given segment in given schema category
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name segment is under.
segment, segment name to get elements for.
classmethod GetSegmentTypes(namespace As %String, className As %String) as %DynamicObject
Get a list of segment names for specified class
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
className, Class name.
classmethod GetSegmentValidationStructure(namespace As %String, schema As %String, category As %String, docType As %String, ordinal As %String) as %DynamicObject
Get validation structure of a segment at a given ordinal in given doc type in given schema category
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name document structure is under.
docType, document structure name to get validation structure for.
ordinal, ordinal of segment to get validation structure for.
classmethod GetSegmentValidationStructureHelper(category, schema, pRef, pSet As %String, pSegIDX As %Integer, tSegID As %String, pEleIDX As %Integer, pEleDesc As %String, pComIDX As %Integer = 0, pComDesc As %String = "") as %DynamicObject
classmethod GetSegmentValidationStructureHelperCompSyntaxRule(pRule As %String) as %DynamicObject
classmethod GetSegmentValidationStructureHelperUnusedComp(schema, docType, tSE, tEleDesc, pRef) as %DynamicObject
classmethod GetSettingsOptions(namespace As %String, productionClass As %String) as %DynamicObject
Get a list of settings options.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
classmethod GetSimpleTypeStructure(namespace As %String, schema As %String, category As %String, structure As %String) as %DynamicObject
Get simple types of a structure in given schema category
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name simple type is under.
structure, simple type structure name to get elements for.
classmethod GetSubSegOrdInfo(namespace As %String, schema As %String, category As %String, docType As %String, subSeg As %String, path As %DynamicObject) as %DynamicObject
Get the list of ordinals and their respective info of a segment at a given path in doctype tree
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name document structure is under.
docType, document structure name to get validation structure for.
subSeg, subseg to get validation structure for.
path, Path at which subSeg can be found within doctype tree
classmethod GetSystemMode() as %DynamicObject
Get the system mode of this instance.
classmethod GetTargetRequestTypes(namespace As %String, productionClass As %String, target As %String) as %DynamicObject
Get list of request types for production and target.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
target, Name or classname of host.
classmethod GetTestingInputs(namespace As %String, ruleClass As %String) as %DynamicObject
Get information on this class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
classmethod GetTrace(namespace As %String, sessionid As %String, filterParameters As %DynamicObject) as %DynamicObject
Get trace information for session
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
sessionid, Session id to retrieve trace.
filterParameters, Parameters to filter data.
classmethod GetTransforms(namespace As %String, mode As %String) as %DynamicObject
Get a list of data transforms.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
mode, The mode of transforms to fetch (optional).Supported value is dtl
classmethod GetWorkflowRole(namespace As %String, role As %String) as %DynamicObject
(%Ens_WorkflowConfig:READ) Get a workflow role
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
role
classmethod GetWorkflowRoleUser(namespace As %String, role As %String, user As %String) as %DynamicObject
(%Ens_WorkflowConfig:READ) Get a user's membership in this role
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
role
user
classmethod GetWorkflowTask(namespace As %String, taskId As %String) as %DynamicObject
(%Ens_MessageContent:U) View the details of a specific workflow task
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
taskId
classmethod GetWorkflowUser(namespace As %String, user As %String) as %DynamicObject
(%Ens_WorkflowConfig:READ) Get a workflow user
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
user
classmethod ImportLookupTables(namespace As %String, LookupImportFileSelection As %DynamicObject) as %DynamicObject
Import lookup tables
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
LookupImportFileSelection, JSON object containing file name and selected files (if not legacy) of the lookup table XML (new) or LUT (legacy) files.
classmethod ListEnterpriseSystems(namespace As %String) as %DynamicObject
(%Ens_MsgBank:READ) View a list of enterprise system client connections
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod ListSchedules(namespace As %String) as %DynamicObject
(%Ens_ProductionConfig:READ) View a list of available schedules
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod ListWorkflowRoleTasks(namespace As %String, role As %String) as %DynamicObject
(%Ens_WorkflowConfig:READ) View a list of tasks assigned to this role
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
role
classmethod ListWorkflowRoleUsers(namespace As %String, role As %String) as %DynamicObject
(%Ens_WorkflowConfig:READ) View a list of users holding this role
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
role
classmethod ListWorkflowRoles(namespace As %String) as %DynamicObject
(%Ens_WorkflowConfig:READ) View a list of workflow roles
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod ListWorkflowTasks(namespace As %String) as %DynamicObject
(%Ens_Portal:U) View a list of workflow tasks
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod ListWorkflowUserRoles(namespace As %String, user As %String) as %DynamicObject
(%Ens_WorkflowConfig:READ) View a list of roles held by this user
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
user
classmethod ListWorkflowUserTasks(namespace As %String, user As %String) as %DynamicObject
(%Ens_WorkflowConfig:READ) View a list of tasks assigned to this user
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
user
classmethod ListWorkflowUsers(namespace As %String) as %DynamicObject
(%Ens_WorkflowConfig:READ) View a list of workflow roles
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod ListWorkflowWorklist(namespace As %String) as %DynamicObject
(%Ens_Portal:U) View the current workflow worklist
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod Logout() as %Stream.Object
Terminate CSP Session.
classmethod PostBPL(namespace As %String, bplClass As %String, BPL As %DynamicObject, ignoreErrors As %Boolean) as %DynamicObject
Create a new BPL class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
bplClass, Name of the ObjectScript class in which this BPL is defined.
BPL, JSON object representation of the BPL class.
ignoreErrors, Whether to proceed despite errors
classmethod PostBPLPreferences(namespace As %String, bplPreferences As %DynamicObject) as %DynamicObject
Create/update the current user's BPL preferences
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
bplPreferences, Object containing gridlines, showAnnotations, autoArrange preferences and lastBPL for a user
classmethod PostDTL(namespace As %String, dtlClass As %String, DTL As %DynamicObject) as %DynamicObject
Create a new DTL class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dtlClass, Name of the ObjectScript class in which this DTL is defined.
DTL, JSON object representation of the DTL class.
classmethod PostDefaultSetting(namespace As %String, settingDetails As %DynamicObject) as %DynamicObject
Create a new system default setting.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
settingDetails, Default setting definition
classmethod PostLookupTable(namespace As %String, lookupTableName As %String, LookupTable As %DynamicObject) as %DynamicObject
Create a new lookup table document.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
lookupTableName, Name of the lookup table.
LookupTable, JSON object representation of the lookup table.
classmethod PostProduction(namespace As %String, productionClass As %String, productionDetails As %DynamicObject) as %DynamicObject
Create new production class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
productionDetails, Fields to create production.
classmethod PostRule(namespace As %String, ruleClass As %String, ruleDefinition As %DynamicObject) as %DynamicObject
Create a new rule class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
ruleDefinition, Definition which defines the contents of a rule class.
classmethod PutAutoStart(namespace As %String, requestBody As %DynamicObject) as %DynamicObject
(%Ens_ProductionConfig:W) Set the auto start settings in this namespace
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
requestBody
classmethod PutBPL(namespace As %String, bplClass As %String, BPL As %DynamicObject, ignoreConflict As %Boolean, ignoreErrors As %Boolean) as %DynamicObject
Overwrite this BPL class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
bplClass, Name of the ObjectScript class in which this BPL is defined.
BPL, JSON object representation of the BPL class.
ignoreConflict, Overwrite this class if it exists, ignoring conflicts.
ignoreErrors, Whether to proceed despite errors
classmethod PutBusinessPartner(namespace As %String, name As %String, requestBody As %DynamicObject) as %DynamicObject
(%Ens_ProductionConfig:W) Update/save a business partner
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
name
requestBody
classmethod PutCodeTableElements(namespace As %String, schema As %String, category As %String, table As %String, requestBody As %DynamicObject) as %DynamicObject
(%Ens_EDISchema:WRITE) Create or update the elements of a code table
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name code table is under.
table, code table name to get elements for.
requestBody
classmethod PutDTL(namespace As %String, dtlClass As %String, DTL As %DynamicObject, ignoreConflict As %Boolean) as %DynamicObject
Overwrite this DTL class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dtlClass, Name of the ObjectScript class in which this DTL is defined.
DTL, JSON object representation of the DTL class.
ignoreConflict, Overwrite this class if it exists, ignoring conflicts.
classmethod PutDataStructureElements(namespace As %String, schema As %String, category As %String, data As %String, requestBody As %DynamicObject) as %DynamicObject
(%Ens_EDISchema:WRITE) Create or update the elements of a data structure
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name data structure is under.
data, data structure name to get elements for.
requestBody
classmethod PutDefaultSetting(namespace As %String, id As %String, settingUpdates As %DynamicObject) as %DynamicObject
Update a system default setting.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
id, The composite ID of the default setting (ProductionName||ItemName||HostClassName||SettingName)
settingUpdates, Default setting update
classmethod PutDocTypeStructureTree(namespace As %String, schema As %String, category As %String, docType As %String, requestBody As %DynamicObject) as %DynamicObject
(%Ens_EDISchema:WRITE) Create or update a document structure
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name document structure is under.
docType, document structure name to get details for.
requestBody
classmethod PutEnterpriseSystem(namespace As %String, name As %String, requestBody As %DynamicObject) as %DynamicObject
(%Ens_MsgBank:W) Update/save an enterprise system client connection
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
name
requestBody
classmethod PutHostClass(namespace As %String, productionClass As %String, hostName As %String, classNameHostID As %DynamicObject) as %DynamicObject
Update class for host in production
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostName, Name of a host
classNameHostID, Object with classname and hostid
classmethod PutLookupTable(namespace As %String, lookupTableName As %String, LookupTable As %DynamicObject, ignoreConflict As %Boolean) as %DynamicObject
Overwrite this lookup table.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
lookupTableName, Name of the lookup table.
LookupTable, JSON object representation of the lookup table.
ignoreConflict, Overwrite this class if it exists, ignoring conflicts.
(%Ens_MsgBankConfig:W) Set the Message Bank Link
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
requestBody
classmethod PutMessageTypeStructure(namespace As %String, schema As %String, category As %String, docType As %String, requestBody As %DynamicObject) as %DynamicObject
(%Ens_EDISchema:WRITE) Create or update a message type
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name message type is under.
docType, message type name to get details for.
requestBody
classmethod PutPurgeDataSettings(namespace As %String, requestBody As %DynamicObject) as %DynamicObject
(%Ens_PurgeSettings:W) Update the purge data settings
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
requestBody
classmethod PutRule(namespace As %String, ruleClass As %String, ruleDefinition As %DynamicObject, ignoreConflict As %Boolean) as %DynamicObject
Overwrite this rule class.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
ruleDefinition, Definition which defines the contents of a rule class.
ignoreConflict, Overwrite this class if it exists, ignoring conflicts.
classmethod PutSchedule(namespace As %String, name As %String, requestBody As %DynamicObject) as %DynamicObject
(%Ens_ProductionConfig:W) Update/save a schedule
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
name
requestBody
classmethod PutSegmentElements(namespace As %String, schema As %String, category As %String, segment As %String, requestBody As %DynamicObject) as %DynamicObject
(%Ens_EDISchema:WRITE) Create or update the elements of a segment
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
schema, Name of schema to get info for.
category, Category name segment is under.
segment, segment name to get elements for.
requestBody
classmethod PutWorkflowRole(namespace As %String, role As %String, requestBody As %DynamicObject) as %DynamicObject
(%Ens_WorkflowConfig:WRITE) Update/save a workflow role
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
role
requestBody
classmethod PutWorkflowRoleUser(namespace As %String, role As %String, user As %String, requestBody As %DynamicObject) as %DynamicObject
(%Ens_WorkflowConfig:W) Update/save a user's membership in this role
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
role
user
requestBody
classmethod PutWorkflowUser(namespace As %String, user As %String, requestBody As %DynamicObject) as %DynamicObject
(%Ens_WorkflowConfig:W) Update/save a workflow user
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
user
requestBody
classmethod ResendMessages(namespace As %String, messageIDs As %DynamicObject, headOfQueue As %Boolean) as %DynamicObject
Resend one or more messages
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
messageIDs, Message IDs to resend
headOfQueue, Option to resend message(s) to head of queue
classmethod ResetProductionItemSettings(namespace As %String, productionClass As %String, hostID As %String, resetSettings As %DynamicObject) as %DynamicObject
Reset default settings
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostID, Id of the host of production
resetSettings, List of settings to reset
classmethod SaveMessageSearch(namespace As %String, filterParameters As %DynamicObject, searchName As %String) as %DynamicObject
Save Message Search
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
filterParameters, Filter object to save.
searchName, Name of message search.
classmethod SaveProductionHost(namespace As %String, productionClass As %String, hostName As %String, itemSettings As %DynamicObject) as %DynamicObject
Create new host for production.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostName, New host name
itemSettings, Settings for host or production
classmethod SaveProductionHostSettings(namespace As %String, productionClass As %String, hostID As %String, itemSettings As %DynamicObject) as %DynamicObject
Update settings for host or production.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostID, Current Host ID
itemSettings, Setting updates for host or production
classmethod SavedSearches(namespace As %String) as %DynamicObject
Get saved searches for user
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod SearchHistory(namespace As %String) as %DynamicObject
Get search history for user
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod SetLanguage(language As %String) as %DynamicObject
Set the language for this session
The method arguments hold values for:
language, Language code to set for this session.
classmethod SourceControlAfterUserAction(namespace As %String, sourceControlRequestBody As %DynamicObject) as %DynamicObject
Requests Source Control After User Action for the given parameters
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
sourceControlRequestBody, The parameters for the requested Source Control function
classmethod SourceControlEnabled(namespace As %String) as %DynamicObject
Returns enabled true or false if Source Control Enabled for the namespace
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
classmethod SourceControlGetMenus(namespace As %String, sourceControlRequestBody As %DynamicObject) as %DynamicObject
Returns Source Control Menu for the given parameters
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
sourceControlRequestBody, The parameters for the requested Source Control function
classmethod SourceControlGetStatus(namespace As %String, sourceControlRequestBody As %DynamicObject) as %DynamicObject
Requests Source Control GetStatus for the given parameters
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
sourceControlRequestBody, The parameters for the requested Source Control function
classmethod SourceControlUserAction(namespace As %String, sourceControlRequestBody As %DynamicObject) as %DynamicObject
Requests Source Control User Action for the given parameters
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
sourceControlRequestBody, The parameters for the requested Source Control function
classmethod StartMessageSearch(namespace As %String, filterParameters As %DynamicObject) as %DynamicObject
Initiate message search.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
filterParameters, Filter to search and filter data.
classmethod TestDTL(namespace As %String, dtlClass As %String) as %DynamicObject
Run DTL and return logs
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
dtlClass, Name of the ObjectScript class in which this DTL is defined.
classmethod TestProductionTarget(namespace As %String, productionClass As %String, target As %String, hostTestMessage As %DynamicObject) as %DynamicObject
Run test for production target and return logs
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
target, Target name.
hostTestMessage, Defines test parameters for production host target.
classmethod TestRule(namespace As %String, ruleClass As %String, ruleTestMessage As %DynamicObject) as %DynamicObject
Run rule and return logs
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
ruleClass, Name of the ObjectScript class in which this rule definition is defined.
ruleTestMessage, Defines test parameters for rule class
classmethod UpdateProduction(namespace As %String, productionClass As %String, hostName As %String, action As %String, newHostName As %String) as %DynamicObject
Copy or delete host in production.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
hostName, Name of a host
action, Copy or delete
newHostName, New host name if copy
classmethod UpdateProductionHostStatus(namespace As %String, productionClass As %String, state As %String, hostID As %String) as %DynamicObject
Update state for production or host.
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
productionClass, Name of the ObjectScript class in which this production definition is defined.
state, Start or Stop item
hostID, Host ID
classmethod UpdateSavedMessageSearch(namespace As %String, searchName As %String, renameSearch As %String, filterParameters As %DynamicObject) as %DynamicObject
Update Saved Message Search
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
searchName, Name of message search.
renameSearch, New name of search
filterParameters, Filter to search and filter data.
classmethod UserReq(pRequirement As %String) as %String
Convert the cryptic requirement symbol into something more user-friendly
classmethod ValidateExpression(namespace As %String, progLanguage As %String, expression As %DynamicObject) as %DynamicObject
Validate the code block for supported languages (ObjectScript, Python)
The method arguments hold values for:
namespace, InterSystems IRIS namespace this operation will be performed in.
progLanguage, The programming language.Supported values are objectscript and python
expression, JSON object containing string expression.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab