The getEnvironmentVariables() function returns an unmodifiable map of system environment variables.

An environment variable is a system-dependent external named value. Similar to Java the function System.getenv(). Note that the keys are case-sensitive.

See also:  getJavaProperties

The getJavaProperties() function returns the map of Java VM system properties.

Similar to Java the function System.getProperties().

See also:  getEnvironmentVariables

The getParamValue() function returns the value of the specified graph parameter.

The argument is the name of the graph parameter without the ${ } characters, e.g. PROJECT_DIR. The returned value is resolved, i.e. it doesn't contain any references to other graph parameters.

The function returns null for non-existent parameters.

	Note
	Function getParamValue decrypts secure parameters.

See also:  getParamValues

The getParamValues() function returns a map of graph parameters and their values.

The keys are the names of the parameters without the ${ } characters, e.g. PROJECT_DIR. The values are resolved, i.e. they don't contain any references to other graph parameters. The map is unmodifiable.

The function returns null for non-existent parameters.

	Note
	The function getParamValues decrypts secure parameters.

See also:  getParamValue

The getRawParamValue() function returns the value of the specified graph parameter.

The argument is the name of the graph parameter without the ${ } characters, e.g. PROJECT_DIR. In contrast with getParamValue(string) function the returned value is unresolved, so references to other graph parameters are not resolved and secure parameters are not de-crypted.

The function returns null for non-existent parameters.

See also:  getRawParamValues

The getRawParamValues() function returns a map of graph parameters and their values.

The keys are the names of the parameters without the ${ } characters, e.g. PROJECT_DIR. Unlike getParamValues() function the values are unresolved, so references to other graph parameters are not resolved and secure parameters are not de-crypted. The map is unmodifiable.

The function returns null for non-existent parameters.

See also:  getRawParamValue

Returns java hashCode of parameter.

The iif() function returns the second argument if the first argument is true or the third if the first is false.

If the first argument is null, the function fails with error.

See also:  nvl, nvl2

The isnull() function returns a boolean value depending on whether the argument is null (true) or not (false). The argument may be of any data type.

Important

If you set the Null value property in metadata for any string data field to any non-empty string, the isnull() function will return true when applied on such string. And return false when applied on an empty field. For example, if field1 has Null value property set to "<null>", isnull($in.0.field1) will return true on the records in which the value of field1 is "<null>" and false on the others, even on those that are empty. See Null value for detailed information.

See also:  isNull, nvl, nvl2

The nvl() function returns the first argument, if its value is not null, otherwise the function returns the second argument. Both arguments must be of the same type.

See also:  iif, isnull, nvl2

The nvl2() function returns the second argument, if the first argument has not null value. If the first argument has null value, the function returns the third argument.

See also:  iif, isnull, nvl

The parseProperties() function converts key-value pairs separated with a new line from a string to a map.

The order of properties is preserved.

If the input string is null or empty, the function returns an empty map.

Compatibility notice:  The function parseProperties() is available since CloverETL 4.1.0.

# lines starting with # are comments
! The exclamation mark can also mark text as comments.

# This is the simplest property
key = value

# A long property may be separated on multiple lines
longvalue = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \
            aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

# The key and element characters #, !, =, and : are written with
# a preceding backslash to ensure that they are properly loaded.
website = http\://www.cloveretl.com/

# Add spaces to the key
key\ with\ spaces = This is the value that could be looked up with the key "key with spaces".

# Unicode u-umlaut
uuml : \u00FC

See also:  Properties (as parameter editor type), java.util.Properties.load(Reader), https://en.wikipedia.org/wiki/.properties

The printErr() function prints out the message to the graph execution log with error log level.

This function works as void printErr(<any type> arg, boolean printLocation) with printLocation set to false. It is a shortcut for printLog(error, message).

Compatibility notice: The functionality printErr() has been changed in CloverETL version 4.1. In earlier versions it wrote to the standard error output, which made it difficult to use in CloverETL Server environment.

The printErr() function prints out the message and the location of the error (if the second argument is true) to the log with error log level.

Compatibility notice: The functionality printErr() has been changed in CloverETL version 4.1. In earlier versions it wrote to the standard error output, which made it difficult to use in CloverETL Server environment.

See also:  printLog, raiseError

The printLog() function sends out the message to a logger.

The log level of the message is one of the following: debug, info, warn, error, fatal. The log level must be specified as a constant. It can be neither received through an edge nor set as variable.

	Note
	Remember that you should use this function especially in any graph that would run on CloverETL Server instead of the printErr() function which logs error messages to the log of Server (e.g., to the log of Tomcat). Unlike printErr(), printLog() logs error messages to the console even when the graph runs on CloverETL Server.

See also:  printErr, raiseError

The raiseError() function throws out error with the message specified as the argument.

The execution of the graph is aborted.

See also:  printErr, printLog

The resolveParams() function substitutes all graph parameters in the parameter by their respective values. So each occurrence of pattern ${<PARAMETER_NAME>} which is referencing an existing graph parameter is replaced by the parameter's value. The function can resolve system properties in a similar manner - e.g. PATH or JAVA_HOME.

You can control what else will be resolved by function parameters:

The argument resolveSpecialChars enables the resolution of special characters (e.g. \n \u).

If resolveSpecialChars is null, function fails.

The resolveParams(string) function behaves as string resolveParams(string, false).

Note

If you are passing the parameter directly, not as a metadata field, e.g. like this: string special = "\u002A"; // Unicode for asterisk - * resolveParams(special, true); // this line is not needed printErr(special); it is automatically resolved. The code above will print an asterisk, even if you omit the second line. It is because resolving is triggered when processing the quotes which surround the parameter.

	string parameter = "DATAIN_DIR";
	string substituted = 'data in is ${' + parameter + '}';
	string result = resolveParams(substituted);

	string special = "\\u" + "002A"; // Unicode for asterisk - *
	string result = resolveParams(special, true, false);
	printErr(result);

See also:  getEnvironmentVariables, getJavaProperties, getParamValues, getParamValue, Chapter 36, Parameters

The sleep() function pauses the execution for specified milliseconds.

The toAbsolutePath() function converts the specified path to an OS-dependent absolute path to the same file. The input may be a path or a URL. If the input path is relative, it is resolved against the context URL of the running graph.

If running on the Server, the function can also handle sandbox URLs. However, a sandbox URL can only be converted to an absolute path, if the file is locally available on the current server node.

If the conversion fails, the function returns null,

If a given parameter is null, the function fails with error.

	Note
	The returned path will always use forward slashes as directory separator, even on Microsoft Windows systems. If you need the path to contain backslashes, use the translate() function: string absolutePath = toAbsolutePath(path).translate('/', '\\');