To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Properties
| Name | Returns | Notes | Example |
|---|---|---|---|
| commonStartDate | Date | ||
| commonFinishDate | Date | ||
| lagStartDate | Date | ||
| lagFinishDate | Date | ||
| metrics | List | ||
| metricTypes | List | ||
| tables | List | ||
| queries | List | ||
| lookupTables | List | ||
| availableSuppliers | List | Find the supplier organisations available to the current user, based on the SupplierFilter role | |
| selectedSupplierIds | List | ||
| selectedOrgIds | List | Get the currently selected list of organisation IDs for the current user | |
| availableOrgIds | List | Returns a list of the ID's (internal kademi ID) of organisations the user has ReportingAccess role to. This list is not expanded, so does not include child organisations of those. | |
| availableOrgs | List | Returns a list of Organisation's which are directly available to the user, ie where the user has ReportingAccess on that org. This is a non-expanded list | |
| selectedOrgs | List | Returns the selected organisation, or multiple if they're selected | |
| currentTeamOrg | Organisation | Return the single currently selected organisation which should represent the team of the current user | |
| params | Map | get report query params |
Methods
| Name | Returns | Notes | Example |
|---|---|---|---|
| saveMetrics ( metrics ) | void | ||
| saveMetric ( m ) | void | ||
| deleteMetric ( metricId ) | void | ||
| metric ( name ) | Metric | ||
| calcMetric ( m ) | BigDecimal | This calculates using default entity and date range | |
| calcMetric ( m, cc ) | BigDecimal | This calculates using default entity and date range | |
| calcMetric ( m, defaultStartDate, defaultEndDate, calcContext ) | BigDecimal | ||
| calcMetric ( m, entity, defaultStartDate, defaultEndDate, calcContext ) | BigDecimal | ||
| metricType ( id ) | MetricType | ||
| findApplicableMetrics ( source ) | List | ||
| newRowsResult ( headers ) | RowsResult | ||
| getTable ( name ) | Table | ||
| queryParams ( startDate, endDate ) | Map | ||
| runQuery ( queryName ) | KSearchResponse | ||
| runQuery ( queryName, from, pageSize ) | KSearchResponse | ||
| runQuery ( queryName, params ) | KSearchResponse | ||
| runQuery ( queryName, from, pageSize, params ) | KSearchResponse | ||
| availableSuppliers ( user ) | List | Find the supplier organisations available to the given user, based on the SupplierFilter role | |
| selectedSupplierIds ( user ) | List | ||
| availableOrgIds ( user ) | List | Returns the org IDs which the given user has reporting access on | |
| getAvailableOrgIds ( group ) | List | ||
| getAvailableOrgIds ( groups ) | List | ||
| selectedOrgHasType ( orgType ) | boolean | ||
| preProcessQuery ( json ) | String | ||
| preProcessQuery2 ( json ) | String | This improves on preProcessQuery and should be used instead. It doesnt simple param substition, as well as lists | |
| getParams ( ) | Map | get report query params |
© 2025 Kademi Ltd