Swing Viewer - URL-parameters

INHOUDSOPGAVE

• Introductie
• Algemeen
• Openen themaboom
• Onderwerpen/kubussen
• Perioden
• Gebieden
• Presentaties
• Rapporten
• Overig

Introductie

Met behulp van querystrings is het mogelijk om aan de Swing Viewer URL (=link) parameters mee te geven. Hiermee wordt opgevraagde inhoud direct weergegeven. Deze parameters variëren en kunnen onder andere betrekking hebben op onderwerpen, rapporten, de themaboom (of een gedeelte daarvan) of presentaties zijn.

In deze handleiding worden concrete voorbeelden gegeven op basis van de URL van de Swing Viewer Demo, https://swing.eu/jive. Het is bijvoorbeeld mogelijk om direct een specifiek thema te openen, dit gaat middels de link: https://swing.eu/jive?cat_open=veiligheid. Het gebruik van deze link resulteert in het openen van het thema Veiligheid .

URL-parameters kunnen direct in de adresbalk van de browser gebruikt worden of u kunt ze gebruiken op andere webpagina’s, zoals bijvoorbeeld een Swing landingspagina of binnen Ballroom.

Onderstaande screenshots illustreren beide toepassingsmogelijkheden. In de linker afbeelding is te zien is dat door de link in de adresbalk van de browser te plaatsen, deze het thema Veiligheid direct opent in Viewer. In de afbeelding rechts opent de browser, na het klikken op de link, het opgegeven thema en een presentatie. Het is mogelijk om meerdere parameters te combineren in één link.

Het format voor het gebruik van URL-parameters is als volgt:

[URL Jive]?[parameter]=[waarde]

In het geval van meerdere parameters en waarden geldt:

[URL Jive]?[parameter1]=[waarde1]&[parameter2]=[waarde2a],[waarde2b].

Er kunnen dus meerdere parameters en waarden worden opgegeven. Parameters dienen gescheiden te worden door een ampersand (&) en de bijbehorende waarden door een komma (,).

In dit voorbeeld wordt vanuit de demoversie https://swing.eu/jive de variabele (=onderwerpcode van Bevolking totaal mannen) ‘bevtotm’ opgeroepen voor de jaren 2001 en 2002.

Het openen van een thema kan op basis van de themanaam of -code. Daarnaast kan een thema exclusief geopend worden, dus zonder andere thema’s. Op deze manier kan slechts een deel van de themaboom beschikbaar worden gesteld.

Cat_open

Het gebruik van de parameter ‘cat_open’ zorgt ervoor dat op basis van de themanaam het betreffende thema wordt geopend, dit kan ook een subthema zijn.

https://swing.eu/jive?cat_open=Leeftijd (hoofdthema)

https://swing.eu/jive?cat_open=Leeftijd/Aantallen (subthema)

Cat_open_code

Daarnaast is het mogelijk om met de parameter ‘cat_open_code’ een thema te openen op basis van de themacode. Elk thema heeft een unieke themacode, deze is in Studio te achterhalen: 'Weergave' > 'Themaboom' > Optie ‘wijzig’ betreffende thema (rechtermuisknop).

https://swing.eu/jive?cat_open_code=datatyp

Cat_show

De parameter ‘cat_show’ opent een thema exclusief op basis van de themanaam en geen van de andere thema’s is zichtbaar in Viewer.

https://swing.eu/jive?cat_show=leeftijd

Cat_show_code

De parameter ‘cat_show_code’ opent een thema exclusief op basis van de themacode en geen van de andere thema’s is zichtbaar in Viewer. Elk thema heeft een unieke themacode, deze is binnen Studio te achterhalen: Weergave > Themaboom > Optie ‘wijzig’ betreffende thema (rechtermuisknop).

https://swing.eu/jive?cat_show_code=datatyp

Het is mogelijk om een onderwerp of kubus direct in Viewer te openen. In het geval van een kubus kan dit nog verder gespecificeerd worden naar dimensieniveaus en dimensie-items. Deze parameters kunnen ook in combinatie met andere parameters gebruikt worden.

Var

Met de parameter ‘var’ kunnen een of meerdere onderwerpen op basis van de onderwerpcode worden opgeroepen. Hierbij wordt de themaboom automatisch geopend. Standaard opent zich een tabel. Met de parameter ‘view’ (zie paragraaf ‘Presentaties’) kan dit aangepast worden.

