Home
JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
JavaScript™ language elements (JavaScript™)
The JavaScript™ language elements are based on the ECMAScript Language Specification Standard ECMA-262 (see http://www.ecma-international.org/publications/standards/Ecma-262.htm). The JavaScript described here applies to the server-side interpreter. Client-side scripts are interpreted by the browser.
@Functions (JavaScript)
@Functions emulate their counterparts in Notes®.
@Failure (JavaScript)
Returns a message.

JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
- JavaScript™ language elements (JavaScript™)
  The JavaScript™ language elements are based on the ECMAScript Language Specification Standard ECMA-262 (see http://www.ecma-international.org/publications/standards/Ecma-262.htm). The JavaScript described here applies to the server-side interpreter. Client-side scripts are interpreted by the browser.
  - Statements (JavaScript)
    JavaScript™ statements consist of keywords and syntax.
  - Operators (JavaScript)
  - Top-level functions (JavaScript)
    Top-level functions are not associated with an object. In the ECMA specification, these functions are properties and methods of the global object.
  - @Functions (JavaScript)
    @Functions emulate their counterparts in Notes®.
    - @Abs (JavaScript™)
      Returns the absolute (unsigned) value of a number.
    - @Abstract (JavaScript™)
      Abbreviates the content of fields.
    - @Adjust (JavaScript™)
      Adjusts a time and date by years, months, days, hours, minutes, and/or seconds.
    - @AttachmentLengths (JavaScript™)
      Returns the lengths in bytes of the files attached to the current document.
    - @AttachmentModifiedTimes (JavaScript™)
      Returns the modification dates and times of the files attached to the current document.
    - @AttachmentNames (JavaScript™)
      Returns the names of the files attached to the current document.
    - @Attachments (JavaScript™)
      Returns the number of files attached to the current document.
    - @Author (JavaScript)
      Returns the names of the authors of the current document.
    - @Begins (JavaScript)
      Determines whether a string begins with a substring.
    - @Char (JavaScript)
      Returns a character that corresponds to a Unicode value.
    - @ClientType (JavaScript)
      Returns a text string to differentiate Notes® clients and Web browsers.
    - @Contains (JavaScript)
      Determines whether a string contains a substring.
    - @Count (JavaScript)
      Returns the number of entries in a list.
    - @Created (JavaScript)
      Returns the creation date and time of the current document.
    - @Date (JavaScript)
      Creates a date and time.
    - @Day (JavaScript)
      Returns the day from a date and time.
    - @DbColumn (JavaScript)
      Returns the values of a view column.
    - @DbLookup (JavaScript)
      Returns view column or field values that correspond to matched keys in a sorted view column.
    - @DbName (JavaScript)
      Returns the server name and the database name of the current database.
    - @DbTitle (JavaScript)
      Returns the label of the current database.
    - @Do (JavaScript)
      Evaluates a series of @function statements.
    - @Element (JavaScript)
      Returns an element of a list.
    - @Elements (JavaScript)
      Returns the number of entries in a list.
    - @Ends (JavaScript)
      Determines whether a string ends with a substring.
    - @Error (JavaScript)
      Assigns an error condition to a value.
    - @Explode (JavaScript)
      Parses a string into elements in a list using specified separators.
    - @Failure (JavaScript)
      Returns a message.
    - @False (JavaScript)
      Returns the number 0.
    - @GetField (JavaScript)
      Returns the value of a document item associated with the current page.
    - @Hour (JavaScript)
      Returns the hour from a date and time.
    - @If (JavaScript)
      Executes a statement based on a conditional test.
    - @Implode (JavaScript)
      Concatenates elements of a text list into a string.
    - @Integer (JavaScript)
      Truncates a number to an integer.
    - @IsAvailable (JavaScript)
      Indicates whether an item exists in the current document.
    - @IsDocBeingLoaded (JavaScript)
      Returns 1 if the current document is being loaded.
    - @IsDocBeingSaved (JavaScript)
      Returns 1 if the current document is being saved.
    - @IsError (JavaScript)
      Indicates if a value is an error condition.
    - @IsMember (JavaScript)
      Indicates if a list contains a string or strings.
    - @IsNewDoc (JavaScript)
      Indicates if the current document is a new document.
    - @IsNotMember (JavaScript)
      Indicates if a list does not contain a string or strings.
    - @IsNull (JavaScript)
      Indicates if a value is an empty string or list of empty strings.
    - @IsNumber (JavaScript)
      Indicates if a value is a number.
    - @IsResponseDoc (JavaScript)
      Indicates if the current document is a response document.
    - @IsText (JavaScript)
      Indicates if a value is a string.
    - @IsTime (JavaScript)
      Indicates if a value is a date and time.
    - @IsUnavailable (JavaScript)
      Indicates whether an item exists in the current document.
    - @Left (JavaScript)
      Returns the leftmost characters of a string for the number of characters specified, or up to and excluding a substring.
    - @LeftBack (JavaScript)
      Returns the leftmost characters of a string minus the number of characters specified, or up to and excluding the last occurrence of a substring.
    - @Length (JavaScript)
      Returns the number of characters in a string.
    - @List (JavaScript)
      Creates a list.
    - @LowerCase (JavaScript)
      Converts a string to lowercase.
    - @Max (JavaScript)
      Returns the largest number in a group of numbers.
    - @Member (JavaScript)
      Returns the position of the first occurrence of a value in a string list.
    - @Middle (JavaScript)
      Returns characters of a string, starting at an offset from the beginning or after a substring, for the number of characters specified or up to and excluding a substring.
    - @MiddleBack (JavaScript)
      Returns characters of a string, starting at an offset from the end or before the last occurrence of a substring, back to and excluding the last occurrence of a substring or for the negative number of characters specified.
    - @Min (JavaScript)
      Returns the smallest number in a group of numbers.
    - @Minute (JavaScript)
      Returns the minute from a date and time.
    - @Modified (JavaScript)
      Returns a time-date value indicating when the document was modified initially.
    - @Modulo (JavaScript)
      Returns the remainder of a division operation.
    - @Month (JavaScript)
      Returns the month from a date and time.
    - @Name (JavaScript™)
      Returns a component of or reformats a hierarchical name.
    - @NewLine (JavaScript)
      Returns the newline character.
    - @No (JavaScript)
      Returns the number 0.
    - @Now (JavaScript)
      Returns the server date and time.
    - @Null (JavaScript)
      Returns an empty string.
    - @ProperCase (JavaScript)
      Converts a string to propercase.
    - @Random (JavaScript)
      Returns a random number greater than or equal to 0.0 and less than 1.0.
    - @Repeat (JavaScript)
      Repeats a string.
    - @Replace (JavaScript)
      Replaces strings in a list.
    - @ReplaceSubstring (JavaScript)
      Replaces substrings in a list.
    - @ReplicaID (JavaScript)
      Returns the replica ID of the current database.
    - @Return (JavaScript)
      Returns execution to the calling function or the user interface.
    - @Right (JavaScript)
      Returns the rightmost characters of a string for the number of characters specified, or starting after a substring.
    - @RightBack (JavaScript)
      Returns the rightmost characters of a string minus the number of characters specified, or back to and excluding the last occurrence of a substring.
    - @Round (JavaScript)
      Rounds a number.
    - @Second (JavaScript)
      Returns the second from a date and time.
    - @Select (JavaScript)
      Returns a value from a parameter list.
    - @SetField (JavaScript)
      Sets a document item associated with the current page to a value.
    - @Subset (JavaScript)
      Subsets a list from left to right.
    - @Success (JavaScript)
      Returns 1 (true).
    - @Sum (JavaScript)
      Sums numbers.
    - @Text (JavaScript)
      Converts a value to a string.
    - @TextToNumber (JavaScript)
      Converts a string to a number.
    - @TextToTime (JavaScript)
      Converts a string to a date and time.
    - @Time (JavaScript)
      Creates a date and time.
    - @Today (JavaScript)
      Returns today's date.
    - @Tomorrow (JavaScript)
      Returns tomorrow's date.
    - @Trim (JavaScript)
      Removes leading and trailing spaces from a string.
    - @True (JavaScript)
      Returns the number 1.
    - @Unique (JavaScript)
      Returns a random, unique text value (no parameter), or removes duplicate values from a list (parameter).
    - @UpperCase (JavaScript)
      Converts a string to uppercase.
    - @UserId (JavaScript)
      Returns the user ID object for a given user in the ID Vault.
    - @UserName (JavaScript)
      Returns the distinguished name of the current user.
    - @UserSecretKeys (JavaScript)
      Returns the secret keys stored in a user's ID file in the ID Vault.
    - @Weekday (JavaScript)
      Returns the day of the week where Sunday is 1.
    - @Word (JavaScript)
      Returns a word from a string.
    - @Year (JavaScript)
      Returns the year from a date and time.
    - @Yes (JavaScript)
      Returns the value 1.
    - @Yesterday (JavaScript)
      Returns yesterday's date.
  - Implied variable typing (JavaScript)
    You can associate a variable with a data type to document your code and direct content assist.
  - Embedding Java™ in JavaScript™
    Java™ code can be embedded directly into JavaScript™ code.
- Simple actions (JavaScript)
  A simple action performs a pre-programmed activity that can be modified by arguments.
- Global objects and functions (JavaScript™)
  Global objects provide entry points to server-side scripts. Entering the name of a global object instantiates it.
- DOM (JavaScript)
  Represents a document in XML Document Object Model format.
- Domino®
  This library provides access to the HCL Domino® back-end.
- Runtime (JavaScript)
  The Runtime library contains classes that provide useful methods for globalization.
- Standard (JavaScript)
  The Standard library contains classes for manipulating data of different types and performing common operations.
- XSP (JavaScript™)
  The XSP library contains classes that access the browser context.

@Failure (JavaScript)

Returns a message.

Defined in

Syntax

@Failure(message : string) :
string


Return value	Description
`string`	The parameter.

Usage

In Notes®, this @function is used in validation formulas, which are not in XPages.