Functions

Global scope functions

• size — Returns the number of items in the collection, where the collection is a list, or a set of nodes retrieved with a search expression.

Log functions

• log.debug — Log the given message with a debug level message. The log messages that are output automatically include the name of the pattern performing the log action.
• log.info — Log the given message with an info level message. The log messages that are output automatically include the name of the pattern performing the log action.
• log.warn — Log the given message with a warn level message. The log messages that are output automatically include the name of the pattern performing the log action.
• log.error — Log the given message with an error level message. The log messages that are output automatically include the name of the pattern performing the log action.
• log.critical — Log the given message with a critical level message. The log messages that are output automatically include the name of the pattern performing the log action.

Text functions

• text.lower — Returns the lower-cased version of the string argument.
• text.upper — Returns the upper-cased version of the string argument.
• text.toNumber — Converts its string argument into a number.
• text.replace — Returns a modified version of the string formed by replacing all occurrences of the string old with new.
• text.join — Returns a string containing all items in a list of strings joined with the specified separator.
• text.split — Returns a list consisting of portions of the string split according to the separator string, where specified.
• text.strip — Strips unwanted characters from the start and end of the given string.
• text.leftStrip — Equivalent to text.strip, but only strips from the left side of the string.
• text.rightStrip — Equivalent to text.strip, but only strips from the right side of the string.
• text.hash — Returns a hashed form of the string, generated with the MD5 hash algorithm.
• text.ordinal — Returns the ordinal value of the string argument.

Number functions

• number.toChar — Converts the integer number in the ASCII range to a character.
• number.toText — Converts the integer number to a text form.
• number.range — Generate a list containing 0 to number - 1.

Regex functions

• regex.extract — Returns the result of extracting the regular expression from the string, optionally with a substitution expression and a specified result if no match is found.
• regex.extractAll — Returns a list containing all the non-overlapping matches of the pattern in the string.

XPath functions

• xpath.evaluate — Returns the result of evaluating the xpath expression against the XML string.
• xpath.openDocument — Returns the DOM object resulting from parsing the XML string.
• xpath.closeDocument — Closes the DOM object resulting from xpath.openDocument.

Table functions

• table — Creates a new table.
• table.remove — Removes the specified key from the specified table.

Discovery functions

• Discovery action functions
  • discovery.fileGet — Retrieves the specified file.
  • discovery.fileInfo — Retrieves information about the specified file, but not the file content.
  • discovery.getNames — Performs a DNS lookup on the IP address and returns a list of FQDN strings. Finds the DiscoveryAccess from the target node and attaches the list of FQDNs to it.
  • discovery.listDirectory — Retrieves the directory listing of the directory specified by the path on the specified target.
  • discovery.listRegistry — Returns a list of the registry entries of the registry key specified by the key_path.
  • discovery.registryKey — Retrieves a registry key from a Windows computer.
  • discovery.wmiQuery — Performs a WMI query on a Windows computer.
  • discovery.wbemQuery — Performs a WBEM query on the target and returns a list of DiscoveredWBEM DDD nodes.
  • discovery.wbemEnumInstances — Performs a WBEM query on the target and returns a list of DiscoveredWBEMInstance DDD nodes.
  • discovery.runCommand — Returns a DiscoveredCommandResult node containing the result of running the specified command.
  • discovery.snmpGet — Performs an SNMP query on the target and returns a DiscoveredSNMP node.
  • discovery.snmpGetTable — Performs an SNMP query that returns a table on the target.
• Discovery data manipulation functions
  • discovery.process — Returns the process node corresponding to the source node, which must be a ListeningPort or NetworkConnection node.
  • discovery.children — Returns a list of the child processes for the given DiscoveredProcess node.
  • discovery.descendents — Returns a list consisting of the children of the given DiscoveredProcess node, and recursively all of the children's children.
  • discovery.parent — Returns the parent process for the given DiscoveredProcess node.
  • discovery.allProcesses — Returns a list of all processes corresponding to the directly discovered data source node.
  • discovery.access — Returns the Discovery Access node for the source node, which must be a directly discovered data node.

Binary functions

• binary.toHexString — Returns the given binary value as a hex string, that is, two hex digits per byte.
• binary.toIPv4 — Returns the given binary value as the text representation of an IPv4 address.
• binary.toIPv4z — Returns the given binary value as the text representation of an IPv4 address with a zone index.
• binary.toIPv6 — Returns the given binary value as the text representation of a canonical IPv6 address.
• binary.toIPv6z — Returns the given binary value as the text representation of a canonical IPv6 address with zone index.
• binary.toMACAddress — Returns the given binary value as the text representation of a MAC address.
• binary.toWWN — Returns the given binary value as the text representation of a WWN value.

Model functions

• model.addContainment — Adds the containees to the container by creating suitable relationships between the nodes.
• model.setContainment — Equivalent to addContainment, except unconfirmed relationships are removed at the end of the pattern body
• model.destroy — Destroy the specified node or relationship in the model.
• model.withdraw — Removes the named attribute from the node.
• model.setRemovalGroup — Add the specified node or nodes to a named removal group.
• model.anchorRemovalGroup — Specify an anchor node for a named removal group.
• model.suppressRemovalGroup — Suppress removal of the named removal group.
• model.host — Returns the Host node corresponding to the given node.
• model.hosts — Returns a list of all the Host nodes corresponding to the given node.
• model.findPackages — Traverses from the node, which must be a Host or a directly discovered data node, and returns a set of all Package nodes that have names matching the provided list of regular expressions.
• model.addDisplayAttribute — Adds a named attribute, or a list of named attributes to the additional attributes displayed in a node view.
• model.removeDisplayAttribute — Removes a named attribute, or a list of named attributes from the additional attributes displayed in a node view.

Related functions

• related.detailContainer — Returns the Software Component, Software Instance, or Business Application Instance node containing to the given node.
• related.host — Returns the Host node corresponding to the given node.

Email functions

• mail.send — Sends an email.

Time functions

• time.current — Returns the current time.
• time.delta — Creates a time delta that can be added to or subtracted from a time.
• time.parseLocal — The time is converted according to the appliance's time zone and daylight saving setting.
• time.parseUTC — The time is assumed to already be UTC, and is not adjusted for timezones or daylight saving time.
• time.formatLocal — Formats a time into a human-readable string.
• time.formatUTC — Formats a time into a human-readable string.
• time.toTicks — Converts a time or time delta into the DCE ticks format.
• time.fromTicks — Converts DCE ticks into a time.
• time.deltaFromTicks — Converts DCE ticks into a time delta.

Inference functions

• inference.associate — Create associate inference relationship(s) from the specified node(s) to the inferred node.
• inference.contributor — Create contributor inference relationship(s) from the specified node(s) to the inferred node, for attribute names specified in the contributes list.
• inference.primary — Create primary inference relationship(s) from the specified node(s) to the inferred node.
• inference.relation — Create relation inference relationship(s) from the specified node(s) to the inferred relationship.
• inference.withdrawal — Create withdrawal inference relationship(s) from the specified node(s) to the inferred node, indicating the withdrawal of the withdrawn attribute name.
• inference.destruction — When destroying a node, indicate that the source node was responsible for its destruction.

System functions

• system.getOption — Takes the name of a BMC Atrium Discovery system option and returns the value.