%Api.InteropEditors.Utils

class %Api.InteropEditors.Utils

Method Inventory

Parameters

parameter AllDTLsRead = 1;

parameter AllDTLsWrite = 2;

parameter AllProductionsRead = 1;

parameter AllProductionsWrite = 2;

parameter AllRulesRead = 1;

parameter AllRulesWrite = 2;

parameter BusinessRulesRead = 3;

parameter BusinessRulesWrite = 4;

parameter ProductionsItemUse = 6;

parameter ProductionsRead = 3;

parameter ProductionsUse = 5;

parameter ProductionsWrite = 4;

parameter RoutingRulesRead = 5;

parameter RoutingRulesWrite = 6;

parameter WhenCommentDelimeter = &sep;;

Comments on 'when's are stored in an attribute rather than an array of elements. This string acts a the delimeter for the comment attribute on each when.

Methods

classmethod CompileOlderThanSource(cls) as %Integer

Returns -1 if not compiled, 0 if compilation up to date, 1 if compilation older than source

classmethod ContractRuleSet(actions As %DynamicArray) as %Status

Transform provided rule definition JSON to match generated rule definition structure. Recursively iterate through the actions array of a ruleSet. Remove each action.expression.valueObject and move each action.expression.value to action.value. Rename each when.expression.value to when.condition and when.expression.valueObject to when.conditionObject and deserialize when.comments array into delimeted when.comment string. Performs inverse of ExpandRuleSet.

classmethod CreateDTLInputObject(namespace As %String, pInputClass As %String = "", pData As %String = "", Output pStatus As %Status, ByRef pDocProperties) as %RegisteredObject

Create an input message for testing. Note that pData may be a stream object if the source data is sufficiently large.

classmethod ExpandRuleSet(actions As %DynamicArray) as %Status

Transform generated rule definition JSON to be more complete and internally consistent. Recursively iterate through the actions array of a ruleSet Rename each when.condition to match action.expression naming style and deserialize when.comment string into when.comments array. Performs inverse of ContractRuleSet.

classmethod ExtractFinderData(ByRef data, container As %DynamicArray)

Extract class names from the finder array into a container

classmethod ExtractSegments(namespace As %String, arrRef As %String, cls As %String = "", doctype As %String = "") as %DynamicAbstractObject

classmethod GetAllHostConnections(pProd As %String, Output pList, Output pColNames) as %Status

classmethod GetDTLFunctions(pNamespace As %String) as %DynamicArray

classmethod GetDTLInputSupportedFormats(namespace As %String, cls As %String) as %DynamicArray

classmethod GetDTLPerms() as %Binary

Get permissions the current user has on data transformations. Permissions are returned in a bitstring with the following mapping:
1: %Ens_DTL:READ or %Ens_Code:READ
2: %Ens_DTL:WRITE or %Ens_Code:WRITE

classmethod GetDTLSegments(pNamespace As %String = "", pMode As %String = "", pClass As %String = "", pDocType As %String = "") as %DynamicArray

Fetch the segments of a DTL source and target message class as JSON, given the pNamespace, pMode ("source" or "target"), pClass(class name), pDocType (document type for virtual documents)

classmethod GetDTLSourceTargetClasses(namespace As %String) as %DynamicObject

classmethod GetDTLSubSegments(pNamespace As %String, pClass As %String, pDocType As %String = "", pNodeIndex As %String = "") as %DynamicObject

Fetch the subsegments of a given node as JSON, given the pNamespace, pClass(class name), pDocType (document type for virtual documents), pNodeIndex (index of the parent segment)

classmethod GetDTLTestInput(namespace As %String, cls As %String, response As %CSP.Response) as %RawString

classmethod GetDocTypesForClass(namespace As %String, messageClass As %String) as %DynamicArray

classmethod GetInputPlugins(contextClassName As %String, ByRef plugins As %DynamicArray) as %Status

Get properties and plugin metadata of an extended context class. The method arguments hold values for: namespace, Namespace to search for extensions in. contextClassName, Context class to get properties and plugin metadata of.

classmethod GetItemID(pProductionName As %String, hostName As %String, Output hostID As %String = "") as %DynamicAbstractObject

classmethod GetProductionPerms() as %Binary

classmethod GetRulePerms() as %Binary

Get permissions the current user has on rules. Permissions are returned in a bitstring with the following mapping:
1: %Ens_Rules Read
2: %Ens_Rules Write
3: %Ens_BusinessRules Read
4: %Ens_BusinessRules Write
5: %Ens_RoutingRules Read
6: %Ens_RoutingRules Write

