IProfile

Prev Next

Creates an Index Profile Report

KeyValue(s)Description
method"IProfile"Creates an Index Profile Report
baseSet{}
Optional.  Base Filter
compositeViewtrue/falseOptional.  Default = false.
If true, a composite index will be calculated.
dataset{}datasetObject{}Optional.
If provided, will be applied as Target Filter.
displayPrecisionNOptional.  Default =2
Precision to be used for the index calculation.
fields[][
"Table1.Field1"
"Table1.Field2"
"..."
]
Optional.  One of either fields[] or template must be provided.
List of fields to apply as dimension(s).  All must be from the same table.
forEach{}

excludeNullsFromCombinedTotals
true/falseIf true, ratio denominators will exclude nulls
includeEmptyTargetRowstrue/false
limitRowstrue/false
saveAs

secondaryProcess{}

sortMode
0 = default
1 = Ascending Label
2 = Descending Label
3 = Ascending Value
4 = Descending Value
sortColumn
Column number of column to sort by.  For multi-dimensional profiles, all label columns have a sort column index of the number of dimesions in the profile.  
template
Optional.  If supplied, a template can be specified instead of a field list.

{Explanation}

{
  "method": "IProfile",
  "project": "DJDemo2023",
  "compositeView": false,
  "zeroCentric": false,
  "limitRows": 0,
  "includeEmptyIndexTargetRows": false,
  "displayPrecision": 2,
  "sortMode": 0,
  "sortColumn": -1,
  "fields": [
    {
      "type": "field",
      "name": "customer.region",
      "table": "customer",
      "valueFilter": []
    }
  ]
}