ELIAS GmbH
Produktdokumentationen

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
~~NOTOC~~

<WRAP noprint>

> Administrator’s Guide #@IC_HTML@# > Configuration and Import

</WRAP>

====== Parameter file "SpecialCategories" ======

----

The →[[en:infra-convert:user:terms#Category (characteristic-)|characteristic categories]] that are available in #@IC_HTML@# are defined in the parameter file //SpecialCategories.json//. More specifically: these definitions are loaded when a new →[[en:infra-convert:user:terms#Project|project]] is created and saved in the project file. This means that it is only in the project possible to later change the category definitions for a project.

> **Important** Each category definition has parameters that cannot be changed. If a parameter is missing or faulty, then the category is no longer available.

If you need additional categories, please let us know so we can expand the parameter file accordingly. Please only modify the file if you want to assign different values to parameters that are identified accordingly in the following description. Remember to make a backup copy.

During installation, the parameter file //SpecialCategories// is saved at the following location:

<WRAP group>
<WRAP indent>
<WRAP column 72%>
<code>%ProgramData%\ELIAS GmbH\infra-convert\JsonData\SpecialCategories.json</code>
</WRAP>
</WRAP> </WRAP>

If another parameter file is to be loaded when starting the program, this can be specified in the startup parameter file (see Configuration and Import > [[en:infra-convert:dev:parameter#Parameterdatei für Merkalkategorien]]).

{{page>en:infra-convert:dev:tip_use_adv_editor}}

<WRAP noprint>
<WRAP group>
<WRAP column 42%>
//**__Content__**//

 • [[en:infra-convert:dev:specialcategories#ID]]\\ 
 • [[en:infra-convert:dev:specialcategories#User ID]]\\ 
 • [[en:infra-convert:dev:specialcategories#Parent category]]\\ 
 • [[en:infra-convert:dev:specialcategories#List position]]\\ 
 • [[en:infra-convert:dev:specialcategories#Friendly Name]]\\ 
 • [[en:infra-convert:dev:specialcategories#Stamp template]]\\ 
 • [[en:infra-convert:dev:specialcategories#Display text]]\\ 
 • [[en:infra-convert:dev:specialcategories#Installation/Deinstallation]]

\\ 

</WRAP>
</WRAP> </WRAP>

===== ID =====

<WRAP group>
<WRAP column 40%>

Unique, internal identifier for the category.

<WRAP group>
<WRAP column 20%>
> {{:en:infra-convert:icon_hinweis_stop.png?nolink&50}}
</WRAP>
<WRAP column 65%>
Please do not delete this parameter or change this value.
</WRAP>
</WRAP>

</WRAP>
<WRAP column 55%>

<code javascript>
"Id": "{6E626731-625F-4F71-A471-2A267D511E18}",
</code>

|< 100% 33% 12% 54% >|
^  Parameter  ^  Type  ^  Value/Content  ^
^ ID | String | GUID of the category |

</WRAP>
</WRAP>

\\ 

===== User ID =====

<WRAP group>
<WRAP column 40%>

Unique, internal identifier for the category in a readable form. Displayed in the user interface to uniquely identify categories.

<WRAP group>
<WRAP column 20%>
> {{:de:infra-convert:icon_hinweis_stop.png?nolink&50}}
</WRAP>
<WRAP column 65%>
Please do not delete this parameter or change this value..
</WRAP>
</WRAP>

</WRAP>
<WRAP column 55%>

<code javascript>
"UserId": 1,
</code>

|< 100% 33% 12% 54% >|
^  Parameter  ^  Type  ^  Value/Content  ^
^ ID | Int | ID of the category |

</WRAP>
</WRAP>

\\ 

===== Parent category =====

<WRAP group>
<WRAP column 40%>

Internal reference to the parent category, if there is one.

<WRAP group>
<WRAP column 20%>
> {{:en:infra-convert:icon_hinweis_stop.png?nolink&50}}
</WRAP>
<WRAP column 65%>
Please do not delete this parameter or change this value.
</WRAP>
</WRAP>

</WRAP>
<WRAP column 55%>

<code javascript>
"ParentCategory": "",
</code>

|< 100% 33% 12% 54% >|
^  Parameter  ^  Type  ^  Value/Content  ^
^ ParentCategory | String | FriendlyName of the parent category, if there is one |

</WRAP>
</WRAP>

\\ 

===== List position =====

<WRAP group>
<WRAP column 40%>

Position in the dropdown list in the characteristic properties function window.

<WRAP group>
<WRAP column 20%>
> {{:en:infra-convert:icon_hinweis_bearbeiten_erlaubt.png?nolink&50}}
</WRAP>
<WRAP column 65%>
The listed values can be assigned for the parameter.
</WRAP>
</WRAP>

> **See also**\\ User’s Guide #@IC_HTML@# > User Interface > Function Window > [[en:infra-convert:user:interface:feature|Characteristic properties]]\\ \\ User’s Guide #@IC_HTML@# > More > Terms > [[en:infra-convert:user:terms#Kategorie (Merkmal-)|Category]]\\ \\ User’s Guide #@IC_HTML@# > Adaptations > Project Settings > [[en:infra-convert:user:config:cat|Categories]]

</WRAP>
<WRAP column 55%>

<code javascript>
"Priority": 1,
</code>

|< 100% 33% 12% 54% >|
^  Parameter  ^  Type  ^  Value/Content  ^
^ Priority | Integer | List position; the higher the value, the higher the classification |

</WRAP>
</WRAP>

\\ 

===== Friendly name =====

<WRAP group>
<WRAP column 40%>

Unique, internal identifier for the category in the form of a “user-friendly name”.

<WRAP group>
<WRAP column 20%>
> {{:en:infra-convert:icon_hinweis_stop.png?nolink&50}}
</WRAP>
<WRAP column 65%>
Please do not delete this parameter or change this value.
</WRAP>
</WRAP>

</WRAP>
<WRAP column 55%>

<code javascript>
"FriendlyName": "CommonCharacteristic",
</code>

|< 100% 33% 12% 54% >|
^  Parameter  ^  Type  ^  Value/Content  ^
^ FriendlyName | String | Unique identifier for the category as descriptive name |

</WRAP>
</WRAP>

\\ 

===== Stamp template =====

<WRAP group>
<WRAP column 40%>

Assigns the category defined in the stamp template parameter file StampTemplates.

<WRAP group>
<WRAP column 20%>
> {{:en:infra-convert:icon_hinweis_bearbeiten_erlaubt.png?nolink&50}}
</WRAP>
<WRAP column 65%>
The listed values can be assigned for the parameter.
</WRAP>
</WRAP>

> **See also**\\ Administrator’s Guide #@IC_HTML@# > Configuration and Import > Function Window > [[en:infra-convert:dev:stamptemplates|Parameter file "StampTemplates"]]

</WRAP>
<WRAP column 55%>

<code javascript>
"StampTemplateId": "{bf69c190-4bcc-4c2c-9ed1-c67328f4f90e}",
</code>

|< 100% 33% 12% 54% >|
^  Parameter  ^  Type  ^  Value/Content  ^
^ StampTemplateId | String | GUID of the stamp template |

</WRAP>
</WRAP>

\\ 

===== Display text =====

<WRAP group>
<WRAP column 40%>

Texts can be specified in this object, which are displayed in #@IC_HTML@# depending on the user language set.

<WRAP group>
<WRAP column 20%>
> {{:en:infra-convert:icon_hinweis_bearbeiten_erlaubt.png?nolink&50}}
</WRAP>
<WRAP column 65%>
The listed values can be assigned for the parameter.
</WRAP>
</WRAP>

</WRAP>
<WRAP column 55%>

<code javascript>
"LocalizedProperties": [
  {
    "Name": "Common Characteristic",
    "Description": "",
    "LanguageCode": "en"
  },
]
</code>

|< 100% 33% 12% 54% >|
^  Parameter  ^  Type  ^  Value/Content  ^
^ Name | String | Display name for the category |
^ Description | String | Description text |
^ LanguageCode | String | Language abbreviation as per ISO 639-1 |

</WRAP>
</WRAP>

\\ 

==== Installation/Deinstallation ====

The following describes the process for deinstalling, reinstalling (installing after previous deinstallation) and installing (without previous deinstallation) #@IC_HTML@# using the parameter file “SpecialCategories.json”. Essential preconditions are: the file is at the location where it was installed, and has not been renamed.

<WRAP group>
<WRAP column 25%>

**Deinstallation**

</WRAP>

<WRAP column 65%>

The file is deleted.

</WRAP>
</WRAP>

<WRAP group>
<WRAP column 25%>

**Reinstallation**

</WRAP>

<WRAP column 65%>

An existing file is not changed.

</WRAP>
</WRAP>

<WRAP group>
<WRAP column 25%>

**Installation**

</WRAP>

<WRAP column 65%>

An existing file is not changed.

</WRAP>
</WRAP>

<WRAP noprint>

----

<WRAP group>
<WRAP col2>

<WRAP rightalign>

**Go to previous page**\\ 
Configuration and Import > [[en:infra-convert:dev:characteristicclasses|Parameter file “CharacteristicClasses”]]

</WRAP>

**Go to next page**\\ 
Configuration and Import > [[en:infra-convert:dev:stamptemplates|Parameter file “StampTemplates”]]

</WRAP> </WRAP>

</WRAP>
ELIAS GmbHProduktdokumentationen

User Tools

Site Tools

Page Tools

ELIAS GmbH
Produktdokumentationen
