Versions Compared

Old Version 7

changes.mady.by.user Christian Schabasser

Saved on

compared with

New Version 8

changes.mady.by.user Christian Schabasser

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Table of Contents

There are different Metadata Types:

  • Selection: drop-down box, containing several, user definable <item> elements.
  • Text: text field.
  • Checkbox: checkbox, can either be off ("0") or on ("1").
  • Date: Date selection via a text input field or a DatePicker.
  • Time: Time selection via a text input field.
  • DateTime: DateTime selection via text field or DateTimePicker.

Info

All of these elements can be used as often as you want and in any possible order and combination.

Overview

All metadata elements follow the same XML structure. Each element starts with the following XML-element:

Code Block
<control></control>

This element can only have one attribute ("resetAfterRecord"), which resets the Metadata Field's value after each Recording (0, means the values stays as it is. Value 1 will reset the value):

Code Block
languagexml
themeConfluence
<control resetAfterRecord="1"></control>

Within this control-element you have to define the name, label, currentValue and type:

Code Block
<control resetAfterRecord="0">
        <name>quality</name>					#use this name to address the value of this element within the ExportXML 
        <label>Quality</label>					#this name will be used to tag the element within the just:in interface (inspector)
		<currentValue>Medium</currentValue>		#sets the default value for this element
        <type class="Selection">				#defines the control type (selection, text, checkbox, etc.)
            <item>Low</item>
            <item>Medium</item>
            <item>High</item>
        </type>
</control>

Selection Box

The Selection Box Element can be used, if the just:in operator should choose from a predefined set of options.

Code Block
<control resetAfterRecord="0">
        <name>quality</name>
        <label>Quality</label>
        <currentValue>Medium</currentValue>
        <type class="Selection">
            <item>Low</item>
            <item>Medium</item>
            <item>High</item>
        </type>
</control>

Text Box

The Text Box can be used for any element, which should contain text only.

Code Block
<control resetAfterRecord="0">
        <name>customText</name>
        <label>Custom Text</label>
        <currentValue>Insert your text here</currentValue>
        <type class="Text" default="Insert your text here"></type>
</control>

Checkbox

The Checkbox is for any elements, which can only have two states.

Code Block
<control resetAfterRecord="0">
        <name>special</name>
        <label>Special</label>
        <currentValue>0</currentValue>
        <type class="Checkbox">
        </type>
    </control>

Date

This element is for choosing a date.

Code Block
<control resetAfterRecord="0">
        <name>date</name>
        <label>Date</label>
        <currentValue></currentValue>
        <type class="Date" default=""/>
</control>

Time

This element can choose a specific time.

Code Block
<control resetAfterRecord="0">
        <name>time</name>
        <label>Time</label>
        <currentValue></currentValue>
        <type class="Time" default=""/>
</control>

DateTime

With this element a specific date and time can be defined.

Code Block
<control resetAfterRecord="0">
        <name>datetime</name>
        <label>DateTime</label>
        <currentValue></currentValue>
        <type class="DateTime" default=""/>
</control>

StartUpXML Example

Please beware that the StartUpXML must follow the rules above, otherwise the Metadata Sets will not work correctly and can lead to unexpected behaviour.

Code Block
languagexml
themeConfluence
linenumberstrue
<metadataSet>
    <name>Example</name>
    <extension>xml</extension>
    
    <control resetAfterRecord="0">
        <name>quality</name>
        <label>Quality</label>
        <currentValue>Medium</currentValue>
        <type class="Selection" default="2">
            <item>Low</item>
            <item>Medium</item>
            <item>High</item>
        </type>
    </control>
    <control resetAfterRecord="0">
        <name>customText</name>
        <label>Custom Text</label>
        <currentValue>Insert your text here</currentValue>
        <type class="Text" default="Insert your text here"></type>
    </control>
    <control resetAfterRecord="0">
        <name>Just_In_Custom_Date</name>
        <label>Custom Date</label>
        <currentValue>YYYY.MMM.dd</currentValue>
        <type class="Text" default="YYYY.MMM.dd"></type>
    </control>
    <control resetAfterRecord="0">
        <name>special</name>
        <label>Special</label>
        <currentValue>0</currentValue>
        <type class="Checkbox" default="0">
        </type>
    </control>
    <control resetAfterRecord="0">
        <name>date</name>
        <label>Date</label>
        <currentValue></currentValue>
        <type class="Date" default=""/>
    </control>
    <control resetAfterRecord="0">
        <name>time</name>
        <label>Time</label>
        <currentValue></currentValue>
        <type class="Time" default=""/>
    </control>
    <control resetAfterRecord="0">
        <name>datetime</name>
        <label>DateTime</label>
        <currentValue></currentValue>
        <type class="DateTime" default=""/>
    </control>
</metadataSet>

ExportXML Example

The ExportXML can have any possible structure. As mentioned above, the variables defined in the StartUpXML can be addressed like shown below.

...