https://swing.eu/jive?var=bevtotm,bevtotv

Dimlevel

De parameter ‘dimlevel’ kan gebruikt worden bij kubusonderwerpen en werkt alleen in combinatie met de parameter ‘var’. Hiermee is het mogelijk om kubusonderwerpen verder uit te splitsen naar een of meer opgegeven dimensieniveaus. In onderstaand voorbeeld wordt met behulp van de parameter ‘var’ een kubusonderwerp opgeroepen, vervolgens wordt dit onderwerp verder uitgesplitst naar de dimensieniveaus geslacht en 10-jaarsleeftijdsklassen hetgeen resulteert in een kruistabel geslacht x leeftijd.

https://swing.eu/jive?var=kb_bev_lft05&dimlevel=dnc_gsl,dnc_lft10

Dimmember

Met de parameter ‘dimmember’ kan een dimensie item worden opgevraagd. De codes van zowel het dimensieniveau als de items moeten hierbij worden opgegeven, zoals: dimmember=dnc_gsl_m. Het dimensieniveau hierbij is 'dnc_gsl' (geslacht) en de bijbehorende item is 'm' (mannen). Deze parameter kan alleenstaand of in combinatie met de parameter 'dimlevel' gebruikt worden.

https://swing.eu/jive?var=kb_bev_lft05&dimmember=dnc_gsl_m&dimlevel=dnc_lft10

Met verschillende parameters is het mogelijk om Viewer automatisch met opgegeven perioden te openen. Deze parameters kunnen in combinatie met andere parameters gebruikt worden; zoals ‘var’. Je kan dan opgeven met welke periode een onderwerp getoond moet worden.

Period

Hiermee kan, op basis van de periodecode, een periode worden opgegeven. Dit kunnen ook meerdere perioden zijn die door komma’s gescheiden zijn. De periodecodes zijn binnen Studio te achterhalen: Perioden > Periodeniveaus > Kolom Perioden.

https://swing.eu/jive?var=bevtotm,msdtot&period=2013,2014 (jaren)

https://swing.eu/jive?var=nwwi_n_tot&period=m10y2016,m12y2016 (maanden)

Mostrecentperiod=true

Hiermee wordt de optie ‘most recent period’ geactiveerd. In onderstaand voorbeeld wordt van twee onderwerpen de meest recente periode automatisch getoond. Deze parameter heeft maar één waarde '=true' en toont de data op het laagst mogelijke periodeniveau. In geval van maandata worden de data dus op maandniveau getoond. Met de parameter ‘periodlevel’ kan het periodeniveau aangepast worden.

https://swing.eu/jive?var=bevtotm,msdtot&mostrecentperiod=true

Mostrecentperiods

Met deze parameter kan een reeks meest recente perioden worden opgeroepen. Deze toont de data op het laagst mogelijke periodeniveau. In geval van maandata worden de data dus op maandniveau getoond. Met de parameter ‘periodlevel’ kan het periodeniveau aangepast worden. In onderstaand voorbeeld wordt van twee onderwerpen de vijf meest recente perioden getoond.

https://swing.eu/jive?var=bevtotm,msdtot&mostrecentperiods=5

Periodlevel

Met de parameter ‘periodlevel’ kan het periodeniveau opgegeven worden. Hiervoor moet de periodeniveaucode zoals is opgegeven binnen Studio gebruikt worden. De periodeniveaucodes zijn binnen Studio te achterhalen: Perioden > Periodeniveaus > Kolom periodeniveaucode.

Deze parameter wordt voornamelijk gebruikt voor het nader specificeren van het periodeniveau en wordt dan in combinatie met de parameters mostrecentperiod=true en mostrecentperiods gebruik. In het geval van maandata kunnen de data ook op kwartaal- of jaarniveau getoond worden.

Hieronder een voorbeeld waarbij een onderwerp dat is ingelezen op maandniveau, op kwartaalniveau getoond wordt voor de vijf meest recente perioden:

https://swing.eu/jive?var=nwwi_n_tot&mostrecentperiods=5&periodlevel=quarter

Met verschillende parameters is het mogelijk om Viewer automatisch met opgegeven gebieden te openen. Deze parameters kunnen in combinatie met andere parameters gebruikt worden; zoals ‘var’. Je kan zo opgeven voor welk gebied de data van een onderwerp getoond moeten worden.

Geolevel

