process-filter-cloud.service.md

Title	Added	Status	Last reviewed
Process Filter Cloud Service	v3.0.0	Experimental	2019-01-09

Process Filter Cloud Service

Manage Process Filters, which are pre-configured Process Instance queries.

Class members

Methods

• addFilter(newFilter: ProcessFilterCloudModel): Observable<ProcessFilterCloudModel[]>
  Adds a new process instance filter

  • newFilter: ProcessFilterCloudModel -
  • Returns Observable<ProcessFilterCloudModel[]> - Observable of process instance filters with newly added filter

• deleteFilter(deletedFilter: ProcessFilterCloudModel): Observable<ProcessFilterCloudModel[]>
  Delete process instance filter

  • deletedFilter: ProcessFilterCloudModel -
  • Returns Observable<ProcessFilterCloudModel[]> - Observable of process instance filters without deleted filter

• getFilterById(appName: string, id: string): Observable<ProcessFilterCloudModel>
  Get process instance filter for given filter id

  • appName: string - Name of the target app
  • id: string - Id of the target process instance filter
  • Returns Observable<ProcessFilterCloudModel> - Observable of process instance filter details

• getProcessFilters(appName: string): Observable<ProcessFilterCloudModel[]>
  Gets all process instance filters for a process app.

  • appName: string - Name of the target app
  • Returns Observable<ProcessFilterCloudModel[]> - Observable of process filters details

• isDefaultFilter(filterName: string): boolean
  Checks if given filter is a default filter

  • filterName: string - Name of the target process filter
  • Returns boolean - Boolean value for whether the filter is a default filter

• readQueryParams(obj: any): ProcessFilterCloudModel
  

  • obj: any -
  • Returns ProcessFilterCloudModel -

• resetProcessFilterToDefaults(appName: string, filter: ProcessFilterCloudModel): Observable<ProcessFilterCloudModel[]>
  Reset the process filters to the default configuration if it exists and stores it. If there is no default configuration for the process cloud filter with the provided filter name, then it changes nothing but stores the current values of the filter

  • appName: string - Name of the target app
  • filter: ProcessFilterCloudModel - The process filter to be restored to defaults
  • Returns Observable<ProcessFilterCloudModel[]> - Observable of process filters details

• updateFilter(updatedFilter: ProcessFilterCloudModel): Observable<ProcessFilterCloudModel[]>
  Update process instance filter

  • updatedFilter: ProcessFilterCloudModel -
  • Returns Observable<ProcessFilterCloudModel[]> - Observable of process instance filters with updated filter

• writeQueryParams(value: any, filterProperties: string[], appName?: string, id?: string): any
  

  • value: any -
  • filterProperties: string[] -
  • appName: string - (Optional)
  • id: string - (Optional)
  • Returns any -

Inject Preference service

Token: PROCESS_FILTERS_SERVICE_TOKEN A DI token that maps to the dependency to be injected.

Process Filter Cloud Service is by default injected with the Local Preference Cloud Service

import { NgModule } from '@angular/core';
import { LocalPreferenceCloudService, PROCESS_FILTERS_SERVICE_TOKEN } from '@alfresco/adf-process-services-cloud';

@NgModule({
    imports: [
        ...Import Required Modules
    ],
    providers: [
        { provide: PROCESS_FILTERS_SERVICE_TOKEN, useClass: LocalPreferenceCloudService }
    ]
})
export class ExampleModule {}

If you would like to inject the User Preference Cloud Service, you can inject the service like below shown

import { NgModule } from '@angular/core';
import { UserPreferenceCloudService, PROCESS_FILTERS_SERVICE_TOKEN } from '@alfresco/adf-process-services-cloud';

@NgModule({
    imports: [
        ...Import Required Modules
    ],
    providers: [
        { provide: PROCESS_FILTERS_SERVICE_TOKEN, useClass: UserPreferenceCloudService }
    ]
})
export class ExampleModule {}

See also

• Process filters cloud component
• Task filter cloud service