ReportPartValidateExpressionParameter
| Field | NULL | Description | Note |
|---|---|---|---|
| expression string | The expression | ||
| izendaDataType string | The Izenda data type | ||
totalProperties New in version 3.11.0. | A dynamic object to keep the total properties in Report Part Properties box, can be user-defined. See ReportPartElementProperties (dataFormattings -> subTotal/grandTotal) for more details. |
Inherited fields:
ReportPartPreviewParameter
| Field | NULL | Description | Note |
|---|---|---|---|
| title string | The report part title | ||
| expandedLevel integer | The expanded level | ||
| filters array of objects | An array of FilterItem objects | ||
| reportField object | A ReportField object | ||
| calculatedField object | A QuerySourceField object | ||
| paging object | A PagingInfo object | ||
| loadAll boolean | Whether to load all rows for printing | ||
overridingFilterValue New in version 3.0. | A dynamic object to store filter values to override overridingFilterValue: {
p1value: "Brazil",
p2value: "6"
},
| ||
ignoreCache New in version 3.3.0. | Y | Whether to load data from cache or retrieve directly from DB |
Inherited fields:
ReportSavingParameter
| Field | NULL | Description | Note |
|---|---|---|---|
| saveAs boolean | Is this saved as new report | ||
| report object | A ReportDefinition object | ||
| section integer | The report section
| ||
| tenantId string (GUID) | Y | The id of the tenant | |
| ignoreCheckChange boolean | Is the check for report changes ignored | ||
| ignoreCheckName boolean | Is the check for report name ignored | ||
| insertWithAssignedId boolean | Whether to use the populated report id in report object to insert | ||
| overrideCalculatedFields boolean | Whether to override calculated fields | ||
| reportState integer |
| ||
| isSavingReport boolean | Whether report is saving or not | Only validate report data source when saving report (isSavingReport = true) New in version 2.6.8. |
Inherited fields:
ReportParameter
| Field | NULL | Description | Note |
|---|---|---|---|
| reportKey object | A ReportKey object | ||
| previewRecord integer | The numer of records to preview | ||
| relationShipIds array of string (GUID) | The array of the relationship Ids | ||
| validateReportDataSource boolean | Whether to validate report data source or not | New in version 2.6.8. |
Inherited fields:
PagedRequest
| Field | NULL | Description | Note |
|---|---|---|---|
| tenantId string (GUID) | Y | The id of the tenant | |
| criteria array of objects | An array of SearchCriteria objects | ||
| sortOrders array of objects | An array of SortOrder objects | ||
| parentIds array of strings (GUIDs) | Ids of the parents | ||
| pageIndex integer | The index of the page | Inherited from PagingInfo | |
| pageSize integer | The size of the page | Inherited from PagingInfo | |
| total integer | The total number of rows | Inherited from PagingInfo | |
| skipItems integer | Skip items | Inherited from PagingInfo | |
| isLastPage boolean | Whether this is the last page | Inherited from PagingInfo |
PagedRequest Sample:
{"criteria":[{"key":"All","value":"","operation":1}],"pageIndex":1,"pageSize":10,"sortOrders":[{"key":"shareWith","descending":true}]}Sample:
{"reportKey":{"key":null,"modified":null},"section":0,"saveAs":false,"ignoreCheckChange":false,"report":{"name":"","type":"Templates","previewRecord":10,"advancedMode":true,"allowNulls":false,"isDistinct":false,"reportDataSource":[{"aliasId":"479be129-338d-45f1-b216-1d95957fe2c8_Order Details","querySourceId":"479be129-338d-45f1-b216-1d95957fe2c8","querySourceName":"Order Details","selected":true},{"aliasId":"54852be4-5584-4c23-ae5d-4197724059e1_Orders","querySourceId":"54852be4-5584-4c23-ae5d-4197724059e1","querySourceName":"Orders","selected":true}],"reportRelationship":[{"tempId":"16d3b9bf-86cb-45fa-b33d-53e3e2a8a042","joinConnectionId":"db19bb46-ffa3-45fd-b205-0dad305fdf98","foreignConnectionId":"db19bb46-ffa3-45fd-b205-0dad305fdf98","joinQuerySourceId":"479be129-338d-45f1-b216-1d95957fe2c8","joinQuerySourceName":"Order Details","joinDataSourceCategoryName":"","foreignDataSourceCategoryName":"","foreignQuerySourceId":"54852be4-5584-4c23-ae5d-4197724059e1","foreignQuerySourceName":"Orders","joinFieldId":"a0011b48-ef08-45fe-b044-abc68442cd17","joinFieldName":"OrderID","foreignFieldId":"3caf9c17-abd7-4119-809d-2c3debb8eb37","foreignFieldName":"OrderID","alias":"","systemRelationship":true,"joinType":"Inner","parentRelationshipId":"c55d696b-f25d-4a6f-a951-7a4e6e532c98","position":null,"relationshipKeyJoins":[],"selectedForeignAlias":"54852be4-5584-4c23-ae5d-4197724059e1_Orders","id":"16d3b9bf-86cb-45fa-b33d-53e3e2a8a052","state":1,"validationKey":"c55d696b-f25d-4a6f-a951-7a4e6e532c98","relationshipPosition":0,"invalidAlias":null,"hidden":false,"level":1}],"reportPart":[]},"expandedLevel":0,"filters":[]}Sample:
{"reportKey":{"key":"1e1316a9-b6ce-46c8-9496-671fd5ddeee1","modified":null},"section":2,"saveAs":false,"ignoreCheckChange":false,"report":{"name":"","type":"Templates","previewRecord":10,"advancedMode":true,"allowNulls":false,"isDistinct":false,"category":{"id":null,"name":"","type":"Templates"},"subCategory":{"id":null,"name":"","type":"Templates"},"reportDataSource":[{"aliasId":"1641cb37-b60c-42bc-b986-c51667e8037d_Suppliers","querySourceId":"1641cb37-b60c-42bc-b986-c51667e8037d","querySourceName":"Suppliers","selected":true,"categoryId":"00000000-0000-0000-0000-000000000000","primaryFields":[{"name":"SupplierID","alias":"","dataType":"int","izendaDataType":"Numeric","allowDistinct":false,"visible":true,"filterable":true,"deleted":false,"querySourceId":"00000000-0000-0000-0000-000000000000","parentId":null,"expressionFields":[],"filteredValue":"","type":0,"groupPosition":0,"position":0,"extendedProperties":"{\"PrimaryKey\":true}","physicalChange":0,"approval":0,"existed":false,"matchedTenant":false,"functionName":null,"expression":null,"fullName":null,"calculatedTree":null,"reportId":null,"originalName":"SupplierID","isParameter":false,"isCalculated":false,"querySource":null,"id":"47954424-fff3-4157-9296-ad08b751e71d","state":0,"inserted":true,"version":null,"created":null,"createdBy":null,"modified":"0001-01-01T00:00:00.0000000-08:00","modifiedBy":null}]}],"reportRelationship":[],"reportFilter":{"logic":"","visible":false,"filterFields":[],"id":"4a75d01f-1fb3-4eca-ae13-8f17d41289ea","reportId":"1e1316a9-b6ce-46c8-9496-671fd5ddeee1"},"reportPart":[{"isDirty":true,"reportPartContent":{"isDirty":false,"type":3,"columns":{"text":null,"properties":{},"settings":{},"elements":[{"reportPartContent":null,"isDirty":true,"name":"Country","properties":{"isDirty":true,"fieldItemVisible":true,"dataFormattings":{"function":"","functionInfo":{},"format":{},"font":{"family":"Roboto","size":14,"bold":false,"italic":false,"underline":false,"color":"","backgroundColor":""},"alignment":"alignLeft","sort":"","color":{"textColor":{},"cellColor":{}},"alternativeText":{"rangePercent":null,"rangeValue":null,"value":null},"customURL":{"url":"","option":"Open link in New Window"},"embeddedJavascript":{"script":""},"subTotal":{"label":"","function":"","expression":"","dataType":"","previewResult":"","fieldDataType":"Text"},"grandTotal":{"label":"Total Number of Countries","function":"Count Distinct","expression":"","dataType":"Numeric","previewResult":10,"fieldDataType":"Text"}},"headerFormating":{"width":{"value":0,"unit":"pixels"},"height":{},"font":{"family":null,"size":null,"bold":null,"italic":null,"underline":null,"color":null,"backgroundColor":null},"alignment":null,"wordWrap":null,"columnGroup":""},"drillDown":{"subReport":{"selectedReport":null,"style":null,"reportPartUsed":null,"reportFilter":true,"mappingFields":[]}},"otherProps":{}},"position":1,"field":{"fieldId":"76139896-c2c3-432e-898a-2c2205bb2e35","fieldName":"Country","fieldNameAlias":"Country","dataFieldType":"Text","querySourceId":"1641cb37-b60c-42bc-b986-c51667e8037d","querySourceType":"Table","sourceAlias":"Suppliers","relationshipId":null,"visible":true,"calculatedTree":null,"schemaName":"dbo","querySourceName":"Suppliers","databaseName":"Northwind","isCalculated":false},"isDeleted":false,"isSelected":true},{"reportPartContent":null,"isDirty":true,"name":"Count (SupplierID)","properties":{"isDirty":true,"fieldItemVisible":true,"dataFormattings":{"function":"8a74f4e0-b845-4b9e-adfa-bb678a116878","functionInfo":{"id":"8a74f4e0-b845-4b9e-adfa-bb678a116878","name":"Count","expression":null,"dataType":"Numeric","formatDataType":"Numeric","syntax":null,"expressionSyntax":null,"isOperator":false},"format":{},"font":{"family":"Roboto","size":14,"bold":false,"italic":false,"underline":false,"color":"","backgroundColor":""},"alignment":"alignLeft","sort":"","color":{"textColor":{},"cellColor":{}},"alternativeText":{"rangePercent":null,"rangeValue":null,"value":null},"customURL":{"url":"","option":"Open link in New Window"},"embeddedJavascript":{"script":""},"subTotal":{"label":"","function":"","expression":"","dataType":"","previewResult":"","fieldDataType":"Numeric"},"grandTotal":{"label":"","function":"","expression":"","dataType":"","previewResult":"","fieldDataType":"Numeric"}},"headerFormating":{"width":{"value":0,"unit":"pixels"},"height":{},"font":{"family":null,"size":null,"bold":null,"italic":null,"underline":null,"color":null,"backgroundColor":null},"alignment":null,"wordWrap":null,"columnGroup":""},"drillDown":{"subReport":{"selectedReport":null,"style":null,"reportPartUsed":null,"reportFilter":true,"mappingFields":[]}},"otherProps":{}},"position":2,"field":{"fieldId":"47954424-fff3-4157-9296-ad08b751e71d","fieldName":"SupplierID","fieldNameAlias":"Count (SupplierID)","dataFieldType":"Numeric","querySourceId":"1641cb37-b60c-42bc-b986-c51667e8037d","querySourceType":"Table","sourceAlias":"Suppliers","relationshipId":null,"visible":true,"calculatedTree":null,"schemaName":"dbo","querySourceName":"Suppliers","databaseName":"Northwind","isCalculated":false},"isDeleted":false,"isSelected":false}],"name":"columns"},"rows":{"text":null,"properties":{},"settings":{},"elements":[],"name":"rows"},"values":{"text":null,"properties":{},"settings":{},"elements":[],"name":"values"},"separators":{"text":null,"properties":{},"settings":{},"elements":[],"name":"separators"},"properties":{"isDirty":true,"generalInfo":{"gridStyle":"Vertical","separatorStyle":"Comma"},"table":{"backgroundColor":"#efefef","border":{"top":{},"right":{},"bottom":{},"midVer":{},"left":{},"midHor":{}}},"columns":{"width":{"value":null,"unit":"Pixels"},"alterBackgroundColor":false},"rows":{"height":40,"alterBackgroundColor":false},"headers":{"font":{"family":"Roboto","size":14,"bold":true,"italic":false,"underline":false,"backgroundColor":"#dbf2ff"},"alignment":"left","wordWrap":true,"removeHeaderForExport":false},"grouping":{"useSeparator":false},"view":{"dataRefreshInterval":{"enable":false,"updateInterval":0,"isAll":true,"latestRecord":0}}},"settings":{},"dataSource":{},"title":{"text":"","properties":{},"settings":{"font":{"family":"","size":14,"bold":true,"italic":false,"underline":false,"color":"","highlightColor":""},"alignment":{"alignment":""}},"elements":[]},"description":{"text":"","properties":{},"settings":{"font":{"family":"","size":14,"bold":false,"italic":false,"underline":false,"color":"","highlightColor":""},"alignment":{"alignment":""}},"elements":[]}},"reportId":"00000000-0000-0000-0000-000000000000","positionX":0,"positionY":0,"width":12,"height":4,"state":3,"modified":null,"numberOfRecord":0,"isBackSide":true,"expandedLevel":0,"points":[{"key":"All","filter":[{"key":"","value":""}],"expandedLevel":0,"isViewSeparator":false}],"isSelected":true,"title":"Grid","id":"561dba1e-f799-42be-be9d-bbfa078aee43"}],"version":0},"expandedLevel":-1,"filters":[],"title":"Grid"}Sample:
{"reportKey":{"key":"1e1316a9-b6ce-46c8-9496-671fd5ddeee1"},"report":{"name":"","type":"Templates","previewRecord":10,"advancedMode":true,"allowNulls":false,"isDistinct":false,"category":{"id":null,"name":"","type":"Templates"},"subCategory":{"id":null,"name":"","type":"Templates"},"reportDataSource":[{"aliasId":"1641cb37-b60c-42bc-b986-c51667e8037d_Suppliers","querySourceId":"1641cb37-b60c-42bc-b986-c51667e8037d","querySourceName":"Suppliers","selected":true,"categoryId":"00000000-0000-0000-0000-000000000000","primaryFields":[{"name":"SupplierID","alias":"","dataType":"int","izendaDataType":"Numeric","allowDistinct":false,"visible":true,"filterable":true,"deleted":false,"querySourceId":"00000000-0000-0000-0000-000000000000","parentId":null,"expressionFields":[],"filteredValue":"","type":0,"groupPosition":0,"position":0,"extendedProperties":"{\"PrimaryKey\":true}","physicalChange":0,"approval":0,"existed":false,"matchedTenant":false,"functionName":null,"expression":null,"fullName":null,"calculatedTree":null,"reportId":null,"originalName":"SupplierID","isParameter":false,"isCalculated":false,"querySource":null,"id":"47954424-fff3-4157-9296-ad08b751e71d","state":0,"inserted":true,"version":null,"created":null,"createdBy":null,"modified":"0001-01-01T00:00:00.0000000-08:00","modifiedBy":null}]}],"reportRelationship":[],"reportFilter":{"logic":"","visible":false,"filterFields":[],"id":"4a75d01f-1fb3-4eca-ae13-8f17d41289ea","reportId":"1e1316a9-b6ce-46c8-9496-671fd5ddeee1"},"reportPart":[{"isDirty":true,"reportPartContent":{"isDirty":false,"type":3,"columns":{"text":null,"properties":{},"settings":{},"elements":[{"reportPartContent":null,"isDirty":false,"name":"Country","properties":{"isDirty":false,"fieldItemVisible":true,"dataFormattings":{"function":"","functionInfo":{},"format":{},"font":{"family":"Roboto","size":14,"bold":false,"italic":false,"underline":false,"color":"","backgroundColor":""},"alignment":"alignLeft","sort":"","color":{"textColor":{},"cellColor":{}},"alternativeText":{"rangePercent":null,"rangeValue":null,"value":null},"customURL":{"url":"","option":"Open link in New Window"},"embeddedJavascript":{"script":""},"subTotal":{"label":"","function":"","expression":"","dataType":"","previewResult":"","fieldDataType":"Text"},"grandTotal":{"label":"Total Number of Countries","function":"Count Distinct","expression":"","dataType":"Numeric","previewResult":10,"fieldDataType":"Text"}},"headerFormating":{"width":{"value":0,"unit":"pixels"},"height":0,"font":{"family":null,"size":null,"bold":null,"italic":null,"underline":null,"color":null,"backgroundColor":null},"alignment":null,"wordWrap":null,"columnGroup":""},"drillDown":{"subReport":{"selectedReport":null,"style":null,"reportPartUsed":null,"reportFilter":true,"mappingFields":[]}},"otherProps":{}},"position":1,"field":{"fieldId":"76139896-c2c3-432e-898a-2c2205bb2e35","fieldName":"Country","fieldNameAlias":"Country","dataFieldType":"Text","querySourceId":"1641cb37-b60c-42bc-b986-c51667e8037d","querySourceType":"Table","sourceAlias":"Suppliers","relationshipId":null,"visible":true,"calculatedTree":null,"schemaName":"dbo","querySourceName":"Suppliers","databaseName":"Northwind","isCalculated":false},"isDeleted":false,"isSelected":true},{"reportPartContent":null,"isDirty":true,"name":"Count (SupplierID)","properties":{"isDirty":true,"fieldItemVisible":true,"dataFormattings":{"function":"8a74f4e0-b845-4b9e-adfa-bb678a116878","functionInfo":{"id":"8a74f4e0-b845-4b9e-adfa-bb678a116878","name":"Count","expression":null,"dataType":"Numeric","formatDataType":"Numeric","syntax":null,"expressionSyntax":null,"isOperator":false},"format":{},"font":{"family":"Roboto","size":14,"bold":false,"italic":false,"underline":false,"color":"","backgroundColor":""},"alignment":"alignLeft","sort":"","color":{"textColor":{},"cellColor":{}},"alternativeText":{"rangePercent":null,"rangeValue":null,"value":null},"customURL":{"url":"","option":"Open link in New Window"},"embeddedJavascript":{"script":""},"subTotal":{"label":"","function":"","expression":"","dataType":"","previewResult":"","fieldDataType":"Numeric"},"grandTotal":{"label":"","function":"","expression":"","dataType":"","previewResult":"","fieldDataType":"Numeric"}},"headerFormating":{"width":{"value":0,"unit":"pixels"},"height":{},"font":{"family":null,"size":null,"bold":null,"italic":null,"underline":null,"color":null,"backgroundColor":null},"alignment":null,"wordWrap":null,"columnGroup":""},"drillDown":{"subReport":{"selectedReport":null,"style":null,"reportPartUsed":null,"reportFilter":true,"mappingFields":[]}},"otherProps":{}},"position":2,"field":{"fieldId":"47954424-fff3-4157-9296-ad08b751e71d","fieldName":"SupplierID","fieldNameAlias":"Count (SupplierID)","dataFieldType":"Numeric","querySourceId":"1641cb37-b60c-42bc-b986-c51667e8037d","querySourceType":"Table","sourceAlias":"Suppliers","relationshipId":null,"visible":true,"calculatedTree":null,"schemaName":"dbo","querySourceName":"Suppliers","databaseName":"Northwind","isCalculated":false},"isDeleted":false,"isSelected":false}],"name":"columns"},"rows":{"text":null,"properties":{},"settings":{},"elements":[],"name":"rows"},"values":{"text":null,"properties":{},"settings":{},"elements":[],"name":"values"},"separators":{"text":null,"properties":{},"settings":{},"elements":[],"name":"separators"},"properties":{"isDirty":true,"generalInfo":{"gridStyle":"Vertical","separatorStyle":"Comma"},"table":{"backgroundColor":"#efefef","border":{"top":{},"right":{},"bottom":{},"midVer":{},"left":{},"midHor":{}}},"columns":{"width":{"value":null,"unit":"Pixels"},"alterBackgroundColor":false},"rows":{"height":40,"alterBackgroundColor":false},"headers":{"font":{"family":"Roboto","size":14,"bold":true,"italic":false,"underline":false,"backgroundColor":"#dbf2ff"},"alignment":"left","wordWrap":true,"removeHeaderForExport":false},"grouping":{"useSeparator":false},"view":{"dataRefreshInterval":{"enable":false,"updateInterval":0,"isAll":true,"latestRecord":0}}},"settings":{},"dataSource":{},"title":{"text":"","properties":{},"settings":{"font":{"family":"","size":14,"bold":true,"italic":false,"underline":false,"color":"","highlightColor":""},"alignment":{"alignment":""}},"elements":[]},"description":{"text":"","properties":{},"settings":{"font":{"family":"","size":14,"bold":false,"italic":false,"underline":false,"color":"","highlightColor":""},"alignment":{"alignment":""}},"elements":[]}},"reportId":"00000000-0000-0000-0000-000000000000","positionX":0,"positionY":0,"width":12,"height":4,"state":3,"modified":null,"numberOfRecord":0,"isBackSide":true,"expandedLevel":0,"points":[{"key":"All","filter":[{"key":"","value":""}],"expandedLevel":0,"isViewSeparator":false}],"isSelected":true,"title":"Grid","id":"561dba1e-f799-42be-be9d-bbfa078aee43"}],"version":0},"title":"Grid","expression":"","reportField":{"fieldId":"76139896-c2c3-432e-898a-2c2205bb2e35","fieldName":"Country","fieldNameAlias":"Country","dataFieldType":"Text","querySourceId":"1641cb37-b60c-42bc-b986-c51667e8037d","querySourceType":"Table","sourceAlias":"Suppliers","relationshipId":null,"visible":true,"calculatedTree":null,"schemaName":"dbo","querySourceName":"Suppliers","databaseName":"Northwind","isCalculated":false}}