Met deze parameter kan het gebiedsniveau worden opgegeven waarvoor data in Viewer getoond moet worden. Hiervoor moet de gebiedsniveaucode worden opgegeven. Deze zijn binnen Studio te achterhalen: Gebieden > Gebiedsniveaus > Kolom gebiedsniveaucode.

Onderstaand een voorbeeld waarbij een onderwerp wordt getoond op provincieniveau.

https://swing.eu/jive?var=nwwi_n_tot&geolevel=provincie

Geoitem

Om gebieden te specificeren wordt gebruik gemaakt van de parameter ‘geoitem’. Hiermee wordt bepaald welk(e) gebied(en) van een bepaald gebiedsniveau getoond moet(en) worden. Deze parameter moet in combinatie met de parameter ‘geolevel’ gebruikt worden. Deze zijn binnen Studio te achterhalen: Gebieden > Gebiedsniveaus > Gebieden > Kolom gebiedscode.

Er kunnen meerdere gebieden door komma’s gescheiden worden opgegeven:

https://swing.eu/jive?var=nwwi_n_tot&geolevel=gemeente&geoitem=1680,518

Geoitem_codes

Deze parameter is een combinatie van de parameters ‘geolevel’ en ‘geoitem’, als waarde moet het gebiedsniveau- en gebiedscode worden opgegeven, gescheiden door een underscore teken. Ook hier is het mogelijk om meerdere waarden op te geven:

https://swing.eu/jive?var=bevtotm&geoitem_codes=gemeente_518,gemeente_1680

Geocompare

Hiermee kunnen een of meerdere gebiedsvergelijkingen worden opgegeven op basis van de gebiedsniveaucode. Hieronder een voorbeeld waarbij de gemeente Den Haag (gebiedscode=518) vergeleken wordt met het gebiedsniveau provincie:

https://swing.eu/jive?var=bevtotm&geoitem_codes=gemeente_518&geocompare=provincie

GeocompareItem

Hiermee kan een gebiedsvergelijking worden gemaakt met behulp van de gebiedsniveau- en gebiedscode. Werkt dus hetzelfde als de parameter 'geoitem_codes', maar dan voor vergelijkingsgebieden. Het gebiedsniveaucode en de code van het gebied zal moeten worden opgegeven.

https://swing.eu/jive?var=bevtotm&geoitem_codes=gemeente_363&geocompareitem=provincie_9

Geosplit

In Viewer is het mogelijk om gebiedsniveaus uit te splitsen naar gebieden van een ander (lager) niveau. In een URL kan met de parameter ‘geosplit’ een gebiedsniveau worden opgegeven waarop de data moeten worden uitgesplitst. Zo is het mogelijk om een provincie uit te splitsen naar gemeenteniveau.

In onderstaand voorbeeld wordt met behulp van de parameter ‘geoitem_codes’ de provincie Friesland (gebiedsniveaucode=provincie, gebiedscode=2) uitgesplitst naar gemeenten.

https://swing.eu/jive?var=bevtotm&geoitem_codes=provincie_2&geosplit=gemeente

Geolevel(item) from/to

Om bij stroompresentaties de 'van en naar' gebieden te bepalen, kan gebruik worden gemaakt van de parameters 'geolevelfrom' en 'geoitemfrom' om de oorsprong gebiedsniveaus en -items op te geven. Met 'geolevelto' en 'geoitemto' kan je dit voor de doel gebiedsniveaus en -items bepalen.

https://swing.eu/jive?var=bimigra&geolevelfrom=landsdelen&geoitemfrom=1&geoitemto=363&geolevelto=gemeente16&view=mapstream

Favorite/benchmarkitem

Met de parameters ‘favorite’ of ‘benchmarkitem’ is het mogelijk om een favoriet gebied op te geven. Als waarde moet een combinatie van het gebiedsniveau- en de gebiedscode worden opgegeven, verbonden door een underscore teken. Onderstaand voorbeeld toont alle provincies, waarbij Friesland als favoriet gebied is gekenmerkt:

https://swing.eu/jive?var=bevtotm&geolevel=provincie&benchmarkitem=provincie_2

Standaard opent Viewer met een tabelpresentatie. Er zijn echter verschillende parameters om de presentievorm aan te passen.

View

