List and overview of functions

A list of all functions with a short overview.

Table 1. List of functions
Name	Type	Description
Activate	Policy	The Activate function runs another policy.
ActivateHibernation	Policy	The `ActivateHibernation` function continues running a policy that was previously put to sleep by using the `Hibernate` function. You must also run the `RemoveHibernation` function to remove the policy from the hibernation queue and to free up memory resources.
AddDataItem	Database, Internal	The AddDataItem function adds a data item to a data type.
BatchDelete	Database	The BatchDelete function deletes a set of data items from a data type.
BatchUpdate	Database	The BatchUpdate function updates field values in a set of data items in a data type.
BeginTransaction	Database	The BeginTransaction is a local transactions function that is used in SQL operations.
CallDBFunction	Database	The CommitTransaction function is a local transactions function that is used in SQL operations.
CallStoredProcedure	Database	The CallStoredProcedure function calls a database stored procedure.
ClassOf	Context	The ClassOf function returns the data type of a variable.
CommandResponse	Systems	Use the CommandResponse function to run interactive and non-interactive programs on both local and remote systems.
CommitChanges	Database	Used only with GetByFilter, and GetByKey functions to force updates in a database.
CommitTransaction	Database	The CommitTransaction function is a local transactions function that is used in SQL operations.
ConvertObjectsToJSON	String	This function converts Netcool/Impact Objects to a one level JSON string.
ConvertXMLToImpactObjects	String	The `ConvertXMLToImpactObjects` function converts any XML string to a nested structure of Impact objects.
Decrypt	String	The Decrypt function decrypts a string that has been previously encrypted by using Encrypt or the nci_crypt tool.
DeleteDataItem	Database, Internal	The DeleteDataItem function deletes a single data item from a data type.
Deploy	Miscellaneous	The Deploy function copies data sources, data types, policies, and services between server clusters.
DirectSQL	Database	The DirectSQL function runs an SQL operation against the specified database and returns any resulting rows to the policy as data items.
Distinct	Array	The Distinct function returns an array of distinct elements from another array.
Encrypt	String	The Encrypt function encrypts a string.
Escape	String	This function escapes special characters in an input string in a policy.
Eval	Context	The Eval function evaluates an expression by using the specified context.
EvalArray	Array, Context	The EvalArray function evaluates an expression by using the specified array.
Exit	Policy	You use the Exit function to stop a function anywhere in a policy or to exit a policy.
Extract	String	The Extract function extracts a word from a string.
Float	Numeric	The Float function converts an integer, string, or Boolean expression to a floating point number.
FormatDuration	Time	The FormatDuration function converts a duration in seconds into a formatted date/time string.
GetByFilter	Database, Internal, ITNM, LDAP, XML	The GetByFilter function retrieves data items from a data type by using a filter as the query condition.
GetByKey	Database, Internal, LDAP	The GetByKey function retrieves data items from a data type by using a key expression as the query condition.
GetByLinks	Database, Internal, XML	The GetByLinks function retrieves data items in target data types that are linked to one or more source data items.
GetByXPath	XML	The GetByXPath function provides a way to parse an XML string or get an XML string through a URL specified as parameter.
GetClusterName	Variables, Impact	You use the GetClusterName function inside a policy to identify which cluster is running the policy.
GetDate	Time	The GetDate function returns the date/time as the number of seconds expired since the start of the UNIX epoch.
GetFieldValue	Java	Use this function to get the value of static or non-static public fields in a Java class. For non-static fields, use the variable `FieldName` for a Java class or `TargetObject` for a Java object. For a static Java class field, use the variable `ClassName`.
GetGlobalVar	Variables	This function retrieves the global value that is saved by previous SetGlobalVar calls.
GetHTTP	REST	You can use the GetHTTP function to retrieve any HTTP URL or to post content to a web page.
GetHibernatingPolicies	Policy	The GetHibernatingPolicies function retrieves data items from the Hibernation data type by performing a search of action key values.
GetHostAddress	Variables, Impact	You use the GetHostAddress function inside a policy to get the IP address of the system where the Netcool/Impact server is running.
GetScheduleMember	Time	The GetScheduleMember function retrieves schedule members that are associated with a particular time range group and time.
GetServerName	Variables	You use the GetServerName function inside a policy to identify which server is running the policy.
GetServerVar	Variables	You use this function to retrieve the global value that is saved by previous SetServerVar.
Hibernate	Policy	The Hibernate function causes a policy to hibernate.
Illegal	String	If the input in the policy has malicious content, the Illegal function throws an exception in a policy.
Int	Numeric	The Int function converts a float, string, or Boolean expression to an integer.
JRExecAction	Systems	The JRExecAction function runs an external command by using the JRExec server.
JavaCall	Java	You use this function to call the method `MethodName` in the Java object `TargetObject` with parameters, or, to call the static method `MethodName` in the Java class `ClassName` with parameters.
Keys	Context	The `Keys` function returns an array of strings that contain the field names of the specified data item.
Length	Array, String	The Length function returns the number of elements or fields in an array or the number of characters in a string.
Load	JavaScript	You use this function to load a JavaScript library into your JavaScript policy.
LocalTime	Time	The LocalTime function returns the number of seconds since the beginning of the UNIX epoch as a formatted date/time string.
Log	Policy	The Log function prints a message to the policy log.
Merge	Context	The `Merge` function merges two contexts or event containers by adding the member variables of the source context or event container to those of the target.
NewEvent	Context	The NewEvent function creates a new event container.
NewJavaObject	Java	The `NewJavaObject` function is used to call the constructor for a Java class.
NewObject	Context	The NewObject function creates a new context.
ParseDate	Time	The ParseDate function converts a formatted date/time string to the time in seconds since the beginning of the UNIX epoch. 1st January 1970 00:00:00 (UTC).
ParseJSON	String	This function converts a JSON string into a Netcool/Impact Object.
Random	Numeric	The Random function returns a random integer between zero and the given upper bound.
RDFModel	RDF	You can use the RDFModel function to create an RDF model without any input parameters.
RDFModelToString	RDF	You can use the RDFModelToString function to export an RDF model to a string in a particular language.
RDFModelUpdateNS	RDF	You can use the RDFModelUpdateNS function to insert, update, or remove a namespace from an RDF model.
RDFNodeIsResource	RDF	You can use the RDFNodeIsResource function to help other functions read and parse objects that are also an RDF resource.
RDFNodeIsAnon	RDF	You can use the RDFNodeIsAnon function to assist in reading and parsing an RDF.
RDFParse	RDF	You can use the RDFParse function to help other functions read and parse an RDF object
RDFRegister	RDF	You can use the RDFRegister function to help you to register service providers or OSLC resources with the registry server.
RDFUnRegister	RDF	To remove the registration record of a service provider or resource from the registry server, use the RDFUnRegister function to supply the location of the registration record, the Registry Services server username and password, and the registration record that you want to remove.
RDFSelect	RDF	You can use the RDFSelect function to assist in reading and parsing an RDF. To retrieve statements based on an RDF model, you call the RDFSelect function and pass the RDF model that is created by the RDFParse function. You can filter based on subject, predicate, and object.
RDFStatement	RDF	You can use the RDFStatement function to create and add statements to an RDF model.
RExtract	String	The RExtract function uses regular expressions to extract a substring from a string.
RExtractAll	String	The RExtractAll function uses regular expression matching to extract multiple substrings from a string.
ReceiveJMSMessage	JMS	The ReceiveJMSMessage function retrieves a message from the specified Java™ Message Service (JMS) destination.
RemoveHibernation	Policy	The RemoveHibernation function deletes a data item from the Hibernation data type and removes it from the hibernation queue.
Replace	String	The Replace function uses regular expressions to replace a substring of a specified string.
ReturnEvent	Policy	The ReturnEvent function inserts, updates, or deletes an event from an event source.
RollbackTransaction	Database	The RollbackTransaction function rolls back any changes that are done by an SQL operation.
SendEmail	Notifications	The SendEmail function sends an email that uses the email sender service.
SendJMSMessage	JMS	The SendJMSMessage function sends a message to the specified destination by using the Java Message Service (JMS) DSA.
SetFieldValue	Java	Use the SetFieldValue function to set a public field variable in a Java class to some value.
SetGlobalVar	Variables	The SetGlobalVar function creates in a policy a global variable, which can be accessed from any local functions, library functions, and exception handlers in a policy.
SetServerVar	Variables	The SetServerVar function creates a server-wide global variable in a policy.
SNMPGetNextAction	SNMP, Systems	The SnmpGetNextAction function retrieves the next SNMP variables in the variable tree from the specified agent.
SNMPGetAction	SNMP, Systems	The SnmpGetAction function retrieves a set of SNMP variables from the specified agent.
SNMPSetAction	SNMP, Systems	The SnmpSetAction function sets variable values on the specified SNMP agent.
SNMPTrapAction	SNMP	The SnmpTrapAction function sends a trap (for SNMP v1) or a notification (for SNMP v2) to an SNMP manager.
Split	String	The Split function returns an array of substrings from a string by using the specified delimiters.
String	String	The String function converts an integer, float, or boolean expression to a string.
Strip	String	The Strip function strips all instances of the specified substring from a string.
Substring	String	The Substring function returns a substring from a specified string by using index positions.
Synchronised	Policy	Use the Synchronized function to write thread-safe policies for use with a multi-threaded event processor by using IPL or JavaScript.
ToLower	String	The ToLower function converts a string to lowercase characters.
ToUpper	String	The ToUpper function converts a string to uppercase characters.
Trim	String	The Trim function trims leading and trailing white space from a string.
URLDecode	String, REST	The URLDecode function returns a URL encoded string to its original representation.
URLEncode	String, REST	The URLEncode function converts a string to a URL encoded format.
UpdateDB	Database	The UpdateEventQueue function updates or deletes events in the event reader event queue.
UpdateEventQueue	Database	The UpdateEventQueue function updates or deletes events in the event reader event queue.
WSInvoke Important: [This feature is deprecated.]	Web Services	Provided for backward-compatibility only.
WSInvokeDL	Web Services	The WSInvokeDL function makes web services calls when a Web Services Description Language (WSDL) file is compiled with `nci_compilewsdl`, or when a policy is configured using the Web Services wizard.
WSNewArray	Web Services	The WSNewArray function creates an array of complex data type objects or primitive values, as defined in the WSDL file for the web service.
WSNewEnum	Web Services	The WSNewEnum function returns an enumeration value to a target web service.
WSNewObject	Web Services	The WSNewObject function creates an object of a complex data type as defined in the WSDL file for the web service.
WSNewSubObject	Web Services	The WSNewSubObject function creates a child object that is part of its parent object and has a field or attribute name of ChildName.
WSSetDefaultPKGName	Web Services	WSSetDefaultPKGName

For more details about each of these functions, see the Policy Reference Guide.