Caution
We recommend shutting down all the Cinegy Desktop clients and not using them until the changes made in the descriptors and presets configuration are committed to the Cinegy Archive database. Set the "Set Halt Flag" flag in the "Global parameters and settings" configuration group to automatically close the already started Cinegy Desktop clients and to prevent connections for the new ones.
Caution
It is strongly recommended to have the identical set of descriptors for the master and slave databases; otherwise some data may be lost when copying between the databases.

Descriptors, Presets

You can customize the structure of the database with this control – create new metadata fields and new tabs, move the fields to another tab (group) and rename any object.

The main interface shows the structure of the entire Cinegy Archive:

14_DBM_descriptors_main

You have the following elements:

14_DBM_descriptors_main_02

The interface allows you to:

  • create a new group;

  • delete a group;

  • create a new metadata field;

  • delete an existing field;

  • rename an existing field;

  • change the type of an existing field;

  • change the set of values for the present field types.

Creating a New Group

To create a new group, press the "New" button on the group panel. Rename the new group field to your requirements.

Note
When the group is associated with the Bin, the group name will be displayed in the Bin view; so try to use a short, distinct and unique name.

14_DBM_descriptors_main_group

arrow_right

14_DBM_descriptors_main_group_02

Deleting a Group

To delete a group, select it on the group panel and press the "Delete" button.

Caution
The deletion of a group is permanent and cannot be undone!

Creating a New Metadata Field

14_DBM_descriptors_main_field

Select the group, in which you want to create the new metadata field and press the "New" button on the fields panel.

The following dialog box appears:

14_DBM_descriptors_main_field_02

In this dialog, fill in the description of the new field.

Description of Fields

Name

Here enter the name of the new field.

Note
When the group is associated with the Bin, the field name will be displayed in the Bin view. So try to use a short, distinct and unique name.
14_DBM_descriptors_main_field_03
Internal Name

This is used for the internal addressing of the field. This name is created automatically.

Caution
Never change the internal name of the existing fields of a currently active database!

Value Type

14_DBM_descriptors_main_field_04

Field Type Description

String

For strings, up to 4000 characters long

TimeCode

The timecode

Text

For text fields, longer than 4000 characters

A set of name constants

Date

The date

Integer

An integer value of 32 bit (min/max settings are required)

Boolean

True/False value

Real

A floating point value of 64 bit (min/max settings are required)

Note
Do not use the "Text" type for short strings, as this may slow down the database performance.

Min Value / Max Value

For numeric fields, you have to define the valid range of values. For the text and string types, the max value defines the maximum allowed length of text.

Caution
Inconsistent settings of the values will cause a serious malfunction of the system.

Main Settings

Flags
Flags Description

Ingest

The "Ingest" field appears in the "Ingest Roll info" dialog (the so-called "mandatory ingest fields")

Important
Refer to the Setting Up Roll Info article in the Cinegy Ingest Manual.

Ingest only

The field appears in the "Ingest Roll info" dialog and will not be shown in the bin grid

Playout

This field is used in the "Schedule Playout" table (out of date)

Playout only

The field appears in the "Schedule Playout" table, but will not appear in the bin grid (out of date)

Search

This option makes this field searchable for the "Search" plug-in of Cinegy Desktop or other application using CBA (Common Bus Architecture)

Note
Please note that search will be performed only for descriptors marked with the "Search" flag.

Do not concatenate

This option controls the behavior of the text fields during the "Join" operation in a Roll. For the fields like a text description, enable concatenation; for some text fields like "Make up artist" this would make less sense

System field

System feature, for internal use only

Caution
Do not change the value of the field!

Special metadata copy

This option makes this field available in the "Paste metadata" dialog box when copying metadata between nodes of the same type in Cinegy Desktop

Read only

This option marks this field as "read only" in Cinegy Desktop

Do not copy metadata

This option disables metadata copying between nodes of the same type in Cinegy Desktop

Inventory

The descriptor marked with this flag will be exported to MCRItem as a custom metadata field.

Important
Refer to the Custom Metadata paragraph within the Cinegy Air Manual.
Description

Here write a small and clear description for the new field.

Extended

14_DBM_descriptors_extended

On the "Extended" tab, you can create extended properties for the descriptors in XML format.

Creating Fields of the Type "Preset"

When you select the "Preset" type, you will see in the lower right a new area called "Presets". Here you can create a set of values for the new field.

16_DBM_descriptors_new_preset

This example shows the "Preset" field in Roll info of the camera operator:

16_DBM_descriptors_new_preset_02

The "Preset" field in the Roll grid:

16_DBM_descriptors_new_preset_03

You will also see the presets on the preset panel.

Description

Use this field to describe the metadata. Write a small and clear description of the new field. If you cannot describe the field in a few words, it could be better not to introduce the field into Cinegy Archive.

Modifying a Metadata Field

To modify a metadata field, select the field and press the "Edit" button on the fields panel. The process of the metadata field editing is similar to its creating with the difference that the "Value Type" option is disabled.

Deleting a Metadata Field

To delete a metadata field, select it on the field panel and press the "Delete" button. The deleted field will be moved to the scrap panel.

System Metadata Fields

There is a special metadata fields set in Cinegy required for internal processing – system fields. They are displayed on the red background.

descriptor_fields_required
Caution
It is strongly recommended not to delete the system metadata field(s) as it may lead to the incorrect work of Cinegy.

Working with the Scrap Panel

17_DBM_descriptors_scrap

All the deleted fields are moved to the scrap panel located in the bottom right section of the window. This means it is always possible to move the field back to the selected group. Simply press the "Insert" button. If you want to delete the field permanently, press the "Remove" button.

Committing Changes to the SQL Server

Your editing is not committed immediately to the database. If you would like to undo the deletion of a field, you will have to do this manually. To commit your current changes to the SQL Server, press the "Commit" button.

17_DBM_descriptors_commit
Note
When you exit Cinegy Enterprise Manager, the data will be committed automatically.

Ingest Templates

An ingest template contains a set of assigned ingest fields available in the "Roll info" dialog box for the ingest operator:

14_DBM_descriptors_Ingest Templates_Roll Info
Important
Read the Setting Up Roll Info article in the Cinegy Ingest Manual for details about setting the values for ingest metadata fields.

On the "Ingest Templates" tab, you can create and customize as many ingest templates as you need for ingest purposes.

14_DBM_descriptors_Ingest Templates
Important
Refer to the Main Settings paragraph for more details about descriptor flags and their meanings.

14_DBM_descriptors_add_button

Press the "New" button to create a new template. Fill in the "Name" field and press the "Save" button to save your template. It will be displayed in the table below:

14_DBM_descriptors_Ingest Templates_template creation

delete_button

Press the "Delete" button to remove the selected template.

refresh_button1

The "Refresh" button renews the list of ingest templates existing in the current database.

To assign descriptors to a selected template, select the descriptor type from the "Available descriptors" list and add it to the "Selected descriptors" list via the add_buttonbutton. To add all available descriptors to the "Selected descriptors" list, press the add_all_buttonbutton.

To remove a descriptor from the "Selected descriptors" list, press the remove_buttonbutton for the selected descriptor or use the remove_all_buttonbutton to clear the whole list.

template_descriptors_for template
Note
The descriptors marked as "Ingest" are displayed on the right of the dialog.

Node Type’s Descriptors, Templates

17_DBM_node_types_main

Basic Settings

On the "Basic Settings" tab, you can assign descriptors for each node type. To do this, select the node type from the "Node types" list and add it to the "Selected descriptors" list via the add_buttonbutton. To add all available descriptors to the selected descriptors list, press the add_all_buttonbutton.

To remove selected descriptor(s) from the selected descriptors list, press the remove_buttonbutton or use the remove_all_buttonbutton to clear the whole list.

Caution
When removing the node type descriptors from the selected descriptors list, all the corresponding field values will be erased.

Descriptors

All node subtypes will have the same set of descriptors as their parent node type. To assign descriptors for just a particular node type, select it and specify the descriptors as described above.

All assigned descriptors have the corresponding fields in the "Metadata" dialog, available from the node "Show metadata" context menu for the node in the Cinegy Desktop explorer tree.

Important
Refer to the Node Metadata article in the Cinegy Desktop Manual for details.

Select specific descriptors in the "Selected descriptors" list to make them mandatory within Cinegy Desktop. These fields cannot be left empty; if they are, you will be informed about it with an error message.

Read-Only Settings

On the "Read-Only settings" tab, you can assign read-only permission to specific descriptors for certain user roles. To do this, select the required descriptor in the "Selected descriptors" box of the "Descriptors" tab, then go to the "Read-Only settings" tab and choose the required user role from the list and press the "Add" button:

14_DBM_descriptors_Ingest Templates_read-only

The corresponding descriptor will be read-only for the selected role. To assign the read-only permission to all the available roles, press the "Add all" button.