De parameter ‘view’ bepaalt welke presentatievorm in Viewer getoond wordt. Als waarde moet de code van de gewenste presentatievorm opgegeven worden. Deze parameter kan gecombineerd worden met andere parameters, zoals ‘period’, ‘geolevel’ en ‘geoitem’. Voorwaarde is dat de presentatievorm wel gemaakt kan worden met de opgegeven parameters. Zo is bijvoorbeeld een lijngrafiek alleen mogelijk wanneer (met de parameter ‘period’) meer dan één periode wordt opgevraagd en het aantal gebieden beperkt is (maximaal 24).

Met onderstaande URL wordt bijvoorbeeld de presentatievorm staaf (=bar) getoond:

https://swing.eu/jive?var=bevtotm&geolevel=provincie&view=bar

Onderstaande tabel toont de presentatievormen en de bijbehorende codes die als waarde voor de parameter 'view' kunnen worden opgegeven:

De onderstaande URL toont de mannelijke bevolking (var=bevtotm) van het jaar 2014 (period=2014), voor alle provincies (geolevel=provincie), gepresenteerd in een radardiagram (view=radar).

https://swing.eu/jive?var=bevtotm&geolevel=provincie&period=2014&view=radar

Flip_table=true

In Viewer heb je de mogelijkheid om met de knop  een tabel te kantelen. Door middel van de parameter ‘flip_table’ kan dit worden opgegeven in een URL. De waarde moet altijd ‘true’ zijn. Onderstaande URL opent een tabel met het aantal mannen en vrouwen voor alle provincies.

https://swing.eu/jive?var=bevtotm,bevtotv&geolevel=provincie&view=table

Door hieraan de parameter ‘flip_bar’ met waarde '=true' toe te voegen wordt het staafdiagram gekanteld:

https://swing.eu/jive?var=bevtotm,bevtotv&geolevel=provincie&view=table&flip_table=true

Flip_bar=true

In Viewer heb je de mogelijkheid om middels de knop  een staafdiagram te kantelen. Door middel van de parameter ‘flip_bar’ kan dit worden opgegeven in een URL. De waarde moet altijd ‘true’ zijn. Onderstaande URL opent een staafdiagram met het aantal mannen en vrouwen voor alle provincies.

https://swing.eu/jive?var=bevtotm,bevtotv&geolevel=provincie&view=bar

Door hieraan de parameter ‘flip_bar’ met waarde '=true' toe te voegen wordt het staafdiagram gekanteld:

https://swing.eu/jive?var=bevtotm,bevtotv&geolevel=provincie&view=bar&flip_bar=true

Sort & sort_index

Deze twee parameters moeten altijd samen gebruikt worden en zorgen ervoor dat een bepaalde kolom van de presentatievorm tabel gesorteerd wordt. Met ‘sort’ bepaal je de richting (op- of aflopend) en met ‘sort_index’ wordt bepaald welke kolom gesorteerd moet worden.

De parameter ‘sort’ kent twee mogelijke waarden: ‘asc’ voor oplopend sorteren en ‘desc’ voor aflopend sorteren. ‘Sort_index’ bevat de index van de te sorteren kolom. De eerste kolom bevat de onderwerpen of gebieden en kan met 'sort_index=-1' (min één!) gesorteerd worden. De eerste kolom met data kan met 'sort_index=0' gesorteerd worden, de tweede met 'sort_index=1', etc. Met onderstaande URL worden de provincies alfabetisch gesorteerd:

https://swing.eu/jive?var=bevtotm,bevtotv&geolevel=provincie&view=table&sort=asc&sort_index=-1

Directplay

Viewer heeft een functie om presentaties ‘af te spelen’. In het geval een presentatie in Viewer voor verschillende jaren gepresenteerd kan worden dan kunnen alle jaren worden afgespeeld. Met de parameter ‘directplay’ kan deze functie direct worden geactiveerd. Met onderstaande URL worden alle jaren van de presentatie demo6 afgespeeld.

https://swing.eu/Jive?presel_code=demo6&directplay

Presel/presel_code

Presentaties kunnen ook vooraf gedefinieerd zijn. Deze zijn in Studio te vinden onder Weergave > Presentaties. Aan de hand van de codes van deze presentaties kunnen vooraf gedefinieerde presentaties middels een URL worden opgeroepen. Gebruik hiervoor de parameter ‘presel’ of ‘presel_code’. Met onderstaande URL wordt een presentatie met code demo43 opgeroepen:

https://swing.eu/jive?presel=demo43

