Setting files

From Maria GDK Wiki
Revision as of 08:27, 26 March 2020 by Mbu (talk | contribs) (→)
Jump to navigation Jump to search

This section documents the setting files used by Maria Map Maker. It is primarily intended for developers and advanced users.

Making invalid changes to the setting files can result in breaking the application, so be sure that you know what you are doing, and back up your files! If a setting is not explained here, it is controlled by the application and not intended to be changed by the user.

The files which M3 uses are located at C:\Users\<user>\AppData\Local\TeleplanGlobe\MariaMapMaker

MariaMapMakerConfig.xml

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<MariaMapMakerconfig xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <version>1.0.0</version>
  <clientconfig>
    <productexporttypes>
      <exporttype>
        <type>Zip</type>
        <ext>zip</ext>
        <displaytype>Zip</displaytype>
      </exporttype>
      <exporttype>
        <type>ISO</type>
        <ext>iso</ext>
        <displaytype>ISO</displaytype>
      </exporttype>
      <exporttype>
        <type>Directory</type>
        <ext>*</ext>
        <displaytype>Directory</displaytype>
      </exporttype>
    </productexporttypes>
    <servicehoster internal="true" showwindow="false" />
    <lastworkspacefolder>C:\Data\MariaGeoData</lastworkspacefolder>
    <lastpreviewtilefolder>C:\Data\previewtiles</lastpreviewtilefolder>
    <tempdeviceminsize>5 GB</tempdeviceminsize>
    <lastwindowsize>1314,919.2</lastwindowsize>
    <windowstate>Maximized</windowstate>
  </clientconfig>
  <metadataconfig>
    <genericmetadata>
      <metadata key="classification" defaultvalue="UGRADERT" embedded="true">
        <legalvalues>
          <legalvalue value="NATO UNCLASSIFIED" />
          <legalvalue value="UGRADERT" />
          <legalvalue value="NATO RESTRICTED" />
          <legalvalue value="BEGRENSET" />
          <legalvalue value="NATO CONFIDENTIAL" />
          <legalvalue value="KONFIDENSIELT" />
          <legalvalue value="NATO SECRET" />
          <legalvalue value="HEMMELIG" />
        </legalvalues>
      </metadata>
      <metadata key="limitations" embedded="true" />
      <metadata key="designation" />
      <metadata key="datadate" date="true" />
      <metadata key="edition" />
      <metadata key="datasource" />
      <metadata key="name" />
      <metadata key="description" />
      <metadata key="expirationdate" />
      <metadata key="metadatadate" date="true" />
      <metadata key="metadataeditor" />
    </genericmetadata>
    <embeddedmetadata>
      <metadata key="productuuid" valuefrom="productuuid" />
      <metadata key="productname" valuefrom="productname" />
      <metadata key="displayversion" valuefrom="displayversion" />
      <metadata key="datasetuuid" valuefrom="datasetuuid" />
      <metadata key="datasetname" valuefrom="datasetname" />
    </embeddedmetadata>
  </metadataconfig>
</MariaMapMakerconfig>

version

Semantic version used to compare config files. See Version control

productexporttypes

The child element <exporttype> defines a choice for the "Export Product" button in the Workspace window.

servicehoster

Attribute internal="true/false" indicates whether or not to use the service hoster which is built into M3. If the internal service hoster is not used, the application will attempt to connect to an external Windows service. This is not recommended outside debugging scenarios. Attribute showwindow="true/false" indicates whether or not to show the output window from the internal service hoster. This is also used for debugging purposes.

tempdeviceminsize

This number denotes the minimum amount of available storage space on the device which is used for temporary storage. If there is less space than this, it will not be possible to start new map imports.

genericmetadata

The <metadata> elements control the default metadata keys which appear in the Metadata tab on each dataset in M3. If the user fills them with a value, they will be written to the <generic> metadata of the dataset. See Basemaps/overlays. There are a few ways to customize how each key appears to the user. Adding child element <legalvalues> with child elements <legalvalue value=""> turns the key into a combo box, where the user is can choose from one of the legal values, in addition to typing a value.

Adding attribute <metadata date="true"> gives the key a date selector.

Adding attribute <metadata embedded="true"> will add the key/value pair as child elements to the <embedded> element in the metadata file which follows the dataset.

embeddedmetadata

These metadata keys are intended to be automatically written to the <embedded> metadata on the dataset, and as such, these keys are not visible to the user in M3. The "valuefrom" attribute is used to automatically fetch values from the given parameter. The available values to to use with the "valuefrom" attribute are

  • productname
  • productsequence
  • displayversion
  • productdisplayname
  • datasetuuid
  • datasetname
  • lastchanged
  • releasedate
  • maxclassification
Keys cannot contain spaces

MariaMapMakerUserSettings.xml

