java.lang.Object

com.flowable.platform.service.reports.PlatformReportService

public class PlatformReportService
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field	Description
`protected org.flowable.cmmn.api.CmmnRepositoryService`	`cmmnRepositoryService`
`protected com.flowable.platform.security.permission.PermissionServiceRegistry`	`permissionServiceRegistry`
`protected org.flowable.engine.RepositoryService`	`repositoryService`
`protected SearchService`	`searchService`
`protected TemplateLoader`	`templateLoader`
`protected WorkDefinitionService`	`workDefinitionService`

Constructor Summary

Constructors
Constructor	Description
`PlatformReportService(com.fasterxml.jackson.databind.ObjectMapper objectMapper, TemplateLoader templateLoader, SearchService searchService, com.flowable.platform.security.permission.PermissionServiceRegistry permissionServiceRegistry, WorkDefinitionService workDefinitionService, org.flowable.cmmn.api.CmmnRepositoryService cmmnRepositoryService, org.flowable.engine.RepositoryService repositoryService, org.springframework.core.io.Resource[] reportResources)`

Method Summary

Modifier and Type	Method	Description
`protected void`	`addAllAccessibleDefinitions(java.util.Map<java.lang.String,java.lang.Object> defaultParameters)`
`protected void`	`addDefinitionParameters(PlatformRunReportRequest request, java.util.Map<java.lang.String,java.lang.Object> defaultParameters)`
`protected ReportResult`	`calculateInstancesReport(PlatformRunReportRequest request, java.lang.String indexName, java.lang.String templateName)`
`protected java.lang.String`	`checkForValidInterval(java.lang.String aggregatePeriod)`
`protected java.lang.String`	`getDefinitionType(PlatformRunReportRequest reportRequest)`
`protected java.util.Map<java.lang.String,java.lang.String>`	`getGroupByFromBuckets(com.fasterxml.jackson.databind.JsonNode buckets)`
`protected java.lang.String`	`getQueryTemplate(PlatformReport report, java.lang.String reportType)`
`java.util.Optional<PlatformReport>`	`getReport(java.lang.String reportId)`
`java.util.List<PlatformReport>`	`getReports()`
`java.util.List<PlatformReport>`	`getReports(java.lang.String searchText)`
`protected java.lang.String`	`getScopeType(PlatformRunReportRequest reportRequest)`
`protected freemarker.template.Template`	`getTemplate(java.lang.String templateName)`
`protected boolean`	`hasDefinitions(java.util.List<java.lang.String> scopeDefinitionIds, java.util.List<java.lang.String> scopeDefinitionKeys)`
`protected boolean`	`hasDefinitions(java.util.Map<java.lang.String,java.lang.Object> params)`
`protected boolean`	`isFinished(PlatformRunReportRequest request)`
`protected boolean`	`isMultipleDefinitions(java.util.Map<java.lang.String,java.lang.Object> defaultParameters)`
`ReportGroupByResult`	`runHeatMapReport(PlatformRunReportRequest request)`
`ReportResult`	`runReport(java.lang.String reportId, PlatformRunReportRequest request)`
`protected java.util.List<java.lang.String>`	`swapDefinitionIdsWithKeys(java.util.Map<java.lang.String,java.lang.Object> defaultParameters, java.util.List<java.lang.String> scopeDefinitionIds, java.lang.String scopeType)`
`protected void`	`validateDefinitionAccessOrAddDefaults(PlatformRunReportRequest request, java.util.Map<java.lang.String,java.lang.Object> defaultParameters, java.util.List<java.lang.String> scopeDefinitionIds, java.util.List<java.lang.String> scopeDefinitionKeys)`
`protected void`	`validateDefinitionsAccess(java.lang.String scopeType, java.util.List<java.lang.String> definitionIds, java.util.List<java.lang.String> definitionKeys)`	This removes any processDefinitionId which is not allowed for the current user.
`protected void`	`validatePassedDefinitionIdsAndKeys(java.util.List<java.lang.String> scopeDefinitionIds, java.util.List<java.lang.String> scopeDefinitionKeys)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- templateLoader
  
  protected TemplateLoader templateLoader
- searchService
  
  protected SearchService searchService
- permissionServiceRegistry
  
  protected com.flowable.platform.security.permission.PermissionServiceRegistry permissionServiceRegistry
- workDefinitionService
  
  protected WorkDefinitionService workDefinitionService
- cmmnRepositoryService
  
  protected org.flowable.cmmn.api.CmmnRepositoryService cmmnRepositoryService
- repositoryService
  
  protected org.flowable.engine.RepositoryService repositoryService
Constructor Details
- PlatformReportService
  
  public PlatformReportService(com.fasterxml.jackson.databind.ObjectMapper objectMapper, TemplateLoader templateLoader, SearchService searchService, com.flowable.platform.security.permission.PermissionServiceRegistry permissionServiceRegistry, WorkDefinitionService workDefinitionService, org.flowable.cmmn.api.CmmnRepositoryService cmmnRepositoryService, org.flowable.engine.RepositoryService repositoryService, org.springframework.core.io.Resource[] reportResources)
Method Details
- getReports
  
  public java.util.List<PlatformReport> getReports()
- getReports
  
  public java.util.List<PlatformReport> getReports(java.lang.String searchText)
- getReport
  
  public java.util.Optional<PlatformReport> getReport(java.lang.String reportId)
- runReport
  
  public ReportResult runReport(java.lang.String reportId, PlatformRunReportRequest request)
- checkForValidInterval
  
  protected java.lang.String checkForValidInterval(java.lang.String aggregatePeriod)
- getQueryTemplate
  
  protected java.lang.String getQueryTemplate(PlatformReport report, java.lang.String reportType)
- calculateInstancesReport
  
  protected ReportResult calculateInstancesReport(PlatformRunReportRequest request, java.lang.String indexName, java.lang.String templateName)
- getDefinitionType
  
  protected java.lang.String getDefinitionType(PlatformRunReportRequest reportRequest)
- getScopeType
  
  protected java.lang.String getScopeType(PlatformRunReportRequest reportRequest)
- getGroupByFromBuckets
  
  protected java.util.Map<java.lang.String,java.lang.String> getGroupByFromBuckets(com.fasterxml.jackson.databind.JsonNode buckets)
- runHeatMapReport
  
  public ReportGroupByResult runHeatMapReport(PlatformRunReportRequest request)
- getTemplate
  
  protected freemarker.template.Template getTemplate(java.lang.String templateName)
- addDefinitionParameters
  
  protected void addDefinitionParameters(PlatformRunReportRequest request, java.util.Map<java.lang.String,java.lang.Object> defaultParameters)
- validateDefinitionAccessOrAddDefaults
  
  protected void validateDefinitionAccessOrAddDefaults(PlatformRunReportRequest request, java.util.Map<java.lang.String,java.lang.Object> defaultParameters, java.util.List<java.lang.String> scopeDefinitionIds, java.util.List<java.lang.String> scopeDefinitionKeys)
- validatePassedDefinitionIdsAndKeys
  
  protected void validatePassedDefinitionIdsAndKeys(java.util.List<java.lang.String> scopeDefinitionIds, java.util.List<java.lang.String> scopeDefinitionKeys)
- addAllAccessibleDefinitions
  
  protected void addAllAccessibleDefinitions(java.util.Map<java.lang.String,java.lang.Object> defaultParameters)
- swapDefinitionIdsWithKeys
  
  protected java.util.List<java.lang.String> swapDefinitionIdsWithKeys(java.util.Map<java.lang.String,java.lang.Object> defaultParameters, java.util.List<java.lang.String> scopeDefinitionIds, java.lang.String scopeType)
- hasDefinitions
  
  protected boolean hasDefinitions(java.util.Map<java.lang.String,java.lang.Object> params)
- hasDefinitions
  
  protected boolean hasDefinitions(java.util.List<java.lang.String> scopeDefinitionIds, java.util.List<java.lang.String> scopeDefinitionKeys)
- validateDefinitionsAccess
  
  protected void validateDefinitionsAccess(java.lang.String scopeType, java.util.List<java.lang.String> definitionIds, java.util.List<java.lang.String> definitionKeys)
  
  This removes any processDefinitionId which is not allowed for the current user.
- isMultipleDefinitions
  
  protected boolean isMultipleDefinitions(java.util.Map<java.lang.String,java.lang.Object> defaultParameters)
- isFinished
  
  protected boolean isFinished(PlatformRunReportRequest request)

Class PlatformReportService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details