bes property

The <bes property> inspectors return information about the properties of BES Client computers. Properties -- along with their names, IDs and definitions -- can be iterated to produce property lists of all your networked BES computers.

Creation
Properties
Casts
Operators

Version	Platforms
8.0.584.0	Session

Creation

bes property : bes property

Returns a list of all the BES custom site objects.

Plural: bes properties

Version	Platforms
8.0.584.0	Session

permalink source

bes property <string> : bes property

Returns the first property whose name matches the given string. Note that it is not safe to assume that there is only one property with a given name.

Plural: bes properties

Version	Platforms
8.0.584.0	Session

permalink source

element of <bes property set> : bes property

Returns the unique elements of the specified <bes property set>, removing duplicates and sorting by value.

Plural: elements

Version	Platforms
8.0.584.0	Session

permalink source

property <integer> of <bes fixlet> : bes property

If the specified Fixlet is from an analysis, this inspector returns the property with the ID given by <integer>.

Plural: properties

Version	Platforms
8.0.584.0	Session

permalink source

property of <bes fixlet> : bes property

If the specified Fixlet is from an analysis, this inspector returns a list of all of the <bes property> objects associated with it.

Plural: properties

Version	Platforms
8.0.584.0	Session

permalink source

property of <bes property result> : bes property

Returns the property corresponding to the specified BES property result.

Plural: properties

Version	Platforms
8.0.584.0	Session

permalink source

Properties

analysis flag of <bes property> : boolean

Returns True if the specified BES property is an analysis property.

Plural: analysis flags

Version	Platforms
8.0.584.0	Session

permalink source

category of <bes property> : string

Returns the optional category created for the specified BES property.

Plural: categories

Version	Platforms
8.0.584.0	Session

permalink source

custom flag of <bes property> : boolean

Returns True if the specified BES property is custom.

Plural: custom flags

Version	Platforms
8.0.584.0	Session

permalink source

database id of <bes property> : integer

In the Web Reports environment, this inspector returns the numeric ID of the database containing the specified BES property.

Plural: database ids

Version	Platforms
8.0.584.0	Session

permalink source

default flag of <bes property> : boolean

Returns True if the specified BES property is the default.

Plural: default flags

Version	Platforms
8.0.584.0	Session

permalink source

definition of <bes property> : string

Returns the relevance expression which defines the specified property.

Plural: definitions

Version	Platforms
8.0.584.0	Session

permalink source

disk usage of <bes property> : integer

Gives the size in bytes of the cache file holding the results for the given property.

Plural: disk usages

Version	Platforms
8.0.584.0	Session

permalink source

display category of <bes property> : string

Returns the category of the specified BES property. This inspector returns the value as displayed in the Console, which may be translated into various languages.

Plural: display categories

Version	Platforms
8.0.584.0	Session

permalink source

display name of <bes property> : string

Returns the name of the specified BES property. This inspector returns the value as displayed in the Console, which may be translated into various languages.

Plural: display names

Version	Platforms
8.0.584.0	Session

permalink source

display simple name of <bes property> : string

Returns the simple name of the specified BES property. This inspector returns the value as displayed in the Console, which may be translated into various languages.

Plural: display simple names

Version	Platforms
8.0.584.0	Session

permalink source

evaluation period of <bes property> : time interval

Returns the <time interval> that controls how frequently clients will submit reports for the specified property.

Plural: evaluation periods

Version	Platforms
8.0.584.0	Session

permalink source

id of <bes property> : ( integer, integer, integer )

Returns a 3-tuple of integers composed of the site ID, analysis ID and property ID. The first integer identifies the site hosting the Analysis. For custom properties not contained in an analysis (those created using the Manage Properties dialog), it is the ID of the Action site. The second integer indentifies the Analysis containing the property. For custom properties, this is 0. The third integer identifies the property itself. This is the same as the source ID if the property is defined in an Analysis. If it is not defined in an Analysis then this is the unique object ID for the property.

