Documentatie object v2
- 1. Algemene informatie objecten V2
- 2. Veelgestelde vragen over objecten v2
- Kan ik een zaak starten vanuit een object?
- Kan ik een object handmatig bewerken?
- Kunnen objecten geëxporteerd en geïmporteerd worden?
- Welke kenmerktypes worden ondersteund?
- Kan iedereen zo maar een object V2 verwijderen?
- Wanneer ik het relatiekenmerk gebruik voor een persoon, krijgt deze dan automatisch rechten?
- Ik wil het object gebruiken om in nieuwe zaken informatie automatisch in te laten vullen wanneer ik het object opvraag, kan dit?
- Ik wil het object updaten d.m.v. een kenmerk aan te passen in de zaak, kan dit?
- Kunnen objecten v2 geïmporteerd worden naar andere omgevingen?
- We hebben veel objecten V1 aangemaakt, kunnen we deze in blijven zien de komende tijd?
- Kunnen zaken vanuit het Object V2 aangemaakt worden?
- Kan ik documenten vanuit de zaak linken aan een Object V2?
- Ik wil een kenmerk mappen in het object, hoe vertaal ik de magic string naar de juiste mapping?
- 3. Object maken
- 4. Object gebruiken in zaaktype
- 5. Algemene informatie Objectacties v2
- 6. Handleiding Objectacties v2
1. Algemene informatie objecten V2
Definitie en eigenschappen
Een object is een gegenereerde momentopname van de waarden uit een zaak waarin deze aangemaakt wordt. Het is als het ware een uitdraai van de details uit de zaak. Een object bestaat los van de zaak, maar wordt automatisch gerelateerd aan de zaak waarin deze is aangemaakt.
Rechten
Per objecttype is er één rechten-structuur. Er zit dus geen verschil tussen openbaar of vertrouwelijk, zoals je dat kent uit het zaaktype. De rol Admin en Zaaksysteembeheerder hebben niet automatisch beheerrechten op objecten. Deze moet je dus toekennen in de rechtenstructuur in het object.
- Geen rechten
Je kunt in een zaak (waar je recht op hebt) wel zien dat er een object in zit en wat de naam van het object is. Maar je kunt deze niet openen. - Raadpleegrechten
* Je kunt objecten zoeken in uitgebreid zoeken en daadwerkelijk openen.
* Je kunt geen object aanmaken.
* Je kun het object wegklikken uit de zaak (indien je behandelrechten hebt op de zaak). De relatie met het object is dan ook direct verwijderd. - Behandelrechten
* Je kunt objecten aanmaken
* Je kunt objecten handmatig bewerken (zonder zaak) - Beheerrechten
* Met beheerrechten kun je een object “verwijderen”. Het object is dan niet definitief verwijderd. De beheerder(s) van het object kunnen (enkel vanuit een oude zaak waarin het object is aangemaakt of aangeroepen) het object weer herstellen.
Ondersteunde kenmerken (invoertypen)
- Geo
- Relatie
- Rekeningnummer
- Datum
- Geocoordinaten (lat/lon)
- Afbeelding (URL)
- Numeriek
- Enkelvoudige keuze
- Keuzelijst
- Tekstveld
- Groot tekstveld
- Webadres
- Valuta
- Document
Niet ondersteunde kenmerken (invoertypen)
- Meervoudig keuzeveld
Status
Een object heeft altijd een status, deze kan actief of inactief zijn. Enkel met een objectactie kan de status gewijzigd worden.
Relaties
Een object kan een relatie hebben met meerdere zaken en betrokkenen.
Tijdlijn
Een object heeft een eigen tijdlijn.
Zoeken op objecten
Er kan gezocht worden op objecten met een uitgebreid zoeken functie, deze kun je (tot op heden) alleen benaderen door het webadres te vervolgen met: /main/advanced-search/custom_object
Archief
Objecten zijn niet archiefwaardig.
Object in de praktijk
- Contractregistratie: Objecten worden veel gebruikt voor het vastleggen en beheren van contracten.
- Vergunningen: Objecten worden gebruikt voor het vastleggen en beheren van vergunningen
- Subsidies: Objecten worden gebruikt voor het vastleggen en beheren van subsidies
- Kennisbank: Objecten worden gebruikt om gemakkelijk kennis op te slaan en op te zoeken.
2. Veelgestelde vragen over objecten v2
- Kan ik een zaak starten vanuit een object?
- Kan ik een object bewerken?
- Kunnen objecten geëxporteerd en geïmporteerd worden?
-
Wanneer ik het relatiekenmerk gebruik voor een persoon, krijgt deze dan automatisch rechten?
-
Ik wil het object updaten d.m.v. een kenmerk aan te passen in de zaak, kan dit?
-
Kunnen objecten v2 geïmporteerd worden naar andere omgevingen?
-
We hebben veel objecten V1 aangemaakt, kunnen we deze in blijven zien de komende tijd?
-
Ik wil een kenmerk mappen in het object, hoe vertaal ik de magic string naar de juiste mapping?
Kan ik een zaak starten vanuit een object?
Nee, dit is momenteel niet ondersteund.
Kan ik een object handmatig bewerken?
Ja, dit kan mits je minimaal behandelrechten op het object hebt.
Objecten V2 werken op basis van rollen / rechten inrichting. Wanneer iemand geen rechten heeft tot een object bewerken, dan kan hij/zij dit ook niet.
Let op! Wanneer er een object aangemaakt wordt in de zaak, zorg ervoor dat de behandelaar van de zaak wel de rechten heeft voor het object, mits hij/zij het object ook moet kunnen inzien.
Kunnen objecten geëxporteerd en geïmporteerd worden?
Nee, objecten dienen handmatig aangemaakt te worden in omgevingen. Het bijbehorende relatie-kenmerk komt wel mee bij het exporteren en importeren van een zaaktype.
Kan iedereen zo maar een object V2 verwijderen?
Nee, alleen de Admin of medewerker met beheerrechten in het object kan het object verwijderen. Dit gebeurt in het object zelf.
Wanneer ik het relatiekenmerk gebruik voor een persoon, krijgt deze dan automatisch rechten?
Nee, momenteel is het via het relatiekenmerk alleen mogelijk om personen op te vragen en te betrekken bij de zaak o.b.v. de rollen en rechten die zij voor de zaak hebben. Hebben zij dus geen rechten om de zaak te kunnen inzien / raadplegen / behandelen, dan kunnen zij dit nog altijd niet. Wil je wel iemand als betrokkene toevoegen met specifieke rechten, gebruik dan voor nu nog het relatie tab in de zaak en voeg via hier een betrokkene toe aan de zaak.
Let op, wanneer je een persoon opvraagt via het relatiekenmerk dan zal deze alleen een mailnotificatie krijgen. Het belletje in Zaaksysteem wordt nog niet getriggerd.
Ik wil het object gebruiken om in nieuwe zaken informatie automatisch in te laten vullen wanneer ik het object opvraag, kan dit?
Momenteel is het nog niet mogelijk om dit te doen. Het staat echter wel op de planning om ervoor te zorgen dat objecten V2 met regels gemuteerd kunnen worden. Het objecttype moet in dit geval wel geconfigureerd worden.
Ik wil het object updaten d.m.v. een kenmerk aan te passen in de zaak, kan dit?
Ja, het updaten van een Object kan straks via de zaak. Dit gaat dan via object acties. Het is straks mogelijk om Objecten aan te maken en te muteren via regels. Met zo'n regel kun je dan ook een kenmerk wijzigenen in de zaak, mits ze ook gemapt zijn in het Object zelf.
Kunnen objecten v2 geïmporteerd worden naar andere omgevingen?
Nee, objecten moeten handmatig aangemaakt worden op elke individuele omgeving. Het relatiekenmerk wordt wel meegenomen met de import.
We hebben veel objecten V1 aangemaakt, kunnen we deze in blijven zien de komende tijd?
Ja, omdat veel klanten objecten V1 gebruikt hebben worden bugs die het werkproces verstoren nog altijd opgepakt en blijven objecten V1 inzichtelijk voor de eerstkomende tijd. Let wel op, we gaan objecten v1 niet meer updaten en op termijn uitfaseren.
Kunnen zaken vanuit het Object V2 aangemaakt worden?
Nee, dit is wel iets dat nog op de planning staat. Echter wordt de focus eerst op de zoekfunctionaliteit gelegd.
Kan ik documenten vanuit de zaak linken aan een Object V2?
Nee, helaas is het niet mogelijk om een document vanuit het documententab te linken aan een object. M.a.v. een documentveld in de zaak komt niet mee in het Object V2. Wat wel mogelijk is, is om d.m.v. een Relatiekenmerk "Document" een document te uploaden in een Object V2 zelf.
Note! Het is bij development bekend dat de documenten in een Object V2 niet geopend kunnen worden, dit is als bug geregistreerd en wordt naar gekeken.
Ik wil een kenmerk mappen in het object, hoe vertaal ik de magic string naar de juiste mapping?
Wanneer de magic string [[bomen_datum]] is, dan wordt de juiste manier van mappen [[bomen_datum | isodate]]. In het geval van b.v.b. een datum kenmerk, wordt [[datumkenmerk]] dus [[datumkenmerk | isodate]
3. Object maken
Maak in de catalogus een Object V2 aan door op de blauwe plusknop te drukken. Kies voor Objecttype (beta)
Stap 1 Tab Algemeen:
Vul de volgende gegevens in:
- Objecttype: Het soort object. Bijvoorbeeld Contract of vergunning. Nodig om de zaak op te vragen in het relatiekenmerk
- Objecttitel: Hier bepaal je op basis van welke velden de titel van het object wordt gegenereerd. Met deze titel kun je het object later ook opzoeken.
Vul de objecttitel op de volgende manier in, Let op! Dikgedrukt is dus de magicstring waar je op wil kunnen zoeken:
[[ j("$.attributes.custom_fields.ztc_onderwerp.value") ]] -
[[ j("$.attributes.custom_fields.dso_projectomschrijving.value") ]] - Object subtitel: Hier kan je een subtitel samenstellen voor de objecten van dit type
- Externe referentie (optioneel):
Stap 2 Tab Kenmerken
Vul hier de nodige kenmerken toe: Klik op ‘zoek en voeg toe'. Op het moment dat je het kenmerk intypt, worden er suggesties gegeven. Geef ook een titel aan het kenmerk, zo zal het veld verschijnen in het object.
Stap 3 Tab Relaties
Voeg hier eventueel een relatie toe. Niet verplicht.
Stap 4 Tab Rechten
Aandachtspunten bij het toevoegen van de rechten
- Je kunt maar 1 type recht aanvinken, kies je bijvooebeeld voor ‘behandelen’ dan heeft deze rol ook automatisch raadpleegrechten.
- De rol ‘Administrator’ en ‘Zaaksysteembeheerder’ hebben niet automatisch beheerrechten op het object.
Stap 5 Tab Afronden
Rond het aanmaken van het Object af:
- Geef aan welke wijzigingen je hebt aangemaakt in het object en rond af.
Je kunt nu je object terugvinden in de catalogus onder de naam die je hebt gegeven bij ‘Object type’ in stap 1.
5. Object gebruiken in zaaktype
Stap 1 Relatiekenmerk aanmaken
Open in de catalogus de blauwe plusknop
- Invoertype: Relatie
- Relatietype: Object
- Meerdere waarden = objecten relateren. (makkelijker kopiëren/relateren van objecten)
- De optie bij vervolgzaak “gerelateerde objecten kopiëren” komt hierdoor te vervallen.
- Objecttype: Zoek en kies het object dat je wil gebruiken in jouw zaaktype.
Stap 2: Relatiekenmerk toevoegen in zaaktype
Open het zaaktype waarin je gebruik wil maken van het object. Je kunt het relatiekenmerk toevoegen in de gewenste fase.
Je kunt het object op 2 manieren gebruiken in je zaak:
- Aanmaken: Deze functie gebruik je wanneer je een object wilt kunnen aanmaken in een zaak van dit zaaktype. Je kunt gebruik maken van deze functie door het relatiekenmerk te bewerken.
Selecteer het vinkje bij ‘Object aanmaken’.
Je kunt de tekst van de knop wijzigen
De kenmerkmapping gaat vanzelf. Je hoeft hier dus niets in te vullen tenzij je een veld in het object wil laten vullen dat afwijkt van de waarde in de zaak. Bijvoorbeeld: Je wilt ZTC Onderwerp laten vullen door ZTC Samenvatting. Je vult dan dus de mapping bij onderwerp met [[ztc_samenvatting]].
Aandachtspunt: Mocht je een datumveld willen gebruiken, dan voeg je | isodate toe aan de magic string in de mapping. ZTC Ontvangstdatum wordt dan dus [[ztc_ontvangstdatum | isodate]]
- Aanroepen: Deze functie gebruik je als je een object wil aanroepen in de zaak. Nadat je het relatiekenmerk hebt toegevoegd aan het zaaktype zijn er geen extra handelingen nodig. Het vinkje ‘Object aanmaken’ dus niet activeren.
Stap 3: Object aanmaken in de zaak
- Maak een zaak aan van het zaaktype waarin je het relatiekenmerk hebt toegevoegd.
- Zorg ervoor dat je bent ingelogd met een rol die minimaal behandelrechten op het object en op het zaaktype hebt.
- Ga naar de fase waarin je het relatiekenmerk hebt toegevoegd.
- Klik op de knop om het object aan te maken.
- Check of alle velden die je zowel in de zaak als in het object hebt toegevoegd worden gevuld op basis van de waarden in de zaak.
- Scroll helemaal naar beneden in de preview van het object en kies voor ‘Aanmaken’.
- Je kunt het object nu openen door op het icoontje met pijltje te klikken.
5. Algemene informatie Objectacties v2
Definitie en eigenschappen
Een objectactie is een geautmatiseerde actie die je inricht om het de gebruik van objecten te faciliteren.
- Je kunt hiermee een object geautomatiseerd aanmaken
- Je kunt hiermee een object door middel van een zaak (geautomatiseerd) muteren naar een nieuwe versie.
Praktijkvoorbeeld: Als je een object hebt gebruikt voor het vastleggen van een contract en er vindt een wijziging op dat contract plaats, dan is het object niet meer up-to-date. Het is dus nodig om het object bij te werken met de laatste gegevens zodat je het object weer kunt zien als actuele waarheid. Een manier om dit te doen is door objectacties in te zetten in de zaak waarin de wijziging tot stand is gekomen / is vastgelegd.
Redenen om objectacties in te zetten
Objecten worden gebruikt om actueel inzicht te verkrijgen over een object (zoals een contract of vergunning). Objectacties worden gebruikt om te faciliteren dat het object de actuele waarheid blijft behouden.
Voordeel objectacties
- Je kunt dit inbouwen in je proces (zaak) waardoor het niet vergeten kan worden. Tevens is dit de minst foutgevoelige manier.
- Het is (door middel van gerelateerde zaken) makkelijk inzichtelijk wanneer, welke wijzigingen op het object zijn gedaan.
Nadeel objectacties
- Er moet een proces (zaak) zijn waarin je wijzigingen faciliteert. Zonder zaak, geen objectacties.
Alternatief van objectacties
Je kunt er ook voor kiezen om geen objectacties in te zetten om de actuele waarheid van het object te behouden. In plaats daarvan kun je het object telkens handmatig bewerken
Voordeel handmatig bewerken
- Het gaat snel
Nadelen handmatig bewerken
- Het is foutgevoelig. Je kunt het namelijk vergeten en het is maar op 1 plek vastgelegd
- Het is lastig terug te vinden wanneer en waarom het veld in een object is bewerkt. Het kan wel, door middel van de timeline van het object, maar het is niet overzichtelijk.
6. Handleiding Objectacties v2
Stap 1: Objectactie aanmaken in zaaktype
Voorwaarden:
1. Het relatiekenmerk van het object moet bestaan in het zaaktype, anders kun je geen objectactie toevoegen
2. Een objectactie kan niet worden toegevoegd in de eerste fase
- Open het zaaktype en de fase van dat zaaktype waarin je een objectactie wil toevoegen.
- Kies ‘Objectactie’ bij het menu om een Element toe te voegen
Stap 2: Objectactie inrichten
- Het venster om de objectactie in te richten verschijnt direct
- Je kiest het relatiekenmerk van het object dat je wilt muteren met deze objectactie
- Je kiest het soort mutatie dat je wilt doen
De opties zijn: Aanmaken en Wijzigen. Bij het aanmaken zorg je ervoor dat er geautomatiseerd een object wordt aangemaakt. Bij wijzigen doen we een mutatie op een bestaand object.
- Je geeft een titel aan de actie (bijvoorbeeld: Verlengen, beëindigen, wijzigen, inactief maken, etc).
- Je geeft aan of deze objectactie automatisch moet worden uitgevoerd bij faseovergang.
- Je geeft aan of de status van het object moet wijzigen.
- Als laatste definieer je in de kenmerkmapping welke velden je bij het uitvoeren van deze objectactie wilt muteren. Zo kun je bijvoorbeeld de einddatum en de contractwaarde van een contract wijzigen als je een objectacite instelt voor ‘Verlengen’.
- In het screenshot zie je 3 velden die gemappt zijn. Dit betekent dat enkel deze 3 velden gemuteerd worden in het object bij het uitvoeren van de objectactie.
Aandachtspunt: Mocht je een datumveld willen gebruiken, dan voeg je | isodate toe aan de magic string in de mapping. ZTC Ontvangstdatum wordt dan dus [[ztc_ontvangstdatum | isodate]]
- Klik op opslaan en publiceer je zaaktype.
Stap 3: Gebruik de objectactie in een zaak
- Start een zaak van het zaaktype, waarin je de objectactie hebt ingesteld.
- Roep een bestaand object op in het relatiekenmerk.
- Vul de waarden in de zaak van de velden die je hebt gemapt in je objectactie en sla op.
- Ga naar de fase waarin je de objectactie hebt ingesteld.
- Zie in het actiemenu jouw objectactie staan. Klik op de objectactie en kies voor ‘Ja, nu uitvoeren’.
- Open het object (via relaties of via het relatiekenmerk waarin je net het object hebt gekoppeld aan de zaak).
- Controleer of de velden zijn gemuteerd.