IBM Endpoint Manager Inspectors Reference

Terminology

Win: Windows
Lin: Red Hat and SUSE Linux
Sol: SUN Solaris
HPUX: Hewlett-Packard UNIX version
AIX: IBM AIX
Mac: Apple Macintosh
Ubu: Ubuntu/Debian
WM: Windows Mobile

The version (e.g. Lin:8.1) corresponds to the version of the IEM product (8.1) in which the inspector was introduced in the client on that platform.
The version number is not shown if it is less than 8.0.


Platform


Contents

Action Objects
Authorization Objects
Client Objects
Directory Services
Environment Objects
Filesystem Objects
Firewall Objects
Fixlet Objects
Formatting Objects
Installed System Software
Introspectors
License Objects
Microsoft IIS Metabase Objects
Miscellaneous
Networking Objects
Power Objects
Primitive Objects
array
bit set
boolean
date
date with multiplicity
day of month
day of month with multiplicity
day of week
day of week with multiplicity
day of year
day of year with multiplicity
floating point
floating point with multiplicity
hertz
hertz with multiplicity
integer
integer set
integer with multiplicity
month
month and year
month and year with multiplicity
month with multiplicity
number of months
number of months with multiplicity
regular expression
regular expression match
rope
string
string position
string set
string with multiplicity
substring
time
time interval
time interval with multiplicity
time of day
time of day with multiplicity
time of day with time zone
time of day with time zone with multiplicity
time range
time range with multiplicity
time with multiplicity
time zone
time zone with multiplicity
undefined
year
year with multiplicity
Registry Objects
Session Objects
Session Statistics
Site Objects
SMBIOS objects
System Objects
Task Objects
User Objects
Windows Mobile Device Objects
WMI Objects
World Objects

IBM Endpoint Manager wiki

Primitive Objects

The relevance language is based upon a comprehensive set of primitive objects. These primitives are the basic building blocks of the more complex objects to follow. The Core Inspector Guide documents the bulk of the primitive object inspectors. Where a specialized platform-specific method exists to create, inspect, or manipulate primitive objects, they will be documented in the respective Inspector guide.

boolean

Creation Methods

DeclarationDescriptionPlatforms (?)
conjunction of <boolean>This inspector performs a serial AND on all its boolean arguments:conjunction of (true; true; true) -> TRUEconjunction of (true; true; false) -> FALSE.

Example:
conjunction of (current month = April; leap of year of current date) - Returns TRUE during April of a leap year.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
disjunction of <boolean>This inspector performs a serial OR on all its boolean arguments:disjunction of (false; false; false) -> FALSEdisjunction of (false; false; true) -> TRUE.

Example:
disjunction of (current day_of_week = Monday ;current day_of_week = Wednesday; current day_of_week = Friday) - Returns TRUE on either Monday, Wednesday or Friday.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<boolean> {cmp} <boolean>Compare two boolean expressions. Returns another boolean, depending on the evaluation of the comparison:{cmp} is one of: =, != .Win, Lin, Sol, HPUX, AIX, Mac, WM
<boolean> {op} <boolean>Operates on two boolean expressions. Returns another boolean, depending on the evaluation of the operation, for example, (True And True) = True.{op} is one of: And, Or .Win, Lin, Sol, HPUX, AIX, Mac, WM
<floating point> {cmp} <floating point>Compares two floating point numbers, where: {cmp} is one of: =, <, <=.Win, Lin:8.0, Mac, WM
<floating point> {cmp} <integer>Compares a floating point number and an integer, where: {cmp} is one of: =, <=, <.Win, Lin:8.0, Mac, WM
<integer> {cmp} <floating point>Compares an integer to a floating point number, where:{cmp} is one of: =, <=, <.Win, Lin:8.0, Mac, WM
<time interval> {cmp} <time interval>Compare two time intervals, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
bit <integer> of <integer>Returns TRUE if the numbered bit is on. Bits are numbered starting at zero. Bit 0 is the least significant bit.

Example:
bit 0 of (least integer + 1) - Returns the least significant bit of the smallest possible integer, plus one.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<floating point> {cmp} <integer>Compares a floating point number and an integer, where: {cmp} is one of: =, <=, <.Win, Lin:8.0, Mac, WM
<integer set> contains <integer>Returns TRUE if the specified set contains the given integer.

Example:
set of (1;2;3) contains 3 - Returns TRUE.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> {cmp} <integer>Returns boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<integer set> = <integer set>Returns TRUE if the specified sets have identical contents.

Example:
set of (3; 2; 2; 1; -1) = set of (2; -1) - Returns FALSE.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer set> contains <integer set>Returns TRUE if the first set contains all the elements of the second set.

Example:
set of (1;2;3) contains set of (2;3) - Returns TRUE.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer set> contains <integer>Returns TRUE if the specified set contains the given integer.

Example:
set of (1;2;3) contains 2 - Returns TRUE.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
divided by zero of <floating point>Returns TRUE if the calculation raised the divide-by-zero exception; that is, if some part of the calculation produced an exact infinity.Win, Lin:8.0, Mac, WM, Ubu:8.1
finite of <floating point>Returns TRUE if the floating point number is finite.

Example:
finite of (floating point "1"/ 0) - Returns FALSE.
Win, Lin:8.0, Mac, WM, Ubu:8.1
inexact of <floating point>Returns TRUE if the calculation raised the inexact exception; that is, if some intermediate result could not be represented exactly.Win, Lin:8.0, Mac, WM, Ubu:8.1
infinite of <floating point>Returns TRUE if the floating point number is infinite.

Example:
infinite of (floating point "1"/ 0) - Returns TRUE.
Win, Lin:8.0, Mac, WM, Ubu:8.1
invalid of <floating point>Returns TRUE if the calculation raised the invalid exception; that is, if some part of the calculation a function was applied to a value outside its domain.Win, Lin:8.0, Mac, WM, Ubu:8.1
nan of <floating point>Returns TRUE if the value is not a number.

Example:
nan of (floating point "1.e-99999" * floating point "1.e999999") - Returns TRUE.
Win, Lin:8.0, Mac, WM, Ubu:8.1
normal of <floating point>Returns TRUE if the value is a valid floating point number.Win, Lin:8.0, Mac, WM, Ubu:8.1
overflow of <floating point>Returns TRUE if the calculation raised the overflow exception; that is, if some intermediate result was too large to be represented, but not an exact infinity.

Example:
overflow of (floating point "1.0e50000") - Returns TRUE, since the number is too big to represent in floating point.
Win, Lin:8.0, Mac, WM, Ubu:8.1
underflow of <floating point>Returns TRUE if the calculation raised the underflow exception; that is, if some intermediate result was a nonzero value too small to be represented.Win, Lin:8.0, Mac, WM, Ubu:8.1
<integer> {cmp} <floating point>Compares an integer to a floating point number, where:{cmp} is one of: =, <=, <, >, >=, !=.Win, Lin:8.0, Mac, WM
<string> contains <string>Returns a boolean TRUE if the first string contains the second string.Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
<string> as booleanReturns a boolean value for the string. All possible capitalization's of "TRUE" and "FALSE" will convert successfully.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<rope> contains <string>Returns boolean TRUE if the rope contains the string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string set> contains <string>Returns TRUE if the specified set of strings contains the given string.

Example:
set of ("foo";"bar") contains "foo" - Returns TRUE.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> {cmp} <string>Returns a boolean TRUE/FALSE depending on the result of the comparison, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<string set> = <string set>Returns TRUE if the specified sets have identical contents.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string set> contains <string set>Returns TRUE if the first set contains all the elements of the second set.

Example:
set of ("to";"be";"or";"not") contains set of ("to";"be") - Returns TRUE.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string set> contains <string>Returns TRUE if the specified set of strings contains the given string.

Example:
set of ("foo";"bar") contains "foo" - Returns TRUE.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<rope> contains <string>Returns TRUE if the rope contains the string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
bit <integer> of <bit set>Returns the value of the bit at the given <integer> position in the set.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<bit set> = <bit set>Returns true if the corresponding bits of the two sets are equal.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<bit set> contains <bit set>Returns false if -- for any n -- bit n of the left set is false, but bit n of the right set is true.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<regular expression> = <string>Returns TRUE if the regular expression is equal to the specified string.

Example:
regex ".+match.+" = "We will win the match tonight" - Returns TRUE.

Example:
regex ".*PATH.*" = line 1 of file "/etc/profile" - Returns TRUE if the word "PATH" exists in line 1 of the given file.
Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<string> = <regular expression>Returns TRUE if the regular expression is equal to the specified string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<string> contains <regular expression>Returns TRUE if the specified string contains the contents of the regular expression.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<string> ends with <regular expression>Returns TRUE if the string ends with the contents of the regular expression.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<string> starts with <string>Returns a boolean TRUE if the first string starts with the second string.Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
<string> ends with <string>Returns a boolean TRUE if the first string ends with the second string.Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
<string> starts with <regular expression>Returns TRUE if the string starts with the contents of the regular expression.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<hertz> {cmp} <hertz>Returns a boolean TRUE/FALSE depending on the result of the comparison, where:{cmp} is one of: =, !=, <, <=, >, >= .

Example:
speed of processor - Returns the speed of the processor in hz, such as 3394000000 hertz for a 3.4 GHz computer.
Win, Lin, Sol, HPUX, AIX, Mac, WM
<time> {cmp} <time>Returns a boolean TRUE/FALSE depending on the result of the comparison, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<time of day with time zone> = <time of day with time zone>Compares two times of day with time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time range> = <time range>Compares two time range types and returns TRUE if they are equal.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<date> {cmp} <date>Compares two dates, where: {cmp} is one of: =, <, <=.Win, Lin, Sol, HPUX, AIX, Mac, WM
<day of week> = <day of week>Compares two days of the week and returns a boolean TRUE or FALSE.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> {cmp} <day of month>Compare two day of month types, where {cmp} is one of: <, <=, =.Win, Lin, Sol, HPUX, AIX, Mac, WM
<day of year> {cmp} <day of year>Compares two days of the year, producing a boolean TRUE or FALSE, where {cmp} is one of: <, <=, =.Win, Lin, Sol, HPUX, AIX, Mac, WM
<month> {cmp} <month>Compares the values of two months, where {cmp} is one of: <, <=, =.

Example:
July <= current month - Returns true in the second half of the year, when the month is greater than or equal to July.
Win, Lin, Sol, HPUX, AIX, Mac, WM
<month and year> {cmp} <month and year>Compares two dates (in month year format), where {cmp} is one of: <, <=, =.

Example:
january of 2009 < current month_and_year - Evaluates to TRUE when the current date is later than the specified date. This phrase could serve as an expiration flag.
Win, Lin, Sol, HPUX, AIX, Mac, WM
<number of months> {cmp} <number of months>Compare two numbers of months, where {cmp} is one of: <, <=, =.Win, Lin, Sol, HPUX, AIX, Mac, WM
leap of <year>Returns a flag indicating whether or not the specified year is a leap year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> {cmp} <year>Compares two years, where {cmp} is one of: <, <=, =.

Example:
year 2080 > current year - Returns TRUE until the year 2080.
Win, Lin, Sol, HPUX, AIX, Mac, WM
boolean <string>Returns a boolean. For example, boolean "TRUE".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
false Returns the boolean FALSE.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pending loginInstallers may leave values in the registry that the operating system will execute when the next user logs in. Pending login can detect these registry entries.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pending restartReturns TRUE if the operating system indicates that a restart needs to occur.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pending restart <string>Immediately after issuing a command like 'Action requires restart "PatchGroupX"', the expression 'Pending restart "PatchGroupX"' will be true until the next restart.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
true Returns the boolean TRUE.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
in agent contextWin:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
in proxy agent contextWin:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
group execute of <filesystem object>Returns TRUE if the group execute flag is set for the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
group read of <filesystem object>Returns TRUE if the group read flag is set for the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
group write of <filesystem object>Returns TRUE if the group write flag is set for the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
other execute of <filesystem object>Returns TRUE if others (not in the group) have execute permissions on the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
other read of <filesystem object>Returns TRUE if others (not in the group) have read permissions on the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
other write of <filesystem object>Returns TRUE if others (not in the group) have write permissions on the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
setgid of <filesystem object>Returns TRUE if the setgid (group ID) bit is set for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
setuid of <filesystem object>Returns TRUE if the setuid (user ID) bit is set for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
user execute of <filesystem object>Returns TRUE if the owner (user) has execute permissions on the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
user read of <filesystem object>Returns the owner (user) read permissions for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
user write of <filesystem object>Returns the owner (user) write permissions for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
<file content> contains <string>Returns TRUE if the string is located in the content provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<version> {cmp} <string>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<string> {cmp} <version>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<string> {cmp} <version>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<version> {cmp} <version>Returns a boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .

Example:
version "09" < version "1" - Returns TRUE. Uses the UNIX version compare, strverscmp().