Rapporten kunnen ook middels een URL direct worden geopend. Aan de URL kunnen parameters voor de gedefinieerde ‘inputs’ (indien van toepassing) worden toegevoegd.

Report

Elk rapport heeft een unieke code die in Studio te vinden is onder 'Weergave' > 'Rapporten'. Deze code moet als waarde worden ingevoerd bij de parameter ‘report’. Het rapport wordt binnen de Viewer interface geopend, dus inclusief themaboom. Met onderstaande URL wordt de rapport met code ‘gemeenteinbeeld’ opgeroepen:

https://swing.eu/jive?report=gemeenteinbeeld

Id

Soms kan het gewenst zijn om het rapport niet in de Viewer interface te openen, dus zonder themaboom. Met onderstaande URL wordt het rapport met de code ‘gemeenteinbeeld’ geopend:

https://swing.eu/jive/report/?id=gemeenteinbeeld

Openinputs=true

Rapporten bevatten vaak een inputscherm waarin perioden en/of (vergelijkings)gebieden kunnen worden geselecteerd. Door gebruik te maken van de parameter 'openinputs' (met de waarde ‘true’) wordt (eerst) het inputscherm automatisch geopend:

https://swing.eu/jive?report=gemeenteinbeeld&openinputs=true

Input_geo

Met het opnemen van een input voor gebieden in een rapport is het voor een gebruiker mogelijk om van een (gekozen) gebiedsniveau één of meerdere gebieden te kiezen waarvoor het rapport wordt opgevraagd. De code die deze input in het rapport heeft kan als parameter worden gebruikt om het rapport direct voor een opgegeven gebied te tonen. In de meeste rapporten is dit ‘input_geo’ of ‘inp_geo’. Als waarde moet een combinatie van het gebiedsniveau en de gebiedscode worden opgegeven, verbonden door een underscore (_) teken.

In onderstaand voorbeeld wordt het rapport ‘gemeenteinbeeld’ direct geopend met de gemeente Den Haag (gebiedsniveaucode= ‘gemeente16’ en gebiedscode=518):

https://swing.eu/jive?report=gemeenteinbeeld&input_geo=gemeente16_518

Workspace_guid

De parameter ‘workspace_guid’ opent een opgeslagen presentatie of werkblad (met meerdere presentaties) aan de hand van een Global Unique Identifier (GUID). De GUID is de waarde die bij deze parameter moet worden gebruikt. Het is de code achter deze parameter in de URL die aangemaakt wordt met de functie ‘Delen via link’ in Viewer:

https://swing.eu/Jive?workspace_guid=28149bfd-2d0a-4d3a-9145-1ea19c0e381c

Lang

Hiermee kan de taalkeuze in Viewer bepaald worden. De interface zal in de opgegeven taal worden getoond. Dit werkt alleen indien de Viewer voorzien is van de (optionele) taalmodule. Neem voor meer informatie contact op met de Swing Helpdesk¹.

Met de volgende URL zal de Viewer openen met de Engelse interface:

https://swing.eu/jive?lang=en

In onderstaande tabel staan de talen die standaard in de taalmodule beschikbaar zijn en de codes van de beschikbare talen die gebruikt moet worden in de URL:

Keepworkspace=true

Hiermee wordt het laatst getoonde werkblad behouden. Indien Viewer afgesloten wordt, worden de werkbladen opgeslagen met behulp van cookies. Als Viewer daarna opnieuw wordt opgestart dan worden de opgeslagen werkbladen opnieuw geopend. Dit gebeurt echter niet als je Viewer opent met behulp van een URL met parameter. Om dit te voorkomen kan gebruik worden gemaakt van de parameter 'keepworkspace', de waarde is altijd ‘true’. De via de URL opgevraagde gegevens worden hierdoor in een nieuw tabblad van het bestaande werkblad geopend.

https://swing.eu/jive?presel=demo43&keepworkspace=true

Loginas

Met deze parameter wordt automatisch het loginscherm van Viewer geopend met de opgegeven naam. Onderstaande URL opent automatisch het loginscherm en vult de naam ‘gebruiker’ in bij het veld ‘Naam’:

https://swing.eu/jive?loginas=gebruiker

Startintro

De selectie-assistent van Viewer begeleidt gebruikers door het selectieproces (onderwerpen > perioden > gebieden) om een presentatie te maken. Met de URL-parameter ‘startintro’ start deze introductie direct.

https://swing.eu/jive?startintro