The Search Editor's main view is a panel with two tabs: Input and Output.
1.1 Input
The Input tab deals with creating, deleting, and updating 2 Filters for a search.
Here is a brief explanation of various terms, which are relevant for the Search Editor's Input tab. Each term has a link to a page, where there will be a more in-depth explanation and guide on how to apply it.
- 2 Filter
- A 2 Filter is a condition, which is applied to the data in the DAM Center during a search.
- 7 Group
- 3 Comparison Type
- Determines how a given 2 Filter does its "filtering".
- 4 Input Type
- Determines how any 8 Visible filter gets the user's input. This is specific to Media Manager and Video Portal, i.e. 4 Input Type can be used to gather a search's parameters and therefore has no impact on the search itself.
- 8 Visible filter
- If a 2 Filter is visible, then parameters for that filter can be supplied by the user in Media Manager and Video Portal.
- 5 Predetermined values
- If the parameters for a 2 Filter are known in advance, predetermined values can be applied to the 2 Filter. If 5 Predetermined values are applied to a 2 Filter, any parameters supplied by the user or client code will be ignored.
1.2 Output
The Output tab deals with creating, deleting, and updating the 9 Value Fields for a search.
Here is a brief explanation of various terms, which are relevant for the Search Editor's Output tab. Each term has a link to a page, where there will be a more in-depth explanation and guide on how to apply it.
- Value Field
- A Value Field is an element, which defines a property in the search result.
- isArray
- Determines whether a Value Field is ALWAYS output as an array.
- returnType
- Determines how a Value Field is represented in the search result.
- Tooltip
- Determines whether a Value Field is used in the tooltip of an asset
- Determines whether a Value Field is used in the tooltip of an asset
1.3 Input and Output
Some terms are used in both the Input and Output tabs. As with the two previous paragraphs, here is a brief explanation of these terms as well as a link to a page with a more in-depth explanation.
- 1 ID
- The ID has two different implications: one for 1 Input, and one for 3 Output
- 1 Input: The ID of a 2 Filter is the name of the parameter given to the search.
- 3 Output: The ID of a 9 Value Field is the name of the property in the JSON returned by the search. It can also be the Constant of a label, which is used in the DAM Center, Media Manager, and Video Portal to display the output of a 9 Value Field.
- The ID has two different implications: one for 1 Input, and one for 3 Output
- 10 Custom attributes
- 10 Custom attributes are user-defined attributes of a 2 Filter or 9 Value Field.
- 11 Field
- A 11 Field is used in conjunction with a 12 Meta data field to specify a value other than the default 12 Meta data field value.
- 19 Meta field group
- A meta data field belongs to a meta field group.
A user can add three different kinds of 2 Filters and 9 Value Fields:
- 14 Table and column
- This is a filter or value field, which acts upon a specific table and column in the database.
- 12 Meta data field
- This is a filter or value field, which acts upon a meta data field, eg "Keywords", "Description", or "Title".
- 13 Predefined
- This is a special filter or value field, which can be a 7 Group, 9 Value Field, 2 Filter, any combination of these, or something else entirely. A 13 Predefined 2 Filter or 9 Value Field is an element, which represents functionality, that is not supported by either a 14 Table and column element or 12 Meta data field.
1.4 "Translations"
During the genesis of the Search Editor a decision was made to rename certain concepts. This was done to help the user understand what these concepts do.
This small section's purpose is to explain, that these concepts might be called something different elsewhere in the documentation.
"searchField" → 2 Filter.
"searchFields" → 7 Group.
"valueHandler" → "3 Comparison Type".
"renderType" → "4 Input Type".
"operator" → "1 Condition"