In the example below, the "Expiration" and "Ingest site" fields cannot be edited in Cinegy Desktop because they are read-only:

read_only_premissions_master clip

To remove the read-only status for the selected user role, use the "Remove" button or press "Remove all" to remove the read-only status for all the user roles.

Additional Templates

On the "Additional Templates" tab, you can create and customize as many additional templates as you need for your purposes.

14_DBM_descriptors_add_button

Select a node type from the "Node types" list and press the "New" button to create a new additional template.

save_button

Fill in the "Name" field and press the "Save" button to save your template. It will be displayed in the table below:

14_DBM_descriptors_additional_templates

delete_button

Press the "Delete" button to remove the selected additional template.

To use a selected template as your default template, tick off the "Use by default" checkbox. Press the "Save" button to apply this setting:

14_DBM_descriptors_additional_templates_default

To assign the descriptors for a selected template, select the descriptor type from the "Available descriptors" list and add it to the "Selected descriptors" list via the add_buttonbutton:

additional_templates

To add all available descriptors to the "Selected descriptors" list, press the add_all_buttonbutton.

To remove the selected descriptor(s) from the "Selected descriptors" list, press the remove_buttonbutton or use the remove_all_buttonbutton to clear the whole list.

The default template defines a set of metadata for the node in Cinegy Desktop.

Form Designer

The form designer provides the ability to create a custom metadata form for each node type.

Form Designer_button

To create a metadata form for the currently selected node type, press the "Form Designer" button; the following dialog box appears:

Form designer_adding descriptors into designer

In the "Insert node descriptors" field, you can choose one of the following:

  • All descriptors – to insert all the selected node descriptors to the designer surface;

  • Mandatory only – to insert only mandatory node descriptors to the designer surface;

  • Do not insert – not to insert node descriptors to the designer surface.

In the "Insert descriptor groups" field define the metadata arrangement in the designer surface: either each group can be located on a separate tab or all the groups can be gathered into a single form:

In tab pages

In primary control

Designer_Surface1_a

_Designer Surface2

The Interface

Form Designer_interface

The form designer interface consists of the following parts:

  • Toolbox (on the left) – displays available descriptors for the current node type. This toolbox contains the following two tabs: "Windows Components", which includes a set of default Windows controls, and "Cinegy Components", which includes all the descriptor controls for the current node type.

  • Designer Surface (in the center) – is used to create and edit various controls in the metadata form. To add a new control to the designer surface, select the required one from the "Toolbox" and drag-and-drop it to the desired position in the form; horizontal and vertical guides appear helping you to align the control. Each element can be selected with the mouse and relocated within the form, if needed.

    The control type depends on the descriptor type and typically consists of two elements: label with the descriptor name and custom control that allows user to view and edit the descriptor value.

    Note
    All the mandatory descriptor labels are shown in bold.
  • Output (at the bottom) – logs output events. Use the Ctrl+Insert keyboard shortcut to copy the selected text from the "Output" window to the clipboard.

  • Assembly options (on the right) – defines the type of the assembly being created:

    • Enable form – select this checkbox to enable the current assembly;

    • Create two forms – select this checkbox to create two different assembly forms: the first form to be used during the particular node creation and the second one to be used for particular node’s metadata editing. Otherwise, a single assembly form will be created to be used both when creating a new node of a particular type or editing metadata of this node.

      Use the "Remove Assembly" button to delete the current assembly from the database.

  • Property Grid (below the "Assembly options") – provides access to the parameters of the currently selected controls in the "Designer Surface".

form designer_main menu

The main menu bar is located in the top left corner of the "Form Designer" window and consists of the following submenu items:

  • File – provides the ability to create a new assembly, save an existing one in XML format, build the assembly or exit the form designer.

  • Edit – provides access to the editing commands such as "Undo"/"Redo", "Copy", "Paste", "Delete", "Select all".

  • Tools – allows user to customize the controls tab order and alignment.

Main Toolbar

form designer_main toolbar
Button Action

form designer_open

Opens the existing assembly (in XML format)

form designer_build

Builds the assembly form

form designer_undo-redo

Undoing/redoing one or more actions

form designer_cut

Cuts the selected control

form designer_copy

Copies the selected control

form designer_paste

Pastes the copied control

form designer_delete

Deletes the selected control

form designer_preview

Previews the assembly form on a separate tab (if more than one assembly form is created, for each of them a separate preview will be created on a separate tab)

form designer_customize

Customizes the controls tab order