Difference between revisions of "HowTo:Create a new MetaProperty"

Latest revision as of 16:32, 1 February 2024

Creation of a new MetaProperty

A new MetaProperty has to be created as an instance from CUSTOMMETAPROPERTY using the Bulk Editor control

Navigate to the MetaClass CUSTOMMETAPROPERTY
Create a new instance of CUSTOMMETACLASS by entering a name
Set the data type for the property
It is recommenmded to set at least the description and namespace
Save the changes with Ctrl+S or the save command

VALUE TYPE

Since Version 4.7 we support the possibility to define the value type of a property.

With this property, the customizer can control how the property is displayed on the client.

Possible values are:

Standard (default)
MinNormMax (supported for string, double and int properties)
MinMax (supported for string, double and int properties)

Optional Attributes

REFERENCE

Assign a reference

Assign a reference if the value of the property should link to an UBIK^® object. The data type of the MetaProperty has to be Guid that the data (guid) can hold a reference to an UBIK^® object.

Locate an existing or create a new Reference
Assign the reference to the REFERENCE property either by
- dragging and dropping the reference object onto the cell
- selecting the desired reference from the dialog appearing after double-clicking the cell

SELECTIVELIST

Assign a selective list

Assign a selective list to a property, if the respective column should display a Combobox with all items of the list instead of the value field. The value can then only be selected from the list, but not be edited manually anymore.

Locate an existing or create a new Selective List
Assign the list to the SELECTIVELIST property either by
- dragging and dropping the list object onto the cell
- selecting the desired list from the dialog appearing after double-clicking the cell

UNITITEM

Set a unit item

If the property should consider a Unit (for example Ampere, Volt, etc.) the underlying MetaProperty has to incorporate a Unit Item either by

dragging and dropping the unit item object onto the cell
selecting the desired unit item from the dialog appearing after double-clicking the cell

Only properties of type Double can posses measuring units!

FORMAT

INDEXCOUNT

Set the number of named index keys, for example to 4.

INDEXKEYS

Enter the index keys as a comma separated list of strings, for example "a,b,c,d" (INDEXCOUNT = 4).

DEFAULTVALUE

Set up to 10 default value(s) for the MetaProperty.

INITIALVALUE

Set up to 10 initial value(s) for the MetaProperty.

NEEDSVALIDATION

Enable validation by checking the NEEDSVALIDATION attribute of the MetaProperty and let the system explicitely store a validation time stamp information in the database. This is particularly used on the mobile client in combination with the SYSCLS TASK and SYSCLS MEASUREMENTTASK classification.

'NEEDSVALIDATION' is replaced by UBIK Attribute technique since Version 2.5!

Learn more about UBIK Attributes.

VALUEVALIDATION

Assign a value validation object to the VALUEVALIDATION attribute of the MetaProperty either by

dragging and dropping the validation object onto the cell
selecting the desired validation object from the dialog appearing after double-clicking the cell

@@ Line 1: / Line 1: @@
-A new [[MetaProperty]] can be created and automatically assigned to a [[MetaClass]] via the ''Create new MetaProperty'' workflow. This workflow guides the user through the creation and configuration procedure of a MetaProperty and relates it to the selected MetaClass .
+== Creation of a new MetaProperty ==
+A new [[MetaProperty]] has to be created as an instance from [[CUSTOMMETAPROPERTY]] using the ''[[Bulk Editor]]'' control
+# Navigate to the MetaClass [[CUSTOMMETAPROPERTY]]
+# Create a new instance of CUSTOMMETACLASS by entering a name
+# Set the [[MetaProperty#Data_Types|data type]] for the property<br/>[[File:IL_HowTo_CreateMetaProperty_01.png|220 px|border|alt=Create new MetaProperty|Create new MetaProperty]]
+# It is recommenmded to set at least the description and namespace
+# Save the changes with {{key press|Ctrl|S}} or the save command
+===VALUE TYPE===
+{{Version/WinXSince|4.7.0}}  Since Version 4.7 we support the possibility to define the value type of a property.
+With this property, the customizer can control how the property is displayed on the client.
+Possible values are:
+* Standard (default)
+* MinNormMax (supported for string, double and int properties)
+* MinMax (supported for string, double and int properties)
+[[Category:How-To|Create a new MetaProperty]]
+[[Category:Studio|Create a new MetaProperty]]
+== Optional Attributes ==
+=== REFERENCE ===
+[[File:IL_HowTo_CreateMetaProperty_AssignReference_01.png|thumb|alt=Assign a reference|Assign a reference]]
+Assign a reference if the value of the property should link to an {{UBIK}} object. The data type of the MetaProperty has to be ''Guid'' that the data (guid) can hold a reference to an {{UBIK}} object.
+# Locate an existing or [[HowTo:Create_a_new_Reference|create a new Reference]]
+# Assign the reference to the '''REFERENCE''' property either by
+#* dragging and dropping the reference object onto the cell
+#* selecting the desired reference from the dialog appearing after double-clicking the cell
+=== SELECTIVELIST ===
+[[File:IL_HowTo_CreateMetaProperty_AssignSelectiveList_01.png|thumb|alt=Assign a selective list|Assign a selective list]]
+Assign a selective list to a property, if the respective column should display a Combobox with all items of the list instead of the value field. The value can then only be selected from the list, but not be edited manually anymore.
+# Locate an existing or [[HowTo:Create_a_new_Selective_List|create a new Selective List]]
+# Assign the list to the '''SELECTIVELIST''' property either by
+#* dragging and dropping the list object onto the cell
+#* selecting the desired list from the dialog appearing after double-clicking the cell
+=== UNITITEM ===
+[[File:IL_HowTo_CreateMetaProperty_UnitItem_01.png|thumb|alt=Set a unit item|Set a unit item]]
+If the property should consider a [[Unit]] (for example Ampere, Volt, etc.) the underlying [[MetaProperty]] has to incorporate a [[UNITITEM|Unit Item]] either by
+* dragging and dropping the unit item object onto the cell
+* selecting the desired unit item from the dialog appearing after double-clicking the cell
+{{Hint|Only properties of type Double can posses measuring units!}}
+=== FORMAT ===
+=== INDEXCOUNT ===
+Set the number of named index keys, for example to 4.
+=== INDEXKEYS ===
+Enter the index keys as a comma separated list of strings, for example "a,b,c,d" (INDEXCOUNT = 4).
+=== DEFAULTVALUE ===
+Set up to 10 [[MetaProperty#Default_value|default value(s)]] for the MetaProperty.
+=== INITIALVALUE ===
+Set up to 10 [[MetaProperty#Initial_value|initial value(s)]] for the MetaProperty.
+=== CATEGORY ===
+[[File:IL_HowTo_CreateMetaProperty_Category_01.png|thumb|alt=Change category|Change category]]
+If desired change the category of the MetaProperty to a value of the list. The property will then be moved to a new tab if the object is viewed in the [[View Test Environment]] or using the [[Object Editor]].
+=== NEEDSVALIDATION  ===
+Enable [[MetaProperty#Needs_Validation|validation]] by checking the '''NEEDSVALIDATION''' attribute of the MetaProperty and let the system explicitely store a validation time stamp information in the database. This is particularly used on the mobile client in combination with the [[SYSCLS_TASK]] and [[SYSCLS_MEASUREMENTTASK]] classification.
+{{Attention|'''NEEDSVALIDATION''' is replaced by UBIK Attribute technique since Version 2.5!}}
+Learn more about [[UBIK Attributes]].
+=== VALUEVALIDATION ===
+Assign a [[MetaProperty#Value_Validation|value validation]] object to the '''VALUEVALIDATION''' attribute of the MetaProperty either by
+* dragging and dropping the validation object onto the cell
+* selecting the desired validation object from the dialog appearing after double-clicking the cell
-# Start Workflow “System / Create new MetaProperty ” from the context menu
-# Set at least name, description and data type
-# Change the MetaProperty ’s category if necessary
-# Save the changes
-# Optional configuration:
-:: - Reference
-:: - Selective list
-:: - Unit item
-:: - Format
-:: - Validation flag
-:: - Number of index keys
-:: - Default values
-:: - Initial values
-== Using Workflows ==
-== Technical implementation ==
-Without the workflow the user has to complete the following steps:
-Step 1: Create new MetaProperty instance
-# Navigate to the MetaClass ''CUSTOMMETAPROPERTY''
-# Create a new instance
-# Set at least name, description and data type
-# Change the MetaProperty’s category if necessary
-# Save the changes
-# Optional configuration:
-:: - Reference
-:: - Selective list
-:: - Unit item
-:: - Format
-:: - Validation flag
-:: - Number of index keys
-:: - Default values
-:: - Initial values
-Step 2: Relate the instance of MetaProperty to a MetaClass
-# Open the control “Class Details”
-# Set the designated MetaClass to the control
-# Add the MetaProperty either by dragging and dropping the MetaProperty's instance onto the MetaClass or by clicking the [[File:IC_PlusGreen.png|20px|Add MetaProperty button]] button in the menu
-# By clicking on the [[File:IC_PlusGreen.png|20px|Add MetaProperty button]] button the user has to navigate through the hierarchy to the appropriate MetaProperty
-==Settings==
-NEEDSVALIDATION
-* explizite Speicherung des Validierungszeitstempels
-* zB Verwendung am Client: der Wert dieser Eigenschaft muss am Client validiert, dh. zumindest einmal angeklickt, werden. Bei Verwendung der CLS_TASK Klassifizierung wird dieses Objekt als Finished gekennzeichnet, sobald ALLE solch konfigurierten MetaEigenschaften validiert sind.
 ==See also==
-* [[UBIK Studio Basics]]
+* [[HowTo:Create a new MetaClass]]
-* [[Create a new MetaClass]]
+* [[MetaProperty]]
-[[Category:How-To]]
+[[Category:How-To|Create a new MetaProperty]]
-[[Category:UBIK Studio]]
+[[Category:Studio|Create a new MetaProperty]]