Property: allowduplicatetv

Yes if the tagged values may be duplicated, recording several values

Waarde: yes|no, type: string, verplicht: true, default: (geen)

Module: XmiTranslator (XmiTranslator parameters)

In de modellen mogen op dezelfde construct al dan niet dezelfde tagged values meermaals voorkomen.

Property: allowemptymodel

Yes if the model or any model domain may be empty; this is feasible in development phases

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: Validator (Validator parameters)

Onder specifieke omstandigheden is het toegestaaan een leeg model aan te bieden. Dit kan bijvoorbeeld wanneer je wilt forceren dat de respec documentatie (via de documentor module, zie createoffice) wordt gegenereerd terwijl er nog geen informatiemodel (en catalogus) beschikbaar is.

Hou er rekening mee dat het aanbieden van een leeg informatiemodel kan betekenen dat bepaalde Imvertor modulen falen, omdat deze expliciet zijn ingericht op minimaal één domein en één objecttype.

Property: allowmultiplesuppliers

Allow any construct to have multiple suppliers

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: common (Standard initial parameters)

Het kan zijn dat een constructie is afgeleid van meerdere supplier-constructies. In dat geval moet deze parameter worden gezet. De validatie van de afleiding zal dit anders melden:

Multiple suppliers found

Property: apcfile

Path to the application specific configuration Excel file

Waarde: path, type: string, verplicht: false, default: (geen)

Module: ApcModifier (Application configuration modifier)

An APC file is an excel file holding applicatie specific configuration information. Specify the apc file using this property.

Property: application

Name of the application, i.e. root package in UML

Waarde: name, type: string, verplicht: true, default: (geen)

Module: common (Standard initial parameters)

Een model wordt in Imvertor een application genoemd. De naam van het model wordt hier meegegeven.

In de Imvertor SaasS geef jij zelf deze naam niet mee, dat doet de add-in voor je op bais van het gekozen model dat je publiceert.

Property: arguments

Path to the file holding (additional) arguments (in the form key = value)

Waarde: filepath, type: file, verplicht: false, default: (geen)

Module: common (Standard initial parameters)

Een lijst van properties in een bestand kan worden doorgegeven middels de arguments property. Deze bestandnaam moet absoluut zijn (hele pad). De properties in het bestand worden gelezen op de plek waar de arguments property is aangetroffen.

Alle properties die ná eerdere properties worden gelezen, worden als geldend opgevat. Dus je kunt eerdere properties op deze manier overschrijven.

Property: assocbyreference

Associations to an objecttype/featuretype must be realized "by reference" in ISO 19136 XML instances

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Context: XSD compiler for ISO 19136 schemas

Module: XsdCompiler (XML schema compiler)

In de XML schema compiler kan een relatie (met een Objecttype e.d.) worden vormgegeven door middel van een “by reference” link. Kies hiervoor met deze property op yes. NB de link wordt gerealiseerd middels een xlink:href zoals deze is opgenomen in een AssociationAttributeGroup van het GML schema.

Als deze op no wordt gezet wordt ervanuit uitgegaan dat het element wordt opgenomen op de plek waar de relatie is gemaakt. De mogelijkheid om via xlink:href te verwijzen blijft beschikbaar.

Property: attributeisqualified

The XML schema attributes are qualified. Defaults to No.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Moet de XML schema’s van de VNG Open API module voor <xsd attributeFormDefault=> de waarde qualified hebben? Zet dat hier.

Property: buildcollection

Yes if collections (and referencing) are used, no if referencing is not used

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

In het samenstellen van een XML schema conform de regels van het Kadaster, geeft aan of automatisch een collection class moet worden samengesteld of dat kan worden aangenomen dat dit door de analist is gedaan.

Property: chop

Yes if all references to classes/datatypes outside the application should be removed

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: ImvertCompiler (Imvert compiler)

Referenties naar constructies (Objecttypen etc.) buiten het informatiemodel moeten worden begrepen door Imvertor, met name doordat het voorkomt in een conceptual schema. Als dit in een bepaald fase van de ontwikkeling van het model niet het geval is of kan zijn, kun je aangeven dat die referentie gewoon weggelaten mag worden uit het model. Dat geef je hier aan.

Deze property moet bij productie modellen altijd op no staan.

Property: cleanupschemas

Yes if schemas should be indented and cleared of insignificant whitespace

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Geef aan of XML schema’s moeten worden worden “pretty printed”, om de leesbaarheid te bevorderen.

Property: codelistoption

The codelist option to apply in the ISO19136 schema.

Waarde: Name, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Er zijn meerde manieren waarop codelists kunnen worden weergegeven in ISO 19136 schema’s. Die opties zijn benoemd als (waarde is:) option1, option2 of option3:

• Option1: In de GML wordt de waarde uit de waardelijst als string opgenomen en optioneel ook de URL van de waardelijst.

• Option2: In de GML wordt de waarde uit de waardelijst als string opgenomen en de URL van de waardelijst. De URI van de waardelijst wordt tevens opgenomen in XSD.

• Option3: In de GML wordt de waarde uit de waardelijst als URI opgenomen en optioneel de waarde uit de waardelijst als string.

Voor alle 3 de opties geldt dat de naam en de URI van de waardelijst in de XSD in een <appinfo> blokje wordt opgenomen.

Voorbeelden van XSD encoding van opties 1, 2 en 3:

Optie 1:

<element name="typeWeg" type="gml:ReferenceType" maxOccurs="unbounded">
  <annotation>
    <appinfo>
      <TOP10NL:CodeListName>T10WegTypeWegWaarde</TOP10NL:CodeListName>
      <TOP10NL:CodeListURI>https://brt.basisregistraties.overheid.nl/
         top10nl/id/collectie/Wegdeel</TOP10NL:CodeListURI>
    </appinfo>
  </annotation>
</element>

Optie 2:

<element name="typeWeg" type="gml:CodeType">
  <annotation>
    <appinfo>
      <TOP10NL:CodeListName>T10WegTypeWegWaarde</TOP10NL:CodeListName>
      <TOP10NL:CodeListURI>https://brt.basisregistraties.overheid.nl/
         top10nl/id/collectie/Wegdeel</TOP10NL:CodeListURI>
    </appinfo>
  </annotation>
</element>

• Optie 3:

<element name="typeWeg" type="brt:typeWegType"> <annotation>
    <appinfo>
      <TOP10NL:CodeListName>T10WegTypeWegWaarde</TOP10NL:CodeListName>
      <TOP10NL:CodeListURI>https://brt.basisregistraties.overheid.nl/ 
          top10nl/id/collectie/Wegdeel</TOP10NL:CodeListURI>
    </appinfo>
  </annotation>
</element>
<complexType name="brt:typeWegType">
 <simpleContent>
    <restriction base="gml:CodeWithAuthorityType">
      <attribute name="codeSpace" type="anyURI" use="required"
         fixed="https://brt.basisregistraties.overheid.nl/
                top10nl/id/collectie/Wegdeel">
    </restriction>
 </simpleContent>
</complexType >

Download eventueel het document met uitgebreidere beschrijving uit 2018.

Property: compare

Compare the model to the supplier, a release, or do not compare.

Waarde: supplier|release|none, type: string, verplicht: false, default: (geen)

Module: ReleaseComparer (Release comparer)

Hiermee geeft u aan dat er een vergelijking moet worden uitgevoerd. De doorgegeven waarde geeft het type vergelijking aan dat is gemaakt.

Mogelijke waarden zijn:

• supplier: vergelijkt deze klant UML met de supplier UML.

• release: vergelijkt deze release met een eerdere release. Vereist comparewith property met een waarde.

• geen. Standaard, niet vergelijken.

