Published at: 2026-09-17
Joined report functions
Appendix: Joined report structure
♦Header — displayFields
♦Data set — dataSet
3.1 Query a joined report by chart ID (loads the first 20 records by default): Fx.BI.queryLwtViewDataById()
3.1.1 Purpose
Query joined report data by viewId.
3.1.2 Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| viewId | String | Yes | Joined report ID | <pre>“BI_lwt_1657506871248” </pre> |
3.1.3 Example
def(isError,data,errorMsg) = Fx.BI.queryLwtViewDataById("BI_lwt_1657506871248")
if(!isError){
log.info("Pagination information: "+data["page"])
log.info("Header information: "+data["displayFields"])
log.info("Data set: "+data["dataSet"])
}else{
log.info("Query failed: "+errorMsg)
}
3.1.4 Return values
| Parameter | Type | Description |
|---|---|---|
| code | Int | Function status code. 200: success. 403: no permission. 500: system error. |
| message | String | Returned message |
| page | Object | Pagination information |
| displayFields | Object | Header information |
| dataSet | Object | Result data set |
3.1.5 Return value example
Chart data is returned in a unified two-dimensional table structure and maps in pairs.
{
"code": 200,
"message": "success",
"i18nCode": null,
"data": {
"displayFields": [
[
{
"fieldId": "BI_lwt_calc_6ad70579d41f4901aee273eb7e9aeb0b",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_b421df3270824345b6c5dc13f2fea14e",
"fieldName": "Year",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_f289f266427f4cedba1a746c6b058298",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_bba3a46afcf14f158855fa733de92205",
"fieldName": "Quarter",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_83cb73bcc82f4f2897e79799d0ff6d9f",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_a010a7cbf99646ae89eef3e6deb64557",
"fieldName": "Month",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_7e11d20cdabb47fb9ed0fe6291ee7e2b",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
}
],
[
{
"fieldId": "BI_5be1388756fc11448c4567dc",
"fieldName": "Product Line",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "MultiSelectEnum",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "product_line",
"linkObjName": "ProductObj"
},
{
"fieldId": "BI_5be3b0ff2563710001ab1b62",
"fieldName": "Sales Quantity (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "quantity",
"linkObjName": ""
},
{
"fieldId": "BI_6178cf99ea585200014b0ef9",
"fieldName": "Total Order Amount (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "subtotal",
"linkObjName": ""
},
{
"fieldId": "BI_5be3b0ff2563710001ab1b62",
"fieldName": "Sales Quantity (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "quantity",
"linkObjName": ""
},
{
"fieldId": "BI_6178cf99ea585200014b0ef9",
"fieldName": "Total Order Amount (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "subtotal",
"linkObjName": ""
},
{
"fieldId": "BI_5be3b0ff2563710001ab1b62",
"fieldName": "Sales Quantity (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "quantity",
"linkObjName": ""
},
{
"fieldId": "BI_6178cf99ea585200014b0ef9",
"fieldName": "Total Order Amount (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "subtotal",
"linkObjName": ""
}
]
],
"dataSet": [
[
{
"value": "Product Line1",
"displayValue": "Product Line1",
"dataFormatStr": ""
},
{
"value": "2625.0",
"displayValue": "2625",
"dataFormatStr": "0.00"
},
{
"value": "26250.0",
"displayValue": "2.630K",
"dataFormatStr": "0.00"
},
{
"value": "66934.0",
"displayValue": "66934",
"dataFormatStr": "0.00"
},
{
"value": "669340.0",
"displayValue": "66.930K",
"dataFormatStr": "0.00"
},
{
"value": "0.0",
"displayValue": "0",
"dataFormatStr": "0.00"
},
{
"value": "0.0",
"displayValue": "0.00",
"dataFormatStr": "0.00"
}
],
[
{
"value": "--",
"displayValue": "--",
"dataFormatStr": ""
},
{
"value": "23464.0",
"displayValue": "23464",
"dataFormatStr": "0.00"
},
{
"value": "234640.0",
"displayValue": "23.460K",
"dataFormatStr": "0.00"
},
{
"value": "143423.0",
"displayValue": "143423",
"dataFormatStr": "0.00"
},
{
"value": "1434230.0",
"displayValue": "143.420K",
"dataFormatStr": "0.00"
},
{
"value": "18389.0",
"displayValue": "18389",
"dataFormatStr": "0.00"
},
{
"value": "183890.0",
"displayValue": "18.390K",
"dataFormatStr": "0.00"
}
],
[
{
"value": "--",
"displayValue": "--",
"dataFormatStr": ""
},
{
"value": "23464.0",
"displayValue": "23464",
"dataFormatStr": "0.00"
},
{
"value": "234640.0",
"displayValue": "23.460K",
"dataFormatStr": "0.00"
},
{
"value": "143423.0",
"displayValue": "143423",
"dataFormatStr": "0.00"
},
{
"value": "1434230.0",
"displayValue": "143.420K",
"dataFormatStr": "0.00"
},
{
"value": "240947.0",
"displayValue": "240947",
"dataFormatStr": "0.00"
},
{
"value": "2409470.0",
"displayValue": "240.950K",
"dataFormatStr": "0.00"
}
],
[
{
"value": "--",
"displayValue": "--",
"dataFormatStr": ""
},
{
"value": "23464.0",
"displayValue": "23464",
"dataFormatStr": "0.00"
},
{
"value": "234640.0",
"displayValue": "23.460K",
"dataFormatStr": "0.00"
},
{
"value": "547561.0",
"displayValue": "547561",
"dataFormatStr": "0.00"
},
{
"value": "5475610.0",
"displayValue": "547.560K",
"dataFormatStr": "0.00"
},
{
"value": "18389.0",
"displayValue": "18389",
"dataFormatStr": "0.00"
},
{
"value": "183890.0",
"displayValue": "18.390K",
"dataFormatStr": "0.00"
}
],
[
{
"value": "--",
"displayValue": "--",
"dataFormatStr": ""
},
{
"value": "23464.0",
"displayValue": "23464",
"dataFormatStr": "0.00"
},
{
"value": "234640.0",
"displayValue": "23.460K",
"dataFormatStr": "0.00"
},
{
"value": "547561.0",
"displayValue": "547561",
"dataFormatStr": "0.00"
},
{
"value": "5475610.0",
"displayValue": "547.560K",
"dataFormatStr": "0.00"
},
{
"value": "240947.0",
"displayValue": "240947",
"dataFormatStr": "0.00"
},
{
"value": "2409470.0",
"displayValue": "240.950K",
"dataFormatStr": "0.00"
}
]
],
"page": {
"pageSize": 20,
"pageNumber": 1,
"pageCount": 1,
"totalCount": 5
}
}
}
3.2 Query a joined report by viewId and pagination information: Fx.BI.queryLwtViewDataByPage(,,)
3.2.1 Purpose
Query a joined report by viewId and pagination information. You can specify the page number to query and the number of records per page.
3.2.2 Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| viewId | String | Yes | Joined report ID | <pre>“BI_lwt_1657506871248”</pre> |
| pageNumber | Integer | Yes | Page number | 1 |
| pageSize | Integer | Yes | Records per page | 1 |
3.2.3 Example
==Query page 1 with one record per page=======
=============================================================================================
def(isError,data,errorMsg) = Fx.BI.queryLwtViewDataByPage("BI_lwt_1657506871248",1,1)
if(!isError){
log.info("Pagination information: "+data["page"])
log.info("Header information: "+data["displayFields"])
log.info("Data set: "+data["dataSet"])
}else{
log.info("Query failed: "+errorMsg)
}
3.2.4 Return values
| Parameter | Type | Description |
|---|---|---|
| code | Int | Function status code. 200: success. 403: no permission. 500: system error. |
| message | String | Returned message |
| page | Object | Pagination information |
| displayFields | Object | Header information |
| dataSet | Object | Result data set |
3.2.5 Return value example
Chart data is returned in a unified two-dimensional table structure and maps in pairs.
{
"code": 200,
"message": "success",
"i18nCode": null,
"data": {
"displayFields": [
[
{
"fieldId": "BI_lwt_calc_390f421f5d51471d889f27fe3bc1849b",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_c51e947793a4448e964e21a19855d637",
"fieldName": "Year",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_ba0dcd60e4ca404b9f0c49278a776718",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_ccb483314eae4008a83cce58bf28b36f",
"fieldName": "Quarter",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_a62e283869af4b29885c583f1ddf6934",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_e6f0d1ba2c3c428e9ab9818da6a00ae3",
"fieldName": "Month",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_3d6e6fb55d924a61bd6ebec94bab1c84",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
}
],
[
{
"fieldId": "BI_5be1388756fc11448c4567dc",
"fieldName": "Product Line",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "MultiSelectEnum",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "product_line",
"linkObjName": "ProductObj"
},
{
"fieldId": "BI_5be3b0ff2563710001ab1b62",
"fieldName": "Sales Quantity (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "quantity",
"linkObjName": ""
},
{
"fieldId": "BI_6178cf99ea585200014b0ef9",
"fieldName": "Total Order Amount (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "subtotal",
"linkObjName": ""
},
{
"fieldId": "BI_5be3b0ff2563710001ab1b62",
"fieldName": "Sales Quantity (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "quantity",
"linkObjName": ""
},
{
"fieldId": "BI_6178cf99ea585200014b0ef9",
"fieldName": "Total Order Amount (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "subtotal",
"linkObjName": ""
},
{
"fieldId": "BI_5be3b0ff2563710001ab1b62",
"fieldName": "Sales Quantity (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "quantity",
"linkObjName": ""
},
{
"fieldId": "BI_6178cf99ea585200014b0ef9",
"fieldName": "Total Order Amount (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "subtotal",
"linkObjName": ""
}
]
],
"dataSet": [
[
{
"value": "Product Line1",
"displayValue": "Product Line1",
"dataFormatStr": ""
},
{
"value": "2625.0",
"displayValue": "2625",
"dataFormatStr": "0.00"
},
{
"value": "26250.0",
"displayValue": "2.630K",
"dataFormatStr": "0.00"
},
{
"value": "66934.0",
"displayValue": "66934",
"dataFormatStr": "0.00"
},
{
"value": "669340.0",
"displayValue": "66.930K",
"dataFormatStr": "0.00"
},
{
"value": "0.0",
"displayValue": "0",
"dataFormatStr": "0.00"
},
{
"value": "0.0",
"displayValue": "0.00",
"dataFormatStr": "0.00"
}
]
],
"page": {
"pageSize": 1,
"pageNumber": 1,
"pageCount": 5,
"totalCount": 5
}
}
}
3.3 Query joined report data by viewId and filterList: Fx.BI.queryLwtViewDataByFilter(,)
- )
3.3.1 Purpose
Query a joined report by viewId and filter ranges.
3.3.2 Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| viewId | String | Yes | Joined report ID | <pre>“BI_lwt_1657506871248” </pre> |
| filterList | Integer | Yes | Filter conditions | <pre>List filterList = [["filterId":"BI_62cb8af6741ac20001debf72","value1":"","value2":"","dateRangeId":6]]</pre> |
filterList structure
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| filterId | String | Yes | Filter ID | <pre>“BI_62cb8af6741ac20001debf72” </pre> |
| value1 | String | Yes | Filter value | <pre>“” </pre> |
| value2 | Integer | Yes | Filter value | <pre>”" </pre> |
| dateRangeId | Integer | No | Enumeration value | 6 (Note: For enumeration values, see “1.6 Notes on using filterList: date filter cases and enumeration values”) |
3.3.3 Example
==Query filtered joined report data=======
=============================================================================================
List filterList = [["filterId":"BI_62cb8af6741ac20001debf72","value1":"","value2":"","dateRangeId":6]];
def(isError,data,errorMsg) = Fx.BI.queryLwtViewDataByFilter("BI_lwt_1657506871248",filterList)
if(!isError){
log.info("Pagination information: "+data["page"])
log.info("Header information: "+data["displayFields"])
log.info("Data set: "+data["dataSet"])
}else{
log.info("Query failed: "+errorMsg)
}
3.3.4 Return values
| Parameter | Type | Description |
|---|---|---|
| code | Int | Function status code. 200: success. 403: no permission. 500: system error. |
| message | String | Returned message |
| page | Object | Pagination information |
| displayFields | Object | Header information |
| dataSet | Object | Result data set |
3.3.5 Return value example
Chart data is returned in a unified two-dimensional table structure and maps in pairs.
{
"code": 200,
"message": "success",
"i18nCode": null,
"data": {
"displayFields": [
[
{
"fieldId": "BI_lwt_calc_d9cad9232d464077b5eafcd13f60183f",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_228e9fbb9359411faa3f5ee2bb13649b",
"fieldName": "Year",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_d2530cb668b64b06ae54a4232b0ccc87",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_399493e3de2c4d299c10d705f188eb49",
"fieldName": "Quarter",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_f3b44d6bb3324183bf164596ea0dbd5c",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_40095e45357947b792fe855350dd84be",
"fieldName": "Month",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_8f6ddee4bf9d49c99902f30b769801ea",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
}
],
[
{
"fieldId": "BI_5be1388756fc11448c4567dc",
"fieldName": "Product Line",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "MultiSelectEnum",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "product_line",
"linkObjName": "ProductObj"
},
{
"fieldId": "BI_5be3b0ff2563710001ab1b62",
"fieldName": "Sales Quantity (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "quantity",
"linkObjName": ""
},
{
"fieldId": "BI_6178cf99ea585200014b0ef9",
"fieldName": "Total Order Amount (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "subtotal",
"linkObjName": ""
},
{
"fieldId": "BI_5be3b0ff2563710001ab1b62",
"fieldName": "Sales Quantity (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "quantity",
"linkObjName": ""
},
{
"fieldId": "BI_6178cf99ea585200014b0ef9",
"fieldName": "Total Order Amount (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "subtotal",
"linkObjName": ""
},
{
"fieldId": "BI_5be3b0ff2563710001ab1b62",
"fieldName": "Sales Quantity (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "quantity",
"linkObjName": ""
},
{
"fieldId": "BI_6178cf99ea585200014b0ef9",
"fieldName": "Total Order Amount (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "subtotal",
"linkObjName": ""
}
]
],
"dataSet": [
[
{
"value": "Product Line3",
"displayValue": "Product Line3",
"dataFormatStr": ""
},
{
"value": "73976.0",
"displayValue": "73976",
"dataFormatStr": "0.00"
},
{
"value": "739760.0",
"displayValue": "73.980K",
"dataFormatStr": "0.00"
},
{
"value": "19194.0",
"displayValue": "19194",
"dataFormatStr": "0.00"
},
{
"value": "191940.0",
"displayValue": "19.190K",
"dataFormatStr": "0.00"
},
{
"value": "0.0",
"displayValue": "0",
"dataFormatStr": "0.00"
},
{
"value": "0.0",
"displayValue": "0.00",
"dataFormatStr": "0.00"
}
],
[
{
"value": "Product Line2",
"displayValue": "Product Line2",
"dataFormatStr": ""
},
{
"value": "199451.0",
"displayValue": "199451",
"dataFormatStr": "0.00"
},
{
"value": "1994510.0",
"displayValue": "199.450K",
"dataFormatStr": "0.00"
},
{
"value": "47691.0",
"displayValue": "47691",
"dataFormatStr": "0.00"
},
{
"value": "476910.0",
"displayValue": "47.690K",
"dataFormatStr": "0.00"
},
{
"value": "0.0",
"displayValue": "0",
"dataFormatStr": "0.00"
},
{
"value": "0.0",
"displayValue": "0.00",
"dataFormatStr": "0.00"
}
],
[
{
"value": "Product Line1",
"displayValue": "Product Line1",
"dataFormatStr": ""
},
{
"value": "269469.0",
"displayValue": "269469",
"dataFormatStr": "0.00"
},
{
"value": "6041360.0",
"displayValue": "604.140K",
"dataFormatStr": "0.00"
},
{
"value": "66934.0",
"displayValue": "66934",
"dataFormatStr": "0.00"
},
{
"value": "669340.0",
"displayValue": "66.930K",
"dataFormatStr": "0.00"
},
{
"value": "0.0",
"displayValue": "0",
"dataFormatStr": "0.00"
},
{
"value": "0.0",
"displayValue": "0.00",
"dataFormatStr": "0.00"
}
],
[
{
"value": "--",
"displayValue": "--",
"dataFormatStr": ""
},
{
"value": "557336.0",
"displayValue": "557336",
"dataFormatStr": "0.00"
},
{
"value": "5573415.0",
"displayValue": "557.340K",
"dataFormatStr": "0.00"
},
{
"value": "143423.0",
"displayValue": "143423",
"dataFormatStr": "0.00"
},
{
"value": "1434230.0",
"displayValue": "143.420K",
"dataFormatStr": "0.00"
},
{
"value": "18389.0",
"displayValue": "18389",
"dataFormatStr": "0.00"
},
{
"value": "183890.0",
"displayValue": "18.390K",
"dataFormatStr": "0.00"
}
],
[
{
"value": "--",
"displayValue": "--",
"dataFormatStr": ""
},
{
"value": "557336.0",
"displayValue": "557336",
"dataFormatStr": "0.00"
},
{
"value": "5573415.0",
"displayValue": "557.340K",
"dataFormatStr": "0.00"
},
{
"value": "143423.0",
"displayValue": "143423",
"dataFormatStr": "0.00"
},
{
"value": "1434230.0",
"displayValue": "143.420K",
"dataFormatStr": "0.00"
},
{
"value": "240947.0",
"displayValue": "240947",
"dataFormatStr": "0.00"
},
{
"value": "2409470.0",
"displayValue": "240.950K",
"dataFormatStr": "0.00"
}
],
[
{
"value": "--",
"displayValue": "--",
"dataFormatStr": ""
},
{
"value": "557336.0",
"displayValue": "557336",
"dataFormatStr": "0.00"
},
{
"value": "5573415.0",
"displayValue": "557.340K",
"dataFormatStr": "0.00"
},
{
"value": "547561.0",
"displayValue": "547561",
"dataFormatStr": "0.00"
},
{
"value": "5475610.0",
"displayValue": "547.560K",
"dataFormatStr": "0.00"
},
{
"value": "18389.0",
"displayValue": "18389",
"dataFormatStr": "0.00"
},
{
"value": "183890.0",
"displayValue": "18.390K",
"dataFormatStr": "0.00"
}
],
[
{
"value": "--",
"displayValue": "--",
"dataFormatStr": ""
},
{
"value": "557336.0",
"displayValue": "557336",
"dataFormatStr": "0.00"
},
{
"value": "5573415.0",
"displayValue": "557.340K",
"dataFormatStr": "0.00"
},
{
"value": "547561.0",
"displayValue": "547561",
"dataFormatStr": "0.00"
},
{
"value": "5475610.0",
"displayValue": "547.560K",
"dataFormatStr": "0.00"
},
{
"value": "240947.0",
"displayValue": "240947",
"dataFormatStr": "0.00"
},
{
"value": "2409470.0",
"displayValue": "240.950K",
"dataFormatStr": "0.00"
}
],
[
{
"value": "--",
"displayValue": "--",
"dataFormatStr": ""
},
{
"value": "2436277.0",
"displayValue": "2436277",
"dataFormatStr": "0.00"
},
{
"value": "24380370.0",
"displayValue": "2,438.040K",
"dataFormatStr": "0.00"
},
{
"value": "143423.0",
"displayValue": "143423",
"dataFormatStr": "0.00"
},
{
"value": "1434230.0",
"displayValue": "143.420K",
"dataFormatStr": "0.00"
},
{
"value": "18389.0",
"displayValue": "18389",
"dataFormatStr": "0.00"
},
{
"value": "183890.0",
"displayValue": "18.390K",
"dataFormatStr": "0.00"
}
],
[
{
"value": "--",
"displayValue": "--",
"dataFormatStr": ""
},
{
"value": "2436277.0",
"displayValue": "2436277",
"dataFormatStr": "0.00"
},
{
"value": "24380370.0",
"displayValue": "2,438.040K",
"dataFormatStr": "0.00"
},
{
"value": "143423.0",
"displayValue": "143423",
"dataFormatStr": "0.00"
},
{
"value": "1434230.0",
"displayValue": "143.420K",
"dataFormatStr": "0.00"
},
{
"value": "240947.0",
"displayValue": "240947",
"dataFormatStr": "0.00"
},
{
"value": "2409470.0",
"displayValue": "240.950K",
"dataFormatStr": "0.00"
}
],
[
{
"value": "--",
"displayValue": "--",
"dataFormatStr": ""
},
{
"value": "2436277.0",
"displayValue": "2436277",
"dataFormatStr": "0.00"
},
{
"value": "24380370.0",
"displayValue": "2,438.040K",
"dataFormatStr": "0.00"
},
{
"value": "547561.0",
"displayValue": "547561",
"dataFormatStr": "0.00"
},
{
"value": "5475610.0",
"displayValue": "547.560K",
"dataFormatStr": "0.00"
},
{
"value": "18389.0",
"displayValue": "18389",
"dataFormatStr": "0.00"
},
{
"value": "183890.0",
"displayValue": "18.390K",
"dataFormatStr": "0.00"
}
],
[
{
"value": "--",
"displayValue": "--",
"dataFormatStr": ""
},
{
"value": "2436277.0",
"displayValue": "2436277",
"dataFormatStr": "0.00"
},
{
"value": "24380370.0",
"displayValue": "2,438.040K",
"dataFormatStr": "0.00"
},
{
"value": "547561.0",
"displayValue": "547561",
"dataFormatStr": "0.00"
},
{
"value": "5475610.0",
"displayValue": "547.560K",
"dataFormatStr": "0.00"
},
{
"value": "240947.0",
"displayValue": "240947",
"dataFormatStr": "0.00"
},
{
"value": "2409470.0",
"displayValue": "240.950K",
"dataFormatStr": "0.00"
}
]
],
"page": {
"pageSize": 20,
"pageNumber": 1,
"pageCount": 1,
"totalCount": 11
}
}
}
3.4 Query joined report data by viewId, pagination information, and filterList: Fx.BI.queryLwtViewData(,,,)
- )
3.4.1 Purpose
Query a joined report by viewId, filterList, and pagination information.
3.4.2 Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| viewId | String | Yes | Joined report ID | <pre>“BI_lwt_1657506871248” </pre> |
| filterList | Integer | Yes | Filter conditions | <pre>List filterList = [["filterId":"BI_62cb8af6741ac20001debf72","value1":"","value2":"","dateRangeId":6]] </pre> |
| pageNumber | Integer | Yes | Page number | 1 |
| pageSize | Integer | Yes | Records per page | 1 |
3.4.3 filterList structure
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| filterId | String | Yes | Filter ID | <pre>“BI_62cb8af6741ac20001debf72” </pre> |
| value1 | String | Yes | Filter range | <pre>“” </pre> |
| value2 | Integer | Yes | Filter range | <pre>“” </pre> |
| dateRangeId | Integer | No | Enumeration value required for date filters | 6 (Note: For enumeration values, see “1.6 Notes on using filterList: date filter cases and enumeration values”) |
3.4.4 Example
==Query joined report data by pagination information, viewId, and filterList=======
=================================================================================================================
List filterList = [["filterId":"BI_62cb8af6741ac20001debf72","value1":"","value2":"","dateRangeId":6]];
def(isError,data,errorMsg) = Fx.BI.queryLwtViewData("BI_lwt_1657506871248",1,1,filterList)
if(!isError){
log.info("Pagination information: "+data["page"])
log.info("Header information: "+data["displayFields"])
log.info("Data set: "+data["dataSet"])
}else{
log.info("Query failed: "+errorMsg)
3.4.5 Return values
| Parameter | Type | Description |
|---|---|---|
| code | Int | Function status code. 200: success. 403: no permission. 500: system error. |
| message | String | Returned message |
| page | Object | Pagination information |
| displayFields | Object | Header information |
| dataSet | Object | Result data set |
3.4.6 Return value example
Chart data is returned in a unified two-dimensional table structure and maps in pairs.
{
"code": 200,
"message": "success",
"i18nCode": null,
"data": {
"displayFields": [
[
{
"fieldId": "BI_lwt_calc_ddc948d7b23d4a4c9da0f4d27b79d465",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_86273a3178fe4ceab71538462ee13962",
"fieldName": "Year",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_35fc27cbe17444d6951fc4a3f82519b6",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_8c5755a7669a41f5ba57e89afc17b459",
"fieldName": "Quarter",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_208110f605e94df2af1333c12c4a89bd",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_e5a5ac5d61924ce0a81699c9668c7b1b",
"fieldName": "Month",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
},
{
"fieldId": "BI_lwt_calc_be4b6adce187454ebd35d2a3289eb55c",
"fieldName": "",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "String",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "",
"linkObjName": ""
}
],
[
{
"fieldId": "BI_5be1388756fc11448c4567dc",
"fieldName": "Product Line",
"formatStr": "",
"objName": "",
"objectNodeName": null,
"fieldType": "MultiSelectEnum",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "product_line",
"linkObjName": "ProductObj"
},
{
"fieldId": "BI_5be3b0ff2563710001ab1b62",
"fieldName": "Sales Quantity (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "quantity",
"linkObjName": ""
},
{
"fieldId": "BI_6178cf99ea585200014b0ef9",
"fieldName": "Total Order Amount (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "subtotal",
"linkObjName": ""
},
{
"fieldId": "BI_5be3b0ff2563710001ab1b62",
"fieldName": "Sales Quantity (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "quantity",
"linkObjName": ""
},
{
"fieldId": "BI_6178cf99ea585200014b0ef9",
"fieldName": "Total Order Amount (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "subtotal",
"linkObjName": ""
},
{
"fieldId": "BI_5be3b0ff2563710001ab1b62",
"fieldName": "Sales Quantity (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "quantity",
"linkObjName": ""
},
{
"fieldId": "BI_6178cf99ea585200014b0ef9",
"fieldName": "Total Order Amount (Sum)",
"formatStr": "",
"objName": "Order Product",
"objectNodeName": null,
"fieldType": "Number",
"joinType": "outer",
"refObjName": "",
"dbFieldName": "subtotal",
"linkObjName": ""
}
]
],
"dataSet": [
[
{
"value": "Product Line3",
"displayValue": "Product Line3",
"dataFormatStr": ""
},
{
"value": "73976.0",
"displayValue": "73976",
"dataFormatStr": "0.00"
},
{
"value": "739760.0",
"displayValue": "73.980K",
"dataFormatStr": "0.00"
},
{
"value": "19194.0",
"displayValue": "19194",
"dataFormatStr": "0.00"
},
{
"value": "191940.0",
"displayValue": "19.190K",
"dataFormatStr": "0.00"
},
{
"value": "0.0",
"displayValue": "0",
"dataFormatStr": "0.00"
},
{
"value": "0.0",
"displayValue": "0.00",
"dataFormatStr": "0.00"
}
]
],
"page": {
"pageSize": 1,
"pageNumber": 1,
"pageCount": 11,
"totalCount": 11
}
}
}