10 Custom attributes

Custom attributes are attributes, which have nothing to do with the actual filtering of the values, which are outputted.

Custom attributes can be applied to both filters and value fields.

Every custom attribute is a key-value pair.

Prime examples of custom attributes, which the DigiZuite™ products Media Manager and Video Portal use, are Input Type and Visible filter. Both of these have no impact on the search itself, but the products use these attributes to decide which filters to use and how to collect the input from the user.

Media Manager makes an HTTP request to the API to determine what filters to show and how to gather input to these filters. 

Example request:

<API URL>/SearchService.js?searchName=DigiZuite_System_Framework_My_Videos&method=GetVisibleSearchFields

The method "GetVisibleSearchFields" parses a specific search and returns any visible filters. Media Manager then displays the filters returned by the request.

The response from the API:

{
    "errors": [],
    "searchFields": [
        {
            "dataTypeId": 169,
            "itemId": 2481,
            "metafieldItemId": 2380,
            "parameterName": "sKeywords",
            "renderType": "multicombo"
        },
        {
            "dataTypeId": 300,
            "itemId": 5722,
            "metafieldItemId": 5719,
            "parameterName": "sMenu",
            "renderType": "tree"
        },
        {
            "dataTypeId": 0,
            "itemId": 0,
            "metafieldItemId": 0,
            "parameterName": "sAssetType",
            "renderType": "assettype"
        }
    ],
    "success": true
}

10.1 Restrictions

Please note, that because DigiZuite™'s own products use the custom attributes "inputType" and "visible", a user cannot add a custom attribute, which has the keys "inputType" or "visible". These two are a subset of the keys, which have been blacklisted. The list of blacklisted keys are

 'aggregate', 'bindid', 'DefaultToDisabled', 'Distinct', 'editable', 'edlField', 'exifField', 'field', 'fieldName', 'fieldStructure' ,'GroupBy', 'id', 'iptcField', 'isArray', 'itemGuid', 'metaFieldId', 'metaFieldLabelId', 'metaFieldName', 'ObjectReferenceType', 'operator', 'renderType', 'returnType', 'securityType', 'sortDirection', 'standardGuid', 'tooltip', 'type', 'UseAsBigFreetextField', 'valueHandler', 'valueType', and 'visible'.

This list is subject to change in the future.

Furthermore, a key MUST be unique and MUST start with a letter or underscore. After the first letter, a key may have any number of letters, underscores, or numbers.

A value may be any combination of letters , underscores, or numbers.

10.1.1 Allowed letters

The allowed letters are english letters, ie. A-Z and a-z, and the danish letters Æ, Ø, Å and æ, ø, å.

A custom attribute can be defined during creation of a filter or value field:

Creation of a filter.

and edited/deleted in the The Details panel.