Vergelijkingsresultaten worden weergegeven in de documentatie, sectie Releasevergelijking (# verschillen).

Voorbeeld:

compare = supplier

Property: comparekey

Assume the same construct has the same name, or the same ID.

Waarde: id|name, type: string, verplicht: false, default: (geen)

Module: ReleaseComparer (Release comparer)

Bepaal de identiteit van twee vergeleken constructies. Geef id op wanneer constructen dezelfde ID moeten hebben in de vergeleken releases; anders name, in welk geval de namen als gelijk worden beschouwd.

Voorbeeld:

compare = supplier
comparekey = name

Houd er rekening mee dat suppliers nooit dezelfde ID's hebben als de client. We kunnen alleen maar aannemen dat namen hetzelfde (kunnen) zijn.

Property: comparemethod

Specify a name of a known compare method or "default". Currently known methods are: "xmldiff" and "xmlunit".

Waarde: name, type: string, verplicht: false, default: (geen)

Module: ReleaseComparer (Release comparer)

Deze parameter is effectief vervallen.

TODO verwijderen uit de code. https://github.com/Imvertor/Imvertor-Maven/issues/560

Property: comparerules

The name of the file recording the rules for comparison.

Waarde: name, type: string, verplicht: false, default: (geen)

Module: ReleaseComparer (Release comparer)

Geeft aan welke regels moeten worden toegepast bij het vergelijken van releases. Dit is een naam die overeenkomt met een geconfigureerd bestand (binnen de map met vergelijkingsregels), dat de specificatie bevat van welke elementen in de vergelijking moeten worden weergegeven, en hun toelichting.

Dit is een technische property en mag alleen worden gewijzigd door een systeembeheerder.

Voorbeeld:

comparerules = kadaster

Property: comparewith

Compare the new model to the same model released at the specified date.

Waarde: YYYYMMDD, type: string, verplicht: false, default: (geen)

Module: ReleaseComparer (Release comparer)

Vergelijk het nieuwe model met hetzelfde model dat op de opgegeven datum is uitgebracht. De datum moet de vorm JJJJMMDD hebben (zoals elke release).

Voorbeeld:

compare = release
comparewith = 20160301

Property: contactemail

The email address for support on the (form of the) distributed release

Waarde: email-address, type: string, verplicht: false, default: (geen)

Module: ReadmeCompiler (Readme compiler)

Een model kan een specifiek project of een specifieke analist als eigenaar hebben. In dat geval kan via deze property het email adres worden opgegeven. Dit adres keert terug in het readme.html file dat in de root van de release ZIP file staat.

Property: contacturl

The URL for support on the (form of the) distributed release

Waarde: url, type: string, verplicht: false, default: (geen)

Module: ReadmeCompiler (Readme compiler)

Een model kan een specifiek project of een specifieke analist als eigenaar hebben. In dat geval kan via deze property een URL voor meer informatie over de eigenaar worden opgegeven. Deze URL keert terug in het readme.html file dat in de root van de release ZIP file staat.

Property: copyxmi

Yes if the XMI file must be copied to the result folder.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XmiCompiler (XmiCompiler parameters)

Geef aan of de XMI waaroip de Imvertor run is gebaseerd ook moet worden gekopieerd naar de release ZIP file.

Property: createcomplyexcel

Yes if a compliancy Excel should be generated for this application

Waarde: yes|no, type: string, verplicht: true, default: (geen)

Module: ComplyCompiler (Compliancy Excel compiler)

Heef aan of een compliancy excel moet worden samengesteld voor dit model.

TODO status van compliancy? https://github.com/Imvertor/Imvertor-Maven/issues/561

Property: createcvafile

Yes if CVA files must be generated

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

TODO deze parameter heeft geen functie meer, verwijderen. https://github.com/Imvertor/Imvertor-Maven/issues/560

Property: createderivedeap

Yes if an full representation of all derived information should be created. If EAP provided, return full EA project. If XMI provided, return adapted XMI.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: EapCompiler (EapCompiler parameters)

Geef aan of een EA import bestand moet worden samengesteld dat als basis kan dienen voor een van dit model afgeleid model. Dit is een XMI bestand dat kan worden geimporteerd náást het oorspronkelijke informatiemodel. Let op dat het afgeleide model ook zal verwijzen naar exact dezelfde externe constructies. Het is dus niet altijd voldoende om het bestand te importeren in een “leeg” EA bestand.

Property: createeaprofile

Should an EA profile be generated?

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: ConfigCompiler (Configuration compiler)

Geef Ja op als er een EA-profiel moet worden gegenereerd.

Het resultaatprofiel wordt in /etc geplaatst als *.ea-profile.xml. De naam is vooraf geconfigureerd voor dit metamodel.

Property: createeatoolbox

Should an EA toolbox be generated?

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: ConfigCompiler (Configuration compiler)

Als je wilt dat een EA toolbox wordt mee-gegenereerd met de rest van de producten geef je dit met deze property aan.

Property: creategmlprofile

Generate a GML profile for the model from XSD files configured. Only avaiable for GML 3.2.2.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Als je wilt dat een GML profiel wordt gegenereerd voor het opgeleverde XML schema, dan geef je dit met deze property aan. Dit profiel is een subset van een GML 3.2.2 schema, dat alleen de constructies bevat waar daadwerkelijk naar wordt verwezen vanuit het XML schema.

Property: createhistory

Yes if history info should be read from Excel file

Waarde: yes|no, type: string, verplicht: true, default: (geen)

Module: HistoryCompiler (History compiler)

Je kunt bij een Imvertor run een Excel file meeleveren waarin de verschiegeschiedenis van het model is opgenomen. Het file heeft een specifieke opbouw en wordt uitgelezen, zo dat in het rapport (doc folder) een voor dit model geldende geschiedenis wordt samengesteld.

Property: createimagemap

Specify if an image map should be compiled.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XmiCompiler (XmiCompiler parameters)

Geef aan of een imagemap voor diagrammen in de documentatie moet worden opgenomen. Hiermee worden diagrammen klikbaar in de Respec documentatie, waarmee wordt gesprongen naar de passage in de catalogus waar die construct wordt beschreven.

Property: createjsonconcepts

Yes if JSON concepts must be generated

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: JsonConceptsCompiler (JSON schema compiler)

Geef aan of een lijst van concepten in JSon vorm moet worden gegenereerd. Deze definitie komen terecht in de NEN3610 conceptenbibliotheek http://definities.geostandaarden.nl/.

Property: createjsonschema

Yes if JSON schema must be generated

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: JsonSchemaCompiler (JSON schema compiler)

Genereer een Json schema vanuit dit informatiemodel. Dit kan alleen als voor deze eigenaar een configuratie is ingericht op het genereren van Json schema’s.

Het Json schema zal voldoen aan Best Practice for OGC - UML to JSON Encoding Rules.

Property: createjsonschemavariant

The name of the variant of the JSON schema generated

Waarde: name, type: string, verplicht: false, default: (geen)

Module: JsonSchemaCompiler (JSON schema compiler)

Json schemas kunnen in allerlei vormen worden samengesteld: plain, jsonfg, of geojson, met specifieke keuzes die zijn beschreven in Best Practice for OGC - UML to JSON Encoding Rules, met name requirements classes die daarin zijn opgenomen. Maak hier een keuze voor een van deze varianten.

De json schema varianten zijn opgenomen als files met de naam JSON-* in folder /resources/input/[owner]/cfg/schemarules in Imvertor OS.

Property: createld

Yes if Linked Data Turtle must be generated

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: LDCompiler (Linked Data compiler)

Geef aan of een Linked data (turtle) file moet worden gegenereerd. De specificaties hiervoor zijn voor en door het Kadaster opgesteld.

Property: createmimformat

Yes if MIM format must be generated

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: MIMCompiler (MIM format compiler)

Geef Yes als je een MIM formaat serialisatie wilt laten samenstellen. MIM formaat is een weergave in XML van de MIM structuur van het informatiemodel.

Het resultaat wordt geplaat in de folder ./mim. Binnen deze folder wordt ook het XML schema ingekopieerd welke de opbuw van het MIM serialisatie document beschrijft.

Er zijn meerdere vormen die kunnen worden gegenereerd, afhankelijk van de parameter mimformattype. De naam van het resuiltaat bestand is opgenomen als parameter mimformatname.

Property: createoffice

Create a documentation file in plain HTML, MsWord, or Respec format. By default, create none.

Waarde: html | none, type: string, verplicht: false, default: (geen)

Module: OfficeCompiler (Office compiler)

Geef aan of je wilt dat catalogus documentatie moet worden gegenereerd in HTML. De waarden kunnen zijn: html (wel documentatie) en none (geen documentatie).

TODO parameter waarde doc verwijderen.

Property: createofficeanchor

Hyperlink anchors should be IDs (PDF) or based on actual names (HTML).

Waarde: name|id, type: string, verplicht: false, default: (geen)

Module: OfficeCompiler (Office compiler)

Moeten de referenties die in de catalogus documentatie worden opgenomen gebaseerd zijn op de EA identifiers (id), of op formele namen (name)? Wanneer de vorm van de referenties (URL’s) liever geen onherkenbare identifiers moet bevatten, kies dan voor name.

Property: createofficemode

When creating office, use plain or clickable mode.

Waarde: plain|click, type: string, verplicht: false, default: (geen)

Module: OfficeCompiler (Office compiler)

Moeten in de catalogus documentatie referenties (klikbare links) worden geplaatst tussen constructies? Bijvoorbeeld: het type van een attribuut is niet alleen weergegeven met naam, maar die naam is ook klikbaar.

Property: createofficevariant

Specify the type of office file. Multiple formats are allowed, separate list by whitespace.

Waarde: msword | respec | documentor, type: string, verplicht: When createoffice is set to html, default: (geen)

Module: OfficeCompiler (Office compiler)

Geef aan welk type HTML catalogus documentatie je wilt samenstellen. Mogelijkheden zijn msword (geschikt voor import in MsWord), respec (de catalogus kan worden ingevoegd in een HTML omgeving), of documentor (de catalogus in respec formaat, met náást de catalogus ook hoofdstukken vanuit aangeleverde MsWord bestanden).

• Msword: in dit geval kan worden aangesloten bij BRO dat een template document heeft met macro, waarmee de opgeleverde en geïmporteerde HTML kan worden gestroomlijnd ten behoeve van bijvoorbeeld PDF exports.

• Respec: veelal wordt de catalogus dan geüpload naar GIThub waar vervolgens de complete Respec dolcumentatie wordt samengesteld op basis van HTML en markdown bestanden. Dit is de aanpak van Geonovum.

• Documentor: sinds versie Imvertor 5.0 is het mogelijk MsWord bestanden mee te leveren die samen met de catalogus een complete documentatie opleveren. Dit is de aanpak van o.a. Waarderingskamer en BIJ12. Zie daarvoor https://armatiek.nl/doc/imvertor/documentor.

Documentor kan actief worden gemaakt als de createofficevariant is gezet op documentor, als de configuratie compleet is (/docrules/documentor), en als de benodigde MsWord bestanden zijn aangeleverd.

Property: createshacl

Yes if SHACL RDF must be generated

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: ShaclCompiler (SHACL compiler)

Gef aan of je een Shacl schema representatie van het model wilt generereren. Deze Shacl variant is ontwikkeld door het Kadaster en is verouderd. Een nieuwe Shacl versie is in ontwikkeling.

Property: createskos

Yes if SKOS RDF must be generated

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: SkosCompiler (SKOS compiler)

Geef aan of je een SKOS representatie van informatie in dit model wilt genereren.

Property: createstccsv

Yes if Stelselcatalogus CSV must be generated

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: StcCompiler (Stelselcatalogus CSV compiler)

Wil je een CSV formaat genereren dat kan worden aangeleverd aan de stelsecatalogus?

Property: createtemplate

Yes if an EAP template should be created for this application. If EAP provided, return template EAP. If XMI provided, return template XMI.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: EapCompiler (EapCompiler parameters)

Geef aan of je een EA template file wilt genereren. Dit is een sjabloon in XMI dat als startpunt kan worden gebruikt voor verdere verwerking van dit model.

TODO vaststellen of dit nog gebruikt wordt en relatie met afgeleide modellen bepalen. https://github.com/Imvertor/Imvertor-Maven/issues/561

Property: createumlreport

(Deprecated) Yes if an UML report should be created. Only applicable for EA enabled environments.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: EapCompiler (EapCompiler parameters)

TODO verwijderen. https://github.com/Imvertor/Imvertor-Maven/issues/561

Property: createxmlschema

Yes if XML schemas must be generated

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Geef aan of je wilt dat een XML schema wordt samengesteld op basis van dit model. Aanname is dat het model een logisch karaketer heeft, dus dat de constructies, namen en relaties alszodanig kunnen worden gebruikt als uitgangspunt voor het schema.

Property: createxmlschemavariant

The name of the variant of the XML schema generated

Waarde: name, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Geef de naam op van een schema variant. In Imvertor OS 4.2 zijn alleen de volgende varianten beschikbaar:

• Kadaster, dit is een vorm die kadaster hanteert in haar XML uitwisselingen

• ISO19136, dit is een vorm die ISO 19136 volgt, en vooral door Geonovum wordt gebruikt.

Property: createyaml

Yes if YAML must be generated

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: YamlCompiler (YAML compiler)

Geef aan of Yaml conform de VNG implementatie van Open API moet worden gegenereerd.

TODO Er wordt gewerkt aan een stroomlijning van de code en deze parameter kan worden vervangen.

Property: createziprelease

Yes if the released application should be zipped for distribution

Waarde: yes|no, type: string, verplicht: true, default: (geen)

Module: ReleaseCompiler (Release compiler)

Geef aan of je een ZIP file wilt maken waarin de complete release (alle eindproducten op basis van dit model) een plek hebben gekregen. Deze waarde is de de Imvertor SaaS altijd yes en kan niet worden overschreven.

Property: dashboardpath

The path to the Imvertor dashboard application.

Waarde: http-path, type: string, verplicht: true, default: (geen)

Module: common (Standard initial parameters)

TODO verwijderen uit Imvertor OS. https://github.com/Imvertor/Imvertor-Maven/issues/560

Property: debug

Yes if run in debug mode

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: common (Standard initial parameters)

Geef aan of je wilt dat debugging op de code moet worden geactiveerd. Als yes, dan worden alle meldingen die onder de opgegeven debugmode vallen ingevoegd en/of getoond. In productieversies moet deze mode uitstaan (no).

Property: debugmode

If debug=yes, then the debug mode must be any of the codes specified between ";". The main chain is "CHAIN".

Waarde: CODE, type: string, verplicht: false, default: (geen)

Module: common (Standard initial parameters)

Er zijn meerdere debug modes die kunnen worden geactiveerd. Deze namen, alle in hoofdletters, kunnen worden meegegeven in de debugmode; deze codes worden gescheiden door punt-komma. Voorbeelden zijn EP, MIMCOMPILER, SKOS, maar ook CHAIN waarin alle stappen die worden gemaakt worden gelogd.

Deze property wordt typisch in code ontwikkelfase gezet. Het kan zijn dat een ontwikkelaar je vraagt deze property tijdelijk een waarde te geven en het resultaat van de run (de job ID of het ZIP bestand) naar haar/hem terug te sturen.

Property: derivedoc

Yes if derivation of documentation is required

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: ImvertCompiler (Imvert compiler)

Wanneer twee modellen van elkaar zijn afgeleid wordt verondersteld dat bepaalde eigenschappen in het afgeleide bestand (de client) overeenkomstig zijn met het supplier bestand. De waarden van het supplier bestand (bijvoorbeeld: een overkoepelend “basis”-model waar afzonderlijke productmodellen van zijn afgeleid) kunnen worden ingevoegd in de documentatie van dat afgeleide model. Geef aan of je dit wenst (yes).

Property: docrelease

If supplied, this is a documentation release with specified release date

Waarde: YYYYMMDD, type: string, verplicht: false, default: (geen)

Module: common (Standard initial parameters)

Geef aan dat de release van dit model feitelijk een documentatie release is. Dat betekent dat het model zelf niet is veranderd, maar dat de documentatie daarvan (definities, toelichtingen etc.) is aangepast. Je geeft de datum mee van de documentatie release; de oorspronkelijke (model-)release datum blijft beschikbaar.

TODO bepaal waar deze property invloed op heeft. Check system/documentation-release.

Property: docrules

The name of the file holding the documentation rules. If omitted, assume metamodel name and version as extracted from the supplied model.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: OfficeCompiler (Office compiler)

Geef de naam op van het bestand met de documentatie regels. Dat bestand moet zijn opgenomen in de configuratie /input/[ownernaam]/cfg/docrules.

Wanneer geen naam is opgegeven wordt een naam samengesteld op basis van de nam van de owner, naam van het metamodel, de minor versie van het metamodel, de naam van de extensie op het metamodel, en een eventuele versie van die extensie. Voorbeeld: Armatiek-MIM-12-CONCEPTUAL.

Wanneer deze opgegeven naam niet als XML bestand voorkomt duidt dit op een configuratiefout, vraag je contactpersoon om dit te (laten) herstellen.

Property: documentorfile

Path to the folder or zipfile holding the Documentor files, i.e. MsWord files and binaries used to create full Respec documentation.

Waarde: filepath, type: file, verplicht: false, default: (geen)

Module: OfficeCompiler (Office compiler)

Geef een pad op naar de modeldoc info die nodig is om de Respec documentatie via Documentor samen te stellen. Het betreft hier MsWord documenten, plaatjes, en andere bestanden die tesamen de documentatie vormen. Dit is uitgelegd in https://armatiek.nl/doc/imvertor/documentor.

Let op: het documentorfile pad kan een pad naar een folder betreffen, of een ZIP file. Beide moeten de juiste opbouw hebben, namelijk starten met een modeldoc folder, en eventueel een sections folder.

Property: elementisqualified

The XML schema elements are qualified. Defaults to Yes.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Moet de XML schema’s van de VNG Open API module voor <xsd elementFormDefault=> de waarde qualified hebben? Zet dat hier.

Property: endproductbaseconfig

Name of the Excel file holding the base product configuration

Waarde: File name, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Property: externalurl

Yes if external schemas must be referened by URL

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Wanneer een extern XML schema onderdeel is van het gegenereerde schema, dan kan dat externe XML schema via een URL worden binnengehaald (yes), of kan worden verwezen naar een lokale kopie (no).

Property: flattenschemas

Yes if schemas should also be flattened

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

TODO nagaan of it nog gebruikt wordt (kadaster) https://github.com/Imvertor/Imvertor-Maven/issues/560

Property: forcecompile

Force a compile and ignore possible errors

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: common (Standard initial parameters)

Forceer dat bij het aflopen van de verschillende stappen in het Imvertor proces niet wordt gestopt als er fouten optreden. Als no, dan stopt Imvertor OS met het verwerken van de opdrachten als een fout is aangetroffen. Als yes, dan probeert Imvertor tóch door te gaan. Dat kan betekenen dat het hele proces niet netjes kan worden afgerond; gebruik deze waarde dus alleen in testomgevingen.

Property: forcenillable

Force all properties in the resulting schema to be nillable.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Zorg ervoor dat alle attributen en relaties in het XML schema nillable zijn. Dit geldt voor Kadaster en ISO19136 schema’s.

Property: fullrespec

Should a full respec version be generated along with the catalog?

Waarde: yes|no, type: string, verplicht: , default: no

Module: OfficeCompiler (Office compiler)

Maak een Respec document aan. Dat wil zeggen: het heeft een kop, table of contents, en andere voor Respec herkenbare eigenschappen. Wanneer documentor actief is gemaakt, dan volgt dat bestand de weergave zoals ingericht voor de owner. Wanneer documentor niet actief is, dan krijgt dit een rudimentaire vorm onder W3C logo.

Documentor kan actief worden gemaakt als de createofficevariant is gezet op documentor, als de configuratie compleet is (/docrules/documentor), en als de benodigde MsWord bestanden zijn aangeleverd.

Property: gitcfg

Name of the GIT configuration used by Imvertor to gain access to the GIT repository. The name must have been configured in the server.

Waarde: name, type: string, verplicht: When officepass is set to "git", default: (geen)

Module: OfficeCompiler (Office compiler)

TODO andere manier doen; moet eigenlijk via configuratie

Property: gitcomment

Description to pass as comment when committing to GIT.

Waarde: string, type: string, verplicht: When officepass is set to "git", default: (geen)

Module: OfficeCompiler (Office compiler)

TODO andere manier doen; moet eigenlijk via configuratie

Property: gitpath

Subpath to the remote GIT repository, starting with / e.g. /MyOrganization/MyRepository

Waarde: path, type: string, verplicht: When officepass is set to "git", default: (geen)

Module: OfficeCompiler (Office compiler)

TODO andere manier doen; moet eigenlijk via configuratie

Property: giturl

URL of the Github IO (pages) location

Waarde: URL, type: string, verplicht: When officepass is set to "git", default: (geen)

Module: OfficeCompiler (Office compiler)

TODO andere manier doen; moet eigenlijk via configuratie

Property: gmlprofilename

Name of the GML profile XSD file. You may use [...] parameters. Defaults to "[owner]-gml".

Waarde: template, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Geef de naam van het bestand met het GML profiel dat wordt gegeneeerd. Dit bestand wordt samengesteld als property creategmlprofile op yes is gezet.

Property: gmlprofileversion

Version of the GML profile XSD file. You may use [...] parameters. Defaults to "1.0.0-3.2.2".

Waarde: template, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Geef de versie van het bestand met het GML profiel dat wordt gegeneeerd. Dit bestand wordt samengesteld als property creategmlprofile op yes is gezet.

Property: gmlversion

The GML version to be used for ISO19136 schemas. Example: "3.3".

Waarde: version nr, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Geef aan welke versie van GML gewenst is bij het samenstellen van XML schema’s waarin GML wordt gebruikt. De GML versie moet zijn geconfigureerd op de server.

Property: help

Print program help and copyright/license info for this application

Waarde: program|license, type: string, verplicht: false, default: (geen)

Module: common (Standard initial parameters)

Toon alle properties en korte informatie daarover. Toon ook info over de licentie waaronder Imvertor OS gebruikt wordt.

Property: hisfile

Path to the input xls history file

Waarde: filepath, type: file, verplicht: false, default: (geen)

Module: HistoryCompiler (History compiler)

Gef aan waar je historie bestand is opgenomen. Dit is alleen nodig als createhistory de waarde yes heeft.

Property: identifier

A unique identifier for this application. The report is stored in the outfolder by this name. Typical use: the RUN ID.

Waarde: String, type: string, verplicht: false, default: (geen)

Module: RegressionExtractor (Regression extractor)

Property: identifierdomains

Generate schemas with IDs with domains. This parameter applies to Kadaster schemas.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Deze parameter wordt gezet voor het genereren van Kadaster schema’s. Hierin wordt een referentie element gebruikt als plaatsvervanger (of link) van een identificeerbaar objecttype.

Een referentie bestaat uit:

1. identifier van het gerefereerde objecttype. Voorbeeld: 19818112

2. naamruimte (of domein) van deze identifier. Voorbeeld: NL.IMKAD.KadastraalObject

3. Interne link naar de XML representatie van dat objecttype in het document. Voorbeeld: #KO-19818112

Wanneer identifierdomains is gezet op yes, dan wordt het domein van de identifier uitgelezen en gebruikt in de link. Dit domein is een taggd value Domein op het identificerende attribuut. Dit attribuut is dan in het model zelf gemarkeerd als Is ID.

De domein toevoeging wordt dus alleen gemaakt als 1/ attribuut is ID, én 2/ Domein tagged value is gezet, én parameter identifierdomains = yes.

Het XSD resultaat is in dat geval, bijvoorbeeld:

Supertypen die geen identifier declareren krijgen wel een domein, maar dat is vrij in te vullen:

Subtypen krijgen het domein mee van het supertype:

Property: includedoclist

Yes if codelists and reference lists that have a location must be read dynamically from that location and included in the model documentation.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: OfficeCompiler (Office compiler)

Bij het samenstellen van documentatie kun je besluiten ook de lijstwaarden uit te lezen uit een externe bron. Die is aangegeven in de tagged value Locatie. De lijstwaarden worden dan integraal onderdeel van de documentatie, het betreft dus een soort “snapshot” in tijd.

Als de parameter includedoclist op “yes” staat wordt de lijst uitgelezen. De waarde in de tagged value kan in dat geval drie vormen aannemen:

• URL met xml extensie. In dit geval wordt de URL volledig uitgelezen.

• URL zonder xml extensie. In dit geval wordt de URL teruggebracht tot de naam achter de laatste “/”, en geldt de aanpak onder “Naam”.

• Naam. In dit geval wordt gekeken naar de “owner configuratie” voor doclist-xml-url. Dit is een “sjabloon” waarin de aangetroffen waarde kan worden ingevoegd.

Een voorbeeld van die laatste optie is:

doclist-xml-url  = https://raw.githubusercontent.com/BROprogramma/[appinfo/model-abbreviation]/gh-pages/lists/[temp/latest-list-key].xml

Als het model de afkorting EPL heeft, en als de lijst TV Locatie de waarde GeologischeEenheid, dan wordt de waardenlijst uitgelezen vanuit:

https://raw.githubusercontent.com/BROprogramma/EPL/gh-pages/lists/GeologischeEenheid.xml

Het is in het algemeen beter te verwijzen naar de waardenlijsten op basis van hun naam. Dit, omdat internet locaties veranderen en dit technische locaties zijn, terwijl de bedoeling is in de tagged value slechts een “hint” te geven van waar betreffende informatie te vinden is. Het model zou waar mogelijk techniek-vrij moeten blijven. Het verplaatsen van de internet locatie (server) heeft in dat laatste geval dan ook geen effect op de inhoud van de modellen.

Property: includemodelinfo

Yes if model info should be included as part of the catalog.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: OfficeCompiler (Office compiler)

Bij het samenstellen van de catalogus / documentatie kun je besluiten de metadata van het model zelf (definitie, herkomst e.d.) op te nemen, en de domeinen/views daarbinnen. Zet de waarde dan op Yes.

Property: jobid

An ID for this particular run of Imvertor

Waarde: ID, type: string, verplicht: true, default: (geen)

Module: common (Standard initial parameters)

Dit is de unieke naam van de “job”, dwz. één aanroep van Imvertor OS. Deze wordt in de Imvertor SaaS context automatisch samengesteld en heeft de vorm van een datum-tijd string, zoals 2024-10-28-12-35-06-395.

Deze ID kan altijd (en bij voorkeur) worden gebruikt voor communicatie met technische ondersteuning bij het verwerken van modellen.

Property: jsonconceptsname

The name of the JSON concepts file generated

Waarde: string, type: string, verplicht: false, default: (geen)

Module: JsonConceptsCompiler (JSON schema compiler)

Geef de naam op van het resultaat Json concepts file. Dit is nodig als de property createjsonconcepts de waarde yes heeft.

Property: jsonschemaname

The name of the json schema generated

Waarde: string, type: string, verplicht: false, default: (geen)

Module: JsonSchemaCompiler (JSON schema compiler)

Geef de naam op van het resultaat Json schema. Dit is nodig als de property createjsonschema de waarde yes heeft.

Property: jsonschemasource

This is MIM or any other source. If MIM (default), Json schemas are based on a MIM serialisation.

Waarde: string, type: string, verplicht: false, default: (geen)

Module: JsonSchemaCompiler (JSON schema compiler)

Geef aan dat de bron van de Json schema compiler een MIM serialisatie is, of een andere serialisatie. Op dit moment is alleen MIM ondersteund. Dit is nodig als de property createjsonschema de waarde yes heeft.

Property: language

Language of the metamodel and model. Specify metamodel:model, like "en:nl", or single code for both.

Waarde: ISO 639-1 codes, type: string, verplicht: false, default: (geen)

Module: common (Standard initial parameters)

Geef de taal op van het model. Dat is een combinatie van metamodel (o.a. de keuze van taal voor namen van stereotypen en tagged values) en model (de keuze voor de namen van de gemodelleerde constructies en de notities e.d.).

Property: ldrules

The name of the Linked Data rules file

Waarde: name, type: string, verplicht: false, default: (geen)

Module: LDCompiler (Linked Data compiler)

TODO komt dit te vervallen? Zie ook createld. De parameter lijkt niet effectief te worden gebruikt. https://github.com/Imvertor/Imvertor-Maven/issues/560

Property: mapping

Name of a mapping to be used for conceptual schemas

Waarde: name, type: string, verplicht: false, default: (geen)

Module: ImvertCompiler (Imvert compiler)

Geef de naam op van de conceptual schema mapping die moet worden toegepast.

Mappings zijn onderdeel van de methodiek om externe definities van constructies (zoals GML of MIM datatypen) op te nemen in je eigen documentatie of schema’s. Zie elders voor een uitleg.

Property: maxreport

Max number of differences reported.

Waarde: Integer, type: string, verplicht: true, default: (geen)

Module: RegressionExtractor (Regression extractor)

Geef aan hoeveel verschillen tussen twee modellen er moeten worden gerapporteerd.

Property: messagecollapsekeys

If similar messages should be collapsed, provide a space-separated list of keys for these types of messages.

Waarde: name(s), type: string, verplicht: false, default: (geen)

Module: common (Standard initial parameters)

Sommige fouten of waarschuwingen komen héél veel voor, maar hebben alle dezelfde vorm. Deze fouten kunnen worden samengevoegd onder één noemer, zodat het zicht op andere meldingen niet wordt weggenomen. De “keys” voor deze meldingen kunnen worden opgegeven, met spaties gescheiden.

TODO nagaan of deze wel correct worden uitgelezen i.c.m. de parameter message-collapse-keys.

Property: messagelevel

Set the message level to error (no warnings) or warning (errors and warnings)

Waarde: warning|error, type: string, verplicht: false, default: (geen)

Module: common (Standard initial parameters)

Geef aan of je in de log alleen errors wilt zien (error) of ook alle waarschuwingen (warning).

Property: metamodel

Name of metamodel used in UML model. If omitted, assume metamodel name and version as extracted from the supplied model.

Waarde: name, type: string, verplicht: true, default: (geen)

Module: common (Standard initial parameters)

Geef de naam op van het bestand met de eigenschappen van het gebruikte metamodel. Dat bestand moet zijn opgenomen in de configuratie /input/[ownernaam]/cfg/metamodels.

Wanneer geen naam is opgegeven wordt een naam samengesteld op basis van de nam van de owner, naam van het metamodel, de major versie van het metamodel, de naam van de extensie op het metamodel, en een eventuele versie van die extensie. Voorbeeld: Armatiek-MIM-1-CONCEPTUAL.

Wanneer deze opgegeven naam niet als XML bestand voorkomt duidt dit op een configuratiefout, vraag je contactpersoon om dit te (laten) herstellen.

Property: metamodelextension

Name of the extension on the metamodel. When this is a MIM model, specify the MIM extension name

Waarde: name, type: string, verplicht: false, default: (geen)

Module: ConfigCompiler (Configuration compiler)

Geef aan welke naam de extensie op het metamodel heeft.

Als het een MIM model betreft, dan kan dit ook worden opgegeven via de tagged value MIM extensie.

Property: metamodelextensionversion

Version of the extension on the metamodel. When this is a MIM model, specify the MIM extension version

Waarde: version-number, type: string, verplicht: false, default: (geen)

Module: ConfigCompiler (Configuration compiler)

Geef aan welke versie de extensie op het metamodel heeft.

Als het een MIM model betreft, dan kan dit ook worden opgegeven via de tagged value MIM extensie versie.

Property: metamodelname

Name of the metamodel. When this is a MIM model, specify MIM

Waarde: name, type: string, verplicht: false, default: (geen)

Module: ConfigCompiler (Configuration compiler)

Geef de naam van het metamodel. Wanneer het een MIM metamodel is, geeft dan MIM op.

Property: metamodelversion

Version of the metamodel. When this is a MIM model, specify the MIM version

Waarde: version-number, type: string, verplicht: false, default: (geen)

Module: ConfigCompiler (Configuration compiler)

Geef de versie van het metamodel. Wanneer het een MIM metamodel is, geeft dan een geimplementeerde versie van MIM op. Dat kan zijn: 1.0, 1.1, 1.1.1, 1.2.

Property: migrate

Specify a name if the source XMI file must be migrated to a (new) metamodel.

Waarde: name, type: string, verplicht: false, default: (geen)

Module: XmiCompiler (XmiCompiler parameters)

TODO Kijken of dit nog van toepassing is. https://github.com/Imvertor/Imvertor-Maven/issues/560

Property: mimformatname

The name of the MIM format file generated

Waarde: string, type: string, verplicht: false, default: (geen)

Module: MIMCompiler (MIM format compiler)

De naam van het mim serialisatie bestand dat wordt samengesteld wanneer de parameter createmimformat op yes staat.

Property: mimformattype

The type of the MIM format file generated

Waarde: xml|rdf-xml|turtle|legacy, type: string, verplicht: false, default: (geen)

Module: MIMCompiler (MIM format compiler)

Het type bestand dat het resultaat is wanneer createminformat op yes is gezet. Mogelijkheden zijn:

• xml – serialisatie zoals vastgesteld door de MIM community.

• rdf-xml – een RDF formaat dat afgeleid is van de MIM informatie

• turtle – een Turtle formaat dat is afgeleid van de MKIM informatie

• legacy – Een vroegere repersentatie van de MIM serialisatie, die wrsch komt te vervallen.

Als meerdere formaten gewenst zijn, dan deze scheiden met spaties.

Property: mimformatversion

The version of the MIM compiler

Waarde: v1|v2, type: string, verplicht: false, default: (geen)

Module: MIMCompiler (MIM format compiler)

Er zijn 2 implementaties van de MIM compiler. Versie v2 is vigerend. Voor historische doeleinden is versie v1 ook nog beschikbaar.

Property: modeldocfile

Path to the folder or zipfile holding the modeldoc files, i.e. profile and MsWord files and images used to create a full Respec.

Waarde: filepath, type: file, verplicht: false, default: (geen)

Module: OfficeCompiler (Office compiler)

Dit is een pad naar de folder waarin alle modeldoc files te vinden zijn. Dit pad wordt in de Imvertor SaaS add-in opgegeven, waarbij de inhoud in ZIP vorm wordt meegestuurd naar Imvertor OS. Als Imvertor “aan de prompt” wordt opgestart, zoals in ontwikkelomgevingen, kan ook een pad naar een folder worden meegegeven.

Property: modelistraced

Yes if the model derivation is implemented by UML tracing

Waarde: yes|no, type: string, verplicht: true, default: (geen)

Module: ImvertCompiler (Imvert compiler)

Bepaalt of het model door de gebruiker gedefinieerde traces heeft (client verwijzen naar hun supplier(s) via traces) of dat traces worden gegenereerd door Imvertor op basis van constructies, typen en namen.

In het eerste geval heeft de gebruiker de volledige controle over welke constructies informatie leveren voor de client aan de bronzijde van de trace. Traces zijn volledig functionele modelleertechnieken.

In het laatste geval probeert Imvertor de exacte locatie van een construct te matchen (attribuut, klasse,...) in het suppliermodel en maakt een trace naar die supplier. In dat geval zijn traces puur technische constructies.

Property: nativescalars

Yes if scalar types may be entered without reference to a UML datatype

Waarde: yes|no, type: string, verplicht: false, default: yes

Module: common (Standard initial parameters)

Als parameter nativescalars op “yes” staat (dat is de default) worden typen die niet gerelateerd zijn aan een bestaande constructie (zoals ingetikte "AN10" of "CharacterString" o.i.d) omgezet naar het type dat in het metamodel is opgenomen (in het “scalars” deel daarvan). Hier is bijvoorbeeld aangegeven dat CharacterString bestaat, en een “XML schema string” is.

Deze herkenning van scalars worden alleen gebruikt voor type referenties die niet verwijzen naar echte constructs in de EA. Er worden feitelijk geen native scalars herkend als je ze nergens hebt gebruikt, dus als je nergens het type hebt "ingetikt", en als alle referenties kloppen.

Nativescalars op “no” zetten betekent dat deze "terugvaloptie" niet meer mag worden gebruikt: alle typen moeten teruggaan op echte UML constructies, die mogelijk in een extern package zijn opgenomen (zoals het MIM datatypen package).

Property: normalizeids

Yes if XMI based ID's should be normalized, i.e. reduced to unique strings valid for Imvertor processing

Waarde: yes|no, type: string, verplicht: true, default: (geen)

Module: common (Standard initial parameters)

Kies voor yes als je wilt dat onder water alle EA identifiers worden teruggebracht tot een vaste vorm. Dit kan sommige identificatie problemen oplossen.

TODO nagaan of dit nog nodig is / wordt gebruikt. https://github.com/Imvertor/Imvertor-Maven/issues/560

Property: normalizenames

Yes if names of classes, attributes and relations should be normalized

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: Validator (Validator parameters)

TODO Deze parameter lijkt niet in gebruik. https://github.com/Imvertor/Imvertor-Maven/issues/560

Property: notesrules

Name of the configuration folder for notes rules. If omitted, assume metamodel name and version as extracted from the supplied model.

Waarde: name, type: string, verplicht: false, default: (geen)

Module: ConfigCompiler (Configuration compiler)

Geef de naam op van het bestand met de regels voor het uitlezen van het notitieveld in EA. Dat bestand moet zijn opgenomen in de configuratie /input/[ownernaam]/cfg/notesrules.

Wanneer geen naam is opgegeven wordt een naam samengesteld op basis van de nam van de owner, naam van het metamodel, de minor versie van het metamodel, de naam van de extensie op het metamodel, en een eventuele versie van die extensie. Voorbeeld: Armatiek-MIM-12-CONCEPTUAL.

Wanneer deze opgegeven naam niet als XML bestand voorkomt duidt dit op een configuratiefout, vraag je contactpersoon om dit te (laten) herstellen.

Property: officename

Name of the office result document file. You may use [...] parameters.

Waarde: template, type: string, verplicht: false, default: (geen)

Module: OfficeCompiler (Office compiler)

De naam van het HTML bestand dat de Respec documentatie of de catalogus bevat.

Deze naam kan worden opgebouwd door middels van variabelen tussen rechte haken, zie elders.

Ook kan voor index worden gekozen, waarna een index.html bestand wordt gemaakt.

Property: outfolder

Full path to the folder that will hold the report XML as generated by the regression test

Waarde: path, type: string, verplicht: false, default: (geen)

Module: RegressionExtractor (Regression extractor)

TODO regression test

Property: owner

The owner of the configurations that are applied in a single Imvertor OS run. Typically an organization name.

Waarde: name, type: string, verplicht: true, default: (geen)

Module: ComplyExtractor (Compliancy Excel extractor)

Der naam van de organisatie voor welke een configuratie is vastgelegd in de Imvertor OS /input folder. Een aantal van deze namen betreft afnemers van de Imvertor SaaS dienst.

Property: passftp

URL of the ftp file e.g. ftp.example.com

Waarde: URL, type: string, verplicht: When officepass is set to "ftp", default: (geen)

Module: OfficeCompiler (Office compiler)

De FTP folder waar de catalogus infomatie naar toe kan worden gekopieerd. Alleen van toepassing als overdracht van de resultaten via FTP is geconfigueerd op de Imvertor SaaS server, zie elders.

Property: passoffice

Enter "ftp" when the documentation file should be passed on directly to FTP, "git" when updating Github.

Waarde: ftp|git, type: string, verplicht: false, default: (geen)

Module: OfficeCompiler (Office compiler)

Geef aan of de catalogus infomatie moet worden gekopieerd naar een externe locatie. Dat kan zijn via FTP (ftp) of gia GIT (git). Alleen van toepassing als overdracht van de resultaten is geconfigueerd op de Imvertor SaaS server, zie elders.

Property: passpass

FTP password

Waarde: password, type: string, verplicht: When officepass is set to "ftp", default: (geen)

Module: OfficeCompiler (Office compiler)

Geef het password voor de FTP locatie bij overdracht naar een externe locatie. Alleen van toepassing als overdracht van de resultaten via FTP is geconfigueerd op de Imvertor SaaS server, zie elders.

Property: passpath

Path on server to the destination file e.g. /data/doc/result.html

Waarde: remote path, type: string, verplicht: When officepass is set to "ftp", default: (geen)

Module: OfficeCompiler (Office compiler)

Geef het pad binnen de FTP locatie bij overdracht naar een externe locatie. Alleen van toepassing als overdracht van de resultaten via FTP is geconfigueerd op de Imvertor SaaS server, zie elders.

Property: passprotocol

FTP protocol

Waarde: true|false, type: string, verplicht: false, default: (geen)

Module: OfficeCompiler (Office compiler)

Geef het protocol dat moet worden gebruikt overdracht naar een externe locatie. Alleen van toepassing als overdracht van de resultaten via FTP is geconfigueerd op de Imvertor SaaS server, zie elders.

TODO uitwerken?

Property: passuser

FTP user name

Waarde: username, type: string, verplicht: When officepass is set to "ftp", default: (geen)

Module: OfficeCompiler (Office compiler)

Geef de gebruikersnaam voor het schrijven naar de FTP locatie bij overdracht naar een externe locatie. Alleen van toepassing als overdracht van de resultaten via FTP is geconfigueerd op de Imvertor SaaS server, zie elders.

Property: processingmode

Specify the processing mode. This takes the form "Owner:Meta:Stage"

Waarde: Processing mode, type: string, verplicht: false, default: (geen)

Module: common (Standard initial parameters)

Geef aan welke Processing mode (verwerkingsconfiguratie) moet worden gehanteerd. Deze processing mode komt overeen met een enkele kolom in de properties Excel file, die als naam overeenkomt met de opgegeven mode. De naam is opgebouwd uit eigenaar, indicatie vanm het metamodel, en de wijze waarop het model moet worden verwerkt. Zie elders.

Voorbeeld: Armatiek:CONCEPTUAL:uitgebreid. Dit komt overeen met tabblad Armatiek, kolom Config, waarde CONCEPTUAL:uitgebreid zoals in de excel kolommen hieronder.

Property: profilemode

Specify for which stylesheets (identified by code) a runtime profile must be generated. Codes are specified between ";". Profiling is only available when debug=yes.

Waarde: CODE, type: string, verplicht: false, default: (geen)

Module: common (Standard initial parameters)

Property: project

Name of the project

Waarde: name, type: string, verplicht: true, default: (geen)

Module: common (Standard initial parameters)

Het project waarbinnen het informatiemodel valt. Dit is het eerste deel van het zgn. subpath (zie elders) waarmee het informatiemodel formeel wordt benoemd. Voorbeeld: CM binnen CM/Fietsenwinkel/20210901.

Dit is onderdeel van de naam van het EA package dat het stereotype <<project>> heeft. De naam van dat package bestaat uit de naam van de owner, een dubbele punt, en de naam van het project. Bijvoorbeeld: Armatiek: CM.

Property: proxyurl

Reliable URL for testing internet connection

Waarde: URL, type: url, verplicht: true, default: (geen)

Module: common (Standard initial parameters)

Een URL die kan worden gelezen om te bepalen of het internet beschikbaar is.

TODO nagaan of dit nog wel nodig is. Lijkt alleen bij conceptcollector in gebruik, en in SAAS is dit sowieso niet relevant. https://github.com/Imvertor/Imvertor-Maven/issues/560

Property: rebuildref

Rebuild the reference content representation for every regression test.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: RegressionExtractor (Regression extractor)

Moet de regressietest referentie output opnieuw worden samengesteld bij en regressietest?

Property: reffolder

Full path to the folder that holds the reference Imvertor files

Waarde: path, type: string, verplicht: false, default: (geen)

Module: RegressionExtractor (Regression extractor)

De naam van de folder waarin referentie output is of kan worden opgenomen.

Property: refreshconcepts

Yes to force re-read of concepts, No to read when required only, Never when to ignore concepts alltogether

Waarde: yes|no|never, type: string, verplicht: false, default: (geen)

Module: ConceptCollector (Concepts collector)

Concepten kunnen uit elke bron worden gelezen. Geef aan of en wanneer concepten uit die bron moeten worden gelezen. Dit kan tijdrovend zijn. Mogelijke waarden zijn:

• Yes: om het herlezen van concepten te forceren.

• No: alleen lezen wanneer nodig. Concepten moeten worden gelezen wanneer

  • de lijst met concepten moet worden vernieuwd (er is geen eerdere lijst met concepten die levensvatbaar zijn voor de releasedatum van het model),

  • of wanneer de release "final" is.

• never: wanneer je concepten helemaal moet negeren

Voorbeeld:

refreshconcepts = never

Property: refreshxmi

Yes if the XMI file generated from EA must be recreated each time.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XmiCompiler (XmiCompiler parameters)

Geef aan of de XMI in de ontwikkelomgeving altijd opnieuw moet worden gegenereerd vanuit EA.

Property: regowner

Names of the owners for which to perform the regression test. Separate by semicolon.

Waarde: names, type: string, verplicht: false, default: (geen)

Module: RegressionExtractor (Regression extractor)

Een lijst van owners voor wie de regressietest moet worden uitgevoerd.

Property: regression

Should a regression test be performed on the results of this run?

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: RegressionExtractor (Regression extractor)

Geef aan of je een regressietest wilt uitvoeren op dit imvertor OS resultaat.

Property: regressionmethod

Specify a name of a known compare method. Currently known methods are: "xmlunit" and "raw".

Waarde: name, type: string, verplicht: false, default: (geen)

Module: RegressionExtractor (Regression extractor)

Geef aan welke methode je wilt gebruiken voor de vergelijking van test- en referentie-resultaten van een Imvertor OS run in een regressietest.

Property: releasename

Name of the release. May hold placeholders. Will be used as the file name of the ZIP result.

Waarde: template, type: string, verplicht: true, default: (geen)

Module: ReleaseCompiler (Release compiler)

Dit is een beschrijving met een combinatie van de volgende aanduidingen:

• [project-name] die de parameter -project representeert

• [application-name] die de parameter -application representeert

• [versie] die de versie representeert zoals gespecificeerd in de UML

• [fase] die de fase representeert zoals gespecificeerd in de UML

• [release] die de release representeert zoals gespecificeerd in de UML

• [documentation-release] die de parameter -docrelease representeert

• [generation-id] die een unieke generatie-ID representeert op basis van de datum en tijd

Bijvoorbeeld:

-zipfilename release-[projectnaam]-[applicatienaam]-[versie]-[fase]-[release][documentatie-release]-[generatie-id] 

Kan resulteren in:

"release-MyProject-MyApplication-MyVersion-2-20160301-at-20160323-102945.zip"

Property: reportshortview

Yes if a short view on the model must be generated as part of the report.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: ImvertCompiler (Imvert compiler)

TODO verwijderen, wordt altijd meegegeneerd. https://github.com/Imvertor/Imvertor-Maven/issues/560

Property: resolveconcepturi

Yes if an URI entered as a tagged value for a concept must be tested.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XmiCompiler (XmiCompiler parameters)

Een concept kan worden geidentifceerd door een URI. Het kan zijn dat die URI als URL kan worden opgevat, en dat kan dus worden getest: is het een bestaande locatie? Als je wilt dat dat altijd gebeurt geef je yes op.

Property: sentinel

A (possibly empty) list of names of sentinels, separated by ';' and as configured for schema generation.

Waarde: Names, type: string, verplicht: false, default: (geen)

Module: XmiCompiler (XmiCompiler parameters)

Bij het uitlezen van conceptual schemas kan de aanweizgheid van een sentinel nodig zijn. De sentinel is een construct die als enige functie heeft dat zijn signalleert dat de map waarin het zich bevindt moet worden gelezen.

Property: sfconformance

The GM 3.2 Simple Feature profile conformance level. Possible values are 0, 1 2.

Waarde: level nr, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Geef aan welk conformance level van de GML simple feature profile is gerealiseerd.

Property: shaclrules

The name of the SHACL rules file

Waarde: name, type: string, verplicht: false, default: (geen)

Module: ShaclCompiler (SHACL compiler)

Geef aan welke naam het shacl rules file moet krijgen.

In deze naam kun je gebruik maken van namen van properties (tussen rechte haken). Zie uitleg elders.

Property: shortprefix

Yes if namespace prefixes for XSDs should be shortened

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

De namespace prefixes in de XML schema’s kunnen soms lang worden, en daarom kun je kiezen voor een verkorte naam van de prefix. Die prefix wordt dan teruggebracht tot de eerste hoofdletter(s) van de naam zoals die terugkeert in de naam van het model domein. NB Schema’s worden gegenereerd voor domeinen binnen een informatiemodel.

Property: signaldeadurls

Yes if a warning should, be issued for each inaccessible URL detected in notes and tagged values.

Waarde: yes|no, type: string, verplicht: false, default: no

Module: common (Standard initial parameters)

Sommige tagged values hebben een URI waarde, of kunnen deze hebben. Ook kun je URL’s opnemen in notitievelden. Als imvertor een URI waarde aantreft, kan deze de waarde testen: is dit een bestaande URL? Als je wilt dat dat altijd gebeurt geef je yes op.

Property: skosrules

The name of the SKOS rules file

Waarde: name, type: string, verplicht: false, default: (geen)

Module: SkosCompiler (SKOS compiler)

Geef de naam op van het bestand waarin de SKOS regels zijn opgenomen. Deze regels leggen vast hoe SKOS documenten kunnen worden gegenereerd.

Property: skosusealias

Yes if the alias should be used, when available, to create the SKOS concept URI

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: SkosCompiler (SKOS compiler)

TODO uitleggen

Property: starthistory

Release date from which to compile history to be included in documentation; defaults to most recent previous release

Waarde: YYYYMMDD, type: string, verplicht: false, default: (geen)

Module: HistoryCompiler (History compiler)

Vanaf welke release (zoals vastgelegd in een history excelfile) moet de versieinformatie in de documentatie worden opgenomen?

Property: stccsvname

The name of the Stelselcatalogus CSV file generated

Waarde: string, type: string, verplicht: false, default: (geen)

Module: StcCompiler (Stelselcatalogus CSV compiler)

Geef de naam op van het Stelselcatalogus CSV resultaatbestand.

Je kunt gebruik maken van properties tussen rechte haken.

Property: stub_requiresalias

No if aliases for objects and relations should not be tested (STUB)

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: Validator (Validator parameters)

Property: STUBnilreason

When specified, pass the release number of Imvertor which nilreason approach must be used. Currently supported: 1.28.

Waarde: Release number, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Property: substitutions

Yes if substitutions should be generated, in stead of choice groups

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Wanneer je een XML schema genereert kun je “overerving” / “subtypering” realiseren door ofwel substitution groups te laten samenstellen, of keuzen tussen typen te laten maken. Geef hier aan welke methode je wenst te volgen.

Property: suppresswarnings

Yes if warnings should be suppressed in documentation

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: common (Standard initial parameters)

Verwijder alle waarschuwingen uit het verwerkingsrapport.

Over het algemeen is een model niet “afgerond” als er nog waarschuwingen worden gegeven. Wees dus terughouden met de waarde yes.

Property: task

Set task to compile or release

Waarde: compile|release, type: string, verplicht: true, default: (geen)

Module: common (Standard initial parameters)

Wanneer de waarde op compile wordt gezet, wordt ervan uitgegaan dat het model niet wordt vrijgegeven.

Wanneer de waarde release is, is het mogelijk dat het model als final (afgerond en bevroren) wordt vrijgegeven. In dat geval kan het model niet worden overschreven.

TODO nagaan of dit nog een vigerend onderscheid is. https://github.com/Imvertor/Imvertor-Maven/issues/560

Property: tstfolder

Full path to the folder that holds the Imvertor files to be tested

Waarde: path, type: string, verplicht: false, default: (geen)

Module: RegressionExtractor (Regression extractor)

Property: tvmissingaswarning

Should missing tagged values be signalled as an error, as a warning, or does this depend on the phase of the model?

Waarde: yes|no|phase, type: string, verplicht: false, default: (geen)

Module: Validator (Validator)

Moeten tagged values die geen waarde hebben gekregen (maar die wel moeten hebben) worden gerapporteerd als een fout?

• als yes dan worden altijd alle tagged value problemen als waarschuwing doorgegeven, tenzij het een essentiële tagged value betreft. In dat laatste geval is de tagged value belangrijk voor de verwerking van het model en gelden de hier besproken regels niet.

• als no, dan worden deze fouten ook als echte fout doorgegeven (en stop de verwerking).

• als phase, dan is de waarde afhankelijk van de fase.

Als tvmissingaswarning = phase, dan geldt het volgende:

• Fase = 0 (Initieel / Initial) - warning

• Fase = 1 (Klad / Draft) - warning

• Fase = 2 (Voorstel / Final draft) - error

• Fase = 3 (Vastgesteld) - error

• Fase = 4 (Vervallen) – error

NB De fase heeft altijd een cijferwaarde uit 0 /tm 4, en kan worden ingevoegd door de properties van een EA model op te vragen, en daarin Phase te kiezen.

Property: tvset

Name of the configuration folder for tagged value set definitions. If omitted, assume metamodel name and version as extracted from the supplied model.

Waarde: name, type: string, verplicht: false, default: (geen)

Module: ConfigCompiler (Configuration compiler)

Geef de naam op van het bestand met de tagged values van het gebruikte metamodel. Dat bestand moet zijn opgenomen in de configuratie /input/[ownernaam]/cfg/tvset.

Wanneer geen naam is opgegeven wordt een naam samengesteld op basis van de nam van de owner, naam van het metamodel, de major versie van het metamodel, de naam van de extensie op het metamodel, en een eventuele versie van die extensie. Voorbeeld: Armatiek-MIM-1-CONCEPTUAL.

Wanneer deze opgegeven naam niet als XML bestand voorkomt duidt dit op een configuratiefout, vraag je contactpersoon om dit te (laten) herstellen.

Property: umlfile

Path to the input UML file, must be EAP or XMI

Waarde: filepath, type: file, verplicht: true, default: (geen)

Module: common (Standard initial parameters)

Pad naar het input bestand voor Imvertor.

Property: usefirstmap

In case a construct in a conceptual schema mapping is duplicated, allow the first construct to be selected, if other resolve mechanisms fail.

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: ImvertCompiler (Imvert compiler)

Deze parameter geeft aan dat de conceptual maps in gebruik mogelijk overlap vertonen, en dat in dat geval constructs met dezelfde naam feitelijk hetzelfde zijn. Een voorbeeld is CharacterString dat voorkomt in OGC/GML en in MIM.

Als "usefirstmap = yes", dan gebruikt Imvertor de eerste opkomst van het concept in de mapping.

Er wordt nog steeds een waarschuwing gegeven voor ieder geval waarin de eerste opkomst is gekozen. Dit is noodzakelijk, omdat het in de praktijk doorgaans niet zo is dat deze gelijknamige constructies ook werkelijk dezelfde configuratie hebben. Voorbeeld is de locatie van de beschrijving van de construct (CharacterString), die verschilt (OGC beschrijft deze anders dan MIM).

Property: userid

ID of the user who started this run

Waarde: ID, type: string, verplicht: true, default: (geen)

Module: common (Standard initial parameters)

De naam/ID van de gebruiker die de Imvertror OS run heeft gestart.

Property: validatecomplyexcel

Yes if the compliancy excels created must be validated

Waarde: yes|no, type: string, verplicht: true, default: (geen)

Module: ComplyCompiler (Compliancy Excel compiler)

TODO status van compliancy? https://github.com/Imvertor/Imvertor-Maven/issues/561

Property: validatederivation

Yes if derivation must be validated

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: ImvertCompiler (Imvert compiler)

Moet de afleiding van modellen worden getest?

Als wezenlijk onderdeel van de test of modellen correct van elkaar zijn afgeleid moeten tagged values van supplier modellen worden “doorgekopieerd” naar client modellen. Vandaar dat een belangrijk test in deze slag is of tagged values correct zijn opgevoerd. Het uitschakelen van deze validatie betekent daarom dat ook de validatie van tagged values wordt tegengehouden. Wees daarom terughoudend met de waarde yes.

Property: validatedocmissing

Yes if the notes fields that are required must be checked (for content)

Waarde: yes|no, type: string, verplicht: true, default: (geen)

Module: Validator (Validator parameters)

Het kan zijn dat bepaalde documentatie (nog) niet beschikbaar is. Bijvoorbeeld een definitie van een attribuut. Als je zeker wilt weten dat voor alle plekken waar documentatie nodig is deze ook is opgevoerd, zet deze property dan op yes.

De rapportage van niet opgevoerde documentatie vind je terug in het verwerkingsrapport (/doc folder).

TODO deze parameter lijkt te zijn vervallen; documentatie wordt altijd gerapporteerd en je ziet op het oog waar iets niet is gevuld. https://github.com/Imvertor/Imvertor-Maven/issues/560

Property: validateschema

Yes if result schemas must be validated

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: SchemaValidator (Schema validator)

Valideer alle gegeneerde XML schema’s na samenstelling.

Property: validateshacl

Yes if SHACL RDF must be validated after it has been generated

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: ShaclCompiler (SHACL compiler)

Valideer alle gegeneerde Shacl specificaties na samenstelling.

Property: validateskos

Yes if SKOS RDF must be validated after it has been generated

Waarde: yes|no, type: string, verplicht: false, default: (geen)

Module: SkosCompiler (SKOS compiler)

Valideer alle gegeneerde SKOS specificaties na samenstelling.

Property: validatetrace

When full, test if each derivable construct is actually derived from at least one supplier construct.

Waarde: full|none, type: string, verplicht: true, default: (geen)

Module: ImvertCompiler (Imvert compiler)

Als de waarde full is, test dan of elk afleidbaar construct daadwerkelijk is afgeleid van ten minste één supplier construct. Als deze er niet is, wordt er geen trace controle uitgevoerd.

Deze optie is zinvol in situaties waarin een model stapsgewijs wordt gemaakt en expliciete verwijzingen naar een onderliggend model nog niet beschikbaar zijn. Merk op dat dit een zeldzame situatie is.

Voorbeeld:

validatetrace = full

Property: validatetvassignment

Yes if tagged value assignment is correct

Waarde: yes|no, type: string, verplicht: true, default: (geen)

Module: Validator (Validator parameters)

Bij het uitlezen van taggd values, check of de tagged value een acceptabele waarde heeft.

Property: validatetvoccurs

Yes if tagged values multiplicity should be checked (min/max occurs)

Waarde: yes|no, type: string, verplicht: true, default: (geen)

Module: Validator (Validator parameters)

Stel vast of het aantal gelijke tagged values op een en hetzelfde construct acceptabel is. Een specifieke tagged value kan volgens configuratie 0 (optioneel), 1 (verplicht) of nul, één, of meer keer (meermaals) voorkomen.

In MIM 1.2 kan een tagged value begrip meermaals voorkomen.

Property: versionrules

Name of the version rules file

Waarde: name, type: string, verplicht: true, default: (geen)

Module: common (Standard initial parameters)

Geef de naam op van het version rules file. Dit file is deel van de configuratie en bepaalt hoe versies worden benoemd, bijvoorbeeld met een vrije naam of een semantic versioning nummer zoals 2.2.3.

Property: visuals

Name of the visuals file. If omitted, assume metamodel name and version as extracted from the supplied model.

Waarde: name, type: string, verplicht: false, default: (geen)

Module: common (Standard initial parameters)

Geef de naam op van het bestand met de regels voor het samenstellen van de EA toolbox. Dat bestand moet zijn opgenomen in de configuratie /input/[ownernaam]/cfg/visuals.

Wanneer geen naam is opgegeven wordt een naam samengesteld op basis van de nam van de owner, naam van het metamodel, de minor versie van het metamodel, de naam van de extensie op het metamodel, en een eventuele versie van die extensie. Voorbeeld: Armatiek-MIM-12-CONCEPTUAL.

Wanneer deze opgegeven naam niet als XML bestand voorkomt duidt dit op een configuratiefout, vraag je contactpersoon om dit te (laten) herstellen.

Property: xlinkversion

Version of the xlinks specification

Waarde: id, type: string, verplicht: false, default: 20010627

Module: common (Standard initial parameters)

Geef aan welke versie van de Xlink standaard je wilt hanteren in de XML schema’s. Voorbeeld: 20010627

Property: xsdfilename

The name of each XSD file generated by the ISO19136 module. Named parameters such as [application-name] may be used.

Waarde: name template, type: string, verplicht: false, default: (geen)

Module: XsdCompiler (XML schema compiler)

Geef de naam op van de XML schema resultaat files. Deze naam bestaat typisch uit parameter namen die per XNL schema een andere aarde hebben.

Property: xsdsubpath

A path within the result XSD folder to which the XSDs for the model provided are written. Named parameters such as [application-name] may be used.

Waarde: subpath, type: string, verplicht: true, default: (geen)

Module: XsdCompiler (XML schema compiler)

Geef aan waar XML schema bestanden moeten worden geplaatst in een folderstructuur binnen de /xsd folder.