To view files which use a selected Keyword

1. Open the Administer Keywords... window.

2. Click on a keyword(s).

3. Double click a keyword to view files assigned to it.

4. All files assigned with the selected keywords show in the right side panel.

To create a Keyword

1. Open the Administer Keywords window.

2. Click the New button. In the left panel, a new keyword is created.

   

3. Enter a name for the new keyword, and press <Enter>.

To delete a Keyword

A keyword can only be deleted if it is not assigned to a file or folder. Look in the No. of Obj. field to verify how many files or folders the keyword(s) are assigned to.

1. Open the Administer keywords window.

2. In the left panel, click on the keyword(s) to delete.

3. Click the Delete button.

4. Click Yes in the delete confirm window.

To assign a Keyword to a file

1. Right-click a file in the File panel and select Properties from the context menu.

2. Click on Keywords in the Properties for <file name> window that opens.

   

3. Select/find a keyword(s) to assign to the file:

   1. Enter a keyword name in the search box.

   2. Click on Search, or Show All to see all available keywords

      Tip: Wildcards such as * or ? are allowed in the keywords search string.

4. Click a keyword, in the Assignable keywords panel, to select it.

5. Click the < Add button.

   Note: Up to 20 keywords can be assigned to one file.

6. Click OK.

To assign a Keyword with the file context menu

To assign a keyword(s) with the file context menu is better for on-the-fly keyword additions, but does not show any other data about the keyword(s) which are assigned.

1. Right-click a file in the File panel to open the file context menu and select Add keywords...

2. Search for available keywords by entering the name of a specific keyword, or asterisk (*) to show all available keywords.

3. Select the required keyword(s).

4. Click Add...

5. Click Add in the Add keywords... window.

6. Click Close.

To remove a Keyword from a file

With this procedure a keyword(s) is first selected then the file(s). The advantage to that method is greater visibility of information regarding each keyword and where it is used.

1. Open the Administer Keywords... window.

2. Click on a keyword(s) in the list of available keywords.

3. Double click a keyword to view the files assigned to the selected keyword.

   • All files assigned with the selected keyword(s) show in the right side panel.

4. Right-click on the file(s) from which the keyword is to be removed.

5. Click Remove keyword(s).

6. Click Remove.... in the Remove keywords from <file name>... window.

7. Click Remove in the Remove keywords... window.

8. Click Close.

To remove a Keyword with the file context menu

To remove a keyword(s) with the file context menu is better for on-the-fly keyword removal, but does not show any other data about the keyword(s) which are to be deleted.

1. Right-click a file in the File panel to open the file context menu, and select Remove Keywords...

   

2. Select the keyword(s) to be removed.

3. Click Remove....

4. Click Remove in the Remove keywords... window

5. Click Close

Simple add-on use case and conceptional workflow

Images of people need to be tagged with the first name, last name, gender, and age.

1. Addon template with corresponding fields is created and published. Only published add-ons can be assigned to files.

2. The addon is assigned to a file and the values wanted are entered.

3. Afterwards, the search grants the ability to view this information, for example, all files with a specific addon or gender male assigned are retrieved.

A typical add-on assigned on a specific file could look like:

• Add-On: Vizrt Meta Data

  • Title: My Metadata Element 01

  • Alternative title: Add-on Example 01

  • Synopsis: Add-on use case

  • Rights: Rights reserved and held by creator and contributors

  • Date: 20-02-2018

  • Language Code: ENGLISH

  • Media Type: Production Element

  • Creators: various

Add-ons are administered from the Add-ons window. They are assigned from the Add-ons Panel.

Each add-on can have several entries. Entries can be numbers, strings, UUID, date and XML (for use by external applications). Each entry also has a Proposal, which will set out the options for the add-on in an eventual drop down box. You can also add informational text for a tool tip, which will be shown when you mouse over the region of its name in the add-ons window.

One use case for add-ons is approval states. You can create an add-on with the parameters of Draft, Pending, and Approved. If an art director does not want any scene on the design cluster to be make it to the playout engine, he can use the Import external images functionality to take all new scenes, assign the add-on, and then only deploy scenes that he has personally approved to the playout engine.

To create a New Add-on

1. Open the Graphic Hub Manager

2. Open the Administer add-ons window:

   • Click Tools > Administer add-ons..., or

   • Press <Ctrl+Shift+F8>

3. Open the Create add-on window:

   • From the Administer add-ons window, click the Create new add-on... button , or right-click in the Add-ons quadrant and select Create new add-on...

     

4. In the Name field, enter a name for the add-on.

5. From the Group drop down box, select from:

   • ungrouped: the new add-on will not be in a group.

   • <group name>: Select a group to put the new add-on.

6. Check the Allow transfer via DDC, if required (when checked, the add-on will be transferred through DDC (Direct Deploy Copy)).