classmethod GetSubTransforms(subTransformName As %String, transformID As %String, ByRef subsExisting) as %DynamicArray

classmethod GetWholeProductionAsJSON(pProductionName As %String = "", Output prodJSONObject As %String = "") as %DynamicAbstractObject

classmethod HasDTLPerms(permStr As %String, perms As %Binary = 0) as %Boolean

Check if the current user has specified DTL permissions. Input 'permString' defines what permissions to check: valid values are "R", "W", and "RW". Input 'perms' defines the permissions the current user has on DTLs: expected format is a bitstring as returned by GetDTLPerms().

classmethod HasKey(parent As %DynamicObject, key As %String) as %Integer

Check if 'parent' has key 'key'

classmethod HasPermsByAssistClass(assistClass As %String, permStr As %String, perms As %Binary) as %Boolean

Check if the current user has specified permissions on rules that use this assist class. Input 'permString' defines what permissions to check: valid values are "R", "W", and "RW". Input 'perms' defines the permissions the current user has on rules: expected format is a bitstring as returned by GetRulePerms().

classmethod HasPermsByProductionClass(productionClass As %String, permStr As %String, perms As %Binary)

Check if the current user has specified permissions on this rule class. Input 'permString' defines what permissions to check: valid values are "R", "W", and "RW". Input 'perms' defines the permissions the current user has on rules: expected format is a bitstring as returned by GetRulePerms().

classmethod HasPermsByRuleClass(ruleClass As %String, permStr As %String, perms As %Binary)

classmethod HasPermsByRuleType(ruleTypes As %String, permStr As %String, perms As %Binary) as %Boolean

Check if the current user has specified permissions on all rules in 'ruleTypes' input: valid values are "B" (Business Rules), "R" (Routing Rules), "A" (All Rules), and "*" (Any Rules). Input 'permString' defines what permissions to check: valid values are "R", "W", and "RW". Input 'perms' defines the permissions the current user has on rules: expected format is a bitstring as returned by GetRulePerms().

classmethod HasProductionPerms(permStr As %String, perms As %Binary) as %Boolean

Check if the current user has specified permissions. Input 'permString' defines what permissions to check: valid values are "R", "W", and "RW". Input 'perms' defines the permissions the current user has on production config: expected format is a bitstring as returned by GetProductionPerms().

classmethod InLocale(pName As %String, pTabs As %List) as %Boolean

classmethod IsReadOnly(cls As %String) as %Boolean

Check if this class is read only for this user due to the underlying database or source control User permissions that are specific to the application also need to be checked but that is not done in this generic method.

classmethod IsSubClass(class As %String, superClass As %String) as %Integer

Check if the given 'class' is a subclass of 'superClass': if class is guaranteed to be compiled use %Extends instead.

classmethod ItemLineConnectionsById(pItemId As %String, pProd As %String, inBound As %Boolean, outBound As %Boolean, Output pList, Output pColNames) as %Status

classmethod RuleAlreadyExists(pClassName As %String) as %Boolean

classmethod SaveDTL(namespace As %String, className As %String, DTL As %DynamicObject) as %Status

Save 'DTL' dynamic object into class. If the class exists it will be overwritten.

classmethod SaveRule(ruleClass As %String, ruleDefinition As %DynamicObject) as %Status

Save 'ruleDefinition' into class 'ruleClass'. If a class 'ruleClass' exists it will be overwritten.

classmethod SubmitRoutingRule(protocol As %String, ruleClass As %String, productionName As %String = "", className As %String = "", itemName As %String = "") as %Status

Add new routing rule to complete a new HL7 or X12 service that has created its own "dedicated" router.

classmethod TestDTL(namespace As %String, cls As %String, inputMessage As %RawString, extras As %DynamicObject, Output raw As %Stream.Object, Output formatted As %Stream.Object)

Callback method to create the necessary objects and capture the transformed output. We make context and process public for possible use is in Transform method

classmethod WritetoAuditLog(action As %String, productionClass As %String, itemName As %String, loggedAction As %String) as %Status

classmethod evaluateRule(pContext As %RegisteredObject, pRuleName As %String, Output pRuleLogData As %String = "", pDebugFlags As %String = "crd", pSelectMode As %Integer = 2) as %Status

Given a context object evaluate the rule and create result output as JSON

classmethod findDefaultableSettings(pHostType As %String = "") as %DynamicObject

classmethod serializeMessageAsHTML(pMessageObject As %RegisteredObject, Output pNeedsHTMLEscaping As %Boolean = 1, Output tXMLStream As %Stream.TmpCharacter) as %Status

Given an object create an HTML serialization of the object.