Zoekdefinitie eigenschappen

key (string)

Unieke ID van de zoekdefinitie

“key” : “bulkGoedkeuring”

label (string)

Naamgeving van de zoekdefinitie

“label” : “Selecteer dossiers voor goedkeuring”

allowSearch (boolean)

Zoekvenster boven de resultatenlijst.

Default true

“allowSearch” : false

allowViewConfiguration (boolean)

Knoppen boven de resultatenlijst voor het aanmaken, opslaan en verwijderen van weergaves.

• Default true

• Bij select task (zie use case bulktaken) false

“allowViewConfiguration” : true

allowViewSelection (boolean)

Dropdown selector voor het selecteren van een weergave.

• Default true

• Bij select task (zie use case bulktaken) false

“allowViewSelection” : true

allowSelectableItems (boolean)

Aanvinkbare checkboxes voorafgaand aan elk item.

• Default false

• Bij select task (zie use case bulktaken) true

“allowSelectableItems” : true

allowExport (boolean)

Export knop (hiervoor heeft de gebruiker ook een specifieke UI authorisatie nodig).

• Default false

• Bij select task (zie use case bulktaken) altijd false, je kan dit niet wijzigen

“allowExport” : false

showDossierTypeFilter (boolean)

Dropdown selector boven de resultatenlijst waar je kan filteren op dossiertype.

Default false (behalve in dashboard dossier overzicht)

“showDossierTypeFilter” : true

Eigenschap & Type

Beschrijving & Sample

datasourceType (string)

Gegevensbron waar de data opgehaald moet worden. Dit is altijd een combinatie van twee elementen.

Opties eerste element:

• search/… (backend search)

• es/… (elastic search)

• be/… (backend)

Opties tweede element:

• …/tasks

• …/dossiers

• …/documents

“datasourceType” : “es/dossiers”

Eigenschap & Type

Beschrijving & Sample

hiddenFilters (string)

Filterregels die toegepast worden, maar verborgen blijven voor de backoffice gebruiker. Hij of zij kan ze dan ook niet uitschakelen.

• Default geen filters toegepast

• Bij select task (zie use case bulktaken) zijn er sowieso enkele default filters. Zo moet de gerelateerde bulktaak bijvoorbeeld actief staan.

"hiddenFilters" : {} (geen extra verborgen filters toegepast)

Eigenschap & Type

Beschrijving & Sample

columnDefinitions (lijst van kolom definitie keys en definitie objecten)

Hieronder een sample met vier kolommen waarvan de laatste kolom ‘Aanvrager’ samengesteld is uit informatie uit twee formuliervelden ‘Naam’ en ‘Voornaam’.

 "columnDefinitions": [
  {
  "heading": "Dossiernummer",
  "select": ["dossier.label", "dossier.id"],
  "field": "dossier.label"
  },
  {
  "heading": "Dossiertype",
  "key": "dossier.type",
  "field": "dossier.dossierDefinition.label"
  },
  {
  "heading": "Naam vereniging",
  "key": "vereniging",
  "field": "dossier",
  "content": "[lookup('dossier.dossierDefinition.key', item) === 'subsidieSportvereniging' ? lookup('document.aanvraagformulierSubsidieSportvereniging.naamVereniging', item) : lookup('document.aanvraagSubsidieStraatFeestWijkComite.naamComite', item)]"
  },
  {
  "heading": "Aanvrager",
  "key": "aanvrager",
  "type": "multi-field",
  "fields": [
  {
  "type": "search/text",
  "field": {
    "path": "document.aanvraagformulierSubsidieSportvereniging.hoofdaanvrager.voornaam",
    "options": { "nesting": "document" }
    }
  },
  {
  "type": "search/text",
  "field": {
    "path": "document.aanvraagformulierSubsidieSportvereniging.hoofdaanvrager.naam",
    "options": { "nesting": "document" }
    }
  }
  ]
  }
 ]

heading (string)

Naam van de kolom

“heading” : “Dossiernummer”

key (string)

Unieke ID van de kolom

“key” : “dossierNummer”

type (string)

Gegevenstype van de info die je in de kolom gevisualiseerd wil zien. Bijvoorbeeld tekst, boolean, enzovoort.

Default: tekst (“search/text”)

Opties:

