Selectable Fields for Webreports

This section lists the selectable fields for webreports.

Selectable Fields for Webreport
Field Description Output

name

Webreport name

Value

description

Not used

 

property[].*

Associated properties

If property[ ] is specified, returns property name and values. If blank, returns all property names and values.

hidden

Is this webreport defined as hidden?

True/False

id

Webreport identifier

Value

modified

Time and date the webreport was modified

Value

modified.generic

The time and date in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator) the webreport was modified

Value

object[ ]

a corresponding business object

Returns a business object where the type matches the string in [ ] and the name is the same as the webreport's name. If no string is given, the object type is webreport, with case ignored. In a case sensitive environment if more than 1 type meets that criteria (such as both a Person type and a PERSON type), OR if there are more than 1 object with the same type and name that are not in the same revision chain, the object with the latest originated date is returned. When objects with same type and name are in the same revision chain, the latest revision is returned.

originated

Time and date the webreport was created

Value

originated.generic

The time and date in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator) the webreport was created

Value

searchcriteria

Expression string or object name

Value

notes

A string

Value

reporttype

A string

Value

groupby[].*

A string

If groupby[ ] is specified, returns groupby index and value. If blank, returns all groupby indices and values.

data[].*

A string

If data[ ] is specified, returns data index and value. If blank, returns all data indices and values.

user.*

The user's workspace to which the webreport belongs

Value

visible[ ]

What users are visible?

List of users with visibility. If a user is specified, returns true or false.

appliesto

A string

One of "businessobjects", "relationships", or "both"

groupby[].maxgroupings

A integer

Value

##The following are valid for both data and groupby:

groupby[]/data[].value

A string

The string expression for this groupby or data whether it was defined as a value string or by referring to an expression object.

groupby[]/data[].label

A string

The label for this groupby or data.

groupby[]/data[].expression

A string

Nave of expression object, if any. (Empty string if defined without an expression object)

groupby[]/data[].appliesto

A string

One of "businessobjects", "relationships", or "both"

summary

A string

Value

##The following are valid for summary:

summary.name

A string

Name of the summary.

summary.appliesto

A string

One of "businessobjects", "relationships", or "both"

summary.groupby[].*

A string

List of groupby indices in this summary

summary.data[].*

A string

List of data indices in this summary.

result

A boolean

True if there is a saved result; False if not.

archive

An integer

List of indices of the saved result archives.

##The following are valid for result and archive:

result/archive[].created

A string

Returns date/time when created

result/archive[].creator

A string

Returns name of user who evaluated it

result/archive[].cell[].*

An integer

List of indices for all subsets defined by unique combinations of groupby values.

result/archive[].cell[].groupby

An integer

Number of groupby values defined for this cell. This will be the total number of groupbys for regular cells but will be a smaller number for summary cells.

result/archive[].cell[].groupby.index

An integer

For each cell this will give the list of indices for the groupbys defining the cell.

result/archive[].cell[].data

An integer

Number of data values defined for this cell. This will be the total number of datas for regular cells but will be a smaller number for summary cells.

result/archive[].cell[].data.index

An integer

For each cell this will give the list of indices for the datas defining the cell.

result/archive[].cell[].kindof

A string

One of "businessobject" or "relationship", indicating what the cell was evaluated against.

result/archive[].cell[].businessobject

An integer

Count of businessobjects associated with this cell.

result/archive[].cell[].relationship

An integer

Count of connections associated with this cell.

result/archive[].duration

A real

Returns how long (in seconds) it took to evaluate.

result/archive[].label

A string

Returns the result/archive label

result/archive[].description

A string

Returns the result/archive description

result/archive[].current

A boolean

Returns TRUE if webreport definition has not been changed since this result was computed, FALSE otherwise.

result/archive[].full

A boolean

Returns TRUE or FALSE depending on whether the computed data is complete. E.g., FALSE is returned if not all summaries or datas were computed.

result/archive[].value

A string

Returns the text that "evaluate webreport" would print if run with the same options as created these results

result/archive[].xml

A string

Same as value except the results are printed out as an xml string.