This file contains less consequential settings which are more related to a user's perferences. The settings in this file are mostly managed from the application. 

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<MariaMapMakerUserSettingsconfig xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <version>1.0.0</version>
  <usersettingsconfig>
    <openrepositories>
      <repository>C:\Data\MariaGeoData</repository>
    </openrepositories>
    <accompanyinglettersettings>
      <logoimagepath>C:\OneDrive\OneDrive - Teleplan AS\My Screen Shots\FMGT_logo_2017\original\logo_etatsvpen_liten_FMGT.jpg</logoimagepath>
      <supportinformation>
        <support name="Teleplan Globe" address="Fornebuveien 31" mail="info@teleplan.no" phonenumber="" />
      </supportinformation>
      <systemrequirements />
      <title>
        <metadatakey key="classification" type="highest" />
        <metadatakey key="limitations" type="unique" />
      </title>
    </accompanyinglettersettings>
    <recentlyimportedmaps>
      <importedmap jobid="c120d3a6-a5a9-4f99-99b5-e857f2b822ae" name="Buildings_Frogn" timestamp="2019-10-29T13:19:31.7375778+01:00" mapsignature="Buildings_Frogn_b013dbc8f274" servicetype="VectorService" />
      <importedmap jobid="954598b8-e2f2-42d6-9e78-d02057e70313" name="finland_tactical_test" timestamp="2019-10-29T13:03:58.8570013+01:00" mapsignature="finland_tactical_test_ed23016d30e5" servicetype="RasterService" />
      <importedmap jobid="2c1b2efb-2e51-450a-b526-6bf688befa97" name="drobak_orto" timestamp="2019-10-29T10:23:37.2190814+01:00" mapsignature="drobak_orto_c953bcf00eb8" servicetype="RasterService" />
      <importedmap jobid="63cf04be-4438-4ac0-9c8e-d4c63c3ac472" name="n50_akershus" timestamp="2019-10-29T10:14:28.0075787+01:00" mapsignature="n50_akershus_f52e0934e1c9" servicetype="RasterService" />
      <importedmap jobid="4ba995fd-488a-4001-93ff-e54ea351209b" name="20190821arctico" timestamp="2019-10-28T21:01:49.1543778+01:00" mapsignature="20190821arctico_38889ce68e61" servicetype="RasterService" />
    </recentlyimportedmaps>
    <zoomtoextent>false</zoomtoextent>
    <backgroundmap>
      <mapsignature>M3_background_05046c502cc3</mapsignature>
      <Visible>true</Visible>
    </backgroundmap>
  </usersettingsconfig>
</MariaMapMakerUserSettingsconfig>

accompanyinglettersettings

The child element <title> defines the content of the sub-title in accompanying letters. Contains child elements <metadatakey>. Attribute key references a metadata key in the <metadataconfig> section in .

Attribute type decides how multiple datasets with the same key are handled. If type="highest", then the highest value for that key is used. The ordering of the values is decided by the order in which they appear in a <legalvalues> element. The bottom value is the highest. See <metadata key="classification"> for an example. Here, the classification value HEMMELIG is on the bottom, and thus it is the value which will appear in the accompanying letter subtitle.

If <type="unique">, then all unique values from the specified key will be listed in the accompanying letter subtitle.

MariaMapMakerAutoCompleteConfig.xml

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<MariaMapMakerAutoCompleteConfig xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <version>1.0.0</version>
	<dynamictags allowotherkeys="false">
		<tag key="IMAGERY-MAP"/>
		<tag key="IMAGERY-DETAIL"/>
		<tag key="TOPO-MAP"/>
		<tag key="TOPO-DETAIL"/>
		<tag key="SEA-MAP"/>
		<tag key="SEA-DETAIL"/>
		<tag key="AIR-MAP"/>
		<tag key="AIR-DETAIL"/>
	</dynamictags>
	<foldernames>
		<tag key="ELEVATION"/>
		<tag key="IMAGERY"/>
		<tag key="TOPO"/>
		<tag key="SEA"/>
		<tag key="DETAIL"/>
		<tag key="DEPTH"/>
		<tag key="LOCATION"/>
		<tag key="NAUTICAL"/>
		<tag key="OVERLAY"/>
		<tag key="BOUNDARIES"/>
		<tag key="ADMINISTRATIVE BOUNDARIES"/>
		<tag key="POLAND"/>
		<tag key="SWEDEN"/>
		<tag key="DENMARK"/>
	</foldernames>
</MariaMapMakerAutoCompleteConfig>

This configuration file allows you to define a set of values which will show up in an auto-complete list as the user types. Below is the text input fields which can be used with auto-complete.

dynamictags

Tags in dynamic layers and overlays. Attribute allowotherkeys="false" prevents the user from entering a value which is not pre-defined.

foldernames

Folder names for products.

Settings.json

This file is used by the built-in service hoster component of Maria Map Maker. The file is documented at Service configuration. The settings.json file used by M3 is controlled by the application and there is no need for the user to change it.

Version control

The config files MariaMapMakerConfig.xml and settings.json both have a version number. On startup, M3 will check C:\ProgramData\TeleplanGlobe\MariaMapMaker for config files with a higher version number. If a higher version exists, the file will be copied into C:\Users\<user>\AppData\Local\TeleplanGlobe\MariaMapMaker and it will be used as the active config file. This allows the application to be distributed with custom configuration settings.

Retrieved from "http://docs.maria.teleplanglobe.com/index.php?title=Setting_files&oldid=3149"