• datum (“search/date")

• tekst (“search/text")

• multichoice (“search/document/multichoice"); hierbij moet je de mogelijke opties oplijsten (zie “choices") + sorteerfunctie uitschakelen (zie “sort").

• choice (“search/document/choice"); hierbij moet je de mogelijke opties oplijsten (zie “choices") + sorteerfunctie uitschakelen (zie “sort").

• boolean (“search/document/boolean")

• attachment (“search/document/attachment"); toont de naam van de opgeladen bijlage

• combinatie tekstvelden (“multi-field"); alle geneste velden moeten van het type tekst (“search/text") zijn

field (string of object)

Pad naar de info die je in de kolom gevisualiseerd wil zien.

Root level info:

“field” : “dossier.label” (root level)

Formulier info:

"field" : {
  "path" : "document.keyFormulier.keyVeld",
  "options" : {"nesting" : "document"}
}

fields (lijst van objecten)

Enkel wanneer type een combinatie van tekstvelden (multi-field) is. De lijst bevat de objecten “type" en “field".

"fields": [
 {
 "type": "search/text",
 "field": {
    "path": "document.aanvraagformulierSubsidieSportvereniging.hoofdaanvrager.voornaam",
    "options": { "nesting": "document" }
    }
 },
 {
 "type": "search/text",
 "field": {
 "path": "document.aanvraagformulierSubsidieSportvereniging.hoofdaanvrager.naam",
 "options": { "nesting": "document" }
    }
 }
]

choices

Enkel wanneer type “choice" of “multichoice" is. Oplijsting van de mogelijke opties in dit veld.

"choices" : [
  {
    "name" : "a",
    "label" : "optie a"
  },
  {
    "name" : "b",
    "label" : "optie b"
  }
  ]

filter (boolean)

Bepaal of de gebruiker de kolom kan filteren.

Default true

“filter” : false

sort (boolean)

Bepaal of de gebruiker de kolom kan sorteren.

Default true

“sort” : false

Eigenschap & Type

Beschrijving & Sample

views (lijst van weergave definitie keys en definitie objecten)

Hieronder een sample met slechts één enkele view.

"views": [
 {
 "name": "Default view",
 "searchTerm": "",
 "columns": ["dossier.label", "dossier.type", "vereniging", "aanvrager"],
 "filters": [],
 "sort": {
 "criterion": "dossier.label"
 }
 }
 ]

Eigenschap & Type

Beschrijving & Sample

defaultView (key van een weergave)

Dit is de weergave die de gebruiker standaard te zien krijgt.

“defaultView” : “onlyHighPriority”

Eigenschap & Type

Beschrijving & Sample

name (string)

Naam van de weergave.

“name” : “Detailweergave”

key (string)

Unieke ID van de weergave.

“key” : “detailWeergave”

columns (lijst van kolom definition keys)

Lijst met kolom definitie keys. Deze verwijzen naar de kolommen gedefinieerd in de kolom sectie van de zoekdefinitie.

“colmuns” : [“dossierNummer”, “naamAanvraag”, “bedragPremie”]

searchTerm (string)

Default zoekterm die ingevuld wordt in het zoekvenster bovenaan. De gebruiker kan de zoekterm uiteraard zelf wijzigen.

“searchTerm” : “Typ hier om te zoeken"

sort (lijst met objecten)

Lijst met default sorteerregel. De eerst ingevulde regel krijgt de hoogste prioriteit. De eigenschap criterion is het pad naar het veld waarop je wil sorteren. Opgelet: gebruik enkel sorteerbare velden. De orde van sorteren geef je aan via de desc parameter (desc: false is oplopend, desc: true is aflopend). De gebruiker kan de sortering steeds wijzigigen.

sort: [
    {
      criterion: "document.aanvraag.aanvraagdatum", 
      desc: false
    },
    {
      criterion: "document.aanvraag.naamAanvrager",
      desc: false
    }
  ]

filters (lijst van objecten)

Lijst met filterregels. De eerst ingevulde regel krijgt de hoogste prioriteit. De eigenschap name is het pad naar het veld waarop je wil filteren. De gebruiker kan de filterregels steeds verwijderen of wijzigen.

filters: [
    {
      name: "document.aanvraag.naamAanvrager", 
      value: "Janssens"
    }
  ]

Eigenschap & Type

Beschrijving & Sample

aggregations (lijst van weergave definitie keys en definitie objecten)

Hieronder een sample met slechts één enkele aggregatie.

"aggregations": [
  {
    "label": "Total amount",
    "key": "amount-total",
    "type": "full-selection",
    "operator": "sum",
    "field": "document.book-reservation-request.amount"
  },
 ]

Eigenschap & Type

Beschrijving & Sample

label (string)

Naam van de aggregatie.

“name” : “Detailweergave”

key (string)

Unieke ID van de weergave.

“key” : “detailWeergave”

type

Indien type gedefinieerd, dan is operator en field verplicht.

“type” : “full selection”

operator

Enkel van toepassing als “type” : “full selection”

Operator die de aggregatie definieert. Mogelijkheden:

• avg: gemiddelde van alle waardes (meer info op website elastic search)

• max: maximum (hoogste waarde, meer info op website elastic search)

• min: minimum (laagste waarde, meer info op website elastic search)

• sum: som van alle waardes (meer info op website elastic search)

field

Enkel van toepassing als “type” : “full selection”

Pad naar het veld met de data waarop je de aggregatie wil uitvoeren.

“field” : “document.book-reservation-request.amount”