IDOL Server 24.2

# ValueDetails

Set `ValueDetails` to `True` to return the following additional information about the numeric values that occur in the specified FieldName:

`<autn:values>` | The total number of numeric values. TIP: The `<autn:total_values>` tag in the default GetQueryTagValues response shows the number of unique values that occur in the specified FieldName (including any string values).
`<autn:valuesum>` | The sum of all the numeric values.
`<autn:valueaverage>` | The average (mean) of the numeric values.
`<autn:valuemin>` | The minimum value.
`<autn:valuemax>` | The maximum value.
`<autn:valuepercentile>` | The values for percentiles across the range of the data. By default, IDOL Server returns the 10th, 25th, 50th (median), 75th, and 90th percentiles. You can modify this range by setting ValuePercentiles. NOTE: If you send the GetQueryTagValues to a Distributed Action Handler (DAH), the `ValueDetails` response always includes only the default value percentiles. However, DAH requests additional percentiles from the child servers so that it can calculate the appropriate ranges for the whole dataset.

For example:

    <autn:values>4</autn:values>
    <autn:valuesum>23.00</autn:valuesum>
    <autn:valueaverage>5.75</autn:valueaverage>
    <autn:valuemin>3.00</autn:valuemin>
    <autn:valuemax>9.00</autn:valuemax>
    <autn:valuepercentile percentile="10">3.00</autn:valuepercentile>
    <autn:valuepercentile percentile="25">3.00</autn:valuepercentile>
    <autn:valuepercentile percentile="50">5.00</autn:valuepercentile>
    <autn:valuepercentile percentile="75">6.00</autn:valuepercentile>
    <autn:valuepercentile percentile="90">9.00</autn:valuepercentile>

The `total`, `average`, `min`, `max`, and percentile values are rounded to two decimal places.

String values do not affect the calculated values or the count.

TIP: If the specified FieldName is DateType or NumericDateType, the `ValueDetails` response includes `date` attributes for the values, which contains a date value in the format `HH:NN:SS DD/MM/YYYY` (with `BC`, where appropriate). If you use DateOffset, the response also includes a `date_with_offset` attribute.

You can also use the FieldDependence parameter in combination with `ValueDetails`. When you set both `ValueDetails` and FieldDependence to `True`, IDOL Server prints `ValueDetails` for the last field that you list in the FieldName parameter. In this way, you can obtain value details for a full hierarchy in a single query.

When you set `ValueDetails` and FieldDependenceMultiLevel to `True`, IDOL Server prints the details for the last FieldName in the hierarchy, in the context of the previous fields.

Actions: | GetQueryTagValues
Type: | Boolean
Default: | False
Example: | `ValueDetails=True`
See Also: | FieldDependence FieldDependenceMultiLevel FieldName

Copyright 2024 Open Text
Version 24.2 | Last updated March 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Server 24.2

Topic Title: ValueDetails