Plural: ids

Version	Platforms
8.0.584.0	Session

permalink source

keep statistics flag of <bes property> : boolean

Returns True if statistics are being kept for the specified BES property.

Plural: keep statistics flags

Version	Platforms
8.0.584.0	Session

permalink source

memory usage of <bes property> : integer

Returns an estimate of the number of bytes of virtual memory that is currently being used to store the result of the given property.

Plural: memory usages

Version	Platforms
8.0.584.0	Session

permalink source

name of <bes property> : string

Returns the name of the specified BES property. This name is not guaranteed to be unique.

Plural: names

Version	Platforms
8.0.584.0	Session

permalink source

reported computer set of <bes property> : bes computer set

Returns a list of all the computers that have reported for the specified BES property. The list is formatted as a mathematical set.

Plural: reported computer sets

Version	Platforms
8.0.584.0	Session

permalink source

reserved flag of <bes property> : boolean

Returns True if the specified BES property is reserved.

Plural: reserved flags

Version	Platforms
8.0.584.0	Session

permalink source

result <( bes computer, bes property )> : bes property result

Returns the result of the specified BES property and computer.

Plural: results

Version	Platforms
8.0.584.0	Session

permalink source

result <( bes property, bes computer )> : bes property result

Returns the result of the specified BES property and computer.

Plural: results

Version	Platforms
8.0.584.0	Session

permalink source

result from <bes computer> of <bes property> : bes property result

Returns the result of the specified BES property and computer.

Plural: results from

Version	Platforms
8.0.584.0	Session

permalink source

result of <bes property> : bes property result

Returns a list of the BES property results for every computer reporting a result for the specified property.

Plural: results

Version	Platforms
8.0.584.0	Session

permalink source

set of <bes property> : bes property set

Converts the specified BES Property list to a set that can be arithmetically manipulated.

Plural: sets

Version	Platforms
8.0.584.0	Session

permalink source

simple name of <bes property> : string

Returns the non-category portion of the property name.

Plural: simple names

Version	Platforms
8.0.584.0	Session

permalink source

source analysis of <bes property> : bes fixlet

Returns the <bes fixlet> object corresponding to the analysis that defines the specified property.

Plural: source analyses

Version	Platforms
8.0.584.0	Session

permalink source

source evaluation period of <bes property> : time interval

Returns the period of the property as specified by the analysis that defines it. This period is not necessarily the same as the period of the property.

Plural: source evaluation periods

Version	Platforms
8.0.584.0	Session

permalink source

source id of <bes property> : integer

Returns the ID of the property as specified by the analysis that defines it. This is not the same as the unique property ID.

Plural: source ids

Version	Platforms
8.0.584.0	Session

permalink source

source name of <bes property> : string

Returns the name of the property as specified by the analysis that defines it. This name is not necessarily the same as the name of the property.

Plural: source names

Version	Platforms
8.0.584.0	Session

permalink source

statistic range of <bes property> : statistic range

Returns the range of statistical bins associated with the given property. The property must be marked for statistical aggregation. If not, or if no clients have reported results, it throws NoSuchObject.

Plural: statistic ranges

Version	Platforms
8.0.584.0	Session

permalink source

unique value of <bes property> : bes property with multiplicity

Returns the unique values of a given list of <bes property> types, removing duplicates and sorting by value.

Plural: unique values

Version	Platforms
8.0.584.0	Session

permalink source

Casts

<bes property> as xml : utf8 string

Converts the specified BES Property to XML format, for submission to the EvaluateRelevance API used by the BES Console and Web Reports.

Version	Platforms
8.0.584.0	Session

permalink source

Operators

<bes property set> contains <bes property> : boolean

No documentation exists.

Version	Platforms
8.0.584.0	Session

permalink source

<bes property> = <bes property> : boolean

Compares two BES Property types and returns True if they are equal.

Version	Platforms
8.0.584.0	Session

permalink source