Example:
version "09" < version "1" - Returns TRUE. Uses the UNIX version compare, strverscmp().
Win, Lin, Sol, HPUX, AIX, Mac, WM
<string> {cmp} <strverscmp version>Returns a boolean TRUE/FALSE depending on the result of the comparison (based on the OS supplied strverscmp function), where:{cmp} is one of: =, !=, <, <=, >, >= .Lin, WM, Ubu:8.1
<strverscmp version> {cmp} <string>Returns a boolean TRUE/FALSE depending on the result of the comparison (based on the OS supplied strverscmp function), where:{cmp} is one of: =, !=, <, <=, >, >= .Lin, WM, Ubu:8.1
<strverscmp version> {cmp} <strverscmp version>Returns a boolean TRUE/FALSE depending on the result of the comparison (based on the OS supplied strverscmp function), where:{cmp} is one of: =, !=, <, <=, >, >= .Lin
setgid of <mode>Returns TRUE if setgid (the group ID flag) is set.Lin, Sol, HPUX, AIX, Ubu:8.1
setuid of <mode>Returns TRUE if setuid (the user ID flag) is set.Lin, Sol, HPUX, AIX, Ubu:8.1
sticky of <mode>The `sticky' bit (S_ISVTX) on a directory means that a file in that directory can be renamed or deleted only by the owner of the file, by the owner of the directory, and by root. This inspector returns TRUE if the sticky bit of the given mode is on.Lin, Sol, HPUX, AIX, Ubu:8.1
execute of <mode_mask>Returns TRUE if the execute flag (x) of the rwx mode mask is on. (binary 001 = 1).Lin, Sol, HPUX, AIX, Ubu:8.1
read of <mode_mask>Returns TRUE if the read flag of the rwx mode mask is on. (binary 100 = 4).Lin, Sol, HPUX, AIX, Ubu:8.1
write of <mode_mask>Returns TRUE if the write flag (w) of the rwx mode mask is on. (binary 010 = 2).Lin, Sol, HPUX, AIX, Ubu:8.1
value accessible of <symlink>Returns TRUE if the pathname pointed to by the specified symlink is available. Returns FALSE if the file object is missing or unavailable with the current permissions.Lin, Sol, HPUX, AIX, Ubu:8.1
quiet of <grub bootable image>True if bootable image has been designated as quiet, so as not to display verbose booting information.Lin:8.2, Sol:8.2, Ubu:8.2
savedefault of <grub bootable image>True if bootable image has been designated as "savedefault." This causes the bootable image to become the default after it has been booted.Lin:8.2, Sol:8.2, Ubu:8.2
hiddenmenu of <grub config file>True if menu has been explicitly designated to be hidden.Lin:8.2, Sol:8.2, Ubu:8.2
nounzip of <grub module>True if module is to be loaded without unzipping itLin:8.2, Sol:8.2, Ubu:8.2
mac of <operating system>Returns TRUE if the client computer is a Macintosh.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
unix of <operating system>Returns TRUE if the local computer is a UNIX system.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
windows of <operating system>Returns TRUE if the local computer is a Windows system.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
smt capable of <cpupackage>If detectable, returns true if the cpupackage is capable of SMT threads (Simultaneous multithreading, called "Hyper-Threading" on some platforms)Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
smt enabled of <cpupackage>If detectable, returns true if the cpupackage is using SMT threads (Simultaneous multithreading, called Hyper-Threading on some platforms)Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
coma bug of <processor>Returns TRUE if the specified processor is afflicted by the coma bug. The coma bug afflicts certain Cyrix CPUs, causing them to occasionally lock up. The affected CPUs include the Cyrix/IBM 6x86, 6x86L, and 6x86MX.Lin, Ubu:8.1
f00f bug of <processor>Returns TRUE if the specified processor is afflicted by the f00f bug. This bug is named after the first two of a four-byte assembly language sequence that can freeze up x86 Pentium processors.Lin, Ubu:8.1
fdiv bug of <processor>Returns TRUE if the specified processor is afflicted by the fdiv bug, which occasionally causes incorrect floating point division answers.Lin, Ubu:8.1
fpu exception of <processor>Returns TRUE if the fpu exception has occurred on this processor.Lin, Ubu:8.1
fpu of <processor>Returns TRUE if the specified processor contains a floating point unit.Lin, Ubu:8.1
hlt bug of <processor>Returns TRUE if the specified processor is afflicted by the hlt bug.Lin, Ubu:8.1
sep bug of <processor>Returns TRUE if the given processor improperly reports the value of its SEP (Sysenter/sysexit Present) flag.Lin, Ubu:8.1
wp of <processor>Returns TRUE if the specified processor has the WP feature.Lin, Ubu:8.1
running of <service>Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.2
evaluated of <site>Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
member of <site group>Returns TRUE if the current computer is a member of the specified group.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<site version list> {cmp} <site version list>Compares two site version lists, component by component, where {cmp} is one of: <, <=, =.Win, Lin, Sol, HPUX, AIX, Mac, WM
relevance of <fixlet>Returns a boolean TRUE or False, depending on the Relevance of the specified Fixlet message.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
authenticating of <client>Returns true when client is performing client authentication to the relayUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
certificate of <client>Returns true when the client has received its certificate from the serverUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
enabled of <setting>Returns TRUE if the specified setting is enabled.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
running of <application usage summary>Returns TRUE if the specified application is currently running.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
allow unmentioned site of <license>If this property is TRUE, then the deployment is allowed to use sites that aren't mentioned in the license of any BES products. If FALSE, those sites will not be usable.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
evaluation of <license>Returns TRUE if client is running an evaluation license.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
fips mode of <license>Returns TRUE if the BES Action masthead specifies that applications (the client, console, or web reports, depending on the context) in the deployment should operate in FIPS 140-2 compliant mode.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
perpetual maintenance of <bes product>Returns true if license is of Perpetual Maintenance typeUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
perpetual of <bes product>Returns true if license is of Perpetual typeUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
term of <bes product>Returns true if license is of Term typeUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
legacy of <bes product>Returns true if license is of Legacy typeUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
desired fips mode of <cryptography>Returns TRUE if the application (the client, console, or web reports, depending on the context) tried to enter FIPS 140-2 compliant mode.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
fips mode of <cryptography>Returns TRUE if the application (the client, console, or web reports, depending on the context) is operating in FIPS 140-2 mode (the mode provided by openssl). FIPS mode limits the set of ciphers and SSL protocols that can be used in the cryptographic library.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
desired encrypt report of <client_cryptography>Returns TRUE if the client is configured to attempt to encrypt reports.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
encrypt report of <client_cryptography>Returns TRUE if the client is successfully encrypting reports.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
active of <logged on user>Returns TRUE if the specified user session is active (either as a current Fast User or an active terminal services connection).Win, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac, WM, Ubu:8.2
remote of <logged on user>Returns TRUE if the user session is a remote terminal services connection.Win, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac, WM, Ubu:8.2
active of <action>Returns TRUE if the action is currently running (active).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
constrained of <action>Returns TRUE if action is unable to run yet.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
group leader of <action>Returns TRUE if the action is a group action and the action component is the group leader. When you deploy a mult-action from the BES Console, it constructs a group action with a group leader to control the overall behavior of the action. This inspector is used internally to manage the progress of the group action.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
offer accepted of <action>Returns TRUE when users indicated they want to run the action by accepting the offer presented by the BES Client UI. When an offer has been accepted, the Client evaluates its constraints and runs as soon as conditions allow.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
offer of <action>Returns TRUE when the Action is presented as an offer (as indicated by the header "x-offer: 1").Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pending login of <action>Returns TRUE if the specified action included an 'action requires login' command, and a login has not yet occurred since the action has run.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pending of <action>Returns TRUE if action is available to run.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pending restart of <action>Returns TRUE if the specified action included an 'action requires restart' command and a restart has not occurred since the action has run.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
waiting for download of <action>Returns TRUE if client is waiting for mirroring server to have downloads required by the action.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
close wait of <tcp state>Returns true if the state represented is CLOSE_WAITUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
closed of <tcp state>Returns true if the state represented is CLOSEDUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
closing of <tcp state>Returns true if the state represented is CLOSINGUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
delete tcb of <tcp state>Returns true if the state represented is DELETE_TCBUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
established of <tcp state>Returns true if the state represented is ESTABLISHEDUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
fin wait one of <tcp state>Returns true if the state represented is FIN_WAIT1Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
fin wait two of <tcp state>Returns true if the state represented is FIN_WAIT2Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
last ack of <tcp state>Returns true if the state represented is LAST_ACKUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
listening of <tcp state>Returns true if the state represented is LISTENINGUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
syn received of <tcp state>Returns true if the state represented is SYN_RECEIVEDUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
syn sent of <tcp state>Returns true if the state represented is SYN_SENTUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
time wait of <tcp state>Returns true if the state represented is TIME_WAITUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
tcp of <socket>Returns true if the socket is a TCP socketUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
udp of <socket>Returns true if the socket is a UDP socketUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
alias of <network ip interface>Returns TRUE if the network ip interface has an alias defined for it (a virtual device, rather than a physical device).Lin, Sol, HPUX, AIX, Mac:8.0, Ubu:8.1
broadcast support of <network ip interface>Indicates that broadcast messages are supported by the ip interface.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
loopback of <network ip interface>Indicates that the particular network ip interface is a loopback interface.

Example:
address of ip interface whose (loopback of it = false) of network = "192.168.127.127" - Returns TRUE if the given IP address doesn't have loopback.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multicast support of <network ip interface>Indicates that multicast messages are supported by the ip interface.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
point to point of <network ip interface>Indicates that the interface is a point-to-point interface. Usually TRUE for dialup connections.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
up of <network ip interface>Returns TRUE if the specified network IP interface is currently up.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
loopback of <network adapter>Returns TRUE if the specified network adapter is a loopback interface.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, Ubu:8.1
multicast support of <network adapter>Returns TRUE if multicast messages are supported by the specified network adapter.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, Ubu:8.1
up of <network adapter>Returns TRUE if the specified network adaoter is currently working. Interfaces like wifi may be turned it off to save power, but this Inspector will still tell you if it is active.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, Ubu:8.1
broadcast support of <network adapter interface>Returns TRUE if the given network adapter interface has broadcast support.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
loopback of <network adapter interface>Returns TRUE if the specified interface supports loopbacks.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
multicast support of <network adapter interface>Returns TRUE if the specified interface supports multicasting.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
point to point of <network adapter interface>A network adapter interface can be a point-to-point interface, such as you might use for a VPN connection or a SLIP connection. This Inspector returns TRUE if the specified network adapter interface is configured to run point-to-point.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
up of <network adapter interface>Returns TRUE if the specified interface is currently up and working.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ip version> = <ip version>Compares two IP versions for equality.Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4 address> {cmp} <ipv4 address>Returns a boolean TRUE/FALSE depending on the result of the comparison, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<string> {cmp} <ipv4 address>Returns a boolean TRUE/FALSE depending on the result of the comparison, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<ipv4 address> {cmp} <string>Returns a boolean TRUE/FALSE depending on the result of the comparison, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<ipv6 address> {cmp} <ipv6 address>Where {cmp} is one of: <, <=, =.Win, Lin, Sol, HPUX, AIX, Mac, WM
<ipv4or6 address> {cmp} <ipv4or6 address>Where {cmp} is one of: <, <=, =.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0
<ipv4or6 address> {cmp} <string>Where {cmp} is one of: <, <=, =.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0
<string> {cmp} <ipv4or6 address>Where {cmp} is one of: <, <=, =.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0
gateway flag of <ipv4 route>Returns a boolean specifying if the route is going through a gateway.Lin:8.2, Sol:8.2, Ubu:8.2
host flag of <ipv4 route>Returns a boolean specifying if the target of the route is a host.Lin:8.2, Sol:8.2, Ubu:8.2
reject flag of <ipv4 route>Returns a boolean specifying if the route is a blocking route.Lin:8.2, Sol:8.2, Ubu:8.2
up flag of <ipv4 route>Returns a boolean specifying if the route is up.Lin:8.2, Sol:8.2, Ubu:8.2
installed <string> of <rpmdatabase>Returns TRUE if some package in the RPM database provides the capability represented by this string.Lin, AIX:8.2
<capability> contains <capability>Returns a boolean TRUE if the first capability satisfies the dependency specified by the second capability. A capability without version information is interpreted as a capability over all versions. If a package requires a capability not contained in the RPM database, then the rpm command will not allow that package to be installed.

Example:
capability "x" contains capability "x = 1.0" - Returns TRUE. Having "x" at any version satisfies a requirement to have "x" at version 1.0.

Example:
capability "x = 1.0" contains capability "x" - Returns TRUE. Having "x" at version 1.0 satisfies a requirement to have "x" at any version.

Example:
capability "x = 1.0" contains capability "x > 1.0" - Returns FALSE. Having x = version 1.0 will not satisfy a requirement to have x > version 1.0.

Example:
capability "x = 1.0" contains capability "x < 2.0" - Returns TRUE. Having x = version 1.0 will satisfy a requirement to have x < version 2.0.

Example:
capability "x" contains capability "y" - Returns FALSE. A capability can only be contained/satisfied by a capability with the same name.
Lin
<rpm package release> {cmp} <rpm package release>Compares two RPM Package releases, where {cmp} is one of: <, <=, =.Lin:8.0
<rpm package release> {cmp} <string>Compares an RPM Package release with a string value, where {cmp} is one of: <, <=, =.Lin:8.0
<string> {cmp} <rpm package release>Compares a string to an RPM Package release, where {cmp} is one of: <, <=, =.Lin:8.0
<rpm package version> {cmp} <rpm package version>Compares two RPM Package versions, where {cmp} is one of: <, <=, =.Lin:8.0
<rpm package version> {cmp} <string>Compares an RPM Package version to a string, where {cmp} is one of: <, <=, =.Lin:8.0
<string> {cmp} <rpm package version>Compares a string to an RPM Package version, where {cmp} is one of: <, <=, =.Lin:8.0
<rpm package version record> {cmp} <rpm package version record>Compares two RPM Package version records, where {cmp} is one of: <, <=, =.Lin:8.0
<rpm package version record> {cmp} <short rpm package version record>Compares an RPM Package version record with a short RPM package version record, where {cmp} is one of: <, <=, =.Lin:8.0
<rpm package version record> {cmp} <string>Compares an RPM package version record against a string, where {cmp} is one of: <, <=, =.Lin:8.0
<short rpm package version record> {cmp} <rpm package version record>Compares an RPM Package version record with a short version, where {cmp} is one of: <, <=, =.Lin:8.0
<string> {cmp} <rpm package version record>Compares a string to an RPM Package version record, where {cmp} is one of: <, <=, =.Lin:8.0
<short rpm package version record> {cmp} <short rpm package version record>Compares two short RPM Package version records, where {cmp} is one of: <, <=, =.Lin:8.0
full of <power level>Returns TRUE if the battery is fully charged.

Example:
full of power level - Returns TRUE if the battery is currently topped off.
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
low of <power level>Returns TRUE if the battery is at a low charge level.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
normal of <power level>Returns TRUE if the battery is at a normal charge level.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
plugged of <power level>Returns TRUE if the computer is currently plugged in to AC power.

Example:
plugged of power level - Returns TRUE if the computer is currently plugged in.
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
ups of <power level>Returns TRUE if the computer is currently being powered by a UPS.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<type> = <type>Returns TRUE if both expressions denote the same type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
dependency known of <property>This introspector returns TRUE if a property's dependency is known. If it isn't, then properties containing the expression can't be fingerprinted, an optimization that exempts expressions from re-evaluation if their dependencies haven't changed.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
multivalued of <property>Can the property have more than one value for a single input?.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<boolean> * <time range><timed( time range, boolean )>Returns a time interval labeled with a boolean TRUE or FALSE.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<boolean> {cmp} <boolean><boolean>Compare two boolean expressions. Returns another boolean, depending on the evaluation of the comparison:{cmp} is one of: =, != .Win, Lin, Sol, HPUX, AIX, Mac, WM
<boolean> {op} <boolean><boolean>Operates on two boolean expressions. Returns another boolean, depending on the evaluation of the operation, for example, (True And True) = True.{op} is one of: And, Or .Win, Lin, Sol, HPUX, AIX, Mac, WM
<floating point> {cmp} <floating point><boolean>Compares two floating point numbers, where: {cmp} is one of: =, <, <=.Win, Lin:8.0, Mac, WM
<floating point> {cmp} <integer><boolean>Compares a floating point number and an integer, where: {cmp} is one of: =, <=, <.Win, Lin:8.0, Mac, WM
<integer> {cmp} <floating point><boolean>Compares an integer to a floating point number, where:{cmp} is one of: =, <=, <.Win, Lin:8.0, Mac, WM
<time interval> {cmp} <time interval><boolean>Compare two time intervals, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<time range> * <boolean><timed( time range, boolean )>Returns a time interval labeled with the specified boolean, in the form of:(<date> to <date>), <boolean>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<boolean> as string<string>Converts the boolean value to a string. The possible values returned are "True" and "False" with this exact case, for example:TRUE as string = "True".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
conjunction of <boolean><boolean>

Plural: conjunctions
This inspector performs a serial AND on all its boolean arguments:conjunction of (true; true; true) -> TRUEconjunction of (true; true; false) -> FALSE.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
disjunction of <boolean><boolean>

Plural: disjunctions
This inspector performs a serial OR on all its boolean arguments:disjunction of (false; false; false) -> FALSEdisjunction of (false; false; true) -> TRUE.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

integer

Integers are represented internally as 64-bit signed values.

Creation Methods

DeclarationDescriptionPlatforms (?)
<integer> as integerReflexive cast for completeness.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
absolute value of <integer>Returns the positive value of the integer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <integer>Returns the maximum of a list of integers.

Example:
maximum of (7;2;4;5) - Returns 7.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <integer>Returns the minimum of a list of integers.

Example:
minimum of (sizes of files of folder "c:\") - Returns the size of the smallest file in the indicated folder.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
product of <integer>Multiplies a list of integers, returning the product.

Example:
product of (1;2;3) - Returns 6.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
significant digits <integer> of <integer>Returns a number with <integer> significant digits (for example, significant digits 3 of 1235569 = 1240000).

Example:
significant digits 3 of 1235569 - Returns 1240000.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
sum of <integer>Returns the sum of a list of integers.

Example:
sum of (sizes of files of folder "c:\") - Returns the sum of the sizes of all files in the specified folder.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
- <integer>Creates the negative of the integer provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> {op} <integer>Returns the integer solution to the equation, depending on the operator, where:{op} is one of: +, -, *, /, mod .

Example:
21 mod 5 - Returns 1.
Win, Lin, Sol, HPUX, AIX, Mac, WM
multiplicity of <integer with multiplicity>Returns the multiplicity (quantity) of each element in a multiple integer list.

Example:
multiplicities of unique values of (1;2;3;3) - Returns the multiplicity of (the number of times) each number in the list is used, namely, 1,1,2.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
element of <integer set>Returns the unique elements of the specified <integer set>, removing duplicates and sorting by value.

Example:
elements of set of (5;7;2;3;3;3) - Returns the integers 2,3,5,7.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
size of <integer set>Returns the number of unique elements in the specified set.

Example:
size of set of (3; 2; 2; 1; -1) - Returns 4, the number of unique elements in the defined set.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<floating point> as integerRounds off and casts a floating point number as an integer.

Example:
15/2 as integer - Returns 7.
Win, Lin:8.0, Mac, WM, Ubu:8.1
integer ceiling of <floating point>Returns the smallest integer not less than the floating point number. For example, ceiling of 2.1 = 3, ceiling of 2 = 2 and ceiling of -2.3 = -2.

Example:
integer ceiling of (15/8 as floating point) - Returns 2.
Win, Lin:8.0, Mac, WM, Ubu:8.1
integer floor of <floating point>Returns the largest integer less than or equal to the floating point number. For example, floor of 2.8 = 2, floor of -2 = -2 and floor of -2.1 = -3. For nonnegative x, this is the same as the integer part of x.

Example:
integer floor of ("-2.1" as floating point) - Returns -3.
Win, Lin:8.0, Mac, WM, Ubu:8.1
multiplicity of <floating point with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <floating point> types.Win, Lin:8.0, Mac, WM, Ubu:8.1
<string> as integerReturns an integer value for the string provided. If the string contains anything but ASCII digits, the conversion will fail. Use numeric value for more liberal parsing rules.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
length of <string>Returns the number of characters in the string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
numeric value of <string>Returns an integer for the first numeric value in the string.

Example:
numeric value of "string 123 xyz 45" = 123 - Returns TRUE.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <string with multiplicity>Returns the multiplicity (quantity) of each element in a multiple string list.

Example:
multiplicities of unique values of ("steak"; "chop"; "rib"; "rib"; "rib") - Returns the multiplicity of (the number of times) each string in the list is used, namely, 1,3,1. Note that the multiplicities are based on the alphabetic order of the strings (chop, rib, steak), not their position in the list.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
size of <string set>Returns the number of unique elements in the specified set.

Example:
size of set of ("to";"be"; "or"; "not"; "to"; "be") - Returns 4, the number of unique strings in the set.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
length of <rope>Returns the number of bytes in the rope.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<bit set> as integerReturns the integer whose binary representation matches the bit set.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
least significant one bit of <bit set>Returns the least n such that bit n of the set is true.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
most significant one bit of <bit set>Returns the greatest n such that bit n of the set is true.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
one bit of <bit set>Returns the numbers n for which bit n of the set is true.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <hertz with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <hertz> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <time with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <time> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
hour_of_day of <time of day>Returns the hour section of the 'time of day' object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minute_of_hour of <time of day>Returns the 'minutes after the hour' section of the 'time of day' object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
second_of_minute of <time of day>Extracts the 'seconds after the minute' section of the 'tim of day' object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <time of day with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <time of day> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <time zone with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <time zone> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
hour_of_day of <time of day with time zone>Returns the hour section of the 'time of day with time zone' object.

Example:
hour_of_day of time (universal time zone) of now - Returns the hour of day in Greenwich, England.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minute_of_hour of <time of day with time zone>Returns the 'minutes after the hour' section of the 'time of day with time zone' object.

Example:
minute_of_hour of time (local time zone) of now - Returns the current minute past the hour.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
second_of_minute of <time of day with time zone>Returns the 'seconds after the minute' section of the 'time of day with time zone' object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <time of day with time zone with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <time of day with time zone> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <time range with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <time range> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <time interval with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <time interval> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <date with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <date> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <day of week with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <day of week> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> as integerCast a day of month type as an integer.

Example:
current day_of_month as integer - Returns the day of the month as an integer.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <day of month with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <day of month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <day of year with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <day of year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> as integerConverts the given month into an integer (1-12).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <month with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <month and year with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <month and year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <number of months with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <number of month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> as integerCasts a year as an integer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <year with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
computer idThis is a unique integer assigned to the computer by the BES system.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
greatest integerReturns the largest integer that can be represented on this machine. See integer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
hexadecimal integer <string>Creates an integer from the provided hexadecimal value.

Example:
hexadecimal integer "A0" - Returns 160.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
integer <integer>Returns an integer. The keyword is optional.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
integer <string>Returns integer for name provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
integer in <( integer, integer )>Returns a list of the integers contained between the endpoints (inclusive). The order is preserved, from least to greatest or vice-versa.

Example:
integers in (2,-1) - Returns 2, 1, 0, -1.
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
integer in <( integer, integer, integer )>Returns a list of the integers contained between the endpoints (inclusive) specified by the first two integers, with a step size specified by the third integer.

Example:
integers in (1,6,2) - Returns 1,3,5.
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
integer to <integer>Returns a list of integers from zero up to the specified integer.

Example:
integers to 2 - Returns 0,1,2.
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
least integerReturns the least integer value that can be represented on this machine.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
file count of <filesystem>Returns the total number of files that may be saved on this filesystem.Lin, Sol, HPUX, AIX, Ubu:8.1
free file count of <filesystem>Returns the number of files available on this filesystem.Lin, Sol, HPUX, AIX, Ubu:8.1
free percent of <filesystem>Returns the percentage of the file system currently available.Lin, Sol, HPUX, AIX, Ubu:8.1
free space of <filesystem>Returns the number of bytes on this filesystem.Lin, Sol, HPUX, AIX, Ubu:8.1
size of <filesystem>Returns the total number of bytes on this file system (same as total space).Lin, Sol, HPUX, AIX, Ubu:8.1
total space of <filesystem>Returns the total number of bytes on this file system (same as size).Lin, Sol, HPUX, AIX, Ubu:8.1
used file count of <filesystem>The number of files in use on this filesystem.Lin, Sol, HPUX, AIX, Ubu:8.1
used percent of <filesystem>Returns the percentage of the file system currently in use.Lin, Sol, HPUX, AIX, Ubu:8.1
used space of <filesystem>Returns the number of bytes on this filesystem currently in use.Lin, Sol, HPUX, AIX, Ubu:8.1
gid of <filesystem object>Returns the group ID of the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
group mask of <filesystem object>Returns the group permission mask of the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
link count of <filesystem object>Returns an integer corresponding to the number of hard links attached to the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
other mask of <filesystem object>Returns the other (not in the group) mask as a 3-bit integer corresponding to rwx permissions for the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
uid of <filesystem object>The user ID of the user who owns this filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
user mask of <filesystem object>Integer representing user permissions (3 bit mask, RWX) on the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
byte <integer> of <file>Returns the numeric value of the byte located at the offset specified by number within the file. Byte 0 of the file is the first byte.

Example:
byte 0 of file "C:\test.txt" - Returns the first byte in the specified file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
size of <file>Returns the size in bytes of a file.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <version with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <version> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<mode_mask> as integerConverts the mode mask to an integer, 1-4.Lin, Sol, HPUX, AIX, Ubu:8.1
line number of <file line>Returns the line number of a given line. Can be used to locate specific lines in a file.

Example:
line number of line containing "[mciavi]" of file "mmdriver.inf" of system folder - Returns the line number of the specified line in the given file.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
gid of <symlink>Returns the group ID of the given symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
link count of <symlink>Returns an integer corresponding to the number of hard links attached to the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
uid of <symlink>The user ID of the user who owns this symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
total size of <download storage folder>Returns the amount of storage currently being used to store downloads (in bytes).Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
major of <device file>Returns the major number of the specified device file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
minor of <device file>Returns the minor number of the specified device file.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
timeout of <grub config file>How many seconds to wait for a user choice before booting the default image.Lin:8.2, Sol:8.2, Ubu:8.2
index of <grub image choice>Zero-based index to an image within the grub config file.Lin:8.2, Sol:8.2, Ubu:8.2
core of <cpupackage>Returns the number of physical cores in a single cpupackage (a single socket or physical CPU)Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
count of <cpupackage>Returns the count of physical cpu packages packages (the number of sockets or physical CPUs). Multiply this number by the number of cores to get the total core count of the system.Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
thread of <cpupackage>Returns the number of SMT threads (Simultaneous multithreading, called Hyper-Threading on some platforms) in a single cpupackage (a single socket or physical CPU)Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
extended feature mask of <processor>Returns a mask of the extended feature bits of an x86 processorUbu:9.0, Lin:9.0, Mac:9.0, Win:9.0
adjustment <integer> of <processor>s390 processors only. Returns the processor Adjustment Way (guest performance)Lin:8.2
bogomips of <processor>Returns the Bogomips of the specified processor, which provides a rough indication of its speed.Lin, Ubu:8.1
capability of <processor>s390 processors only. Returns the capability code of the processorLin:8.2
cpuid level of <processor>Returns an integer corresponding to the cpuid level for the given processor.Lin, Ubu:8.1
cpus configured of <processor>s390 processors only. Returns the number of processors configured for the systemLin:8.2
cpus reserved of <processor>s390 processors only. Returns the number of processors reserved for the systemLin:8.2
cpus standby of <processor>s390 processors only. Returns the number of processors in standby for the systemLin:8.2
cpus total of <processor>s390 processors only. Returns the number of total processors for the systemLin:8.2
family of <processor>Returns an integer representing the family of the CPU. See the notes for the meaning of these numbers. As of BES 6.0, this Inspector returns a string on Solaris and AIX computers.Win, Lin, Sol, AIX, Mac:8.2, WM, Ubu:8.1
index of <processor>Returns the ordinal number of the processor on a multi processor machine.Lin, Sol, HPUX, AIX, Ubu:8.1
lpar adjustment of <processor>s390 processors only. Returns the LPAR agjustment for the processorLin:8.2
lpar cpus configured of <processor>s390 processors only. Returns the number of processors configured for the LPARLin:8.2
lpar cpus dedicated of <processor>s390 processors only. Returns the number of processors dedicated for the LPARLin:8.2
lpar cpus reserved of <processor>s390 processors only. Returns the number of processors reserved for the LPARLin:8.2
lpar cpus shared of <processor>s390 processors only. Returns the number of processors shared for the LPARLin:8.2
lpar cpus standby of <processor>s390 processors only. Returns the number of processors in standby for the LPARLin:8.2
lpar cpus total of <processor>s390 processors only. Returns the total number of processors for the LPARLin:8.2
lpar number of <processor>s390 processors only. Returns the LPAR number for this processorLin:8.2
model of <processor>Returns the model number of the CPU.Note: On Solaris, HPUX and AIX computers, this Inspector returns a <string> as of BES 6.0.

Example:
model of processor = 15 - Returns TRUE if the processor model is 15. For more information, see the Intel and AMD documentation on the Model number returned by the CPUID instruction.
Win, Lin, Mac:8.2, WM, Ubu:8.1
stepping of <processor>Returns the stepping number of the processor. This item can be helpful in identifying very specific processor features or limitations.Win, Lin, Mac:8.2, WM, Ubu:8.1
vm adjustment of <processor>s390 processors only. Returns the VM Adjustment for the processorLin:8.2
vm cpus configured of <processor>s390 processors only. Returns the number of processors configured for the VMLin:8.2
vm cpus reserved of <processor>s390 processors only. Returns the number of processors configured for the VMLin:8.2
vm cpus standby of <processor>s390 processors only. Returns the number of processors in standby for the VMLin:8.2
vm cpus total of <processor>s390 processors only. Returns the total number of processors for the VMLin:8.2
available amount of <ram>Returns the amount of system ram that is currently available, in bytes.Lin, Ubu:8.1
buffered amount of <ram>Returns the amount of system RAM currently buffered, in bytes.Lin, Ubu:8.1
cached amount of <ram>Returns the amount of system RAM currently cached, in bytes.Lin, Ubu:8.1
free amount of <ram>Returns the amount of system RAM currently unused, in bytes.Lin, Sol, HPUX, AIX, Ubu:8.1
shared amount of <ram>Returns the amount of system RAM currently shared, in bytes.Lin, Ubu:8.1
size of <ram>Returns the number of bytes of random access memory on the current machine.

Example:
size of ram / (1024 * 1024) - Returns the size of RAM in megabytes.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
total amount of <ram>Same as size of <ram>.Lin, Sol, HPUX, AIX, Ubu:8.1
unavailable amount of <ram>Returns the amount of system RAM currently unavailable, in bytes.Lin, Ubu:8.1
used amount of <ram>Returns the amount of system RAM currently used, in bytes.Lin, Sol, HPUX, AIX, Ubu:8.1
ppid of <process>Returns the PPID of the process specifiedUbu:9.0, Lin:9.0, HPUX:9.0, AIX:9.0, Sol:9.0
id of <process>Returns the integer ID of the specified process.Win:8.0, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
pid of <process>Returns the integer process ID for the specified process.Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
process id of <process>Returns the integer process ID for the specified process.Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
free amount of <swap>Returns the amount of the swap partition currently unused, in bytes.Lin, HPUX, AIX, Ubu:8.1
size of <swap>Returns the size, in bytes, of the swap partition.Lin, HPUX, AIX, Ubu:8.1
total amount of <swap>Same as size of <swap>.Lin, HPUX, AIX, Ubu:8.1
used amount of <swap>Returns the amount of the swap partition currently in use, in bytes.Lin, HPUX, AIX, Ubu:8.1
integer <string> of <smbios structure>Returns the integer data of the named value in a specified smbios structure. Returns NSO if the data type is not integer.

Example:
integer "bios_rom_size" of structure "bios_information" of smbios - Returns the integer value of the bios rom size from the 'bios_information' structure.
Win:8.0, Lin:8.0, Ubu:8.1
length of <smbios structure>Returns the length of the smbios structure as defined in the SMBIOS specification.Win:8.0, Lin:8.0, Ubu:8.1
type of <smbios structure>Returns the type of the smbios structure (as an integer) defined in the SMBIOS specification.Win:8.0, Lin:8.0, Ubu:8.1
offset of <smbios value>Returns the offset position relative to the start of the given smbios value in its smbios structure. For more information about these offsets, see the SMBIOS specification.

Example:
offsets of values of structure "bios_information" of smbios - Returns a list of the offsets of each value in the specified smbios structure.
Win:8.0, Lin:8.0, Ubu:8.1
version of <site>Returns the version number of the site content.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
id of <site group>Returns the numeric ID of the specified site group. This is the number assigned to an automatic group when it is first defined.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
component <integer> of <site version list>Returns the nth element (as specified by <integer>) of the given site version list.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <site version list with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <site version list> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
id of <fixlet>Returns the numeric ID number of the specified Fixlet message.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
competition size of <selected server>The number of servers in the competition from which this server was selected.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
competition weight of <selected server>The total of the weights of the servers in the competition from which this server was selected.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
port number of <selected server>The port number to which reports are sent.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
priority of <selected server>The priority assigned to the server by the BES console. Servers with low priorities are preferred to servers with high priority.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
weight of <selected server>The weight assigned to the server by the BES console. Servers with the same priority and approximate distance compete to be chosen; servers with higher weights are more likely to be chosen.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
id of <root server>The DSA Server ID of the BES root server that the BES Client last registered with.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
average of <evaluation cycle>Returns the average time, in milliseconds, that it takes to evaluate a given BigFix Client content set. The average is based on the last ten cycles.

Example:
average of evaluationcycle of client - Returns the average evaluation cycle time in milliseconds.
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
maximum of <evaluation cycle>Returns the maximum time, in milliseconds, that it takes to evaluate a given BigFix Client content set.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
total run count of <application usage summary>Returns the number of times that the specified application has been run since the client was configured to track it.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
size of <application usage summary instance>Returns the size of the specified application instance.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
total run count of <application usage summary instance>Returns the number of times that the specified application instance has been run since the client was configured to track it.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
maximum seat count of <license>Returns maximum seat count allowed by the license.

Example:
maximum seat count of bes license - Returns the current number of BigFix Clients allowed by this license.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
registrar number of <license>A unique number assigned to the issuer of the Action Site certificate.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
seat of <license>The license number assigned to the client.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
site number of <license>A unique number assigned to the Action Site certificate.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
client device count of <bes product>Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
computer count of <bes product>Returns the number of computers allowed under the license terms of the specified BES product.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
non windows server count of <bes product>Returns the number of non-Windows servers included in the license for the specified BES Product.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
rvu count of <bes product>Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
windows server count of <bes product>Returns the number of Windows Servers licensed for the specified product.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
workstation count of <bes product>Returns the number of workstations licensed for the specified product.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
process id of <logged on user>Returns the process id number for the base session process for logged on users, usually the session manager.Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.2
exit code of <action>Returns an integer corresponding to the exit code of the specified action. This value will not exist if the action has not yet produced an exit code.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
id of <action>Returns the numeric ID associated with the specified Action.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
origin fixlet id of <action>Returns the Fixlet id that contained the action.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
local port of <socket>Returns an <integer> representing the local port number of the socketUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
remote port of <socket>Returns an <integer> representing the remote port number of the socketUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
family of <network interface>Returns an family designator of the address family (i.e., 2=AFI_NET).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <ipv4 address with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <ipv4 address> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
hexadecet <integer> of <ipv6 address>Returns one of the eight 16-bit parts (hexadecets) of an IPv6 address specified by <integer>. Here zero refers to the highest hexadecet (network or big-endian order). Thus hexadecet 0 refers to the most-significant 16-bits of the 128 bit IPv6 address.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
multiplicity of <ipv6 address with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <ipv6 address> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
hexadecet <integer> of <ipv4or6 address>Returns one of the eight 16-bit parts (hexadecets) of an ipv4or6 address specified by <integer>. Here zero refers to the highest hexadecet (network or big-endian order). Thus hexadecet 0 refers to the most-significant 16-bits of the 128 bit ipv4or6 address.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
multiplicity of <ipv4or6 address with multiplicity>Returns the multiplicity (how many entries of each unique address) of a list of ipv4or6 addresses.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
irtt of <ipv4 route>Returns an integer specifying the initial roud trip time for TCP connections over the route in milliseconds (1-12000). Typically only used on AX.25 networks, with a default value of 300 if not specified.,
metric of <ipv4 route>Returns an integer specifying the metric value of the route.,
mtu of <ipv4 route>Returns an integer specifying the maximum transmission unit setting of the route. Typically not used.,
window of <ipv4 route>Returns the TCP window setting for connections over the route. Typically only used on AX.25 networks and with drivers unable to handle back to back frames.,
multiplicity of <rpm package release with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <rpm package release> types.Lin:8.0, AIX:8.2
multiplicity of <rpm package version with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <rpm package version> types.Lin:8.0, AIX:8.2
epoch of <rpm package version record>Returns the integer Epoch (which grants RPM more flexibility in versioning) of the specified RPM Package version record.Lin:8.0, AIX:8.2
multiplicity of <rpm package version record with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <rpm package version record> types.Lin:8.0, AIX:8.2
epoch of <short rpm package version record>Returns the integer Epoch (which grants RPM more flexibility in versioning) of the specified short version of the RPM Package version record.Lin:8.0, AIX:8.2
multiplicity of <short rpm package version record with multiplicity>Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <short rpm package version record> types.Lin:8.0, AIX:8.2
size of <type>The number of bytes used in the internal representation of an object of the given type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
- <integer><integer>Creates the negative of the integer provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<floating point> {cmp} <integer><boolean>Compares a floating point number and an integer, where: {cmp} is one of: =, <=, <.Win, Lin:8.0, Mac, WM
<floating point> {op} <integer><floating point>Operates on a floating point number and an integer, returning a floating point number, where:{op} is one of: +, -, *, /, And .Win, Lin:8.0, Mac, WM
<hertz> {op} <integer><hertz>Returns a hertz object operated on by the given integer, where:{op} is one of: *, / .Win, Lin, Sol, HPUX, AIX, Mac, WM
<integer set> contains <integer><boolean>Returns TRUE if the specified set contains the given integer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> * <number of months><number of months>Multiply a number of months by an integer, producing a new number of months. This is a typical technique to create a value of this type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> * <time range><timed( time range, integer )>Returns a tuple of a time interval and an integer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> {cmp} <integer><boolean>Returns boolean TRUE or FALSE, depending on the comparison operator, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<integer> {op} <floating point><floating point>Operates on an integer and a floating point number, returning a floating point number, where:{op} is one of: -, +, *, /.Win, Lin:8.0, Mac, WM
<integer> {op} <integer><integer>Returns the integer solution to the equation, depending on the operator, where:{op} is one of: +, -, *, /, mod .Win, Lin, Sol, HPUX, AIX, Mac, WM
<number of months> {op} <integer><number of months>Where {op} is one of: *, /.Win, Lin, Sol, HPUX, AIX, Mac, WM
<time range> * <integer><timed( time range, integer )>Returns a time interval labeled with the specified integer, in the form of:(<date> to <date>), <integer>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
april <integer> of <integer><date>

Plural: aprils
Returns the nth day of April and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
april of <integer><month and year>

Plural: aprils
Creates a date (in month year format) corresponding to April of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
august <integer> of <integer><date>

Plural: augusts
Returns the nth day of August and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
august of <integer><month and year>

Plural: augusts
Creates a date (in month year format) corresponding to August of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
december <integer> of <integer><date>

Plural: decembers
Returns the nth day of December and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
december of <integer><month and year>

Plural: decembers
Creates a date (in month year format) corresponding to December of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
february <integer> of <integer><date>

Plural: februarys
Returns the nth day of February and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
february of <integer><month and year>

Plural: februarys
Creates a date (in month year format) corresponding to February of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
january <integer> of <integer><date>

Plural: januarys
Returns the nth day of January and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
january of <integer><month and year>

Plural: januarys
Creates a date (in month year format) corresponding to January of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
july <integer> of <integer><date>

Plural: julys
Returns the nth day of July and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
july of <integer><month and year>

Plural: julys
Creates a date (in month year format) corresponding to July of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
june <integer> of <integer><date>

Plural: junes
Returns the nth day of June and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
june of <integer><month and year>

Plural: junes
Creates a date (in month year format) corresponding to June of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
march <integer> of <integer><date>

Plural: marchs
Returns the nth day of March and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
march of <integer><month and year>

Plural: marchs
Creates a date (in month year format) corresponding to March of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
may <integer> of <integer><date>

Plural: mays
Returns the nth day of May and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
may of <integer><month and year>

Plural: mays
Creates a date (in month year format) corresponding to May of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
november <integer> of <integer><date>

Plural: novembers
Returns the nth day of November and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
november of <integer><month and year>

Plural: novembers
Creates a date (in month year format) corresponding to November of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
october <integer> of <integer><date>

Plural: octobers
Returns the nth day of October and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
october of <integer><month and year>

Plural: octobers
Creates a date (in month year format) corresponding to October of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
september <integer> of <integer><date>

Plural: septembers
Returns the nth day of September and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
september of <integer><month and year>

Plural: septembers
Creates a date (in month year format) corresponding to September of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
<integer> as bit set<bit set>Returns the bits of the binary representation of the integer; bit zero is the least-significant bit.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> as bits<bit set>Returns the bits of the binary representation of the integer; bit zero is the least-significant bit.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> as day_of_month<day of month>Cast an integer as a day of the month type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> as floating point<floating point>Converts an integer into a floating point number.Win, Lin:8.0, Mac, WM, Ubu:8.1
<integer> as hexadecimal<string>Converts an integer into a hexadecimal string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> as integer<integer>Reflexive cast for completeness.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> as month<month>Returns the name of the nth month of the year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> as string<string>Converts an integer to a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> as year<year>Casts an integer as a year type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
absolute value of <integer><integer>

Plural: absolute values
Returns the positive value of the integer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
bit <integer> of <integer><boolean>

Plural: bits
Returns TRUE if the numbered bit is on. Bits are numbered starting at zero. Bit 0 is the least significant bit.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
extrema of <integer><( integer, integer )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <integer> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <integer><integer>

Plural: maxima
Returns the maximum of a list of integers.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <integer><integer>

Plural: minima
Returns the minimum of a list of integers.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
product of <integer><integer>

Plural: products
Multiplies a list of integers, returning the product.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
set of <integer><integer set>

Plural: sets
Creates a set from the given list of semicolon-separated integers.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
significant digits <integer> of <integer><integer>

Plural: significant digitss
Returns a number with <integer> significant digits (for example, significant digits 3 of 1235569 = 1240000).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
sum of <integer><integer>

Plural: sums
Returns the sum of a list of integers.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <integer><integer with multiplicity>

Plural: unique values
Returns the unique values of a given list of <integer> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

integer with multiplicity

The <integer with multiplicity> Inspectors deal with arrays of integers, allowing you to extract unique numbers and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <integer>Returns the unique values of a given list of <integer> types, removing duplicates and sorting by value.

Example:
unique values of (1;2;3;3) - Returns a list of the count of each integer, namely 1,1,2.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <integer with multiplicity><integer>

Plural: multiplicities
Returns the multiplicity (quantity) of each element in a multiple integer list.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

integer set

The <integer set> Inspectors deal with sets of integers, which are essentially lists or arrays with integer elements. Think of them as mathematical sets: you can compare them, subtract them from other sets and form the union and intersection of multiple sets.Note: These Inspectors are not available on SUSE Linux systems.

Creation Methods

DeclarationDescriptionPlatforms (?)
set of <integer>Creates a set from the given list of semicolon-separated integers.

Example:
set of (3; 2; 2; 1; -1) contains 4 - Returns FALSE.

Example:
set of (3; 2; 2; 1; -1) contains set of (2; -1) - Returns TRUE.

Example:
set of (3; 2; 2; 1; -1) = set of (2; -1) - Returns FALSE.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
intersection of <integer set>Returns a set of integers equal to the intersection of the specified sets, in numeric order and with redundant elements stripped out.

Example:
elements of intersection of (set of (3;2;1); set of (2;3;4)) - Returns the list: 2,3.

Example:
intersection of (set of (-1; 2); set of (2; 1; 3); set of (2; 5)) - Returns 2.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
union of <integer set>Returns a set of integers equal to the union of the specified sets, in numeric order and with redundant elements stripped out.

Example:
elements of union of (set of (1;2;3); set of (2;3;4)) - Returns the list: 1,2,3,4.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer set> - <integer set>Subtracts the elements in the second set from the elements in the first.

Example:
elements of (set of (1;2;3) - set of (2;3;4)) - Returns 1.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer set> * <integer set>Returns the intersection of the two specified sets.

Example:
elements of (set of (1;2;3) * set of (2;3;4)) - Returns the list: 2,3.

Example:
elements of (set of (1;2;3) * set of (2;3;4) * set of (3;4;5)) - Returns 3.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer set> + <integer set>Returns the union of the specified sets.

Example:
elements of (set of (1;2;3) + set of (2;3;4)) - Returns the list: 1,2,3,4.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<integer set> - <integer set><integer set>Subtracts the elements in the second set from the elements in the first.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer set> * <integer set><integer set>Returns the intersection of the two specified sets.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer set> + <integer set><integer set>Returns the union of the specified sets.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer set> = <integer set><boolean>Returns TRUE if the specified sets have identical contents.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer set> contains <integer set><boolean>Returns TRUE if the first set contains all the elements of the second set.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer set> contains <integer><boolean>Returns TRUE if the specified set contains the given integer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
element of <integer set><integer>

Plural: elements
Returns the unique elements of the specified <integer set>, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
intersection of <integer set><integer set>

Plural: intersections
Returns a set of integers equal to the intersection of the specified sets, in numeric order and with redundant elements stripped out.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
size of <integer set><integer>

Plural: sizes
Returns the number of unique elements in the specified set.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
union of <integer set><integer set>

Plural: unions
Returns a set of integers equal to the union of the specified sets, in numeric order and with redundant elements stripped out.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

floating point

The <floating point> type holds a floating-point number, with precision dependent on the computer. It also keeps track of the IEEE floating-point exceptions raised in a calculation and an estimate of the significance with which the number should be expressed when it is converted to a string. All arithmetic operations are carried out to the full precision of the computer; only conversions to string are affected by the estimated significance.

Creation Methods

DeclarationDescriptionPlatforms (?)
<integer> as floating pointConverts an integer into a floating point number.Win, Lin:8.0, Mac, WM, Ubu:8.1
<floating point> {op} <integer>Operates on a floating point number and an integer, returning a floating point number, where:{op} is one of: +, -, *, /, And .Win, Lin:8.0, Mac, WM
<integer> {op} <floating point>Operates on an integer and a floating point number, returning a floating point number, where:{op} is one of: -, +, *, /.Win, Lin:8.0, Mac, WM
<floating point> as floating pointThis casting operator is added for completeness. It takes a floating point number and casts it as a floating point number. It facilitates automatic relevance generation where the software is not aware of the input types.

Example:
(floating point "5.0") as floating point - Returns 5.0.

Example:
(3/ "2.00") as floating point - Returns 1.500.

Example:
(3/ "2.0000") as floating point - Returns 1.50000.
Win, Lin:8.0, Mac, WM, Ubu:8.1
less significance <integer> of <floating point>Removes <integer> number of digits of significance from the floating point value.

Example:
less significance 2 of floating point "5.115" - Returns 5.1.
Win, Lin:8.0, Mac, WM, Ubu:8.1
maximum of <floating point>Returns the maximum value from a list of <floating point> types.Win, Lin:8.0, Mac, WM, Ubu:8.1
minimum of <floating point>Returns the minimum value from a list of <floating point> types.Win, Lin:8.0, Mac, WM, Ubu:8.1
more significance <integer> of <floating point>Adds <integer> number of digits of significance to the floating point value.

Example:
more significance 2 of floating point "5.2" - Returns 5.200.
Win, Lin:8.0, Mac, WM, Ubu:8.1
product of <floating point>Multiplies a list of floating point numbers, returning a floating point product.Win:8.0, Lin:8.0, Mac:8.0, Ubu:8.1
relative significance place <integer> of <floating point>The same floating point value, to be expressed to the given number of significant digits.Win, Lin:8.0, Mac, WM, Ubu:8.1
relative significance place of <floating point>The base 10 logarithm of the quotient of the value and its significance place; approximately the number of significant digits to which the number should be expressed.Win, Lin:8.0, Mac, WM, Ubu:8.1
significance place <integer> of <floating point>The same floating point value, to be expressed to the given decimal place.

Example:
significance place 2 of floating point "9123" - Returns 9100.
Win, Lin:8.0, Mac, WM, Ubu:8.1
significance place of <floating point>The base 10 logarithm of the significance threshold; approximately the number of digits to the left (positive) or right (negative) of the ones place to which the number should be expressed.

Example:
significance place of floating point "9000" - Returns 3.00.
Win, Lin:8.0, Mac, WM, Ubu:8.1
significance threshold of <floating point>The difference between the given value and the next number expressed to the same significance level. For example, the significance threshold of 3 is 1, the significance threshold of 3.0 is 0.1, and the significance threshold of 3000 is 1000.Win, Lin:8.0, Mac, WM, Ubu:8.1
sum of <floating point>Returns the sum of a list of floating point numbers.Win:8.0, Lin:8.0, Mac:8.0, Ubu:8.1
- <floating point>Change the sign of a floating point number.Win, Lin:8.0, Mac, WM, Ubu:8.1
<floating point> {op} <floating point>Operates on two floating point numbers, returning another floating point number, where:{op} is one of: +, -, *, /.Win, Lin:8.0, Mac, WM
<floating point> {op} <integer>Operates on a floating point number and an integer, returning a floating point number, where:{op} is one of: +, -, *, / .Win, Lin:8.0, Mac, WM
<integer> {op} <floating point>Operates on an integer and a floating point number, returning a floating point number, where:{op} is one of: -, +, *, /.Win, Lin:8.0, Mac, WM
<string> as floating pointConverts the contents of a string into a floating point number.

Example:
"4.5" as floating point - Returns 4.5.
Win, Lin:8.0, Mac, WM, Ubu:8.1
floating point <floating point>Creates a floating point type object from the specified floating point number.

Example:
floating point (floating point "5.2") - Returns a floating point object of 5.3.
Win, Lin:8.0, Mac, WM, Ubu:8.1
floating point <string>Creates a floating point number from the provided string.Win, Lin:8.0, Mac, WM, Ubu:8.1
action percent of <evaluation cycle>Percentage of total time taken performing action processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
api percent of <evaluation cycle>Percentage of total time taken performing client api processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
archive percent of <evaluation cycle>Percentage of total time taken performing archive processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
gather percent of <evaluation cycle>Percentage of time taken performing gather processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
other percent of <evaluation cycle>Percentage of time taken performing other (unlassified) processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
property percent of <evaluation cycle>Percentage of time taken performing property processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
quiet mode percent of <evaluation cycle>Percentage of time taken performing quite mode processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
relay select percent of <evaluation cycle>Percentage of time taken performing relay select processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
relevance percent of <evaluation cycle>Percentage of time taken performing relevance processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
report percent of <evaluation cycle>Percentage of time taken performing report processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sleep percent of <evaluation cycle>Percentage of time taken sleeping since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
- <floating point><floating point>Change the sign of a floating point number.Win, Lin:8.0, Mac, WM, Ubu:8.1
<floating point> {op} <floating point><floating point>Operates on two floating point numbers, returning another floating point number, where:{op} is one of: +, -, *, /.Win, Lin:8.0, Mac, WM
<floating point> {op} <integer><floating point>Operates on a floating point number and an integer, returning a floating point number, where:{op} is one of: +, -, *, / .Win, Lin:8.0, Mac, WM
<integer> {cmp} <floating point><boolean>Compares an integer to a floating point number, where:{cmp} is one of: =, <=, <, >, >=, !=.Win, Lin:8.0, Mac, WM
<integer> {op} <floating point><floating point>Operates on an integer and a floating point number, returning a floating point number, where:{op} is one of: -, +, *, /.Win, Lin:8.0, Mac, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<floating point> as floating point<floating point>This casting operator is added for completeness. It takes a floating point number and casts it as a floating point number. It facilitates automatic relevance generation where the software is not aware of the input types.Win, Lin:8.0, Mac, WM, Ubu:8.1
<floating point> as integer<integer>Rounds off and casts a floating point number as an integer.Win, Lin:8.0, Mac, WM, Ubu:8.1
<floating point> as scientific notation<string>Converts a floating point number into a string with scientific notation.Win, Lin:8.0, Mac, WM, Ubu:8.1
<floating point> as standard notation<string>Converts a floating point number into a string with standard notation.Win, Lin:8.0, Mac, WM, Ubu:8.1
<floating point> as string<string>Converts a floating point number into a string with standard notation.Win, Lin:8.0, Mac, WM, Ubu:8.1
divided by zero of <floating point><boolean>

Plural: divided by zeroes
Returns TRUE if the calculation raised the divide-by-zero exception; that is, if some part of the calculation produced an exact infinity.Win, Lin:8.0, Mac, WM, Ubu:8.1
extrema of <floating point><( floating point, floating point )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <floating point> types.Win, Lin:8.0, Mac, WM, Ubu:8.1
finite of <floating point><boolean>

Plural: finites
Returns TRUE if the floating point number is finite.Win, Lin:8.0, Mac, WM, Ubu:8.1
inexact of <floating point><boolean>

Plural: inexacts
Returns TRUE if the calculation raised the inexact exception; that is, if some intermediate result could not be represented exactly.Win, Lin:8.0, Mac, WM, Ubu:8.1
infinite of <floating point><boolean>

Plural: infinites
Returns TRUE if the floating point number is infinite.Win, Lin:8.0, Mac, WM, Ubu:8.1
integer ceiling of <floating point><integer>

Plural: integer ceilings
Returns the smallest integer not less than the floating point number. For example, ceiling of 2.1 = 3, ceiling of 2 = 2 and ceiling of -2.3 = -2.Win, Lin:8.0, Mac, WM, Ubu:8.1
integer floor of <floating point><integer>

Plural: integer floors
Returns the largest integer less than or equal to the floating point number. For example, floor of 2.8 = 2, floor of -2 = -2 and floor of -2.1 = -3. For nonnegative x, this is the same as the integer part of x.Win, Lin:8.0, Mac, WM, Ubu:8.1
invalid of <floating point><boolean>

Plural: invalids
Returns TRUE if the calculation raised the invalid exception; that is, if some part of the calculation a function was applied to a value outside its domain.Win, Lin:8.0, Mac, WM, Ubu:8.1
less significance <integer> of <floating point><floating point>

Plural: less significances
Removes <integer> number of digits of significance from the floating point value.Win, Lin:8.0, Mac, WM, Ubu:8.1
maximum of <floating point><floating point>

Plural: maxima
Returns the maximum value from a list of <floating point> types.Win, Lin:8.0, Mac, WM, Ubu:8.1
minimum of <floating point><floating point>

Plural: minima
Returns the minimum value from a list of <floating point> types.Win, Lin:8.0, Mac, WM, Ubu:8.1
more significance <integer> of <floating point><floating point>

Plural: more significances
Adds <integer> number of digits of significance to the floating point value.Win, Lin:8.0, Mac, WM, Ubu:8.1
nan of <floating point><boolean>

Plural: nans
Returns TRUE if the value is not a number.Win, Lin:8.0, Mac, WM, Ubu:8.1
normal of <floating point><boolean>

Plural: normals
Returns TRUE if the value is a valid floating point number.Win, Lin:8.0, Mac, WM, Ubu:8.1
overflow of <floating point><boolean>

Plural: overflows
Returns TRUE if the calculation raised the overflow exception; that is, if some intermediate result was too large to be represented, but not an exact infinity.Win, Lin:8.0, Mac, WM, Ubu:8.1
product of <floating point><floating point>

Plural: products
Multiplies a list of floating point numbers, returning a floating point product.Win:8.0, Lin:8.0, Mac:8.0, Ubu:8.1
relative significance place <integer> of <floating point><floating point>

Plural: relative significance places
The same floating point value, to be expressed to the given number of significant digits.Win, Lin:8.0, Mac, WM, Ubu:8.1
relative significance place of <floating point><floating point>

Plural: relative significance places
The base 10 logarithm of the quotient of the value and its significance place; approximately the number of significant digits to which the number should be expressed.Win, Lin:8.0, Mac, WM, Ubu:8.1
significance place <integer> of <floating point><floating point>

Plural: significance places
The same floating point value, to be expressed to the given decimal place.Win, Lin:8.0, Mac, WM, Ubu:8.1
significance place of <floating point><floating point>

Plural: significance places
The base 10 logarithm of the significance threshold; approximately the number of digits to the left (positive) or right (negative) of the ones place to which the number should be expressed.Win, Lin:8.0, Mac, WM, Ubu:8.1
significance threshold of <floating point><floating point>

Plural: significance thresholds
The difference between the given value and the next number expressed to the same significance level. For example, the significance threshold of 3 is 1, the significance threshold of 3.0 is 0.1, and the significance threshold of 3000 is 1000.Win, Lin:8.0, Mac, WM, Ubu:8.1
sum of <floating point><floating point>

Plural: sums
Returns the sum of a list of floating point numbers.Win:8.0, Lin:8.0, Mac:8.0, Ubu:8.1
underflow of <floating point><boolean>

Plural: underflows
Returns TRUE if the calculation raised the underflow exception; that is, if some intermediate result was a nonzero value too small to be represented.Win, Lin:8.0, Mac, WM, Ubu:8.1
unique value of <floating point><floating point with multiplicity>

Plural: unique values
Returns the unique values of a given list of <floating point> types, removing duplicates and sorting by value.Win, Lin:8.0, Mac, WM, Ubu:8.1

floating point with multiplicity

The <floating point with multiplicity> Inspectors deal with floating point arrays, allowing you to extract unique floating point numbers and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <floating point>Returns the unique values of a given list of <floating point> types, removing duplicates and sorting by value.Win, Lin:8.0, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <floating point with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <floating point> types.Win, Lin:8.0, Mac, WM, Ubu:8.1

string

Strings are typically core objects, but some string Inspectors may be client-specific. Note: A string literal is written within double quotes. Special characters must be inserted by using the percent sign followed by 2 hex digits. Special characters include those characters with ASCII codes less than the 'space' character (hex 20) or greater than 'tilde' character (hex 7f) as well as the percent character itself (25 hex). For example, to create a string containing a null character and a percent character use "a null is %00, the percent itself is %25". Conversion to upper and lower case is also provided. String works in combination with the string position and substring data types. A string position is a point within a string. It can be compared to an integer, but it also acts as a pointer within a string so that the preceding and following text can be extracted. A substring is a part of a larger string. All operations allowed on a string can be performed on a substring. There are two substrings "be" in the string "To be or not to be". The substrings only differ in their positions within the string.

Creation Methods

DeclarationDescriptionPlatforms (?)
<boolean> as stringConverts the boolean value to a string. The possible values returned are "True" and "False" with this exact case, for example:TRUE as string = "True".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> as hexadecimalConverts an integer into a hexadecimal string.

Example:
255 as hexadecimal - Returns the string "ff".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> as stringConverts an integer to a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<floating point> as scientific notationConverts a floating point number into a string with scientific notation.

Example:
floating point "600987.9" as scientific notation - Returns 6.009879e+5.
Win, Lin:8.0, Mac, WM, Ubu:8.1
<floating point> as standard notationConverts a floating point number into a string with standard notation.

Example:
floating point "6.009e8" as standard notation - Returns 600900000.
Win, Lin:8.0, Mac, WM, Ubu:8.1
<floating point> as stringConverts a floating point number into a string with standard notation.Win, Lin:8.0, Mac, WM, Ubu:8.1
md5 of <string>Returns the md5 of the string, hex encoded as a string. Not available in FIPS mode.Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_224 of <string>Returns the sha2-224 of the string, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_256 of <string>Returns the sha2-256 of the string, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_384 of <string>Returns the sha2-384 of the string, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_512 of <string>Returns the sha2-512 of the string, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
<string> as hexadecimalConverts a string to a hexadecimal number.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as left trimmed stringTrims the leading spaces from a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as lowercaseReturns a lowercase version of the string provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as right trimmed stringTrims the trailing spaces from a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as stringReturns the string provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as trimmed stringTrims the leading and trailing spaces off of the specified string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as uppercaseReturns an uppercase version of the string provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
concatenation <string> of <string>This inspector concatenates the string items in the second argument with a separator defined by the string argument.

Example:
concatenation "/" of ("a" ; "b" ; "c" ) - Returns "a/b/c".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
concatenation of <string>Combines the supplied strings into a single string, end-to-end.

Example:
concatenation of (name of it & ":") of files of folder "c:\" - Returns a single string with the names of each file in the specified path separated by a colon.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
regex escape of <string>Creates a new string that escapes the special characters .[]{}()\*+?|^$,-.

Example:
regex escape of "[square] or {curly}" - Returns \[square\] or \{curly\}.
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
sha1 of <string>Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
tuple string item <integer> of <string>Parses the given string as if it were a tuple result string and returns the string which is the nth item of the tuple. The tuple Inspectors used to be session-only, but as of version 8.0, they are core Inspectors, available to all platforms at all times.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, WM:8.0, Ubu:8.1
tuple string item of <string>Parses the given string as if it were a tuple result string and iterates over the <string> objects that make up the tuple. The tuple Inspectors used to be session-only, but as of version 8.0, they are core Inspectors, available to all platforms at all times.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, WM:8.0, Ubu:8.1
<string> & <string>Concatenates two strings, producing a new string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
element of <string set>Returns the unique elements of the specified <string set>, removing duplicates and sorting by value.

Example:
elements of set of ("beta";"beta";"alpha";"gamma";"beta") - Returns the strings alpha, beta, gamma.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<rope> as stringConverts a rope into a string object. When converted, all the other string properties are available.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<bit set> as stringReturns the bits (0s and 1s) in a string format.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<undefined> as stringCasts the 'undefined' error as a string.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<hertz> as stringReturns a string formatted "##### hertz".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> as local stringReturns a string in MIME format of the given time object. The format is: ddd, DD mmm YYYY HH:MM:SS sZZZZ. The string is formatted using the local time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> as stringSame as above.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> as universal stringReturns a string in MIME format of the given time object. The format is:ddd, DD mmm YYYY HH:MM:SS +0000The string is formatted using the universal time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day> as stringCasts the time of day as a string type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
two digit hour of <time of day>Extracts the 2-digit hour from the time of day.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
two digit minute of <time of day>Extracts the 2-digit minute from the time of day.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
two digit second of <time of day>Extracts the 2-digit second from the time of day.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time zone> as stringReturns a string corresponding to the time zone object provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day with time zone> as stringConverts a 'time of day with time zone' object into a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
two digit hour of <time of day with time zone>Returns the hour of the zoned time of day as text, with values less than 10 having a leading zero.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
two digit minute of <time of day with time zone>Returns the minute of the zoned time of day as text, with values less than 10 having a leading zero.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
two digit second of <time of day with time zone>Returns the second of the zoned time of day as text, with values less than 10 having a leading zero.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time range> as stringCasts a time range as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time interval> as stringReturns a string formatted as ddd days, HH:MM:SS.mmmmmmFor example, millisecond as string = " 00:00:00.001".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<date> as stringCast a date type as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of week> as stringCasts the day of week as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of week> as three lettersCasts the day of week as a three-letter abbreviation (Mon, Tue, etcetera.).

Example:
Saturday as three letters - Returns Sat.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> as stringCast a day of month type as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> as two digitsCast a day of month type as a two-digit number.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of year> as stringCasts a day of the year as a string type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> as stringConverts the given month into a string value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> as three lettersConverts the given month into a 3-letter string (Jan, Feb, etcetera.).

Example:
january as three letters - Returns Jan.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> as two digitsConverts the month into a two digit number (01 - 12).

Example:
january as two digits - Returns 01.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month and year> as stringCasts a date (in month year format) as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<number of months> as stringConverts a number of months type into a string type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> as stringCasts a year as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
character <integer>Returns a string containing a single ASCII character. For example, character 90 = "Z".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
computer nameReturns a string corresponding to the name of the computer as it appears on the network.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
dns nameReturns the DNS name of the computer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
domain nameReturns the fully qualified domain name of the machine.Lin, Sol, HPUX, AIX, Ubu:8.1
domainnameSame as domain name.Lin, Sol, HPUX, AIX, Ubu:8.1
download path <string>This inspector is available in relevance subsitution action processing. It returns a string corresponding to the download path of the specified file. This Inspector (along with download folder and download file) is designed to be used during the prefetch process of action execution. This is equivalent to '(pathname of download folder) & pathseparator & "myfile"'.

Example:
wait "{download path"update.exe"}" - In an Action script, this line causes the BES Client to perform relevance substitution to compute the full path to the downloaded file (previously collected by a download command in the same Action script). After relevance substitution, the Client launches the specified executable and waits for it to complete before moving on to other Action lines.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
hexadecimal string <string>Creates a string from the given hexadecimal value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
host nameReturns the machine name (the same as the computer name or hostname on UNIX machines).

Example:
host name - Returns a string like "localhost.localdomain" or "user.bigcorp".
Lin, Sol, HPUX, AIX, Ubu:8.1
hostnameReturns the standard host name, usually for the computer's network.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
parameter <string>This Inspector is a synonym for the parameter <string> of <action>. It looks up the value of the action parameter specified by <string>. This is used in conjunction with the parameter set command.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pending restart nameThis iterated Inspector returns the names of currently pending restarts.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
string <string>Returns a string for the name provided. The keyword string is optional. For example, string "hi" = "hi".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
system language Returns the language of the system as a string. It is identified using the GetSystemDefaultLangID() system call. See the language keyword of the application object for a list of possible language value.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
wake on lan subnet cidr stringReturns the subnet the client is in for Wake on Lan (WoL) purposes. The client sends information to the relay during registration that is used to decide which subnet the client is in. The relay returns the subnet to the client, which is the value this Inspector exposes. This value is used to send WoL commands to forwarders. To wake a machine by computer ID, the server looks up the mac address and subnet of that machine. It then tries to identify clients that have been configured as WoL forwarders within the same subnet and routes WoL commands to those forwarders, sending them the mac address of the machine that needs to be awoken.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
base64 decode <string>Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
base64 encode <string>Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
volume of <filesystem>This is a <Plain> property inspector that takes a <filesystem> type and returns a <volume> type.Ubu:9.0, Lin:9.0, HPUX:9.0, AIX:9.0, Sol:9.0
name of <filesystem>Returns the mount point of the filesystem object.

Example:
names of filesystems - Returns the mount points of the file systems.

Example:
(name of it, type of it) of filesystems - Returns the names and types of all mounted file systems.
Lin, Sol, HPUX, AIX, Ubu:8.1
type of <filesystem>Returns the filesystem format type, as listed in the type header.Lin, Sol, HPUX, AIX, Ubu:8.1
<filesystem object> as stringCasts a filesystem object as a string.Win:8.0, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
group name of <filesystem object>Returns the group name of the given filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
location of <filesystem object>Returns the name of the directory in which the file or folder (filesystem object) is located.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
name of <filesystem object>This returns the name of the file or folder.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pathname of <filesystem object>Returns the full pathname of the specified file or folder (filesystem object) as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
user name of <filesystem object>Returns the owner (user) name of the specified filesystem object.Lin, Sol, HPUX, AIX, Ubu:8.1
md5 of <file>Returns the md5 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_224 of <file>Returns the sha2-224 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_256 of <file>Returns the sha2-256 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_384 of <file>Returns the sha2-384 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_512 of <file>Returns the sha2-512 of the file, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
<file> as stringCreates a string containing the full pathname of the specified file. See <file>.Win, Lin, Sol, HPUX, AIX, WM
key <string> of <file>Returns a key and its value from the given structured text file. It iterates over lines that start with the key name (as specified by <string>) followed by an = or : character. When searching, white space is ignored.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
sha1 of <file>Returns the sha1 checksum of the file hex encoded as a 40 character long string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
variable of <file>Returns the names of variables contained in an INF style file, in the format [section].name=value.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
key <string> of <file section>Returns a string containing the value for the name provided. A case-insensitive search is performed through the section of the file.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<version> as stringTurns a version type into a string of the form "1.2.3.4".

Example:
version of regapp "bigfix.exe" as string = "1.0.45.0" - Returns TRUE if the BigFix application has the specified version.

Example:
version of package "BESAgent" of rpm as string = "3.1.0.19-1" - TRUE if the BESAgent program has the given version.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<mode> as octal stringConverts the mode to a string of octal numbers.Lin, Sol, HPUX, AIX, Ubu:8.1
<mode> as stringConverts the mode to a string.Lin, Sol, HPUX, AIX, Ubu:8.1
<mode_mask> as stringConverts the mode mask to a string, for example "rwx".Lin, Sol, HPUX, AIX, Ubu:8.1
<symlink> as stringCasts a symlink object as a string.Lin, Sol, HPUX, AIX, Ubu:8.1
group name of <symlink>Returns the group name of the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
location of <symlink>Returns a string corresponding to the directory in which the symlink is located.Lin, Sol, HPUX, AIX, Ubu:8.1
name of <symlink>Returns a string that is the full pathname of the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
pathname of <symlink>Returns a string that contains the full pathname of the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
user name of <symlink>Returns the symlink owner's (user's) name.Lin, Sol, HPUX, AIX, Ubu:8.1
value of <symlink>Returns the pathname that the symlink points to.Lin, Sol, HPUX, AIX, Ubu:8.1
device type of <device file>Returns the device type corresponding to the give device file, as a string.Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
<grub block list> as stringString containing a specified block list in form "0+50,100+25,200+1."Lin:8.2, Sol:8.2, Ubu:8.2
<grub bootable image> as stringString containg title of bootable image.Lin:8.2, Sol:8.2, Ubu:8.2
title of <grub bootable image>Title of bootable image.Lin:8.2, Sol:8.2, Ubu:8.2
<grub color pair> as stringString displaying color pair in form "foreground-color/background-colorLin:8.2, Sol:8.2, Ubu:8.2
<grub color> as stringString containing the name of one of the colors in a color pair.Lin:8.2, Sol:8.2, Ubu:8.2
path of <grub config file>Full path to grub config file.Lin:8.2, Sol:8.2, Ubu:8.2
<grub device> as stringString containing name of a device, such as (hd0,0).Lin:8.2, Sol:8.2, Ubu:8.2
<grub file location> as stringFull name of file consisting of device (if present) and path.Lin:8.2, Sol:8.2, Ubu:8.2
path of <grub file location>Path name of file without device.Lin:8.2, Sol:8.2, Ubu:8.2
<grub image choice> as stringString representation of a zero-based index to an image within the grub config file.Lin:8.2, Sol:8.2, Ubu:8.2
boot argument <integer> of <grub kernel>The numbered boot argument for the kernel, in parameter=value form, if applicable.Lin:8.2, Sol:8.2, Ubu:8.2
boot argument of <grub kernel>First boot argument for kernel, in parameter=value form, if applicable.Lin:8.2, Sol:8.2, Ubu:8.2
<grub module> as stringString representing the name of the module moduleLin:8.2, Sol:8.2, Ubu:8.2
<bios> as stringThis Windows-only Inspector returns a string that is the concatenation of the BIOS name and date. On a non-Windows operating system, it returns FALSE.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
date of <bios>This Windows-only Inspector returns the date string stored in the bios. This string is formatted as MM/DD/YY. On a non-Windows operating system, it returns FALSE.

Example:
date of bios = "09/16/97" - Returns TRUE if the BIOS date matches the value provided.

Example:
following text of last "/" of date of bios - Returns the year of the bios as a string. For "09/07/99" it would return "99".

Example:
preceding text of first "/" of date of bios - Returns the month of the bios date as a string.

Example:
preceding text of first "/" of following text of first "/" of date of bios - Returns the day of the bios date as a string.
Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
version of <bios>This Windows-only Inspector returns the first string of the multi-string version stored in the bios. This string may not exist. The format depends upon your BIOS manufacturer. On a non-Windows operating system, it returns FALSE.

Example:
version of bios as lowercase contains "phoenix" - Returns TRUE if the version string contains "phoenix", "PHOENIX" or "Phoenix".
Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<operating system> as stringReturns a string containing the name of the operating system concatenated with the release.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
architecture of <operating system>Returns the architecture of the operating system. This is the value of the 'machine' element of the utsname structure obtained by calling uname.

Example:
architecture of operating system starts with "9000/" - Returns TRUE on an HP 9000 computer.
Win:8.2, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
build of <operating system>Returns a string corresponding to the build number of the OS.Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
codename of <operating system>This *NIX Inspector returns a string that corresponds to the codename of the given release. For example, Ubuntu 8.04 has the codename of 'hardy'.Lin:8.1, Sol:8.1, HPUX:8.1, AIX:8.1, Ubu:8.1
machine of <operating system>Returns the architecture of the machine.Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.2
name of <operating system>Returns the name of the operating system as a string. Names might include Win98, WinNT, etcetera.

Example:
name of operating system = "WinXP" - Returns TRUE on a WinXP System.

Example:
name of operating system = "Mac OS X" - Returns TRUE on a Mac OSX System.

Example:
name of operating system contains "Linux Red Hat" - Returns TRUE on a typical Linux Red Hat system.

Example:
name of operating system contains "Sun" - Returns TRUE on a typical Solaris system.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
release of <operating system>Information about the release of the operating system, formatted as a <version> on the Macintosh, but a <string> on UNIX and Windows.

Example:
release of operating system = "OSR2.1" - Returns TRUE if the Win95 computer is running under operating system release 2.1.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
brand string of <processor>Returns the vendor-defined brand names for newer processors.Win, Lin:8.2, Sol:8.2, Mac:8.2, WM, Ubu:8.2
family name of <processor>Returns the family name of the CPU, dependent on the type of client computer, for instance Pentium, Sparc, PowerPC G4, etcetera.

Example:
family name of main processor = "Pentium III" - Returns TRUE for a computer with a Pentium III cpu.

Example:
number of processors whose (family name of it contains "Pentium") - Returns the number of Pentium chips in the computer.

Example:
processor whose (family name of it = "K6") - Returns a processor object if a K6 chip is detected.

Example:
number of processors whose (family name of it contains "Pentium") - Returns the number of Pentium chips in the computer.

Example:
family name of main processor = "sparcv9" - Returns TRUE if the computer has the specified main processor family name.

Example:
1616 - 1260

Example:
3100 - 4000

Example:
4100 - 7263
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
flag list of <processor>Returns a string containing the processor flags. To check if a processor has a particular flag, use the 'contains' operator.Lin, Ubu:8.1
lpar characteristics of <processor>s390 processors only. Returns the characteristic of the processor. ie: SharedLin:8.2
lpar name of <processor>s390 processors only. Returns the name of the processor for the LPARLin:8.2
machine serial number of <processor>s390 processors only. Returns the serial number of the processorLin:8.2
model name of <processor>Returns a string containing the name of the processor model.Lin, Ubu:8.1
sequence code of <processor>s390 processors only. Returns the Sequence Code for the processor.Lin:8.2
vendor name of <processor>The manufacturer of the CPU. Names include: GenuineIntelAuthenticAMDCyrixInsteadCentaurHaulsAmbiguousCPU.

Example:
vendor name of main processor = "GenuineIntel" - Returns TRUE for an Intel processor chip.

Example:
number of processors whose (vendor name of it = "AuthenticAMD" or vendor name of it = "CyrixInstead" or vendor name of it = "CentaurHauls") = 1 - Returns TRUE for a single processor system with the given vendors.
Win, Lin, Mac:8.2, WM, Ubu:8.1
vm control program of <processor>s390 processors only. Returns the VM Control Program for the processor. ie: z/VM 5.2.0Lin:8.2
vm name of <processor>s390 processors only. Returns the name of the VMLin:8.2
<service> as stringReturns a string containing the Service name, Display name, and State of the service.Win, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.2
state of <service>Returns one of Continuing, Pausing, Paused, Running, Starting, Stopping, Stopped, Unknown.Win, Lin, Sol, HPUX, AIX, Ubu:8.1
command line argument <integer> of <process>Returns the Nth command line argument of the specified process.Lin:8.0, Sol:8.0, AIX:8.0, Ubu:8.1
command line argument of <process>Returns the command line arguments of the specified process.Lin:8.0, Sol:8.0, AIX:8.0, Ubu:8.1
name of <process>Returns the name (as a string) of the specified process.

Example:
names of processes whose (pid of it < 20) - Returns a list of all process with an ID less than 20.
Win:8.0, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<language> as stringReturns the language of the system locale.

Example:
system locale as string - Returns English (United States) if the system locale is US English.
Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
platform id of <language>Returns the string resulting from a call to setlocale(LC_TYPE, ""). This call examines the system environment and returns a string representing the language and character set for any text-related system function. The string is of the form "en_US.UTF-8".Lin, Sol, HPUX, AIX, Ubu:8.1
<primary language> as stringReturns the primary language.

Example:
primary language of system locale - Returns "English" for an English-language system.
Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
<runlevel> as stringCasts a runlevel object as a string.Lin, Sol, HPUX, AIX, Ubu:8.1
previous value of <runlevel>Returns the previous value of the runlevel. In the case where the runlevel has not changed since the system booted, this property evaluates to the empty string.Lin, Ubu:8.1
value of <runlevel>Returns the current runlevel. It evaluates to a platform-dependent string indicating the current runlevel. For instance, on Linux the value '3' indicates runlevel 3 and 'S' indicates single user mode.Lin, Sol, HPUX, AIX, Ubu:8.1
name of <smbios structure>Returns a string containing the name of the specified smbios structure as derived from the 'Type' entry in the SMBIOS specification. To create a valid Relevance keyword, some rules are applied to the name: Spaces are replaced with underscoresParenthesized sections are deletedLeading and trailing whitespace is removedUppercase is transformed to lowercaseKeywords beginning with a number have a 'b' prepended.Win:8.0, Lin:8.0, Ubu:8.1
string <string> of <smbios structure>Returns the named value in the specified smbios structure.Win:8.0, Lin:8.0, Ubu:8.1
<smbios value> as stringCasts a smbios value as a string type.Win:8.0, Lin:8.0, Ubu:8.1
name of <smbios value>Returns the name(s) of the specified smbios values, typically as derived from a smbios structure.

Example:
names of values of structure "bios_information" of smbios - Returns a list of the names of all the values of the specified smbios structure.
Win:8.0, Lin:8.0, Ubu:8.1
type of <smbios value>Returns the data type of the specified smbios value. This can be one of:ByteWordDwordQwordStringBinaryStringMultipleString.

Example:
types of values of structure "bios_information" of smbios - Returns a list of the types of each value in the 'bios information' SMBIOS structure.
Win:8.0, Lin:8.0, Ubu:8.1
gather schedule authority of <site>Returns a string corresponding to the authority of the site schedule, for example: Publisher, Custom, Manual or Disabled.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <site>The name of the site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
site tag of <site>Returns the last component of the specified site's url, eg. 'actionsite', 'enteprisesecurity', etcetera.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
type of <site>Returns one of the following 4 literal strings:Master Action SiteOperator SiteCustom SiteFixlet Site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
url of <site>Returns the Locator found in the masthead. A site locator is used to synchronize with the site. It normally contains the URL of a remote file system folder, or the URL of a cgi-bin program that provides a remote directory listing of the site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<site version list> as stringConverts a site version list to a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <fixlet_header>Headers are name:value pairs, separated by a colon. This Inspector returns the name on the left hand side of the pair.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
value of <fixlet_header>Headers are name:value pairs, separated by a colon. This Inspector returns the value on the right hand side of the pair.

Example:
number of relevant fixlets whose (value of header "x-fixlet-source-severity" of it as lowercase = "critical") of site "enterprise security". - Returns the number of critical fixlets in the Enterprise Security site.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
brand of <client>Returns the branding ID of a client computer. BigFix is the norm, but there are other brands that use the technology, including Trend Micro.Win:8.1, Lin:8.1, Sol:8.1, HPUX:8.1, AIX:8.1, Mac:8.1, Ubu:8.1
build target of <client>Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
registration cidr address of <client>This Inspector returns the cidr address from the adapter that the specified BigFix client registered with.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
registration mac address of <client>This Inspector returns the MAC address that the specified BigFix client registered with.

Example:
registration mac address of client - Returns a MAC address such as 00-1e-c9-4d-ce-5c.
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
upload progress of <client>Returns a status message string indicating No Progress, Errors or a string like the following to indicate the upload progress:<filename>: x of <filesize> bytes in <number> seconds.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<setting> as stringReturns a string formatted as <name>=<value> for the setting.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <setting>Returns the name of the setting.

Example:
names of settings of site "actionsite" - Returns the names of all the settings of the site named "actionsite".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
value of <setting>Returns the value of the setting.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <selected server>The DNS name of the server, if known.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
host name of <root server>The host (DNS) name of the BES root server that the BES Client last registered with.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
track fixlet of <evaluation cycle>Returns tracking statistics of fixlets with the longest evaluation time. Number of fixlets tracked depends on Tracking settings. Default is top 10 fixlets.Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
name of <application usage summary>Returns the names of the applications that are currently enabled for usage summaries.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <application usage summary instance>Returns the name(s) of the application instance(s) currently enabled for usage summaries.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
string version of <application usage summary instance>Returns the version of the specified application instance as a string value.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
common name of <license>Returns the name of the person (such as John Smith) who requested the action site license.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
email address of <license>Returns the email address of the person (such as John_Smith@bigcorp.com) who requested the action site license.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
expiration state of <license>Returns a string, one of "Unrestricted", "Grace" or "Restricted".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
gather url of <license>Returns the gather URL for the deployment's main Action site as specified in the deployment masthead.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
organization of <license>Returns the organization of the person (such as Bigcorp, Inc.) who requested the action site license.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
seat count state of <license>Returns one of "Unrestricted", "Grace" or "Restricted".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
type of <license>Returns the string that was assigned to the license when it was authorized by BigFix.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
name of <bes product>Returns the name of the specified licensed BES product.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
site url of <bes product>Returns a list of the URLs associated with the specified BES product.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<html> as stringCasts an html string into a string type.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<environment variable> as stringCasting the variable as a string yields a string containing the variable name and the value of the variable separated by ' = '.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
name of <environment variable>Returns the name of the variable.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
value of <environment variable>Returns the value of the variable.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
fips mode failure message of <cryptography>Returns the error message returned by the cryptographic library if the application (the client, console, or web reports, depending on the context) tried to enter FIPS 140-2 compliant mode and failed.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
encrypt report failure message of <client_cryptography>If the client is not successfully encrypting reports, this Inspector returns the failure message.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
sha1 of <x509 certificate>Returns the SHA1 hash of the given certificate, which uniquely identifies it.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <user>Returns the name of all the specified user, whether logged in or not.

Example:
names of users - Returns a list of all the users.
Win:8.1, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
tty of <user>Returns the tty of the user.Lin, Sol, HPUX, AIX, Ubu:8.1
name of <logged on user>If Terminal Services is available and enabled under NT4/2000/2003/XP/Vista, this Inspector returns the result of WTSQuerySessionInformation with WTSUserName. With Terminal Services disabled, it examines the ACLs on the security descriptor of the "winsta0" window station. Under Windows 9x, returns the "Current User" of "SYSTEM\CurrentControlSet\Control" if it exists. Otherwise returns No Such Object.Win, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, WM, Ubu:8.2
tty of <logged on user>Returns the name of the connection the user is on. Result is platform specific. Examples are: "Console", "RDP-Tcp#0", "pts/1", ":0"Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
parameter <string> of <action>Returns the value of parameter <string> for the active Action. Parameters only live as long as the action is active. Among the inspectable parameters is the 'action issue date' that is added to each Action by the BigFix Console at issue time.

Example:
parameter "action issue date" of action - This Inspector returns the date the action was issued, a parameter added to each action by the BigFix Console.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
status of <action>Returns one of the following strings: Running = when the action is currently active. Executed = no longer relevant and action has completed. Not Relevant = action was not relevant. Waiting = action is relevant, but waiting to run. Not Executed = action is relevant, unconstrained, but has not yet started. Failed = action is relevant, unconstrained, has completed, but is still relevant.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<tcp state> as stringCast a <tcp state> to a string representationUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0
cidr address of <network ip interface>Returns the Classless Inter-Domain Routing address for the specified network ip interface as a string type.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
cidr string of <network ip interface>Returns the Classless Inter-Domain Routing value for the specified network ip interface as a string type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
mac address of <network ip interface>Returns the MAC address (AKA hardware address) of the network ip interface object. The mac address is formatted as a string of lower case hex digits separated by '-'.

Example:
mac address whose (it = "00-61-b1-d1-7d-29") of ip interfaces of network - Returns the mac address of the specified network ip interface object.
Lin, Sol, HPUX, AIX, Mac:8.0, Ubu:8.1
name of <network ip interface>Returns the name of the network ip interface object. Typical names are lan0, lo0. Virtual interfaces are usually of the form lan0:2.Lin, Sol, HPUX, AIX, Mac:8.0, Ubu:8.1
cidr address of <network adapter>Returns the CIDR address of the specified network adapter as a string type, for example, 192.168.0.0/16 (IPv4) or 2001:db8::/32 (IPv6).Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
cidr string of <network adapter>Returns the Classless Inter-Domain Routing value for the specified network adapter as a string value.Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, WM, Ubu:8.1
friendly name of <network adapter>Returns a user-friendly name for the adapter, for example "Local Area Connection 1".Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, WM, Ubu:8.1
mac address of <network adapter>Returns the mac address of the network adapter.Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, WM, Ubu:8.1
name of <network adapter>Returns the name of the network adapter.Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac, WM, Ubu:8.1
cidr address of <network adapter interface>Returns the CIDR address of the specified interface as a string type, for example, 192.168.0.0/16 (IPv4) or 2001:db8::/32 (IPv6).Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
cidr string of <network adapter interface>A cidr string (see CIDR_notation at Wikipedia) is a string representation of a cidr address. It looks like an ip address followed by a slash and then the number of leading non-zero bits of the routing prefix. For example, 192.168.0.0/16 for IPv4, and 2001:db8::/32 for IPv6.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
mac address of <network adapter interface>Returns the MAC address of the specified network adapter interface as a string type.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ip version> as stringConverts an IP version to a string.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4 address> as stringConverts the ipv4 address to a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<ipv6 address> as compressed stringSimilar to casting as a string, but with double colons used to represent multiple zero 16-bit parts (RFC 4291 section 2.2, item 2).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<ipv6 address> as compressed string with ipv4Similar to casting as a string, but with both colon-compression and standard IPv4 representation for the low 32-bits.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<ipv6 address> as compressed string with ipv4 with zone indexSimilar to casting as a string, but with both colon-compression and standard IPv4 representation for the low 32-bits as well as any zone index.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv6 address> as compressed string with zone indexSimilar to casting as a string, but with both colon-compression and a zone index.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv6 address> as stringReturns a string representation of the IPv6 address in the form x:x:x:x:x:x:x:x, where each x represents one to four hexadecimal digits of the eight 16-bit address fields. Leading zeros in an individual field are omitted. See RFC 4291 section 2.2, item 1.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<ipv6 address> as string with ipv4Similar to casting as a string, but with the lowest 32 bits of the address in the standard IPv4 representation (RFC 4291 section 2.2, item 3).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<ipv6 address> as string with ipv4 with zone indexSimilar to casting as a string, but with standard IPv4 representation for the low 32-bits as well as any zone index.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv6 address> as string with leading zerosSimilar to casting as a string, but leading zeros in individual fields are preserved.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<ipv6 address> as string with leading zeros with zone indexConverts an IPv6 address into a string with all fields packed with leading zeroes as well as a terminating zone index, if any.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv6 address> as string with zone indexConverts an IPv6 address into a string with a terminating slash-delimited zone index, if any.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as compressed stringCompresses the IP address, using double colons to stand in for repeated zeroes in the address.

Example:
("0:0:0:0:0:ffff:c0a8:16a" as ipv4or6 address) as compressed string - Returns "::ffff:c0a8:16a", a compressed string with a double colon standing in for leading zeroes.
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as compressed string with ipv4Similar to casting to a string, but with both colon-compression and standard IPv4 representation for the low 32-bits.

Example:
("0:0:0:0:0:ffff:c0a8:16a" as ipv4or6 address) as compressed string with ipv4 - Returns "::ffff:192.168.1.106", a compressed string (leading zeroes collapsed to ::) with a four-byte IPv4 address as the lower 32 bits.
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as compressed string with ipv4 with zone indexCreates a compressed string (replacing multiple zeroes with double colons) with the lower 32 bits in IPv4 format. It includes the zone index (on Windows, typically a number) following a percent sign (%).Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as compressed string with zone indexCreates a compressed string (replacing multiple zeroes with double colons) and includes the zone index (on Windows, typically a number) following a percent sign (%).Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as stringCasts an IP address (v4 or 6) as a string type.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as string with ipv4Converts an address to a string with the lower 32 bits in IPv4 format.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as string with ipv4 with zone indexConverts an address to a string with the lower 32 bits in IPv4 format as well as any zone index.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as string with leading zerosConverts an IP address into a string with all fields packed with leading zeroes.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as string with leading zeros with zone indexConverts an IP address into a string with all fields packed with leading zeroes, as well as any zone index.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<ipv4or6 address> as string with zone indexConverts an IP address into a string with a zone index, if any.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
interface of <ipv4 route>Returns a string containing the name of the interface the route goes through.Lin:8.2, Sol:8.2, Ubu:8.2
<package> as stringCreates a string containing the package's name, version and release.

Example:
package "apache" of rpm as string - Returns a string with information about the package, such as "apache-1.3.23-88".
Lin, AIX:8.2
architecture of <package>The architecture represents the CPU type that the RPM Package was designed to be used on. Typical values are i386, i686, or x86_64, but packages can be created with archtectures like 'noarch' or have no architecture specified at all.

Example:
architecture of package "BESAgent" of rpm - On a SuSE Linux Enterprise Server 9.0, 64 bit, this will return x86_64, while on a Fedora Core 3, 32 bit, it will return i386.
Lin, AIX:8.2
name of <package>Returns the name of the given RPM package.Lin, AIX:8.2
unique name of <package>Returns the unique values of a given list of <package> types, removing duplicates and sorting by value.Lin:8.0, AIX:8.2
<capability> as stringCreates a string containing the capability's name, relation and version.

Example:
capability "libxml2 >= 2.4.7" - Casts the capability as a string, returning "libxml2 >= 2.4.7".
Lin, AIX:8.2
name of <capability>Returns the name of this capability object.Lin, AIX:8.2
relation of <capability>If this capability object has version information, the relation is returned.

Example:
relation of capability "sh <= 4.1" - Returns "<=", the "less than or equal" relation.
Lin, AIX:8.2
version of <capability>If this capability object has version information, the version is returned.

Example:
version of capability "sh <= 4.1" - Returns "4.1", the version of the specified capability.
Lin, AIX:8.2
<rpm package release> as stringCasts an RPM Package release object as a string type.Lin:8.0, AIX:8.2
<rpm package version> as stringCasts an RPM package version as a string type.Lin:8.0, AIX:8.2
<rpm package version record> as stringCasts an RPM package version record as a string type.Lin:8.0, AIX:8.2
<short rpm package version record> as stringCasts a short RPM Package version record as a string type.Lin:8.0, AIX:8.2
<power level> as stringConverts a power level into a human-readable string.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<type> as stringA string indicating the type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <type>A string naming the type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<property> as stringA short description of the use of the property.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
plural name of <property>The name of the property, in the plural.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
singular name of <property>The name of the property, in the singular.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
usual name of <property>Returns the usual name of the specified property.

Example:
usual name of property "booleans" - Returns "boolean".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<binary operator> as stringA short description of the use of the operator.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <binary operator>A phrase naming the operator.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
symbol of <binary operator>A phrase or punctuation mark used to invoke the operator.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<unary operator> as stringA short description of the use of the operator.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <unary operator>A phrase naming the operator.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
symbol of <unary operator>A phrase or punctuation mark used to invoke the operator.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<cast> as stringA short description of the use of the cast.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
name of <cast>The phrase used after the keyword "as" in an expression using the cast.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<string> contains <string><boolean>Returns a boolean TRUE if the first string contains the second string.Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
<html> & <string><html>Concatenates a string with an HTML file, returning a new HTML file.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<rope> & <string><rope>Concatenates a rope and a string, producing a rope.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<rope> contains <string><boolean>Returns boolean TRUE if the rope contains the string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string set> contains <string><boolean>Returns TRUE if the specified set of strings contains the given string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> & <html><html>Concatenates a string with an HTML file, returning a new HTML file.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<string> & <rope><rope>Concatenates a rope and a string, returning a new rope.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> & <string><string>Concatenates two strings, producing a new string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> {cmp} <string><boolean>Returns a boolean TRUE/FALSE depending on the result of the comparison, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
md5 of <string><string>

Plural: md5s
Returns the md5 of the string, hex encoded as a string. Not available in FIPS mode.Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_224 of <string><string>

Plural: sha2_224s
Returns the sha2-224 of the string, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_256 of <string><string>

Plural: sha2_256s
Returns the sha2-256 of the string, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_384 of <string><string>

Plural: sha2_384s
Returns the sha2-384 of the string, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sha2_512 of <string><string>

Plural: sha2_512s
Returns the sha2-512 of the string, hex encoded as a stringUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
substring <(integer,integer)> of <string><substring>

Plural: substrings
Returns a substring of the specified string as defined by the start and length. The first integer is the start and the second integer is the length.Win:8.0, Ubu:8.1, Lin:8.0, Mac:8.0, HPUX:8.0, AIX:8.0, Sol:8.0
first match <regular expression> of <string><regular expression match>

Plural: first matches
Creates an object containing the first match to the regular expression in the given stringWin, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
<string> as version<version>Returns a version if the string can be parsed as a version. The first numeric set of characters delimited with period, comma or comma-space is returned.Win, WM, Lin, Mac, HPUX, AIX, Sol, Ubu:8.1
<string> as strverscmp version<strverscmp version>Converts a string to strverscmp version, which is compared to other versions using the OS supplied strverscmp function.Ubu:8.1, Lin
<string> as boolean<boolean>Returns a boolean value for the string. All possible capitalization's of "TRUE" and "FALSE" will convert successfully.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as date<date>Casts a string as a date type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as day_of_month<day of month>Casts a string as a day of the month (eg. 28).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as day_of_week<day of week>Casts a string as a day of the week.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as floating point<floating point>Converts the contents of a string into a floating point number.Win, Lin:8.0, Mac, WM, Ubu:8.1
<string> as hexadecimal<string>Converts a string to a hexadecimal number.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as html<html>Casts a string into html.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<string> as integer<integer>Returns an integer value for the string provided. If the string contains anything but ASCII digits, the conversion will fail. Use numeric value for more liberal parsing rules.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as ipv4or6 address<ipv4or6 address>Converts a string version of an IP address into the flexible ipv4or6 address format.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
<string> as ipv6 address<ipv6 address>Converts a string representations of an IPv6 address (with colons and/or dots) as an IPv6 address type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as left trimmed string<string>Trims the leading spaces from a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as local time<time>Returns a local time object from a properly formatted string. See <time>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as local zoned time_of_day<time of day with time zone>Converts a string to a time of day with local time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as lowercase<string>Returns a lowercase version of the string provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as month<month>Converts a string into a month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as right trimmed string<string>Trims the trailing spaces from a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as site version list<site version list>Converts a string into a site version list.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as string<string>Returns the string provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as time<time>Returns a time object from a properly formatted string. See <time>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as time interval<time interval>Returns a time interval object from a properly formatted string. Expects strings formatted as ddd days, HH:MM:SS.mmmmmm.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as time zone<time zone>Returns a time zone object from a properly formatted string. See <time zone>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as time_of_day<time of day>Converts a string to a time_of_day type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as trimmed string<string>Trims the leading and trailing spaces off of the specified string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as universal time<time>Returns a universal time object from a properly formatted string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as universal zoned time_of_day<time of day with time zone>Converts a string into a universal zoned time of day.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as uppercase<string>Returns an uppercase version of the string provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as year<year>Converts a string into a year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as zoned time_of_day<time of day with time zone>Converts a string into a zoned time of day.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
abbr <string> of <string><html>

Plural: abbrs
Returns an HTML snippet with the specified string enclosed in an <abbr> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
abbr of <string><html>

Plural: abbrs
Returns an HTML snippet containing the specified string enclosed in an <abbr> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
acronym <string> of <string><html>

Plural: acronyms
Returns an HTML snippet with the specified string enclosed in an <acronym> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
acronym of <string><html>

Plural: acronyms
Returns an HTML snippet containing the specified string enclosed in an <acronym> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
address <string> of <string><html>

Plural: addresss
Returns an HTML snippet with the specified string enclosed in an <address> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
address of <string><html>

Plural: addresss
Returns an HTML snippet containing the specified string enclosed in an <address> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
anchor <string> of <string><html>

Plural: anchors
Returns an HTML snippet with the specified string enclosed in an <a> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
anchor of <string><html>

Plural: anchors
Returns an HTML snippet containing the specified string enclosed in an <a> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
b <string> of <string><html>

Plural: bs
Returns an HTML snippet with the specified string enclosed in a <b> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
b of <string><html>

Plural: bs
Returns an HTML snippet containing the specified string enclosed in a <b> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
base <string> of <string><html>

Plural: bases
Returns an HTML snippet with the specified string enclosed in a <base> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
base of <string><html>

Plural: bases
Returns an HTML snippet containing the specified string enclosed in a <base> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
big <string> of <string><html>

Plural: bigs
Returns an HTML snippet with the specified string enclosed in a <big> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
big of <string><html>

Plural: bigs
Returns an HTML snippet containing the specified string enclosed in a <big> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
blockquote <string> of <string><html>

Plural: blockquotes
Returns an HTML snippet with the specified string enclosed in a <blockquote> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
blockquote of <string><html>

Plural: blockquotes
Returns an HTML snippet containing the specified string enclosed in a <blockquote> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
body <string> of <string><html>

Plural: bodys
Returns an HTML snippet with the specified string enclosed in a <body> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
body of <string><html>

Plural: bodys
Returns an HTML snippet containing the specified string enclosed in a <body> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
caption <string> of <string><html>

Plural: captions
Returns an HTML snippet with the specified string enclosed in a <caption> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
caption of <string><html>

Plural: captions
Returns an HTML snippet containing the specified string enclosed in a <caption> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
character <integer> of <string><substring>

Plural: characters
Returns a string of length 1 made by taking the character identified by <integer> from the string. Numbering begins at zero. Example, Character 1 of "HI" is "I".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
character of <string><substring>

Plural: characters
Returns the characters from the string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
cite <string> of <string><html>

Plural: cites
Returns an HTML snippet with the specified string enclosed in a <cite> (citation) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
cite of <string><html>

Plural: cites
Returns an HTML snippet containing the specified string enclosed in a <cite> (citation) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
code <string> of <string><html>

Plural: codes
Returns an HTML snippet with the specified string enclosed in a <code> (fixed-width font) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
code of <string><html>

Plural: codes
Returns an HTML snippet containing the specified string enclosed in a <code> (fixed-width font) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
col <string> of <string><html>

Plural: cols
Returns an HTML snippet with the specified string enclosed in a <col> (column) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
col of <string><html>

Plural: cols
Returns an HTML snippet containing the specified string enclosed in a <col> (column) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
colgroup <string> of <string><html>

Plural: colgroups
Returns an HTML snippet with the specified string enclosed in a <colgroup> (column group) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
colgroup of <string><html>

Plural: colgroups
Returns an HTML snippet containing the specified string enclosed in a <colgroup> (column group) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
concatenation <html> of <string><html>

Plural: concatenations
This inspector concatenates the string items in the second argument with a separator defined by the first argument.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
concatenation <string> of <string><string>

Plural: concatenations
This inspector concatenates the string items in the second argument with a separator defined by the string argument.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
concatenation of <string><string>

Plural: concatenations
Combines the supplied strings into a single string, end-to-end.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
dd <string> of <string><html>

Plural: dds
Returns an HTML snippet with the specified string enclosed in a <dd> (definition) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
dd of <string><html>

Plural: dds
Returns an HTML snippet containing the specified string enclosed in a <dd> (definition) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
definition list <string> of <string><html>

Plural: definition lists
Returns an HTML snippet with the specified string enclosed in a <dl> (definition) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
definition list of <string><html>

Plural: definition lists
Returns an HTML snippet containing the specified string enclosed in a <dl> (definition) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
del <string> of <string><html>

Plural: dels
Returns an HTML snippet with the specified string enclosed in a <del> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
del of <string><html>

Plural: dels
Returns an HTML snippet containing the specified string enclosed in a <del> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
dfn <string> of <string><html>

Plural: dfns
Returns an HTML snippet with the specified string enclosed in a <dfn> (definition) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
dfn of <string><html>

Plural: dfns
Returns an HTML snippet containing the specified string enclosed in a <dfn> (definition) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
div <string> of <string><html>

Plural: divs
Returns an HTML snippet with the specified string enclosed in a <div> (division or section) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
div of <string><html>

Plural: divs
Returns an HTML snippet containing the specified string enclosed in a <div> (division or section) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
dt <string> of <string><html>

Plural: dts
Returns an HTML snippet with the specified string enclosed in a <dt> (definition) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
dt of <string><html>

Plural: dts
Returns an HTML snippet containing the specified string enclosed in a <dt> (definition) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
em <string> of <string><html>

Plural: ems
Emphasize the specified string inside an <em string></em> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
em of <string><html>

Plural: ems
Emphasize the specified string inside an <em></em> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
first <integer> of <string><substring>

Plural: firsts
Returns a substring containing the number of characters specified from the given string. For example, First 5 of "To be or not to be" is "To be".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first <string> of <string><substring>

Plural: firsts
Returns a substring containing the first occurrence of the name provided. See substring.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
h1 <string> of <string><html>

Plural: h1s
Returns an HTML snippet with the specified string enclosed in an <h1> (header) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
h1 of <string><html>

Plural: h1s
Returns an HTML snippet containing the specified string enclosed in an <h1> (header) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
h2 <string> of <string><html>

Plural: h2s
Returns an HTML snippet with the specified string enclosed in an <h2> (header) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
h2 of <string><html>

Plural: h2s
Returns an HTML snippet containing the specified string enclosed in an <h2> (header) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
h3 <string> of <string><html>

Plural: h3s
Returns an HTML snippet with the specified string enclosed in an <h3> (header) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
h3 of <string><html>

Plural: h3s
Returns an HTML snippet containing the specified string enclosed in an <h3> (header) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
h4 <string> of <string><html>

Plural: h4s
Returns an HTML snippet with the specified string enclosed in an <h4> (header) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
h4 of <string><html>

Plural: h4s
Returns an HTML snippet containing the specified string enclosed in an <h4> (header) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
h5 <string> of <string><html>

Plural: h5s
Returns an HTML snippet with the specified string enclosed in an <h5> (header) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
h5 of <string><html>

Plural: h5s
Returns an HTML snippet containing the specified string enclosed in an <h5> (header) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
h6 <string> of <string><html>

Plural: h6s
Returns an HTML snippet with the specified string enclosed in an <h6> (header) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
h6 of <string><html>

Plural: h6s
Returns an HTML snippet containing the specified string enclosed in an <h6> (header) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
head <string> of <string><html>

Plural: heads
Returns an HTML snippet with the specified string enclosed in a <head> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
head of <string><html>

Plural: heads
Returns an HTML snippet containing the specified string enclosed in a <head> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
html <string> of <string><html>

Plural: htmls
Returns an HTML snippet with the specified string enclosed in a <html> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
html of <string><html>

Plural: htmls
Returns an HTML snippet containing the specified string enclosed in an <html> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
html tag <string> of <string><html>

Plural: html tags
Returns an HTML snippet with the second string enclosed in a tag specified by the first string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
ins <string> of <string><html>

Plural: inss
Returns an HTML snippet with the specified string enclosed in a <ins> (insert) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
ins of <string><html>

Plural: inss
Returns an HTML snippet containing the specified string enclosed in a <ins> (insert) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
italic <string> of <string><html>

Plural: italics
Returns an HTML snippet with the specified string enclosed in a <i> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
italic of <string><html>

Plural: italics
Returns an HTML snippet containing the specified string enclosed in a <i> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
kbd <string> of <string><html>

Plural: kbds
Returns an HTML snippet with the specified string enclosed in a <kbd> (keyboard entry) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
kbd of <string><html>

Plural: kbds
Returns an HTML snippet containing the specified string enclosed in a <kbd> (keyboard entry) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
last <integer> of <string><substring>

Plural: lasts
Returns a substring containing the number of characters specified. For example, Last 5 of "To be or not to be" is "to be".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
last <string> of <string><substring>

Plural: lasts
Returns a substring containing the last occurrence of the name provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
length of <string><integer>

Plural: lengths
Returns the number of characters in the string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
li <string> of <string><html>

Plural: lis
Returns an HTML snippet with the specified string enclosed in a <li> (list) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
li of <string><html>

Plural: lis
Returns an HTML snippet containing the specified string enclosed in a <li> (list) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
link <string> of <string><html>

Plural: links
Returns an HTML snippet with the specified string enclosed in a <link> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
link of <string><html>

Plural: links
Returns an HTML snippet containing the specified string enclosed in a <link> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
meta <string> of <string><html>

Plural: metas
Returns an HTML snippet with the specified string enclosed in a <meta> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
meta of <string><html>

Plural: metas
Returns an HTML snippet containing the specified string enclosed in a <meta> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
numeric value of <string><integer>

Plural: numeric values
Returns an integer for the first numeric value in the string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
ol <string> of <string><html>

Plural: ols
Creates an ordered list out of <string2> with an optional style specified by <string1>.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
ol of <string><html>

Plural: ols
Creates an ordered list out of the <string>.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
ordered list <string> of <string><html>

Plural: ordered lists
Returns an HTML snippet with the specified string enclosed in an <ol><li> tag, where the <ol> tag is modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
ordered list of <string><html>

Plural: ordered lists
Returns an HTML snippet containing the specified string enclosed in an <ol><li> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
p <string> of <string><html>

Plural: ps
Returns an HTML snippet with the specified string enclosed in an <p> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
p of <string><html>

Plural: ps
Returns an HTML snippet containing the specified string enclosed in an <p> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
position <integer> of <string><string position>

Plural: positions
Returns a string position pointing to the character position specified. The first character is at position 0.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
position of <string><string position>

Plural: positions
Returns the positions of the string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pre <string> of <string><html>

Plural: pres
Returns an HTML snippet with the specified string enclosed in an <pre> (preformatted) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
pre of <string><html>

Plural: pres
Returns an HTML snippet containing the specified string enclosed in an <pre> (preformatted) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
q <string> of <string><html>

Plural: qs
Returns an HTML snippet with the specified string enclosed in a <q> (quotation) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
q of <string><html>

Plural: qs
Returns an HTML snippet containing the specified string enclosed in a <q> (quotation) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
regex escape of <string><string>

Plural: regex escapes
Creates a new string that escapes the special characters .[]{}()\*+?|^$,-.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
samp <string> of <string><html>

Plural: samps
Returns an HTML snippet with the specified string enclosed in a <samp> (sample) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
samp of <string><html>

Plural: samps
Returns an HTML snippet containing the specified string enclosed in a <samp> (sample) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
set of <string><string set>

Plural: sets
Creates a set from the given list of semicolon-separated strings.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
sha1 of <string><string>

Plural: sha1s
Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
small <string> of <string><html>

Plural: smalls
Returns an HTML snippet with the specified string enclosed in a <small> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
small of <string><html>

Plural: smalls
Returns an HTML snippet containing the specified string enclosed in a <small> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
span <string> of <string><html>

Plural: spans
Returns an HTML snippet with the specified string enclosed in a <span> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
span of <string><html>

Plural: spans
Returns an HTML snippet containing the specified string enclosed in a <span> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
strong <string> of <string><html>

Plural: strongs
Returns an HTML snippet with the specified string enclosed in a <strong> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
strong of <string><html>

Plural: strongs
Returns an HTML snippet containing the specified string enclosed in a <strong> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
sub <string> of <string><html>

Plural: subs
Returns an HTML snippet with the specified string enclosed in a <sub> (subscript) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
sub of <string><html>

Plural: subs
Returns an HTML snippet containing the specified string enclosed in a <sub> (subscript) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
substring <( integer, integer )> of <string><substring>

Plural: substrings
Returns a substring of the specified string as defined by the start and length. The first integer is the start and the second integer is the length.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
substring <string> of <string><substring>

Plural: substrings
Iterates through the string returning all the substrings matching the name given. For example, number of substrings "be" of "to be or not to be" = 2.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
substring after <string> of <string><substring>

Plural: substrings after
Returns the substrings that come after the first string delimiter.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
substring before <string> of <string><substring>

Plural: substrings before
Returns the substrings that come before the first string delimiter.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
substring between <string> of <string><substring>

Plural: substrings between
Returns the substring in the second string found between two instances of the first string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
substring separated by <string> of <string><substring>

Plural: substrings separated by
Returns a substring (or set of substrings) delimited by the first string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
sup <string> of <string><html>

Plural: sups
Returns an HTML snippet with the specified string enclosed in a <sup> (superscript) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
sup of <string><html>

Plural: sups
Returns an HTML snippet containing the specified string enclosed in a <sup> (superscript) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
table <string> of <string><html>

Plural: tables
Returns an HTML snippet with the specified string enclosed in a <table> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
table of <string><html>

Plural: tables
Returns an HTML snippet containing the specified string enclosed in a <table> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
tbody <string> of <string><html>

Plural: tbodys
Returns an HTML snippet with the specified string enclosed in a <tbody> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
tbody of <string><html>

Plural: tbodys
Returns an HTML snippet containing the specified string enclosed in a <tbody> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
td <string> of <string><html>

Plural: tds
Returns an HTML snippet with the specified string enclosed in a <td> (table cell) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
td of <string><html>

Plural: tds
Returns an HTML snippet containing the specified string enclosed in a <td> (table cell) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
tfoot <string> of <string><html>

Plural: tfoots
Returns an HTML snippet with the specified string enclosed in a <tfoot> (table foot) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
tfoot of <string><html>

Plural: tfoots
Returns an HTML snippet containing the specified string enclosed in a <tfoot> (table foot) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
th <string> of <string><html>

Plural: ths
Returns an HTML snippet with the specified string enclosed in a <th> (table header) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
th of <string><html>

Plural: ths
Returns an HTML snippet containing the specified string enclosed in a <th> (table header) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
thead <string> of <string><html>

Plural: theads
Returns an HTML snippet with the specified string enclosed in a <thead> (table header) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
thead of <string><html>

Plural: theads
Returns an HTML snippet containing the specified string enclosed in a <thead> (table header) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
title <string> of <string><html>

Plural: titles
Returns an HTML snippet with the specified string enclosed in a <title> tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
title of <string><html>

Plural: titles
Returns an HTML snippet containing the specified string enclosed in a <title> tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
tr <string> of <string><html>

Plural: trs
Returns an HTML snippet with the specified string enclosed in a <tr> (table row) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
tr of <string><html>

Plural: trs
Returns an HTML snippet containing the specified string enclosed in a <tr> (table row) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
tt <string> of <string><html>

Plural: tts
Returns an HTML snippet with the specified string enclosed in a <tt> (teletype font) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
tt of <string><html>

Plural: tts
Returns an HTML snippet containing the specified string enclosed in a <tt> (teletype font) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
tuple string item <integer> of <string><string>

Plural: tuple string items
Parses the given string as if it were a tuple result string and returns the string which is the nth item of the tuple. The tuple Inspectors used to be session-only, but as of version 8.0, they are core Inspectors, available to all platforms at all times.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, WM:8.0, Ubu:8.1
tuple string item of <string><string>

Plural: tuple string items
Parses the given string as if it were a tuple result string and iterates over the <string> objects that make up the tuple. The tuple Inspectors used to be session-only, but as of version 8.0, they are core Inspectors, available to all platforms at all times.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, WM:8.0, Ubu:8.1
ul <string> of <string><html>

Plural: uls
Returns an HTML snippet with the specified string enclosed in a <ul> (unordered list) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
ul of <string><html>

Plural: uls
Returns an HTML snippet containing the specified string enclosed in a <ul> (unordered list) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
unique value of <string><string with multiplicity>

Plural: unique values
Returns the unique values of a given list of <string> types, removing duplicates and sorting by value. As of version 6.0 of BES, this Inspector returns a <string with multiplicity>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unordered list <string> of <string><html>

Plural: unordered lists
Returns an HTML snippet with the specified string enclosed in a <ul><li> (unordered list item) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
unordered list of <string><html>

Plural: unordered lists
Returns an HTML snippet containing the specified string enclosed in a <ul><li> (unordered list item) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
var <string> of <string><html>

Plural: vars
Returns an HTML snippet with the specified string enclosed in a <var> (variable type) tag modified by the first given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
var of <string><html>

Plural: vars
Returns an HTML snippet containing the specified string enclosed in a <var> (variable type) tag.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

string position

String position works in combination with the string and substring data types. A string position is a point within a string. It can be compared to an integer (which it is derived from), but it also acts as a pointer within a string so that the preceding and following text can be extracted.

Creation Methods

DeclarationDescriptionPlatforms (?)
position <integer> of <string>Returns a string position pointing to the character position specified. The first character is at position 0.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
position of <string>Returns the positions of the string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
end of <substring>Returns the position of the substring within its containing string. For example, end of first "be" of "to be or not to be" = 5.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
start of <substring>Returns the position within the string of the substring. For example, start of substring "or" of "to be or not to be" = 6.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
following text of <string position><substring>

Plural: following texts
Returns the substring following the position in the string. For example, following text of position 5 of "0123456789" = "567890".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
preceding text of <string position><substring>

Plural: preceding texts
Returns the substring preceding the position in the string. For example, preceding text of position 5 of "0123456789" = "01234".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

substring

A substring object is a part of a larger string and has all the properties of a string, as well as extra methods and properties.

Creation Methods

DeclarationDescriptionPlatforms (?)
substring <(integer,integer)> of <string>Returns a substring of the specified string as defined by the start and length. The first integer is the start and the second integer is the length.Win:8.0, Ubu:8.1, Lin:8.0, Mac:8.0, HPUX:8.0, AIX:8.0, Sol:8.0
character <integer> of <string>Returns a string of length 1 made by taking the character identified by <integer> from the string. Numbering begins at zero. Example, Character 1 of "HI" is "I".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
character of <string>Returns the characters from the string.

Example:
exists character whose (it is "z") of "Paul Cezanne" - Returns True.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first <integer> of <string>Returns a substring containing the number of characters specified from the given string. For example, First 5 of "To be or not to be" is "To be".

Example:
first 2 of pathname of regapp "bigfix.exe" as lowercase = "c:" - Returns true if BigFix is installed on drive C:.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first <string> of <string>Returns a substring containing the first occurrence of the name provided. See substring.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
last <integer> of <string>Returns a substring containing the number of characters specified. For example, Last 5 of "To be or not to be" is "to be".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
last <string> of <string>Returns a substring containing the last occurrence of the name provided.

Example:
preceding text of last "ab" of "abracadabra" is "abracad" - Returns True.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
substring <( integer, integer )> of <string>Returns a substring of the specified string as defined by the start and length. The first integer is the start and the second integer is the length.

Example:
substring (1,2) of "abcdefg" - Returns "bc".
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
substring <string> of <string>Iterates through the string returning all the substrings matching the name given. For example, number of substrings "be" of "to be or not to be" = 2.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
substring after <string> of <string>Returns the substrings that come after the first string delimiter.

Example:
substrings after ":" of "definition: after the colon" - Returns " after the colon".

Example:
substrings after (character 3 of it) of "woe-is-me" - Returns 'is' and 'me', since character 3 (zero-based) is a dash and this Inspector returns the next substrings separated by dashes.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
substring before <string> of <string>Returns the substrings that come before the first string delimiter.

Example:
substrings before "<--" of "the item pointed to <--" - Returns "the item pointed to".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
substring between <string> of <string>Returns the substring in the second string found between two instances of the first string.

Example:
substrings between "*" of "the item *between* asterisks" - Returns "between".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
substring separated by <string> of <string>Returns a substring (or set of substrings) delimited by the first string.

Example:
substrings separated by "," of "1,2,3" - Returns the list of numbers separated by commas in the specified string.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
following text of <string position>Returns the substring following the position in the string. For example, following text of position 5 of "0123456789" = "567890".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
preceding text of <string position>Returns the substring preceding the position in the string. For example, preceding text of position 5 of "0123456789" = "01234".

Example:
preceding text of position 5 of "Four score and seven.." - Returns "Four".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
following text of <substring>Returns the string following the substring. For example, following text of last "." of "log.txt" = "txt".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
preceding text of <substring>Returns the string preceding the substring. For example, preceding text of last "." of "log.txt" = "log".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
parenthesized part <integer> of <regular expression match>Returns the nth parenthetical (given by <integer>) in the specified regular expression match.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
parenthesized part of <regular expression match>Returns the parenthetical part of the specified regular expression match.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
end of <substring><string position>

Plural: ends
Returns the position of the substring within its containing string. For example, end of first "be" of "to be or not to be" = 5.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
following text of <substring><substring>

Plural: following texts
Returns the string following the substring. For example, following text of last "." of "log.txt" = "txt".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
preceding text of <substring><substring>

Plural: preceding texts
Returns the string preceding the substring. For example, preceding text of last "." of "log.txt" = "log".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
start of <substring><string position>

Plural: starts
Returns the position within the string of the substring. For example, start of substring "or" of "to be or not to be" = 6.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

string with multiplicity

The <string with multiplicity> Inspectors deal with arrays of strings, allowing you to extract unique strings and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <string>Returns the unique values of a given list of <string> types, removing duplicates and sorting by value. As of version 6.0 of BES, this Inspector returns a <string with multiplicity>.

Example:
multiplicities of unique values of ("steak"; "chop"; "rib"; "rib"; "rib") - Returns the multiplicity of (the number of times) each string in the list is used, namely, 1,3,1. Note that the multiplicities are based on the alphabetic order of the strings (chop, rib, steak), not their position in the list.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <string with multiplicity><integer>

Plural: multiplicities
Returns the multiplicity (quantity) of each element in a multiple string list.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

string set

The <string set> Inspectors deal with sets of strings, which are essentially lists or arrays with string elements. Think of them as mathematical sets: you can compare them, subtract them from other sets and form the union and intersection of multiple sets.Note: These Inspectors are not available on SUSE Linux systems.

Creation Methods

DeclarationDescriptionPlatforms (?)
set of <string>Creates a set from the given list of semicolon-separated strings.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
intersection of <string set>Returns a set of strings equal to the intersection of the specified sets, aphabetized and with redundant elements stripped out.

Example:
elements of intersection of (set of ("to";"be"); set of ("or";"not";"to";"be")) - Returns the list: be,to.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
union of <string set>Returns a set of strings equal to the union of the specified sets, alphabetized and with redundant elements stripped out.

Example:
elements of union of (set of ("to";"be"); set of ("or";"not";"to";"be")) - Returns the list: be,not,or,to.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string set> - <string set>Subtracts the elements in the second set from the elements in the first.

Example:
elements of (set of ("to";"be";"or") - set of ("not";"to";"be")) - Returns or.

Example:
elements of (set of ("fee";"fie";"foe") - set of ("fee") - set of("foe")) - Return "fie.".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string set> * <string set>Returns the intersection of the specified sets.

Example:
elements of (set of ("to";"be";"or") * set of ("not";"to";"be")) - Returns the list: be,to.

Example:
elements of (set of ("lime";"pie") * set of ("pie";"face") * set of("pie";"in";"sky")) - Returns "pie.".
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string set> + <string set>Returns the union of the specified sets.

Example:
elements of (set of ("to";"be";"or") + set of ("not";"to";"be")) - Returns the list: be,not,or,to.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<string set> - <string set><string set>Subtracts the elements in the second set from the elements in the first.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string set> * <string set><string set>Returns the intersection of the specified sets.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string set> + <string set><string set>Returns the union of the specified sets.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string set> = <string set><boolean>Returns TRUE if the specified sets have identical contents.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string set> contains <string set><boolean>Returns TRUE if the first set contains all the elements of the second set.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string set> contains <string><boolean>Returns TRUE if the specified set of strings contains the given string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
element of <string set><string>

Plural: elements
Returns the unique elements of the specified <string set>, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
intersection of <string set><string set>

Plural: intersections
Returns a set of strings equal to the intersection of the specified sets, aphabetized and with redundant elements stripped out.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
size of <string set><integer>

Plural: sizes
Returns the number of unique elements in the specified set.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
union of <string set><string set>

Plural: unions
Returns a set of strings equal to the union of the specified sets, alphabetized and with redundant elements stripped out.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

rope

The <rope> object is a way to efficiently concatenate long strings. String literals in the Relevence language are limited to 512 characters, but internally, they can be any length. Ropes provide a technique for concatenating string literals that is memory-efficient. In general, the Fixlet author will not need to worry about ropes, but they are useful for increasing efficiency.

Creation Methods

DeclarationDescriptionPlatforms (?)
<rope> & <string>Concatenates a rope and a string, producing a rope.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> & <rope>Concatenates a rope and a string, returning a new rope.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<rope> & <rope>Concatenates two ropes into a new rope.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<rope> & <string>Concatenates a rope and a string, producing a rope.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> & <rope>Concatenates a rope and a string, returning a new rope.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
rope <string>Creates a rope object from the given string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<rope> & <rope><rope>Concatenates two ropes into a new rope.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<rope> & <string><rope>Concatenates a rope and a string, producing a rope.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<rope> contains <string><boolean>Returns TRUE if the rope contains the string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> & <rope><rope>Concatenates a rope and a string, returning a new rope.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<rope> as string<string>Converts a rope into a string object. When converted, all the other string properties are available.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
length of <rope><integer>

Plural: lengths
Returns the number of bytes in the rope.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

array

The <array> Inspectors return a list of values in a dictionary array.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

bit set

A small, numbered collection of bits that can be examined and manipulated.

Creation Methods

DeclarationDescriptionPlatforms (?)
<integer> as bit setReturns the bits of the binary representation of the integer; bit zero is the least-significant bit.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<integer> as bitsReturns the bits of the binary representation of the integer; bit zero is the least-significant bit.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
left shift <integer> of <bit set>A bit set which, at each position n >= delta, holds bit n-delta of the original bit set, where delta is the given integer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
right shift <integer> of <bit set>A bit set which, at each position n, holds bit n+delta of the original bit set, where delta is the given shift integer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<bit set> - <bit set>Returns the bits that are true in the left bit set and false in the right bit set.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<bit set> * <bit set>Returns the intersection of the two bit sets.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<bit set> + <bit set>Returns the union of the two sets.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
bit <integer>Returns TRUE or FALSE, corresponding to value of the bit specified by <integer>.

Example:
bit 0 of 5 - Returns TRUE.

Example:
bit 3 of bit 3 - Returns TRUE.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
bit set <string>Returns the bits of the binary number given by the string.

Example:
bit set "101" as integer - Returns 5.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<bit set> - <bit set><bit set>Returns the bits that are true in the left bit set and false in the right bit set.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<bit set> * <bit set><bit set>Returns the intersection of the two bit sets.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<bit set> + <bit set><bit set>Returns the union of the two sets.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<bit set> = <bit set><boolean>Returns true if the corresponding bits of the two sets are equal.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<bit set> contains <bit set><boolean>Returns false if -- for any n -- bit n of the left set is false, but bit n of the right set is true.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<bit set> as integer<integer>Returns the integer whose binary representation matches the bit set.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<bit set> as string<string>Returns the bits (0s and 1s) in a string format.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
bit <integer> of <bit set><boolean>

Plural: bits
Returns the value of the bit at the given <integer> position in the set.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
least significant one bit of <bit set><integer>

Plural: least significant one bits
Returns the least n such that bit n of the set is true.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
left shift <integer> of <bit set><bit set>

Plural: left shifts
A bit set which, at each position n >= delta, holds bit n-delta of the original bit set, where delta is the given integer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
most significant one bit of <bit set><integer>

Plural: most significant one bits
Returns the greatest n such that bit n of the set is true.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
one bit of <bit set><integer>

Plural: one bits
Returns the numbers n for which bit n of the set is true.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
right shift <integer> of <bit set><bit set>

Plural: right shifts
A bit set which, at each position n, holds bit n+delta of the original bit set, where delta is the given shift integer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

regular expression

The <regular expression> Inspectors let you use regular expressions (or regexes) in relevance statements. They use the boost library implementation of the 'POSIX-Extended' regular expression syntax, as documented at Wikipedia using the search term "posix-extended regex".

Creation Methods

DeclarationDescriptionPlatforms (?)
case insensitive regex <string>Returns a case-insensitive regular expression from the supplied string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
case insensitive regular expression <string>Same as case insensitive regex <string>.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
regex <string>Creates a regex object from the given string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
regular expression <string>Same as regex <string>.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<regular expression> = <string><boolean>Returns TRUE if the regular expression is equal to the specified string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<string> = <regular expression><boolean>Returns TRUE if the regular expression is equal to the specified string.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<string> contains <regular expression><boolean>Returns TRUE if the specified string contains the contents of the regular expression.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<string> ends with <regular expression><boolean>Returns TRUE if the string ends with the contents of the regular expression.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<string> starts with <string><boolean>Returns a boolean TRUE if the first string starts with the second string.Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
<string> ends with <string><boolean>Returns a boolean TRUE if the first string ends with the second string.Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
<string> starts with <regular expression><boolean>Returns TRUE if the string starts with the contents of the regular expression.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)

regular expression match

The <regular expression match> Inspectors let you match regular expressions (or regexes) in relevance statements. They use the boost library implementation of the 'POSIX-Extended' regular expression syntax, as documented at Wikipedia using the search term "posix-extended regex".

Creation Methods

DeclarationDescriptionPlatforms (?)
first match <regular expression> of <string>Creates an object containing the first match to the regular expression in the given stringWin, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
match <regular expression> of <string>Creates an object containing all the matches to the regular expression in the given string.Win, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol

Properties

DeclarationReturn typeDescriptionPlatforms (?)
match <regular expression> of <string><regular expression match>

Plural: matches
Creates an object containing all the matches to the regular expression in the given string.Win, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
parenthesized part <integer> of <regular expression match><substring>

Plural: parenthesized parts
Returns the nth parenthetical (given by <integer>) in the specified regular expression match.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
parenthesized part of <regular expression match><substring>

Plural: parenthesized parts
Returns the parenthetical part of the specified regular expression match.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

undefined

The "undefined" type is used as the result type of Inspectors that never return a value.

Creation Methods

DeclarationDescriptionPlatforms (?)
error <string>This expression allows you to output your own user-defined error message, typically in the 'else' clause of an 'if/then/else' statement.

Example:
if FALSE then 1 else error "my error message" - Returns the string: User-defined error: my error message.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<undefined> as string<string>Casts the 'undefined' error as a string.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

hertz

The <hertz> object is useful to measure clock cycles. It is used primarily to measure clock frequency by the speed of the processor Inspector. Hertz objects have a resolution of 1 hertz and are stored internally as a 64 bit signed integer.

Creation Methods

DeclarationDescriptionPlatforms (?)
<hertz> {op} <integer>Returns a hertz object operated on by the given integer, where:{op} is one of: *, / .Win, Lin, Sol, HPUX, AIX, Mac, WM
<integer> {op} <hertz>Ubu:8.1, Lin:8.1, Mac:8.1, HPUX:8.1, AIX:8.1, Sol:8.1
<hertz> mod <hertz>Ubu:8.1, Lin:8.1, Mac:8.1, HPUX:8.1, AIX:8.1, Sol:8.1
absolute value of <hertz>Returns the positive value of the hertz object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <hertz>Returns the maximum value from a list of <hertz> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <hertz>Returns the minimum value from a list of <hertz> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
significant digits <integer> of <hertz>Returns the value of a hertz object with <integer> significant digits (for example. significant digits 3 of 1235569 = 1240000).

Example:
significant digits 3 of 1235569 - Returns 1240000.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
- <hertz>Returns the negative of the <hertz> value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<hertz> {op} <hertz>Returns a hertz object equal to the result of the operation, where:{op} is one of: +, -, mod.Win, Lin, Sol, HPUX, AIX, Mac, WM
<hertz> {op} <integer>Returns a hertz object equal to the result of the operation, where:{op} is one of: *, / .Win, Lin, Sol, HPUX, AIX, Mac, WM
ghzReturns a Hertz object corresponding to 1 giga-hertz. See hertz.

Example:
speed of processor > 3*ghz - Returns TRUE on machines faster than 3Ghz.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
greatest hzReturns the largest hertz object that can be represented on this machine. See hertz.

Example:
greatest hz - Returns a large positive value, such as 9223372036854775807 hertz.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
hzReturns a hertz object corresponding to 1 hertz.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
khzReturns a hertz object corresponding to 1 kilohertz.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
least hzReturns the least hertz value that can be represented on this machine.

Example:
least hz - Returns a large negative value, such as -9223372036854775808 hertz.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
mhzReturns a hertz object corresponding to 1 megahertz.

Example:
significant digits 2 of speed of processor/mhz/ 1000 as floating point - Returns a floating point representation of the processor speed in GHz, such as 3.4 ghz.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
speed of <processor>Returns the speed of the processor in Hertz.

Example:
speed of main processor < 2000 * MHz - Returns TRUE is the cpu is slower than 2Ghz.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<integer> {op} <hertz><hertz>Ubu:8.1, Lin:8.1, Mac:8.1, HPUX:8.1, AIX:8.1, Sol:8.1
<hertz> mod <hertz><hertz>Ubu:8.1, Lin:8.1, Mac:8.1, HPUX:8.1, AIX:8.1, Sol:8.1
- <hertz><hertz>Returns the negative of the <hertz> value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<hertz> {cmp} <hertz><boolean>Returns a boolean TRUE/FALSE depending on the result of the comparison, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<hertz> {op} <hertz><hertz>Returns a hertz object equal to the result of the operation, where:{op} is one of: +, -, mod.Win, Lin, Sol, HPUX, AIX, Mac, WM
<hertz> {op} <integer><hertz>Returns a hertz object equal to the result of the operation, where:{op} is one of: *, / .Win, Lin, Sol, HPUX, AIX, Mac, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<hertz> as string<string>Returns a string formatted "##### hertz".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
absolute value of <hertz><hertz>

Plural: absolute values
Returns the positive value of the hertz object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
extrema of <hertz><( hertz, hertz )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <hertz> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <hertz><hertz>

Plural: maxima
Returns the maximum value from a list of <hertz> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <hertz><hertz>

Plural: minima
Returns the minimum value from a list of <hertz> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
significant digits <integer> of <hertz><hertz>

Plural: significant digitss
Returns the value of a hertz object with <integer> significant digits (for example. significant digits 3 of 1235569 = 1240000).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <hertz><hertz with multiplicity>

Plural: unique values
Returns the unique values of a given list of <hertz> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

hertz with multiplicity

The <hertz with multiplicity> Inspectors deal with hertz arrays, allowing you to extract unique hertz values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <hertz>Returns the unique values of a given list of <hertz> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <hertz with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <hertz> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

time

A <time> object is used to identify a point in time. Time objects are used to represent important properties of objects such as the modification time of a file. You can create time objects from literal strings. The format of the string is defined by the MIME standard. The difference between two Time objects may be calculated by subtracting them and yields time intervals. Time intervals may be added or subtracted from time objects to obtain time objects.

Creation Methods

DeclarationDescriptionPlatforms (?)
<string> as local timeReturns a local time object from a properly formatted string. See <time>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as timeReturns a time object from a properly formatted string. See <time>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as universal timeReturns a universal time object from a properly formatted string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <time>Returns the maximum time from a list of times.

Example:
maximum of (modification times of files of folder "temp" of windows folder) - Returns the latest time stamp from the files in the windows temporary folder.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <time>Returns the minimum time from a list of times.

Example:
minimum of (modification times of files of folder "temp" of windows folder) - Returns the latest earliest stamp from the files in the windows temporary folder.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> {op} <time interval>Returns a <time> corresponding to the operator, where:{op} is one of: +, -.Win, Lin, Sol, HPUX, AIX, Mac, WM
<time interval> + <time>Adds the specified time interval to the <time>Win, Lin, Sol, HPUX, AIX, Mac, WM
<date> & <time of day with time zone>Concatenates a date with a time and a time zone for a complete time stamp.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
end of <time range>Returns the end date of a time range.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
start of <time range>Returns the starting date of a time range.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<date> & <time of day with time zone>Concatenates a date with a time and a time zone for a complete time stamp.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day with time zone> & <date>Concatenates a 'time of day with time zone' object with a date object to produce a time object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
apparent registration server timeShorthand for 'now of registration server'. When the client registers with the server, the server passes its current time back to the client. The client starts a stop watch at that time. The apparent registration server time is the time the server passed back to the client, plus the elapsed time on the stop watch.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
custom site subscription effective date <string>Returns the date the custom site (specified by <string>) was last subscribed or unsubscribed. It is used internally by BES to manage custom site subscriptions.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
last relay select timeReturns the time when last relay selection took place.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
local time <string>Returns a time object for the name provided. See time.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
nowReturns the current time as a time object.

Example:
now - Returns the current time.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
time <string>Returns a time object for the name provided. See time.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
universal time <string>Returns a time object for the name provided. See time.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
change time of <filesystem object>Returns the last time the specified filesystem object was changed by either writing it or setting its inode information.Ubu:8.1, Lin, HPUX, AIX, Sol
accessed time of <filesystem object>When the filesystem object (file or folder) was last accessed. Some file systems maintain this property.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
modification time of <filesystem object>The date and time of latest modification of the file. This corresponds to what is shown in the "Get Info" box.

Example:
name of object "iChat.app" of applications folder - Returns iChat.app.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
accessed time of <symlink>Returns the last accessed time of the specified symlink.Lin, Sol, HPUX, AIX, Ubu:8.1
change time of <symlink>Returns the last time the specified symlink was 'changed' by either writing it or setting its inode information.Lin, Sol, HPUX, AIX, Ubu:8.1
modification time of <symlink>Returns the time corresponding to the modification time of the specified symlink, not the file it points to.

Example:
modification time of symlink "/example/link" - Returns the time corresponding to the modification time of the given symlink, not the file it points to.

Example:
modification time of file "/example/link" - Returns the time corresponding to the file object that the symlink is pointing to.
Lin, Sol, HPUX, AIX, Ubu:8.1
boot time of <operating system>Returns the time of the last restart.

Example:
now - boot time of operating system > week - Returns TRUE if the computer hasn't been rebooted for over a week.
Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
effective time of <runlevel>Returns the time at which the runlevel was set to its current value.Lin, Sol, HPUX, AIX, Ubu:8.1
last gather time of <site>Returns the time of last successful gathering from the site.

Example:
last gather time of current site > now - 30 * day - Return TRUE if it has been over 30 days since last gathering, or synchronizing, with the site.

Example:
last gather time of current site < time "4 Aug 1997 01:00 pdt" - Returns TRUE if the site was last synchronized before the specified date.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
subscribe time of <site>Returns the time that the current machine began subscribing to the site.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
last command time of <client>Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
effective date of <setting>Returns the date when the setting was last modified.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first start time of <application usage summary>Returns the start time of the specified application since the computer was configured to track it, regardless of reboots.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
last start time of <application usage summary>Returns the last time this specified application was started.

Example:
last start time of application usage summary "winword.exe" - Returns the date and time Word was last started.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
last time seen of <application usage summary>Returns the last time this specified application was seen running.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first start time of <application usage summary instance>Returns the start time of the specified application instance since the computer was configured to track it, regardless of reboots.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
last start time of <application usage summary instance>Returns the last time this specified application was started.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
last time seen of <application usage summary instance>Returns the last time this specified application was seen running.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
expiration date of <license>Returns date when license will expire.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
start date of <license>The starting date specified for the BigFix license.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
invalid before of <x509 certificate>Returns the date on which the certificate first becomes valid. This is useful for examining encryption certificates, where the 'invalid before date' is the time when the encryption credentials were generated.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
active start time of <action>Returns the time the action started.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
complete time of <action>Returns the time the action completed.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
last change time of <action>Returns the time when the action state last changed.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pending time of <action>Returns the time the action became pending.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<time> - <time><time interval>Subtract one time from another and return a time intervalWM, Win, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
<time interval> & <time><time range>Concatenates a time interval with a time, returning a time range of the form time1 to time2.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time range> & <time><time range>Concatenates a time with a time range, producing a new time range, in the form of:<date> to <date>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> & <time interval><time range>Concatenates a time and a time interval, producing a time range object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> & <time range><time range>Concatenates a time and a time range, producing a new time range.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> & <time><time range>Concatenates two times into a time range, with the earliest date first and the latest date last.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> {cmp} <time><boolean>Returns a boolean TRUE/FALSE depending on the result of the comparison, where:{cmp} is one of: =, !=, <, <=, >, >= .Win, Lin, Sol, HPUX, AIX, Mac, WM
<time> {op} <time interval><time>Returns a <time> corresponding to the operator, where:{op} is one of: +, -.Win, Lin, Sol, HPUX, AIX, Mac, WM
<time interval> + <time><time>Adds the specified time interval to the <time>Win, Lin, Sol, HPUX, AIX, Mac, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<time> as local string<string>Returns a string in MIME format of the given time object. The format is: ddd, DD mmm YYYY HH:MM:SS sZZZZ. The string is formatted using the local time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> as string<string>Same as above.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> as universal string<string>Returns a string in MIME format of the given time object. The format is:ddd, DD mmm YYYY HH:MM:SS +0000The string is formatted using the universal time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
date <time zone> of <time><date>

Plural: dates
Returns the date adjusted for the specified time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
extrema of <time><( time, time )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <time> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <time><time>

Plural: maxima
Returns the maximum time from a list of times.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <time><time>

Plural: minima
Returns the minimum time from a list of times.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
time <time zone> of <time><time of day with time zone>

Plural: times
Adjusts the specified time to the given time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <time><time with multiplicity>

Plural: unique values
Returns the unique values of a given list of <time> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

time with multiplicity

The <time with multiplicity> Inspectors deal with time arrays, allowing you to extract unique time values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <time>Returns the unique values of a given list of <time> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <time with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <time> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

time of day

The <time of day> Inspectors provide tools for dealing and calculating with time-of-day types, which are of the form HH:MM:SS, as in 12:59:59.

Creation Methods

DeclarationDescriptionPlatforms (?)
<string> as time_of_dayConverts a string to a time_of_day type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <time of day>Returns the maximum value from a list of <time of day> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <time of day>Returns the minimum value from a list of <time of day> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
time of <time of day with time zone>Returns the time of day, without the time zone information.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time interval> + <time of day>Adds a time interval (days, hours, minutes, seconds) to a time of the day to create a new time of the day.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day> {op} <time interval>Adds or subtracts a time interval to provide a new time of day. Here {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
midnightReturns 00:00:00 as a time of day object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
noonReturns 12:00:00 as a time of day object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
time_of_day <string>Creates a time of day object out of the given string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<time of day> - <time of day><time interval>Subtracts two times of day, returning a time interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day> & <time zone><time of day with time zone>Concatenates a time of day with a time zone, returning a time of day with time zone type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time zone> & <time of day><time of day with time zone>Concatenates a time of day with a time zone, returning a time of day with time zone type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<time of day> as string<string>Casts the time of day as a string type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
extrema of <time of day><( time of day, time of day )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <time of day> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
hour_of_day of <time of day><integer>

Plural: hours_of_day
Returns the hour section of the 'time of day' object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <time of day><time of day>

Plural: maxima
Returns the maximum value from a list of <time of day> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <time of day><time of day>

Plural: minima
Returns the minimum value from a list of <time of day> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minute_of_hour of <time of day><integer>

Plural: minutes_of_hour
Returns the 'minutes after the hour' section of the 'time of day' object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
second_of_minute of <time of day><integer>

Plural: seconds_of_minute
Extracts the 'seconds after the minute' section of the 'tim of day' object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
two digit hour of <time of day><string>

Plural: two digit hours
Extracts the 2-digit hour from the time of day.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
two digit minute of <time of day><string>

Plural: two digit minutes
Extracts the 2-digit minute from the time of day.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
two digit second of <time of day><string>

Plural: two digit seconds
Extracts the 2-digit second from the time of day.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <time of day><time of day with multiplicity>

Plural: unique values
Returns the unique values of a given list of <time of day> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

time of day with multiplicity

The <time of day with multiplicity> Inspectors deal with time-of-day arrays, allowing you to extract unique time-of-day values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <time of day>Returns the unique values of a given list of <time of day> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <time of day with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <time of day> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

time zone

Time zones are used in conjunction with the time object. Time zones have a resolution of 1 minute.

Creation Methods

DeclarationDescriptionPlatforms (?)
<string> as time zoneReturns a time zone object from a properly formatted string. See <time zone>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time zone> {op} <time interval>Returns a time zone object offset by a time interval, where:{op} is one of: +, - .Win, Lin, Sol, HPUX, AIX, Mac
zone of <time of day with time zone>Returns the zone associated with the specified time.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
local time zoneReturns a time zone object corresponding to the local time zone.

Example:
local time zone - 2 * hour - Returns the time zone two hours away.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
time zone <string>Returns a time zone object for the name provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
universal time zoneReturns a time zone object corresponding to the universal time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<time of day> & <time zone><time of day with time zone>Concatenates a time of day with a time zone, returning a time of day with time zone type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time zone> & <time of day with time zone><time of day with time zone>Converts a 'time of day with time zone' to the time in the specified time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time zone> & <time of day><time of day with time zone>Concatenates a time of day with a time zone, returning a time of day with time zone type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time zone> {op} <time interval><time zone>Returns a time zone object offset by a time interval, where:{op} is one of: +, - .Win, Lin, Sol, HPUX, AIX, Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<time zone> as string<string>Returns a string corresponding to the time zone object provided.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <time zone><time zone with multiplicity>

Plural: unique values
Returns the unique values of a given list of <time zone> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

time zone with multiplicity

The <time zone with multiplicity> Inspectors deal with time zone arrays, allowing you to extract unique time zone values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <time zone>Returns the unique values of a given list of <time zone> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <time zone with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <time zone> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

time of day with time zone

The <time of day with time zone> Inspectors provide tools for dealing and calculating with time-of-day-with-time-zone types, which are of the form HH:MM:SS +ZZZZ, as in 12:59:59 -0400.

Creation Methods

DeclarationDescriptionPlatforms (?)
<string> as local zoned time_of_dayConverts a string to a time of day with local time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as universal zoned time_of_dayConverts a string into a universal zoned time of day.

Example:
12:00:00 -4000 as universal zoned time_of_day - Returns 04:00:00 +0000.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as zoned time_of_dayConverts a string into a zoned time of day.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
time <time zone> of <time>Adjusts the specified time to the given time zone.

Example:
time (time zone "+0000") of now - Returns the time in Greenwich, England.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day> & <time zone>Concatenates a time of day with a time zone, returning a time of day with time zone type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time zone> & <time of day>Concatenates a time of day with a time zone, returning a time of day with time zone type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day> & <time zone>Concatenates a time of day with a time zone, returning a time of day with time zone type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time zone> & <time of day with time zone>Converts a 'time of day with time zone' to the time in the specified time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time zone> & <time of day>Concatenates a time of day with a time zone, returning a time of day with time zone type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day with time zone> & <time zone>Concatenates a 'time of day with a time zone' and another time zone. The 'time of day with time zone' object that is produced is adjusted to fit the appended time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time zone> & <time of day with time zone>Converts a 'time of day with time zone' to the time in the specified time zone.

Example:
time zone "+0000" & time (universal time zone) of now - Returns the time in Greenwich, England.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time interval> + <time of day with time zone>Adds a time interval (days, hours, minutes, seconds) to a time of the day with time zone to create a new time of the day with time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day with time zone> {op} <time interval>Adds or subtracts a time interval and a specified 'time of day with time zone' object, where {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
current time_of_dayReturns the current time of day in the local time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
current time_of_day <time zone>Returns the current time of day in the specified time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
zoned time_of_day <string>Returns a 'time of day with time zone' object from the specified string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<date> & <time of day with time zone><time>Concatenates a date with a time and a time zone for a complete time stamp.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day with time zone> - <time of day with time zone><time interval>Subtracts two times of day (including time zones), returning a time interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day with time zone> & <time zone><time of day with time zone>Concatenates a 'time of day with a time zone' and another time zone. The 'time of day with time zone' object that is produced is adjusted to fit the appended time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day with time zone> = <time of day with time zone><boolean>Compares two times of day with time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time zone> & <time of day with time zone><time of day with time zone>Converts a 'time of day with time zone' to the time in the specified time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<time of day with time zone> as string<string>Converts a 'time of day with time zone' object into a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
hour_of_day of <time of day with time zone><integer>

Plural: hours_of_day
Returns the hour section of the 'time of day with time zone' object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minute_of_hour of <time of day with time zone><integer>

Plural: minutes_of_hour
Returns the 'minutes after the hour' section of the 'time of day with time zone' object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
second_of_minute of <time of day with time zone><integer>

Plural: seconds_of_minute
Returns the 'seconds after the minute' section of the 'time of day with time zone' object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
time of <time of day with time zone><time of day>

Plural: times
Returns the time of day, without the time zone information.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
two digit hour of <time of day with time zone><string>

Plural: two digit hours
Returns the hour of the zoned time of day as text, with values less than 10 having a leading zero.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
two digit minute of <time of day with time zone><string>

Plural: two digit minutes
Returns the minute of the zoned time of day as text, with values less than 10 having a leading zero.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
two digit second of <time of day with time zone><string>

Plural: two digit seconds
Returns the second of the zoned time of day as text, with values less than 10 having a leading zero.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <time of day with time zone><time of day with time zone with multiplicity>

Plural: unique values
Returns the unique values of a given list of <time of day with time zone> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
zone of <time of day with time zone><time zone>

Plural: zones
Returns the zone associated with the specified time.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

time of day with time zone with multiplicity

The <time of day with time zone with multiplicity> Inspectors deal with time-of-day-with-time-zone arrays, allowing you to extract unique time-of-day-with-time-zone values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <time of day with time zone>Returns the unique values of a given list of <time of day with time zone> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <time of day with time zone with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <time of day with time zone> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

time range

The <time range> Inspectors provide tools for dealing and calculating with time-range types, which are of the form 'time to time', such as Tue, 18 Apr 2006 16:46:07 -0400 to Wed, 19 Apr 2006 16:46:07 -0400

Creation Methods

DeclarationDescriptionPlatforms (?)
<time interval> & <time>Concatenates a time interval with a time, returning a time range of the form time1 to time2.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time range> & <time>Concatenates a time with a time range, producing a new time range, in the form of:<date> to <date>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> & <time interval>Concatenates a time and a time interval, producing a time range object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> & <time range>Concatenates a time and a time range, producing a new time range.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> & <time>Concatenates two times into a time range, with the earliest date first and the latest date last.

Example:
time "Sat, 01 Jan 2000 00:00:00 -0400" & now - Returns a time range from the beginning of the millennia to now, eg:Sat, 01 Jan 2000 00:00:00 -0400 to Sat, 08 Apr 2006 20:39:51 -0400.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
final part <time interval> of <time range>Returns a time range with the specified interval, but ending on the final date of the time range.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
initial part <time interval> of <time range>Returns a time range starting with the first date of the time range and lasting for the specified interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
range after <time> of <time range>Returns a new time range, starting from the specified time and continuing through the end of the original range. The time must be within the range, or an error will result.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
range before <time> of <time range>Returns a new time range, starting from the original time in the specified range and continuting to the specified time. The time must be within the range, or an error will result.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time range> & <time range>Returns the smallest range that contains both ot the specified ranges (same as <time range> + <time range>).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time range> & <time>Concatenates a time with a time range, producing a new time range, in the form of:<time - time range> to <time>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time range> * <time range>Returns the intersection of the two specified time ranges, if one exists.

Example:
(week & now) * (day & now) - Returns a one-day time range (from yesterday to today).
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time range> + <time range>Returns the smallest range that contains both ot the specified ranges (same as <time range> & <time range>).

Example:
(week & now) + (day & now) - Returns a one-week time range (from a week ago to today).
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> & <time range>Concatenates a time and a time range, producing a new time range, in the form of:<time> to <time + time range>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time interval> & <time>Concatenates a time interval with a time, returning a time range of the form time1 to time2.

Example:
time interval "01:00:00" & now - Returns a one-hour time range ending now, eg. Fri, 07 Apr 2006 12:36:10 -0400 to Fri, 07 Apr 2006 13:36:10 -0400.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> & <time interval>Concatenates a time and a time interval, producing a time range object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<time range> & <time range><time range>Returns the smallest range that contains both ot the specified ranges (same as <time range> + <time range>).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time range> & <time><time range>Concatenates a time with a time range, producing a new time range, in the form of:<time - time range> to <time>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time range> * <time range><time range>Returns the intersection of the two specified time ranges, if one exists.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time range> + <time range><time range>Returns the smallest range that contains both ot the specified ranges (same as <time range> & <time range>).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time range> = <time range><boolean>Compares two time range types and returns TRUE if they are equal.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> & <time range><time range>Concatenates a time and a time range, producing a new time range, in the form of:<time> to <time + time range>.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<time range> as string<string>Casts a time range as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
end of <time range><time>

Plural: ends
Returns the end date of a time range.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
final part <time interval> of <time range><time range>

Plural: final parts
Returns a time range with the specified interval, but ending on the final date of the time range.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
initial part <time interval> of <time range><time range>

Plural: initial parts
Returns a time range starting with the first date of the time range and lasting for the specified interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
length of <time range><time interval>

Plural: lengths
Returns the time interval (in days, hours, minutes, seconds) between the start and end date of a time range.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
range after <time> of <time range><time range>

Plural: ranges after
Returns a new time range, starting from the specified time and continuing through the end of the original range. The time must be within the range, or an error will result.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
range before <time> of <time range><time range>

Plural: ranges before
Returns a new time range, starting from the original time in the specified range and continuting to the specified time. The time must be within the range, or an error will result.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
start of <time range><time>

Plural: starts
Returns the starting date of a time range.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <time range><time range with multiplicity>

Plural: unique values
Returns the unique values of a given list of <time range> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

time range with multiplicity

The <time range with multiplicity> Inspectors deal with time-range arrays, allowing you to extract unique time-range values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <time range>Returns the unique values of a given list of <time range> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <time range with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <time range> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

time interval

Time intervals are used in conjunction with the time object. Time intervals have a resolution of 1 microsecond.

Creation Methods

DeclarationDescriptionPlatforms (?)
<string> as time intervalReturns a time interval object from a properly formatted string. Expects strings formatted as ddd days, HH:MM:SS.mmmmmm.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time> - <time>Subtract one time from another and return a time intervalWM, Win, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
<time of day> - <time of day>Subtracts two times of day, returning a time interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day with time zone> - <time of day with time zone>Subtracts two times of day (including time zones), returning a time interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
length of <time range>Returns the time interval (in days, hours, minutes, seconds) between the start and end date of a time range.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
absolute value of <time interval>Returns positive value of the time interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <time interval>Returns the maximum interval from a list of time intervals.

Example:
maximum of ("00:00:00" as time interval; "01:01:01"as time interval) - Returns 01:01:10.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <time interval>Returns the minimum interval from a list of time intervals.

Example:
minimum of ("00:00:00" as time interval; "01:01:01"as time interval) - Returns 00:00:00.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
sum of <time interval>Returns the sum of the supplied time intervals.

Example:
sum of ((hour*4); (minute*3); (second*5)) - Returns 04:03:05.
Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
- <time interval>The negative of a time interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time interval> {op} <integer>Creates a time interval calculated as an integer operation on another time interval, where:{op} is one of: *, / .Win, Lin, Sol, HPUX, AIX, Mac, WM
<integer> {op} <time interval>Creates a time interval calculated as an integer operation on another time interval, where:{op} is one of: *, / .Win, Lin, Sol, HPUX, AIX, Mac, WM
<time interval> {op} <time interval>Returns a calculated time interval, where:{op} is one of: +, -, mod, / .Win, Lin, Sol, HPUX, AIX, Mac, WM
<time interval> {op} <time zone>Returns a calculated time interval, where:{op} is one of: +, - .Win, Lin, Sol, HPUX, AIX, Mac, WM
<date> - <date>Subtracts two dates to produce a time interval.

Example:
now - time "Sat, 01 Jan 2000 00:00:00 -0000" - Returns the number of days, hours, minutes and seconds since the turn of the millennia, eg: 2288 days, 17:53:06.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of week> - <day of week>Subtract two day of week types (Monday, Tuesday, etcetera.) to produce a time interval. The answer cannot exceed 6 days.

Example:
Friday - Wednesday - Returns 2.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> - <day of month>Subtract two day of month types, producing a time interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of year> - <day of year>Subtracts two days of the year to produce a time interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
length of <month and year>Returns the number of days in the specified month.

Example:
length of (month "February" & year "2004") - Returns 29.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
length of <year>Returns the number of day in the specified year. Leap years have 366 days.

Example:
length of year "2008" - Returns 366.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
dayReturns a time interval corresponding to 1 day.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
greatest time intervalReturns the greatest time interval representable. The value corresponds to 106751991 days, 04:00:54.775807.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
hourReturns a time interval corresponding to 1 hour.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
least time intervalReturns the least time interval that can be represented on this machine. The value corresponds to -106751991 days, 04:00:54.775808.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
microsecondReturns a time interval corresponding to .000001 seconds.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
millisecondReturns a time interval corresponding to .001 seconds.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minuteReturns a time interval corresponding to 1 minute.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
secondReturns a time interval corresponding to 1 second.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
time interval <string>Creates a time interval from the string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
weekReturns a time interval corresponding to 1 week.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
uptime of <operating system>Returns a time interval that represents the elapsed time since the operating system was last booted. Note: Depending on the notebook, this interval may not include time spent in hibernation.Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
gather schedule time interval of <site>Returns the time interval between automatic gathering of site content.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
action duration of <evaluation cycle>Time taken performing action processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
api duration of <evaluation cycle>Time taken performing client api processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
archive duration of <evaluation cycle>Time taken performing archive processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
gather duration of <evaluation cycle>Time taken performing gather processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
other duration of <evaluation cycle>Time taken performing other (unclassified) processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
property duration of <evaluation cycle>Time taken performing property processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
quiet mode duration of <evaluation cycle>Time taken performing quiet mode processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
relay select duration of <evaluation cycle>Time taken performing relay select processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
relevance duration of <evaluation cycle>Time taken performing relevance processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
report duration of <evaluation cycle>Time taken performing report processing since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
sleep duration of <evaluation cycle>Time taken sleeping since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
total duration of <evaluation cycle>Total time since agent startUbu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
average duration of <evaluation cycle>Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
maximum duration of <evaluation cycle>Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
total duration of <application usage summary>Returns the total elapsed time that the specified application has been running.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
total duration of <application usage summary instance>Returns the total elapsed time that the specified application instance has been running.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
- <time interval><time interval>The negative of a time interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time interval> & <time><time range>Concatenates a time interval with a time, returning a time range of the form time1 to time2.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time interval> {op} <integer><time interval>Creates a time interval calculated as an integer operation on another time interval, where:{op} is one of: *, / .Win, Lin, Sol, HPUX, AIX, Mac, WM
<integer> {op} <time interval><time interval>Creates a time interval calculated as an integer operation on another time interval, where:{op} is one of: *, / .Win, Lin, Sol, HPUX, AIX, Mac, WM
<time interval> {op} <time interval><time interval>Returns a calculated time interval, where:{op} is one of: +, -, mod, / .Win, Lin, Sol, HPUX, AIX, Mac, WM
<time interval> {op} <time zone><time interval>Returns a calculated time interval, where:{op} is one of: +, - .Win, Lin, Sol, HPUX, AIX, Mac, WM
<time interval> + <time of day with time zone><time of day with time zone>Adds a time interval (days, hours, minutes, seconds) to a time of the day with time zone to create a new time of the day with time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time interval> + <time of day><time of day>Adds a time interval (days, hours, minutes, seconds) to a time of the day to create a new time of the day.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day with time zone> {op} <time interval><time of day with time zone>Adds or subtracts a time interval and a specified 'time of day with time zone' object, where {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<time of day> {op} <time interval><time of day>Adds or subtracts a time interval to provide a new time of day. Here {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<time> & <time interval><time range>Concatenates a time and a time interval, producing a time range object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<time interval> as string<string>Returns a string formatted as ddd days, HH:MM:SS.mmmmmmFor example, millisecond as string = " 00:00:00.001".Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
absolute value of <time interval><time interval>

Plural: absolute values
Returns positive value of the time interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
extrema of <time interval><( time interval, time interval )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <time interval> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <time interval><time interval>

Plural: maxima
Returns the maximum interval from a list of time intervals.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <time interval><time interval>

Plural: minima
Returns the minimum interval from a list of time intervals.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
sum of <time interval><time interval>

Plural: sums
Returns the sum of the supplied time intervals.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
unique value of <time interval><time interval with multiplicity>

Plural: unique values
Returns the unique values of a given list of <time interval> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

time interval with multiplicity

The <time interval with multiplicity> Inspectors deal with time-interval arrays, allowing you to extract unique time-interval values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <time interval>Returns the unique values of a given list of <time interval> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <time interval with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <time interval> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

date

The <date> objects are the various Inspectors that access the date types.

Creation Methods

DeclarationDescriptionPlatforms (?)
april <integer> of <integer>Returns the nth day of April and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
august <integer> of <integer>Returns the nth day of August and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
december <integer> of <integer>Returns the nth day of December and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
february <integer> of <integer>Returns the nth day of February and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
january <integer> of <integer>Returns the nth day of January and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
july <integer> of <integer>Returns the nth day of July and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
june <integer> of <integer>Returns the nth day of June and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
march <integer> of <integer>Returns the nth day of March and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
may <integer> of <integer>Returns the nth day of May and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
november <integer> of <integer>Returns the nth day of November and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
october <integer> of <integer>Returns the nth day of October and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
september <integer> of <integer>Returns the nth day of September and the specified year as a date (day of week, month day year).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
<string> as dateCasts a string as a date type.

Example:
"01 Apr 2020" as date - Returns Wed, 01 Apr 2020.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
date <time zone> of <time>Returns the date adjusted for the specified time zone.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <date>Returns the maximum value from a list of <date> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <date>Returns the minimum value from a list of <date> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<date> {op} <number of months>Adds or subtracts a specified number of months to a given date, where {op} is one of: -, +.

Example:
current date + 14*month - Returns the date 14 months from today, eg. Mon, 07 Jan 2008.
Win, Lin, Sol, HPUX, AIX, Mac, WM
<date> {op} <time interval>Add or subtract a time interval to a date, producing a new date, where {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<number of months> + <date>Adds a number of months to a date, returning a new date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time interval> + <date>Adds a time interval (days, hours, minutes, seconds) to a date to create a new date.

Example:
current date + time interval "7 days" - Returns the date a week from now.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> & <month and year>Concatenate a day of month with a month and year type to produce a complete date.

Example:
(day_of_month 2) & june of 2008 - Returns Mon, 02 Jun 2008.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month and year> & <day of month>Concatenates a month and year with a day of month to produce a complete date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of year> & <month and year>Concatenates a day of the year with a month and year to create a complete date type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of year> & <year>Concatenates a day of the year with a year to create a complete date type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month and year> & <day of year>Concatenates a month and year with a day of year to produce a complete date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> & <day of year>Concatenates a year with the day of the year, returning a full date.

Example:
year 2020 & april 1 - Returns Sun, 01 Apr 2007.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first <day of week> of <month and year>Finds the specific date corresponding to the first day of the week (eg. Friday) for a given month and year.

Example:
first monday of april of 2020 - Returns the date of the first Monday in April 2020, which is Mon, 06 Apr 2020.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first friday of <month and year>Finds the date corresponding to the first Friday of any given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first monday of <month and year>Finds the date corresponding to the first Monday of any given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first saturday of <month and year>Finds the date corresponding to the first Saturday of any given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first sunday of <month and year>Finds the date corresponding to the first Sunday of any given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first thursday of <month and year>Finds the date corresponding to the first Thursday of any given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first tuesday of <month and year>Finds the date corresponding to the first Tuesday of any given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first wednesday of <month and year>Finds the date corresponding to the first Wednesday of any given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> & <month and year>Concatenate a day of month with a month and year type to produce a complete date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of year> & <month and year>Concatenates a day of the year with a month and year to create a complete date type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of year> & <year>Concatenates a day of the year with a year to create a complete date type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> & <day of year>Concatenates a year with the day of the year, returning a full date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
current dateReturns the current date in the format:Day of week, Day Month Year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
date <string>Converts the given string into a date. The string should be of the form 'Day Month Year' and the returned date will be of the form 'Day of week, Day Month Year'.

Example:
date "09 Apr 2006" - Returns Sun, 09 Apr 2006.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
expiration date of <bes product>Returns the expiration date for the specified bes product.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<date> - <date><time interval>Subtracts two dates to produce a time interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<date> & <time of day with time zone><time>Concatenates a date with a time and a time zone for a complete time stamp.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<date> {cmp} <date><boolean>Compares two dates, where: {cmp} is one of: =, <, <=.Win, Lin, Sol, HPUX, AIX, Mac, WM
<date> {op} <number of months><date>Adds or subtracts a specified number of months to a given date, where {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<date> {op} <time interval><date>Add or subtract a time interval to a date, producing a new date, where {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<number of months> + <date><date>Adds a number of months to a date, returning a new date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time interval> + <date><date>Adds a time interval (days, hours, minutes, seconds) to a date to create a new date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time of day with time zone> & <date><time>Concatenates a 'time of day with time zone' object with a date object to produce a time object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<date> as string<string>Cast a date type as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
day_of_month of <date><day of month>

Plural: days_of_month
Extracts the day of the month from the specified date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
day_of_week of <date><day of week>

Plural: days_of_week
Extracts the day of the week (Monday, Tuesday, etcetera) from the specified date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
day_of_year of <date><day of year>

Plural: days_of_year
Extracts the day of year from the specified date, in the 'Month Day' format.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
extrema of <date><( date, date )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <date> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <date><date>

Plural: maxima
Returns the maximum value from a list of <date> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <date><date>

Plural: minima
Returns the minimum value from a list of <date> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
month of <date><month>

Plural: months
Returns the month derived from the given date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
month_and_year of <date><month and year>

Plural: months_and_years
Formats the specified date in month year format, eg. March 2012.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <date><date with multiplicity>

Plural: unique values
Returns the unique values and counts of a given list of <date> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
year of <date><year>

Plural: years
Returns the year, extracted from the given date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

date with multiplicity

The <date with multiplicity> Inspectors deal with arrays of dates, allowing you to extract unique dates and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <date>Returns the unique values and counts of a given list of <date> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <date with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <date> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

day of week

The <day of week> Inspectors provide tools for dealing and calculating with day-of-week types, which include Monday, Tuesday, and more. This set of Inspectors includes each day as a self-named object.

Creation Methods

DeclarationDescriptionPlatforms (?)
<string> as day_of_weekCasts a string as a day of the week.

Example:
Tue as day_of_week - Returns Tuesday.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
day_of_week of <date>Extracts the day of the week (Monday, Tuesday, etcetera) from the specified date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of week> {op} <time interval>Add or subtract a time interval from a day of the week to produce a new day of week. Here {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<time interval> + <day of week>Adds a time interval (days, hours, minutes, seconds) to a day of the week to create a new day of the week.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
current day_of_weekReturns the current day of the week, eg. Monday, Tuesday, etcetera.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
day_of_week <string>Converts the given string value to a day of week type, eg. Monday, Tuesday, etcetera.

Example:
day_of_week "Tuesday" - Returns Tuesday as a 'day of week' object.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
fridayReturns Friday as a day of week object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
mondayReturns the day of week object for Monday.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
saturdayReturns Saturday as a day of week object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
sundayReturns Sunday as a day of week object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
thursdayReturns Thursday as a day of week object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
tuesdayReturns Tuesday as a day of week object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
wednesdayReturns Wednesday as a day of week object.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<day of week> - <day of week><time interval>Subtract two day of week types (Monday, Tuesday, etcetera.) to produce a time interval. The answer cannot exceed 6 days.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of week> {op} <time interval><day of week>Add or subtract a time interval from a day of the week to produce a new day of week. Here {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<day of week> = <day of week><boolean>Compares two days of the week and returns a boolean TRUE or FALSE.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time interval> + <day of week><day of week>Adds a time interval (days, hours, minutes, seconds) to a day of the week to create a new day of the week.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<day of week> as string<string>Casts the day of week as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of week> as three letters<string>Casts the day of week as a three-letter abbreviation (Mon, Tue, etcetera.).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <day of week><day of week with multiplicity>

Plural: unique values
Returns the unique values of a given list of <day of week> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

day of week with multiplicity

The <day of week with multiplicity> Inspectors deal with day-of-week arrays, allowing you to extract unique day-of-week values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <day of week>Returns the unique values of a given list of <day of week> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <day of week with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <day of week> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

day of month

The <day of month> Inspectors provide tools for dealing and calculating with day-of-month types, which are numbers from 1-31.

Creation Methods

DeclarationDescriptionPlatforms (?)
<integer> as day_of_monthCast an integer as a day of the month type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as day_of_monthCasts a string as a day of the month (eg. 28).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
day_of_month of <date>Extracts the day of the month from the specified date.

Example:
day_of_month of current date - Returns the current day of the month.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <day of month>Returns the maximum value from a list of <day of month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <day of month>Returns the minimum value from a list of <day of month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> {op} <time interval>Add or subtract a time interval from a day of month to produce a new day of month. Here {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<time interval> + <day of month>Adds a time interval (days, hours, minutes, seconds) to a day of the month to create a new day of the month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
day of <day of year>Returns the day of the month of the specified date.

Example:
day of July 4 - Returns 4.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
current day_of_monthReturns the current day of the month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
day_of_month <integer>Converts the given integer to a day of month type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
day_of_month <string>Converts the given string value (must be an integer from 1-31) to a day of month type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<day of month> - <day of month><time interval>Subtract two day of month types, producing a time interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> & <month and year><date>Concatenate a day of month with a month and year type to produce a complete date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> & <month><day of year>Concatenate a day of month with a month type to produce a day of year (eg. April 20).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> {cmp} <day of month><boolean>Compare two day of month types, where {cmp} is one of: <, <=, =.Win, Lin, Sol, HPUX, AIX, Mac, WM
<day of month> {op} <time interval><day of month>Add or subtract a time interval from a day of month to produce a new day of month. Here {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<month and year> & <day of month><date>Concatenates a month and year with a day of month to produce a complete date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> & <day of month><day of year>Concatenates a month and a day of the month to produce a day of year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time interval> + <day of month><day of month>Adds a time interval (days, hours, minutes, seconds) to a day of the month to create a new day of the month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<day of month> as integer<integer>Cast a day of month type as an integer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> as string<string>Cast a day of month type as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> as two digits<string>Cast a day of month type as a two-digit number.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
extrema of <day of month><( day of month, day of month )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <day of month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <day of month><day of month>

Plural: maxima
Returns the maximum value from a list of <day of month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <day of month><day of month>

Plural: minima
Returns the minimum value from a list of <day of month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <day of month><day of month with multiplicity>

Plural: unique values
Returns the unique values of a given list of <day of month> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

day of month with multiplicity

The <day of month with multiplicity> Inspectors deal with day-of-month arrays, allowing you to extract unique day-of-month values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <day of month>Returns the unique values of a given list of <day of month> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <day of month with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <day of month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

day of year

The <day of year> Inspectors provide tools for dealing and calculating with day-of-month types, which are of the form Sun, 01 Apr 2007.

Creation Methods

DeclarationDescriptionPlatforms (?)
day_of_year of <date>Extracts the day of year from the specified date, in the 'Month Day' format.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> & <month>Concatenate a day of month with a month type to produce a day of year (eg. April 20).

Example:
(day_of_month 2) & june - Returns June 2.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> & <day of month>Concatenates a month and a day of the month to produce a day of year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <day of year>Returns the maximum value from a list of <day of year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <day of year>Returns the minimum value from a list of <day of year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of year> {op} <number of months>Add or subtract a number of months to a day of the year to produce a new day of the year. Here {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<day of year> {op} <time interval>Add or subtract a time interval to a day of the year to produce a new day of the year. Here {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<number of months> + <day of year>Adds a number of months to a day of the year (July 4, say) to produce another day of the year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time interval> + <day of year>Adds a time interval (days, hours, minutes, seconds) to a day of the year to create a new day of the year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of month> & <month>Concatenate a day of month with a month type to produce a day of year (eg. April 20).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> & <day of month>Concatenates a month and a day of the month to produce a day of year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
april <integer>Returns the nth day of april as a 'day of year' type (month day).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
august <integer>Returns the nth day of August as a 'day of year' type (month day).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
current day_of_yearReturns the current day of the year, in a Month Day format.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
december <integer>Returns the nth day of December as a 'day of year' type (month day).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
february <integer>Returns the nth day of February as a 'day of year' type (month day).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
january <integer>Returns the nth day of January as a 'day of year' type (month day).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
july <integer>Returns the nth day of July as a 'day of year' type (month day).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
june <integer>Returns the nth day of June as a 'day of year' type (month day).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
march <integer>Returns the nth day of March as a 'day of year' type (month day).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
may <integer>Returns the nth day of May as a 'day of year' type (month day).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
november <integer>Returns the nth day of November as a 'day of year' type (month day).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
october <integer>Returns the nth day of October as a 'day of year' type (month day).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
september <integer>Returns the nth day of September as a 'day of year' type (month day).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<day of year> - <day of year><time interval>Subtracts two days of the year to produce a time interval.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of year> & <month and year><date>Concatenates a day of the year with a month and year to create a complete date type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of year> & <year><date>Concatenates a day of the year with a year to create a complete date type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of year> {cmp} <day of year><boolean>Compares two days of the year, producing a boolean TRUE or FALSE, where {cmp} is one of: <, <=, =.Win, Lin, Sol, HPUX, AIX, Mac, WM
<day of year> {op} <number of months><day of year>Add or subtract a number of months to a day of the year to produce a new day of the year. Here {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<day of year> {op} <time interval><day of year>Add or subtract a time interval to a day of the year to produce a new day of the year. Here {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<month and year> & <day of year><date>Concatenates a month and year with a day of year to produce a complete date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<number of months> + <day of year><day of year>Adds a number of months to a day of the year (July 4, say) to produce another day of the year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<time interval> + <day of year><day of year>Adds a time interval (days, hours, minutes, seconds) to a day of the year to create a new day of the year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> & <day of year><date>Concatenates a year with the day of the year, returning a full date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<day of year> as string<string>Casts a day of the year as a string type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
day of <day of year><day of month>

Plural: days
Returns the day of the month of the specified date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
extrema of <day of year><( day of year, day of year )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <day of year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <day of year><day of year>

Plural: maxima
Returns the maximum value from a list of <day of year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <day of year><day of year>

Plural: minima
Returns the minimum value from a list of <day of year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
month of <day of year><month>

Plural: months
Returns the month portion of the given date (in month day format).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <day of year><day of year with multiplicity>

Plural: unique values
Returns the unique values of a given list of <day of year> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

day of year with multiplicity

The <day of year with multiplicity> Inspectors deal with day-of-year arrays, allowing you to extract unique day-of-year values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <day of year>Returns the unique values of a given list of <day of year> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <day of year with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <day of year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

month

The <month> Inspectors provide tools for dealing and calculating with month types, which are of the form January, February, and more. This set of Inspectors includes each month as a self-named object.

Creation Methods

DeclarationDescriptionPlatforms (?)
<integer> as monthReturns the name of the nth month of the year.

Example:
5 as month - Returns May.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as monthConverts a string into a month.

Example:
january as month - 1 * month - Returns December (one month before January).
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
month of <date>Returns the month derived from the given date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
month of <day of year>Returns the month portion of the given date (in month day format).

Example:
month of (day_of_year of (current date + 40*day)) - Returns the name of the month 40 days from today, eg. October.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <month>Returns the maximum value from a list of <month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <month>Returns the minimum value from a list of <month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> {op} <number of months>Adds or subtracts a number of months from the given month. Here {op} is one of: -, +.

Example:
current month + 2*month - Returns the name of the month two months from now. If it's currently January, this would return March.
Win, Lin, Sol, HPUX, AIX, Mac, WM
<number of months> + <month>Adds a number of months to the given month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
month of <month and year>Returns the name of the month corresponding to the given date.

Example:
month of date "Sun, 02 Apr 2006" + 2*month - Returns June.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
aprilReturns april as an object of type month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
augustReturns August as an object of type month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
current monthReturns the current month.

Example:
current month + 2*month - Returns the name of the month, two months from today.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
decemberReturns December as an object of type month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
februaryReturns February as an object of type month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
januaryReturns January as an object of type month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
julyReturns July as an object of type month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
juneReturns June as an object of type month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
marchReturns March as an object of type month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
mayReturns May as an object of type month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
month <integer>Returns the month type corresponding to the given <integer>.

Example:
month 9 - Returns September.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
month <string>Returns a month type corresponding to the given <string>.

Example:
month "jun" - Returns June.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
novemberReturns November as an object of type month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
octoberReturns October as an object of type month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
septemberReturns September as an object of type month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<day of month> & <month><day of year>Concatenate a day of month with a month type to produce a day of year (eg. April 20).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> - <month><number of months>Subtracts two months, returning a positive number of months. If the first month is earlier than the second, it assumes the year has rolled over.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> & <day of month><day of year>Concatenates a month and a day of the month to produce a day of year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> & <year><month and year>Returns a date (in month year format) from the concatenation of a month and a year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> {cmp} <month><boolean>Compares the values of two months, where {cmp} is one of: <, <=, =.Win, Lin, Sol, HPUX, AIX, Mac, WM
<month> {op} <number of months><month>Adds or subtracts a number of months from the given month. Here {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<number of months> + <month><month>Adds a number of months to the given month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> & <month><month and year>Returns a date (in month year format) from the concatenation of a month and a year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<month> as integer<integer>Converts the given month into an integer (1-12).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> as string<string>Converts the given month into a string value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> as three letters<string>Converts the given month into a 3-letter string (Jan, Feb, etcetera.).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> as two digits<string>Converts the month into a two digit number (01 - 12).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
extrema of <month><( month, month )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <month><month>

Plural: maxima
Returns the maximum value from a list of <month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <month><month>

Plural: minima
Returns the minimum value from a list of <month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <month><month with multiplicity>

Plural: unique values
Returns the unique values of a given list of <month> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

month with multiplicity

The <month with multiplicity> Inspectors deal with month arrays, allowing you to extract unique month values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <month>Returns the unique values of a given list of <month> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <month with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

month and year

The <month and year> Inspectors provide tools for dealing and calculating with month-and-year types, which are of the form month of year, eg., January of 2007.

Creation Methods

DeclarationDescriptionPlatforms (?)
april of <integer>Creates a date (in month year format) corresponding to April of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
august of <integer>Creates a date (in month year format) corresponding to August of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
december of <integer>Creates a date (in month year format) corresponding to December of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
february of <integer>Creates a date (in month year format) corresponding to February of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
january of <integer>Creates a date (in month year format) corresponding to January of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
july of <integer>Creates a date (in month year format) corresponding to July of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
june of <integer>Creates a date (in month year format) corresponding to June of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
march of <integer>Creates a date (in month year format) corresponding to March of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
may of <integer>Creates a date (in month year format) corresponding to May of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
november of <integer>Creates a date (in month year format) corresponding to November of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
october of <integer>Creates a date (in month year format) corresponding to October of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
september of <integer>Creates a date (in month year format) corresponding to September of the specified year (as an <integer>).Win, WM, Ubu:8.1, Lin, Mac, HPUX, AIX, Sol
month_and_year of <date>Formats the specified date in month year format, eg. March 2012.

Example:
month_and_year of current date - Returns the current date formatted as month year, eg. April, 2006.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> & <year>Returns a date (in month year format) from the concatenation of a month and a year.

Example:
December 3 & "2032" as year - Returns Fri, 03 Dec 2032.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> & <month>Returns a date (in month year format) from the concatenation of a month and a year.

Example:
year 2134 & april - Returns April 2134.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <month and year>Returns the maximum value from a list of <month and year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <month and year>Returns the minimum value from a list of <month and year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month and year> {op} <number of months>Adds or subtracts a number of months from a given date (in month year format), where {op} is one of: -, +.

Example:
current month_and_year + 18*month - Gives a date 18 months ahead of the current date, eg. October 2007.
Win, Lin, Sol, HPUX, AIX, Mac, WM
<number of months> + <month and year>Adds a number of months to a given date (in month year format) producing a new date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> & <year>Returns a date (in month year format) from the concatenation of a month and a year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> & <month>Returns a date (in month year format) from the concatenation of a month and a year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
current month_and_yearReturns the current date in month year format, eg. January 2012.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<day of month> & <month and year><date>Concatenate a day of month with a month and year type to produce a complete date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<day of year> & <month and year><date>Concatenates a day of the year with a month and year to create a complete date type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month and year> - <month and year><number of months>Subtracts two dates (in month year format), returning a number of months.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month and year> {cmp} <month and year><boolean>Compares two dates (in month year format), where {cmp} is one of: <, <=, =.Win, Lin, Sol, HPUX, AIX, Mac, WM
<month and year> {op} <number of months><month and year>Adds or subtracts a number of months from a given date (in month year format), where {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM
<number of months> + <month and year><month and year>Adds a number of months to a given date (in month year format) producing a new date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<month and year> as string<string>Casts a date (in month year format) as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
extrema of <month and year><( month and year, month and year )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <month and year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first <day of week> of <month and year><date>

Plural: firsts
Finds the specific date corresponding to the first day of the week (eg. Friday) for a given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first friday of <month and year><date>

Plural: first fridays
Finds the date corresponding to the first Friday of any given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first monday of <month and year><date>

Plural: first mondays
Finds the date corresponding to the first Monday of any given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first saturday of <month and year><date>

Plural: first saturdays
Finds the date corresponding to the first Saturday of any given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first sunday of <month and year><date>

Plural: first sundays
Finds the date corresponding to the first Sunday of any given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first thursday of <month and year><date>

Plural: first thursdays
Finds the date corresponding to the first Thursday of any given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first tuesday of <month and year><date>

Plural: first tuesdays
Finds the date corresponding to the first Tuesday of any given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
first wednesday of <month and year><date>

Plural: first wednesdays
Finds the date corresponding to the first Wednesday of any given month and year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
length of <month and year><time interval>

Plural: lengths
Returns the number of days in the specified month.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <month and year><month and year>

Plural: maxima
Returns the maximum value from a list of <month and year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <month and year><month and year>

Plural: minima
Returns the minimum value from a list of <month and year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
month of <month and year><month>

Plural: months
Returns the name of the month corresponding to the given date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <month and year><month and year with multiplicity>

Plural: unique values
Returns the unique values of a given list of <month and year> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
year of <month and year><year>

Plural: years
Returns the year portion of the specified date (in month year format).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

month and year with multiplicity

The <month and year with multiplicity> Inspectors deal with month-and-year arrays, allowing you to extract unique month-and-year values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <month and year>Returns the unique values of a given list of <month and year> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <month and year with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <month and year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

number of months

The <number of months> Inspectors provide tools for dealing and calculating with number-of-month types, which are similar to integers, but wih yearly roll-over.

Creation Methods

DeclarationDescriptionPlatforms (?)
<integer> * <number of months>Multiply a number of months by an integer, producing a new number of months. This is a typical technique to create a value of this type.

Example:
(July-current month) < 2*month - Returns TRUE when the current date is between June and July.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<number of months> {op} <integer>Where {op} is one of: *, /.Win, Lin, Sol, HPUX, AIX, Mac, WM
<month> - <month>Subtracts two months, returning a positive number of months. If the first month is earlier than the second, it assumes the year has rolled over.

Example:
december - current month - Returns the number of months left until december. If the current month is April, it returns 8 months.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month and year> - <month and year>Subtracts two dates (in month year format), returning a number of months.

Example:
January of 2020 - current month_and_year - Returns a time interval measured to the nearest month, such as 13 years, 9 months.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <number of months>Returns the maximum value from a list of <number of months> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <number of months>Returns the minimum value from a list of <number of months> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
- <number of months>Creates the negative of the specified number of months.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<number of months> {op} <number of months>Multiplies or divides a number of months by an integer. Here {op} is one of: *, /.Win, Lin, Sol, HPUX, AIX, Mac, WM
<number of months> mod <number of months>Calculates the modulus of number of months by another number of monthsWin, Lin, Sol, HPUX, AIX, Mac, WM
<year> - <year>Subtracts two years and produces a time interval marked in months and years.

Example:
year 2020 - year 2008 - Returns 12 years.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
monthReturns the specified number of months.

Example:
24*month - Returns 2 years.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
yearReturns the specified number of years as a <number of months> type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
- <number of months><number of months>Creates the negative of the specified number of months.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<number of months> {cmp} <number of months><boolean>Compare two numbers of months, where {cmp} is one of: <, <=, =.Win, Lin, Sol, HPUX, AIX, Mac, WM
<number of months> {op} <number of months><number of months>Multiplies or divides a number of months by an integer. Here {op} is one of: *, /.Win, Lin, Sol, HPUX, AIX, Mac, WM
<number of months> mod <number of months><number of months>Calculates the modulus of number of months by another number of monthsWin, Lin, Sol, HPUX, AIX, Mac, WM
<number of months> + <year><year>Returns the year after adding the specified number of months.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> {op} <number of months><year>Adds or subtracts the specified number of months to derive a new year. Here {op} is one of: -, +.Win, Lin, Sol, HPUX, AIX, Mac, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<number of months> as string<string>Converts a number of months type into a string type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
extrema of <number of months><( number of months, number of months )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <number of months> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <number of months><number of months>

Plural: maxima
Returns the maximum value from a list of <number of months> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <number of months><number of months>

Plural: minima
Returns the minimum value from a list of <number of months> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <number of months><number of months with multiplicity>

Plural: unique values
Returns the unique values of a given list of <number of month> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

number of months with multiplicity

The <number of months with multiplicity> Inspectors deal with number-of-month arrays, allowing you to extract unique number-of-month values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <number of months>Returns the unique values of a given list of <number of month> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <number of months with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <number of month> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

year

The <year> Inspectors provide tools for dealing and calculating with year types, which are of the form YYYY, as in 2008.

Creation Methods

DeclarationDescriptionPlatforms (?)
<integer> as yearCasts an integer as a year type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<string> as yearConverts a string into a year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
year of <date>Returns the year, extracted from the given date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
year of <month and year>Returns the year portion of the specified date (in month year format).

Example:
year of current date - Returns the current year, eg. 2006.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<number of months> + <year>Returns the year after adding the specified number of months.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> {op} <number of months>Adds or subtracts the specified number of months to derive a new year. Here {op} is one of: -, +.

Example:
year 1984 + 264*month - Returns 2006.
Win, Lin, Sol, HPUX, AIX, Mac, WM
maximum of <year>Returns the maximum value from a list of <year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <year>Returns the minimum value from a list of <year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
current yearReturns the current year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
year <integer>Creates a year object from the specified integer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
year <string>Creates a year object from the specified string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<day of year> & <year><date>Concatenates a day of the year with a year to create a complete date type.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<month> & <year><month and year>Returns a date (in month year format) from the concatenation of a month and a year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> - <year><number of months>Subtracts two years and produces a time interval marked in months and years.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> & <day of year><date>Concatenates a year with the day of the year, returning a full date.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> & <month><month and year>Returns a date (in month year format) from the concatenation of a month and a year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> {cmp} <year><boolean>Compares two years, where {cmp} is one of: <, <=, =.Win, Lin, Sol, HPUX, AIX, Mac, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<year> as integer<integer>Casts a year as an integer.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
<year> as string<string>Casts a year as a string.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
extrema of <year><( year, year )>

Plural: extremas
Returns the minimum and maximum extreme values of the given list of <year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
leap of <year><boolean>

Plural: leaps
Returns a flag indicating whether or not the specified year is a leap year.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
length of <year><time interval>

Plural: lengths
Returns the number of day in the specified year. Leap years have 366 days.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
maximum of <year><year>

Plural: maxima
Returns the maximum value from a list of <year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
minimum of <year><year>

Plural: minima
Returns the minimum value from a list of <year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
unique value of <year><year with multiplicity>

Plural: unique values
Returns the unique values of a given list of <year> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

year with multiplicity

The <year with multiplicity> Inspectors deal with year arrays, allowing you to extract unique year values and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)
unique value of <year>Returns the unique values of a given list of <year> types, removing duplicates and sorting by value.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
multiplicity of <year with multiplicity><integer>

Plural: multiplicities
Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <year> types.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1