3.2.1.1 Add new meta data field to Media Manager's Asset info - DAM v4.8.0

Owned by Emilis Bliudzius (Unlicensed)
Last updated: Oct 02, 2017 by Mathias Mattson (MHM)
13 min read


Important!

If you want to see the changes, this page describes, in the Media Manager, you MUST recycle the website.

Three actions are required to add a new meta data field to Media Manager's Asset Preview:

  1. Add a new meta data Value Field to Media Manager's DigiZuite_System_Framework_AssetInfo search.
  2. Create a new label (if one does not already exist), whose Constant matches the newly created value field's ID.
  3. Recycle the Media Manager website.

(MM) Add a metadata field to asset info (In short)

  1. Go to System tools → ConfigManager → Digizuite™ Media Manager → 4.0.0 → OOBE
  2. In OOBE press Searches and then DigiZuite_System_Framework_AssetInfo
  3. Press "Output"
  5. Press "Add"
  6. Press "Choose metafield group"
  7. Navigate to the metadata field you'd like to add (Usually beneath Asset → Shared → Asset Info or ... → Options)
  8. Press "Done"
  9. Press "Choose metadata field" and select the field you'd like to add.
  10. If the Asset Info entry should not be rendered as a string, den you need to define a return type. E.g. int for returning whole numbers, or bool for true/false.
  11. (Optional) Change the ID (It just have to be unique to the other searches - you cannot save if it's not)
  12. (Optional) Copy the ID to make it easier to create a label in the upcoming steps
  13. (If you've chosen a combo metadata field) You need to wing off the "isArray?". If not, it'll lump in the entries together.
  14. (If you've chosen a combo metadata field) (Optional) Press "Add custom attributes" and write "searchable" & "true". It will not make it searchable, but instead make entries have a white background.

  15. Press "Create"
  16. (Do NOT wing off the "use Solr"!)
  17. Press "Save" for the search (Not the entry)
  18. Press "OK"

  19. Press Labels
  20. Expand Digizuite™ Media Manager

  21. Press AssetInfo

  22. Press "Add label"
  23. In the new entry that appears, add the ID in the "Constant" and in the "Label" input the text you want it to have in your currently chosen language (If nothing else is shown, you're most likely editing English) Remember to give a Label text for each language.
  24. Press somewhere else on the page, for the "Save" button to be enabled
  25. Press "Save"
  26. Press "OK"
  27. (Sometimes necessary) Recycle of DC (Likely not MM) through the IIS (Failing to do this, will result in your changes not being in the asset info) - Sometimes you only need to refresh the page.
  28. Go to your MM web site.
  29. Go to an asset, and look at its right side data - the label with your data you added some steps back should now be available in your language.


Media Manager's Asset Preview has some data in its right hand panel, such as Title, Upload Date, Width, Height, etc:

The data is requested by calling Media Manager's SearchService.js proxy. The search DigiZuite_System_Framework_Search_AssetInfo is used. This is a special use of SearchService.js in that some post processing is done on the search result, so the response from SearchService.js is not what one might ordinarily expect from DigiZuite_System_Framework_Search_AssetInfo:


{
    "errors": [],
    "items": [
        {
            "errors": [],
            "itemId": 9488,
            "success": true,
            "valueFields": [
                {
                    "format": "",
                    "id": "title",
                    "isIterative": false,
                    "iterativFields": [],
                    "label": "Title",
                    "pattern": "",
                    "searchable": false,
                    "type": "string",
                    "value": "Hydrangeas"
                },
                {
                    "format": "",
                    "id": "description",
                    "isIterative": false,
                    "iterativFields": [],
                    "label": "Description",
                    "pattern": "",
                    "searchable": false,
                    "type": "string",
                    "value": ""
                },
                {
                    "format": "",
                    "id": "uploadDate",
                    "isIterative": false,
                    "iterativFields": [],
                    "label": "Upload Date",
                    "pattern": "",
                    "searchable": false,
                    "type": "string",
                    "value": "2017-01-23T13:53:15.740+01:00"
                },
                {
                    "format": "",
                    "id": "imageWidth",
                    "isIterative": false,
                    "iterativFields": [],
                    "label": "Width",
                    "pattern": "",
                    "searchable": false,
                    "type": "string",
                    "value": "1024"
                },
                {
                    "format": "",
                    "id": "imageHeight",
                    "isIterative": false,
                    "iterativFields": [],
                    "label": "Height",
                    "pattern": "",
                    "searchable": false,
                    "type": "string",
                    "value": "768"
                },
                {
                    "format": "",
                    "id": "imageDPI",
                    "isIterative": false,
                    "iterativFields": [],
                    "label": "DPI",
                    "pattern": "",
                    "searchable": false,
                    "type": "string",
                    "value": "96"
                },
                {
                    "format": "fileSize",
                    "id": "fileSize",
                    "isIterative": false,
                    "iterativFields": [],
                    "label": "File Size",
                    "pattern": "",
                    "searchable": false,
                    "type": "string",
                    "value": "595284"
                },
                {
                    "format": "",
                    "id": "allowDownload",
                    "isIterative": false,
                    "iterativFields": [],
                    "label": "Allow Download",
                    "pattern": "",
                    "searchable": false,
                    "type": "string",
                    "value": "0"
                },
                {
                    "format": "",
                    "id": "menuItems",
                    "isIterative": false,
                    "iterativFields": [],
                    "label": "Portal Menu",
                    "pattern": "",
                    "searchable": false,
                    "type": "array",
                    "value": [
                        "Digizuite"
                    ]
                },
                {
                    "format": "duration",
                    "id": "videoLength",
                    "isIterative": false,
                    "iterativFields": [],
                    "label": "Duration",
                    "pattern": "hh:mm:ss.fff",
                    "searchable": false,
                    "type": "string",
                    "value": ""
                }
            ]
        }
    ],
    "success": true
}

Some JSON Objects' data is not used in the Asset Preview: "videoLength" and "description". These are not used because their values are empty strings. If one were to add a description to the asset used in the image above, the description would also be shown.

1.1 Adding a Keywords value field to the search

Note: Always make sure, you have selected the correct product and version. In this scenario, the product is "DigiZuite™ Media Manager" and the version is "4.0.0" (This is only true for the purposes of this demo: normally one SHOULD never edit the searches in a product's standard version).


The value field:

The Custom attributes "searchable" with value "true" makes the Media Manager display the keywords as

If the searchable custom attribute is missing, the keywords are displayed as

 

At this point, the Asset Preview looks like 

The two keywords "pretty" and "flower" are displayed, but there is no label to tell the user what these words mean. So the next step is to add a label.

1.2 Adding a label

This is done by

  1. Going to DAM Center → System tools → Config manager
  2. Choosing DigiZuite™ Media Manager.
  3. Choosing the version.
  4. Clicking the "Labels" tab.
  5. Expanding the folder "DigiZuite™ Media Manager".
  6. Choosing the folder "AssetInfo".
  7. Adding a new label with a Constant, which matches the keywords value field's ID, ie "Keywords2":

After recycling the website, the Asset Preview is


Congratulations! You have now added the Keywords meta data field to Media Manager's Asset Preview!


Table of Contents: