Otter Documentation

Built-in Functions & Variables

This is generated from the built-in components of Otter 1.7, and may be different than what you have installed(especially if you have extensions); go to [User Icon] > Documentation within your Otter instance to see exactly what operations are available.

executions

  • $ExecutionState - Returns the current state of the execution (normal, warning, or error).
  • GetVariableValue (VariableName, [VariableType]) - Returns the value of a variable if the specified variable name is available in the current context; otherwise returns null.
  • $IsVariableDefined (VariableName, [VariableType]) - Returns true if the specified variable name is available in the current context; otherwise returns false.
  • $WorkingDirectory - Returns the current working directory.

files

  • $DirectoryExists (name) - Returns "true" if the specified directory exists on the current server.
  • $FileContents (name, [maxLength]) - Returns the contents of a file on the current server.
  • $FileExists (name) - Returns "true" if the specified file exists on the current server.
  • $PathCombine (Path1, Path2) - Returns a string containing all of the arguments combined into a complete path.

General

  • $Date ([Format]) - Returns the current date and time of the local timezone in the specified .NET datetime format string, or ISO 8601 format (yyyy-MM-ddThh:mm:ss) if no format is specified.
  • $DateUtc ([Format]) - Returns the current UTC date and time in the specified .NET datetime format string, or ISO 8601 format (yyyy-MM-ddThh:mm:ss) if no format is specified.
  • Eval (Text) - Performs variable substitution and function evaluation for arbitrary text.
  • @Range (Start, Count) - Returns a range of integers starting from a specified value.
  • @ServersInEnvironment ([EnvironmentName]) - Returns a list of all the servers in the specified environment name.
  • @ServersInRole ([RoleName]) - Returns a list of servers in the specified role.

lists

  • $ListCount (List) - Count the number of elements in a list.
  • $ListIndexOf (List, Item) - Finds the index of an item in a list.
  • @ListInsert (List, Item, [Index]) - Inserts an item into a list.
  • ListItem (List, Index) - Gets an item from a list.
  • @ListRemove (List, Index) - Removes an item from a list.

maps

  • MapAdd (Map, Key, Value) - Adds a key-value pair to a map.
  • MapItem (Map, Key) - Gets an item from a map.
  • @MapKeys (Map) - Lists the keys of a map.
  • MapRemove (Map, Key) - Removes a key from a map.

math

  • $Decrement (value, [amount]) - Returns a string that contains the result of decrementing a value.
  • $Increment (value, [amount]) - Returns a string that contains the result of incrementing a value.

PowerShell

  • PSEval (ScriptText) - Returns the result of a PowerShell script.

servers

  • @AllEnvironments - Returns a list of all environments.
  • @AllRoles - Returns a list of all server roles.
  • @AllServers - Returns a list of all servers.
  • $EnvironmentVariable (EnvironmentVariableName) - Returns the value of the specified environment variable on the current server.
  • $RoleName - name of the current server role in context
  • $ServerName - name of the current server in context

strings

  • $HtmlEncode (Text) - Encodes a string for use in HTML.
  • $Join (Separator, Values) - Concatenates all elements of a list into a string using a specified separator.
  • $JSEncode (Text) - Encodes a string for use as a JavaScript literal.
  • $MatchesRegex (Text, RegexPattern) - Returns true when the specified text matches the specified pattern; otherwise returns false.
  • $NewLine ([WindowsOrLinux]) - newline string for either the operating system of the current server in context or specifically Windows or Linux
  • $Replace (Text, Value, ReplaceWith, [IgnoreCase]) - Searches for and replaces text in a string.
  • @Split (Text, Separator, [Count]) - Splits a string into substrings based on a specified separator.
  • $Substring (Text, Offset, [Length]) - Returns a segment of another string.
  • $ToLower (Text) - Returns a string with all letters converted to lowercase.
  • $ToUpper (Text) - Returns a string with all letters converted to uppercase.
  • $Trim (Text) - Returns a string with all leading and trailing whitespace characters removed, or optionally a set of specified characters.
  • $TrimEnd (Text) - Returns a string with all trailing whitespace characters removed, or optionally a set of specified characters.
  • $TrimStart (Text) - Returns a string with all leading whitespace characters removed, or optionally a set of specified characters.
  • $UrlEncode (Text) - Escapes a string for use in a URL.