7. Check the Allow transfer via archive export/import, if required (when checked, the add-on may be transferred via Archives (exported/imported)).

8. Click the Add... button. The Create entry of add-on window is shown.

   

9. In the Name field, enter a name for the add-on entry.

10. From the Data Type drop down box, select one of the following options:

    • Number: Only manual proposals supported.

    • String: Supports manual proposals and having all registered users as a proposal option.

    • Date: No proposals supported, namely selecting a date from a calendar.

    • UUID: No proposals supported.

    • XML: No proposals supported.

11. Check the Mandatory check box for it to be mandatory for this entry to have a value. Uncheck it for the entry to be optional.

12. From Proposal drop down box, make sure Manual is selected.

    Note: If the Data Type is String, the option of selecting <all users> as the Proposal is available. In this case, no further Proposal configuration is required.

13. In the Add field, enter an option that will be available for selection and click the Add button. Repeat for as many options as you want to have in your proposal.
    You can also remove options by clicking the Remove button, as well as changing the order in which options will appear by clicking the Up, Down, Top and Bottom buttons.

14. Check the Restrict check box to restrict the proposal entries to what you have added above. Uncheck it to allow user-defined entries in addition to your proposal options.

15. From the Default value drop down box, select one of the following options:

    • <none>: There will be no default value assigned. Not available if the entry is restricted.

    • <user defined>: The value will be defined when assigning the add-on. Not available if the entry is restricted.

    • <current user>: The logged-in user will be the default value. The other proposal values will also be available.

    • <current time>: The current date and time will be the default value. Only valid if the Data Type is Date.

    • Any of the other proposals you have defined above.

16. In the Info field, enter any text that you wish to appear as a tool tip when mousing over the add-on once it has been published.

    Caution: Any text you enter in this field will be exposed to end users.

17. Click OK.

To create an Add-on group

1. Open the Graphic Hub Manager.

2. Open the Administer add-ons window:

   • Click Tools > Administer add-ons...

3. Open the Create add-on group window:

   • In the Administer add-ons window click the Create new add-on group... button , or right-click in the Add-ons quadrant and select Create new add-on group...

     

4. In the Name field, enter a name for the add-on group

   Note: Make sure that the new Group name is unique.

5. Click the OK button. The new Add-on group will show in the Add-ons quadrant.

   Note: Add-ons can be dragged from group to group as required.

To publish an Add-on

1. In the Add-ons quadrant of the Add-ons window, right-click the add-on and select Publish add-on.
   You are queried if you are sure you want to publish this add-on.

2. If the add-on is ready for use, click Yes.

To filter add-ons by type

• In the Add-ons quadrant of the Add-ons window, from the Filter by type drop down box, select one of the following options:

  • All: All add-ons

  • User-defined: All add-ons created by any users

  • Viz: External metadata created by another Viz application

  • System: All Graphic Hub server-delivered add-ons

To filter add-ons by stage

• In the Add-ons quadrant of the Add-ons window, from the Filter by stage drop down box, select one of the following options:

  • All: All add-ons

  • Draft: Unpublished add-ons

  • Published: Published add-ons

  • Retired: Add-ons retired from active use (because they can be withdrawn from service but not deleted from the system).

  • Imported: Metadata exported to Graphic Hub by other Viz applications.

  • Copied: Transferred in a deploy operation.

  • From archive: Add-ons exported by Viz Engine and re-imported from a Viz Artist archive to the Graphic Hub.

To sort Add-ons and Add-on groups

1. Click Tools > Administer add-ons... to open the Administer add-ons window.

2. In the Add-ons panel, select on an Add-on or an Add-on Group.

3. Drag the Add-on or an Add-on Group to its new location.

To assign an add-on

1. Enable the Add-ons Panel.

2. Select one or more files and drag them into the add-ons header.

   • To remove a file from the add-ons header, click it and press <Delete>.

3. Click the Edit tab.
   Add-ons available for assignment are shown.

   

4. Click the button to the left of an add-on to expand it.

5. Check the check box beside the add-on to select it.

6. Do one of the following:

   • Select a value from the proposals drop down box.

   • Enter a value in the field (allowed only if the add-on is unrestricted).

   • Click the <E> button to the right of the add-on to edit the proposals (allowed only if the add-on is unrestricted).

   • Select a date (allowed only if the add-on is for the Date data type).
     

     Note: With multiple files selected, where some have add-ons with different values, the entries that have different values will display <mixed values!>.

7. Click Apply.

To retire an add-on

1. In the Add-ons quadrant of the Add-ons window, right-click the add-on and select Retire add-on.
   You are queried if you are sure you want to publish this add-on.

2. If the add-on is ready for use, click Yes.
   The add-on is no longer available for use.