Metadata Input field
In most cases, this field is used to enter free-form text, although it can save HTTP links, dates, and data or refer to the application folder ( as an internal link to this folder ).
| Attribute | Description | Required |
|---|---|---|
| label |
The text is shown as a label in the user interface. |
true |
| name |
Unique field identifier. Two metadata can't have the same name. The name must be unique. The name must start with "okp:". Using the metadata group name as the basis for the metadata field name is a good practice. For example use "okg:consulting" has been used for the field name "okp:consulting.input", changing "okg" to "okp". That helps to find the metadata group based on the metadata field name. Please, use only letters, numbers, and underscore: "0-9a-zA-Z_".
|
true |
| type |
Type value. Allowed types:
|
true |
| value |
Specifies a default value for this component. There's a special case for date types. Data is stored in the format "yyyyMMddHHmmss", be aware of this format when using OpenKM API. |
false |
| width |
The width of the HTML element. In the case of KCenter, UI must use width values based on %, for example:
|
false |
| height | The height of the HTML element. | false |
| placeholder | The placeholder value. | |
| description | General description. | false |
| readonly | If the field cannot be modified from user interface. By default, the value is "false". | false |
| timeFormat |
When the input type is "date", we can specify if we want to be able to see and modify hours and minutes. Allowed values:
|
false |
| searchType |
Choose how Lucene analyzes the string value. These are the possible values:
The default value is "fuzzy". When the value is "fuzzy," Lucene analyzes and or tokenizes the string. If the value is set to "exact," Lucene will not tokenize the string to make the search more exact. For example, if you have two nodes with these property values:
In the case of "fuzzy," if you look for "100," both results will appear. In the case of "exact," only Node 2 will appear in the results. |
|
|
dbColumnSize |
Set the size of the database field where the value is stored. By default, fields are stored in a database column with 128 characters in size. Because your data length might be more significant than 128 characters, the administrator should update the default column size. Take a look at the Metadata XML definition documentation section for a deep explanation of metadata stored in the OpenKM database, |
|
|
defaultAccess |
Default security access policy. By default is set to "grant" so all users will see the property. |
|
|
Child elements:
|
||
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 3.10//EN"
"http://www.openkm.com/dtd/property-groups-3.10.dtd">
<property-groups>
<property-group label="Consulting" name="okg:consulting">
<input label="Input label" name="okp:consulting.input" />
</property-group>
</property-groups>
