framework metadata description

8/9/2019 Framework Metadata Description

1/41

Framework Metadata Description

Common Metadata Object Attributes .................................................................11

id ............................................................................................................................................11text ......................................................................................................................................... 11group_name ........................................................................................................................... 11security_entity_usage_id ....................................................................................................... 11visible .....................................................................................................................................11hidden_for_user .....................................................................................................................11

Config.xml ..............................................................................................................11

Config Attributes: ....................................................................................................................12

application_code ....................................................................................................................12application_scope .................................................................................................................. 12child_entity_usage_visible_in_hierarchy ..............................................................................12

plugins ................................................................................................................................... 12Assemblies.xml .......................................................................................................12

Assembly Attributes: ............................................................................................................... 12

id ............................................................................................................................................12namespace ..............................................................................................................................12file_name ............................................................................................................................... 12application_scope .................................................................................................................. 12

Classes.xml .............................................................................................................12

Class Attributes: ...................................................................................................................... 12

id ............................................................................................................................................12assembly_id ........................................................................................................................... 12name .......................................................................................................................................12

Entities.xml .............................................................................................................13

Entities Attributes: .................................................................................................................. 13

group_name ........................................................................................................................... 13Entity Attributes: .....................................................................................................................13

id ............................................................................................................................................13plural_caption ........................................................................................................................ 13single_caption ........................................................................................................................13

operations ...............................................................................................................................13entity_class_id ....................................................................................................................... 13db_object ............................................................................................................................... 13db_object_1 ........................................................................................................................... 14db_object_2 ........................................................................................................................... 14 ........................................................................................................................................... 14db_object_9 ........................................................................................................................... 14self_reference_attr_id ............................................................................................................ 14hint_find .................................................................................................................................14hint_grid .................................................................................................................................14hint_new ................................................................................................................................ 14

hint_edit .................................................................................................................................14hint_view ............................................................................................................................... 14

post_create_command_id ...................................................................................................... 14


2/41

post_update_command_id ..................................................................................................... 14in_security ............................................................................................................................. 14file_lib_category_entity_usage_id .........................................................................................14file_lib_category_reference_attribute_id ...............................................................................14file_lib_category_code_attribute_id ......................................................................................14file_lib_hide_upload_file_section ......................................................................................... 14

grid_row_variable_height ......................................................................................................14auto_generate_filter_condition ..............................................................................................14record_count_limit .................................................................................................................14cached .................................................................................................................................... 14security_entity_usage_id ....................................................................................................... 14current_workspace_filter ....................................................................................................... 14available_workspace_filter ....................................................................................................15insert_on_update ....................................................................................................................15

primary_key_update .............................................................................................................. 15read_only ............................................................................................................................... 15read_only_attributes .............................................................................................................. 15

connection_id .........................................................................................................................15grid_cell_merging ..................................................................................................................15

Entity Web Attributes: ............................................................................................................15

web_find_control ...................................................................................................................15web_edit_control ................................................................................................................... 15filter_enabled .........................................................................................................................15web_page_size .......................................................................................................................15grid_row_css_class ................................................................................................................15grid_word_wrap .....................................................................................................................15web_filter_on_start ................................................................................................................15

Entity Windows Attributes: ....................................................................................................15

frame_class_id .......................................................................................................................15editable_in_grid .....................................................................................................................15auto_width_in_grid ................................................................................................................15image_id ................................................................................................................................ 15win_edit_form_id .................................................................................................................. 15display_grid_layout_in_tree .................................................................................................. 16edit_controller_class_id .........................................................................................................16customizable .......................................................................................................................... 16customize_caption ................................................................................................................. 16refresh_depends_on_entity_usages ....................................................................................... 16

grid_view_customizable ........................................................................................................16edit_form_customizable ........................................................................................................ 16filter_form_customizable .......................................................................................................16query_customizable ...............................................................................................................16disable_bookmarks_and_recent_items ..................................................................................16select_only_when_filter_enabled ..........................................................................................16

paging_enabled ...................................................................................................................... 16reload_entity_after_update .................................................................................................... 16

Entity Unused Attributes: .......................................................................................................16

colors_in_grid ........................................................................................................................16may_disappear_after_update ................................................................................................. 16

edit_class_id .......................................................................................................................... 16Entity Child Tags: ....................................................................................................................17

sql_select ............................................................................................................................... 17


3/41

sql_select_single_row ............................................................................................................17sql_insert ................................................................................................................................17sql_update ..............................................................................................................................17sql_delete ...............................................................................................................................17

primary_key_clause ............................................................................................................... 17parent_entities ........................................................................................................................ 17

hint_find .................................................................................................................................17hint_grid .................................................................................................................................17hint_new ................................................................................................................................ 17hint_edit .................................................................................................................................17hint_view ............................................................................................................................... 17

Parent_Entity Attributes: ....................................................................................................... 17

id ............................................................................................................................................17entity_usage_id ......................................................................................................................17

Parent_Entity Child Tags: ...................................................................................................... 17

where_clause ......................................................................................................................... 17

EntityUsages.xml ...................................................................................................17Entity_Usage Attributes: .........................................................................................................17

id ............................................................................................................................................17entity_id .................................................................................................................................17inherited_entity_usage_id ......................................................................................................17grid_grouping ........................................................................................................................ 18grid_sorting ............................................................................................................................18is_default ............................................................................................................................... 18command_entity_usage_id .................................................................................................... 18

join_condition_in_select ........................................................................................................ 18Entity_Usage Web Attributes: ................................................................................................18

always_expanded ...................................................................................................................18Entity_Usage Windows Attributes: ........................................................................................18

refresh_detail ......................................................................................................................... 18refresh_list ............................................................................................................................. 18refresh_master ....................................................................................................................... 18refresh_master_list .................................................................................................................18

Entity_Usage Unused Attributes: ...........................................................................................18

security_menu_item_id ......................................................................................................... 18base_entity_usage_id ............................................................................................................. 18main_menu_entity_usage_id .................................................................................................18hottable .................................................................................................................................. 18refresh_after_delete ............................................................................................................... 18

Entity_Usage Child Tags: ....................................................................................................... 18

where_clause ......................................................................................................................... 18join_condition ........................................................................................................................ 18child_entity_usages ............................................................................................................... 18entity_usages_to_edit ............................................................................................................ 18

Child_Entity_Usages Attributes: ............................................................................................19

import_from ...........................................................................................................................19Child_Entity_Usage Attributes: ............................................................................................. 19

id ............................................................................................................................................19

entity_usage_id ......................................................................................................................19visible_in_hierarchy .............................................................................................................. 19Child_Entity_Usage Windows Attributes: ............................................................................ 19


4/41

visible_in_list .........................................................................................................................19visible_in_view ......................................................................................................................19win_view_placement .............................................................................................................19change_notification_mode .....................................................................................................19

Child_Entity_Usage Unused Attributes: ............................................................................... 19

owned_by ...............................................................................................................................19

Attributes.xml ........................................................................................................19

Attribute Attributes: ................................................................................................................19

id ............................................................................................................................................19type ........................................................................................................................................ 19caption ................................................................................................................................... 20Caption_grid ..........................................................................................................................20Caption_edit ...........................................................................................................................20Caption_filter .........................................................................................................................20Caption_query ....................................................................................................................... 20form_caption ..........................................................................................................................20

default .................................................................................................................................... 20control_width .........................................................................................................................21control_height ........................................................................................................................21control_modifiers ...................................................................................................................21row_source_id ....................................................................................................................... 21row_source_filter ...................................................................................................................21row_source_constant_filter ................................................................................................... 21row_source_or_filter ............................................................................................................. 21row_source_constant_or_filter .............................................................................................. 21sorting ....................................................................................................................................21sort_order ...............................................................................................................................21

max_length ............................................................................................................................ 21scale ....................................................................................................................................... 21grid_width ..............................................................................................................................21min_value .............................................................................................................................. 21max_value ..............................................................................................................................21

primary_key ........................................................................................................................... 21alternative_key .......................................................................................................................21alternative_key_index ............................................................................................................21nullable .................................................................................................................................. 21storable ...................................................................................................................................21visible .....................................................................................................................................21editable ...................................................................................................................................21filterable .................................................................................................................................21read_only ............................................................................................................................... 22read_only_for_update ............................................................................................................22enabled ...................................................................................................................................22display_name .........................................................................................................................22grid_summary ........................................................................................................................22local_expression .................................................................................................................... 22on_save_expression ...............................................................................................................22incomparable ......................................................................................................................... 22

filter_default .......................................................................................................................... 22filter_default_1 ...................................................................................................................... 22filter_default_2 ...................................................................................................................... 22


5/41

filter_operation ...................................................................................................................... 22filter_condition ...................................................................................................................... 23enabled_filter_operations ...................................................................................................... 23filter_mandatory .................................................................................................................... 23filter_search_field ..................................................................................................................23filter_search_object ............................................................................................................... 23

filter_search_object_join ....................................................................................................... 23filter_myself ...........................................................................................................................23alignment ............................................................................................................................... 23file_lib_entity_usage_id ........................................................................................................ 23file_lib_reference_attribute_id .............................................................................................. 23file_content_attribute_id ........................................................................................................23file_lib_category_code .......................................................................................................... 23file_lib_category_code_attribute_id ......................................................................................23image_small_thumbnail_size ................................................................................................ 23image_large_thumbnail_size ................................................................................................. 23new_line .................................................................................................................................23

new_line_filter .......................................................................................................................23visibility_condition ................................................................................................................23read_only_condition .............................................................................................................. 23hyperlink_command_id .........................................................................................................23hyperlink_entity_usage_id .....................................................................................................23hyperlink_entity_usage_attr_id ............................................................................................. 23hyperlink_ignore_null ........................................................................................................... 24is_calculated .......................................................................................................................... 24min_year_value ..................................................................................................................... 24max_year_value .....................................................................................................................24mandatory_condition .............................................................................................................24default_value_calculation_order ............................................................................................24text_attr_id .............................................................................................................................24db_object_index .....................................................................................................................24init_with_row_source_default_value .................................................................................... 24display_seconds .....................................................................................................................24sort_by_attr_id .......................................................................................................................24

Attribute Web Attributes: .......................................................................................................24

web_control ........................................................................................................................... 24web_control_placement .........................................................................................................25web_filter_control ................................................................................................................. 25

web_filter_control_placement ............................................................................................... 25grid_word_wrap .....................................................................................................................25hyperlink_web_command_id ................................................................................................ 25hyperlink_show_in_popup .................................................................................................... 25hyperlink_show_get_url ........................................................................................................ 25hyperlink_show_get_url_only ...............................................................................................25scrambler_class_cd ................................................................................................................25scrambler_method ................................................................................................................. 25

Attribute Windows Attributes: ...............................................................................................25

win_control ............................................................................................................................25win_control_placement ......................................................................................................... 27

win_filter_control .................................................................................................................. 27win_filter_control_placement ................................................................................................27filter_advanced ...................................................................................................................... 27


6/41

refresh_on_popup .................................................................................................................. 27grid_width_fixed ................................................................................................................... 27

paste_default .......................................................................................................................... 27read_only_in_grid ..................................................................................................................27hyperlink_windows_command_id .........................................................................................27

button_command_id .............................................................................................................. 27

button_command_entity_usage_id ........................................................................................ 27button_image_id .................................................................................................................... 27button_visible ........................................................................................................................ 27button_hidden_for_update ..................................................................................................... 27button_ellipsis ........................................................................................................................ 28button_edit_text_editable ...................................................................................................... 28lookup_width .........................................................................................................................28only_one_selected ................................................................................................................. 28increment_on_create ..............................................................................................................28select_form_class_id ............................................................................................................. 28hyperlink_auto_refresh ..........................................................................................................28

customizable .......................................................................................................................... 28column_header_image_id ......................................................................................................28

Attribute Unused Attributes: ..................................................................................................28

attributes_to_get_from_lookup ............................................................................................. 28value_attribute_id .................................................................................................................. 28user_id ................................................................................................................................... 28custom ...................................................................................................................................28manual .................................................................................................................................. 28grid_filtered ........................................................................................................................... 28definition_attribute_id ........................................................................................................... 28definition_class_id .................................................................................................................28definition_dialog_class_id .....................................................................................................28grid_color ...............................................................................................................................28

Attribute Child Tags: .............................................................................................................. 28

filter_condition ...................................................................................................................... 28visibility_condition ................................................................................................................28read_only_condition .............................................................................................................. 29mandatory_condition .............................................................................................................29

AttributeUsages.xml ..............................................................................................29

Attribute_Usage Attributes: ................................................................................................... 29

id ............................................................................................................................................29Attribute_Usage Tags: .............................................................................................................29

grid_order .............................................................................................................................. 29grid_visible_order ..................................................................................................................29edit_order ...............................................................................................................................29filter_order .............................................................................................................................29

Commands.xml ......................................................................................................30

Command Attributes: ..............................................................................................................30

id ............................................................................................................................................30text ......................................................................................................................................... 30

operation_code .......................................................................................................................30parent_command_id .............................................................................................................. 30is_entity_instance_required ................................................................................................... 30entity_usage_id ......................................................................................................................30


7/41

parent_entity_usage_id .......................................................................................................... 30confirmation_text ...................................................................................................................30command_type .......................................................................................................................30is_default ............................................................................................................................... 30target_command_id ............................................................................................................... 30sql_command .........................................................................................................................30

instance_method .................................................................................................................... 30static_class_id ........................................................................................................................30static_method .........................................................................................................................30refresh_page ...........................................................................................................................30refresh_part ............................................................................................................................30dynamic_entity_usage_attr_id ...............................................................................................30dynamic_command_attr_id ................................................................................................... 30convert_entity_usage_attr_id .................................................................................................31multiple ..................................................................................................................................31application_scope .................................................................................................................. 31

Command Web Attributes: .....................................................................................................31

target_portal_id ......................................................................................................................31target_tree_item_id ................................................................................................................31target_page_id ....................................................................................................................... 31target_tab_id .......................................................................................................................... 31

Command Windows Attributes: .............................................................................................31

unique_id ............................................................................................................................... 31menu_category .......................................................................................................................31image_id ................................................................................................................................ 31windows_handler_class_id ....................................................................................................31windows_handler_batch ........................................................................................................ 31display_order ......................................................................................................................... 31visible_in_main_menu ...........................................................................................................31visible_in_toolbar .................................................................................................................. 31visible_in_popup_menu .........................................................................................................31toolbar_display ...................................................................................................................... 31

begin_group ........................................................................................................................... 31shortcut .................................................................................................................................. 31split_by_entity_usages ...........................................................................................................31

publish_global ....................................................................................................................... 31publish_local .......................................................................................................................... 31hidden_when_disabled .......................................................................................................... 32

copy_entity_image .................................................................................................................32ellipsis_mark ..........................................................................................................................32entity_save .............................................................................................................................32command_category_caption ..................................................................................................32image_entity_usage_id .......................................................................................................... 32split_entity_usages .................................................................................................................32

Command Unused Attributes: ................................................................................................32

web_request ...........................................................................................................................32web_display_mode ................................................................................................................ 32

Command Child Tags: ............................................................................................................ 32

sql_command .........................................................................................................................32

disable_conditions ................................................................................................................. 32Condition Attributes: .............................................................................................................. 32

expression .............................................................................................................................. 32


8/41

error_text ............................................................................................................................... 32error_text_expression ............................................................................................................ 32entity_usage_id ......................................................................................................................32entity_id .................................................................................................................................32

Condition Child Tags: ............................................................................................................. 32

expression .............................................................................................................................. 32

error_text_expression ............................................................................................................ 32

EntityCommands.xml ........................................................................................... 32

Command Attributes: ..............................................................................................................33

id ............................................................................................................................................33EntityCommands Tags: ...........................................................................................................33

command_order .....................................................................................................................33command_groups ...................................................................................................................33

Command_Group Attributes: ................................................................................................ 33

id ............................................................................................................................................33command_type .......................................................................................................................33

excluded_commands ............................................................................................................. 33included_commands .............................................................................................................. 33

RowSources.xml .....................................................................................................34

Row_Source Attributes: ..........................................................................................................34

id ............................................................................................................................................34entity_usage_id ......................................................................................................................34hierarchical ............................................................................................................................ 34hierarchy_orphan_visible ...................................................................................................... 34localizable ..............................................................................................................................34huge ....................................................................................................................................... 34

cached .................................................................................................................................... 34key_type .................................................................................................................................34

Row_Source Web Attributes: .................................................................................................34

Row_Source Windows Attributes: .........................................................................................34

image_attr_id .........................................................................................................................34rgb_color_attr_id ................................................................................................................... 34

RowSource Child Tags: ...........................................................................................................34

rows ....................................................................................................................................... 34Row Attributes: ........................................................................................................................34

key ......................................................................................................................................... 34value .......................................................................................................................................34image_id ................................................................................................................................ 34

Constraints.xml ......................................................................................................34

Constraint Attributes: ............................................................................................................. 35

id ............................................................................................................................................35Constraint Child Tags: ............................................................................................................35

message ..................................................................................................................................35

Images.xml ............................................................................................................. 35

Image_Folder Attributes: ........................................................................................................35

id ............................................................................................................................................35path ........................................................................................................................................ 35

Image Attributes: .....................................................................................................................35

id ............................................................................................................................................35


9/41

Image Web Attributes: ............................................................................................................35

folder_id .................................................................................................................................35file_name ............................................................................................................................... 35

Image Windows Attributes: ....................................................................................................35

provider_class_id ................................................................................................................... 35image_provider_class_id .......................................................................................................35

index ...................................................................................................................................... 35image_index ...........................................................................................................................35

WebParts.xml .........................................................................................................35

Web_Part Attributes: ..............................................................................................................36

id ............................................................................................................................................36text ......................................................................................................................................... 36entity_usage_id ......................................................................................................................36

position .................................................................................................................................. 36content_control ...................................................................................................................... 36content_class_id .....................................................................................................................36

template_control .................................................................................................................... 36min_width ..............................................................................................................................36min_height .............................................................................................................................36fixed_width ............................................................................................................................36fixed_height ...........................................................................................................................36fit_to_width ........................................................................................................................... 36fit_to_height ...........................................................................................................................36hidden_commands .................................................................................................................36content_type ...........................................................................................................................36title_visible ............................................................................................................................ 36menu_visible ..........................................................................................................................36

filter_enabled .........................................................................................................................36hint .........................................................................................................................................36hint_expression ......................................................................................................................36hint_expression_entity_usage_id ...........................................................................................36redirect_after_insert ...............................................................................................................36redirect_after_update ............................................................................................................. 36visibility_condition ................................................................................................................36visibility_condition_entity_usage_id .....................................................................................36ok_button_redirect_page_id .................................................................................................. 36ok_button_redirect_tab_id .....................................................................................................36ok_button_redirect_entity_usage_id ..................................................................................... 36ok_button_text .......................................................................................................................37grid_row_selection ................................................................................................................ 37grid_row_selection_entity_usage_id ..................................................................................... 37grid_row_selection_by_parent .............................................................................................. 37form_column_count ...............................................................................................................37form_control_width ...............................................................................................................37form_label_width ...................................................................................................................37query_value_provider_entity_usage_id .................................................................................37

Web_Part Child Tags: .............................................................................................................37

disable_conditions ................................................................................................................. 37

visibility_condition ................................................................................................................37hint .........................................................................................................................................37hint_expression ......................................................................................................................37


10/41

Pages.xml ................................................................................................................37

Page Attributes: ....................................................................................................................... 38

id ............................................................................................................................................38text ......................................................................................................................................... 38clear_history .......................................................................................................................... 38save_history ...........................................................................................................................38is_default ............................................................................................................................... 38is_secured .............................................................................................................................. 38set_focus_on_load ................................................................................................................. 38

portal_template_control ......................................................................................................... 38is_scrollable ...........................................................................................................................38

Tab Attributes: .........................................................................................................................38

id ............................................................................................................................................38text ......................................................................................................................................... 38visibility_condition ................................................................................................................38visibility_condition_entity_usage_id .....................................................................................38

set_focus_on_load ................................................................................................................. 38is_scrollable ...........................................................................................................................38Tab Child Tags: ....................................................................................................................... 38

visibility_condition ................................................................................................................38Web_Part Attributes: ..............................................................................................................38

id ............................................................................................................................................38

Portals.xml ............................................................................................................. 38

Portal Attributes: .....................................................................................................................38

id ............................................................................................................................................38text ......................................................................................................................................... 38

skin_id ................................................................................................................................... 38is_default ............................................................................................................................... 38title .........................................................................................................................................38hidden_for_user .....................................................................................................................39visible .....................................................................................................................................39

Tree_Item Attributes: ..............................................................................................................39

id ............................................................................................................................................39text ......................................................................................................................................... 39

page_id ................................................................................................................................... 39entity_usage_id ......................................................................................................................39

PortalSkins.xml ......................................................................................................39

Skin Attributes: ........................................................................................................................39

id ............................................................................................................................................39is_default ............................................................................................................................... 39template_folder ......................................................................................................................39

portal_template ...................................................................................................................... 39popup_template ..................................................................................................................... 39web_part_template .................................................................................................................39login_template ....................................................................................................................... 39images_folder ........................................................................................................................ 39

Skin Child Tags: .......................................................................................................................39

stylesheets ..............................................................................................................................39Stylesheets Attributes: .............................................................................................................39

folder ......................................................................................................................................39


11/41

Stylesheet Attributes: .............................................................................................................. 39

name .......................................................................................................................................39

WinSections.xml ....................................................................................................39

Section Attributes: ................................................................................................................... 40

id ............................................................................................................................................40

text ......................................................................................................................................... 40is_default ............................................................................................................................... 40hidden_for_user .....................................................................................................................40visible .....................................................................................................................................40

Tree_Item Attributes: ..............................................................................................................40

id ............................................................................................................................................40text ......................................................................................................................................... 40entity_usage_id ......................................................................................................................40frame_class_id .......................................................................................................................40image_id ................................................................................................................................ 40item_provider_class_id ..........................................................................................................40

item_provider_parameters ..................................................................................................... 40item_provider_replacement ................................................................................................... 40depends_on_entity_usage_ids ............................................................................................... 40

WinForms.xml .......................................................................................................40

Form Attributes: ......................................................................................................................40

id ............................................................................................................................................40Tab Attributes: .........................................................................................................................40

id ............................................................................................................................................40text ......................................................................................................................................... 40

Panel Attributes: ......................................................................................................................41

id ............................................................................................................................................41text ......................................................................................................................................... 41

Common Metadata Object Attributes

Common attributes can be defined for any metadata object, but actually they are used forparticular metadata by framework.id Unique ID of the metadata object.text Caption of metadata object displayed to user.group_name Group name used for security setup purposes.

security_entity_usage_id

Reference to entity usage ID to take security access rights from.

visible True if metadata object should be visible.hidden_for_user True if metadata object should be available only in development

mode.

Config.xml

Optional XML file. Holds configuration settings for the whole project metadata.


12/41

Config Attributes:application_code Code of the application to identify current

application in framework tables. Shouldcorrespond to ApplicationCd field value in theFramework_Applications table.

application_scope Scope of the application: Windows or Web. Some

metadata elements can be filtered by theapplication scope. For example, ifapplication_scope=Web is specified forcommand metadata, the command will beavailable and visible only for web application, notfor windows application.

child_entity_usage_visible_in_hierarchy

Default visibility of child entity usages in thehierarchical grids. This setting is taken whenvisible_in_hierarchy property of the child entityusage is not specified.

plugins Plugins XML tag contains comma-separated list of

metadata plugin DLL names. '.dll' extension isautomatically added to the name, the namespace ofthe assembly must equal to the dll name (w/oextension). Example: Custom.Metadata namemeans Custom.Metadata.dll file, andCustom.Metadata namespace.

Assemblies.xml

Assembly Attributes:id Unique ID of the assembly.namespace C# namespace, for example: Mesh.BackOfficefile_name Assembly DLL name, for example Mesh.BackOffice.dllapplication_scope Windows or Web. Assembly is registered if the application scope is

empty or equals to the application scope value from the Config.xml.

Classes.xml

Class Attributes:id Unique ID of the class.assembly_id Reference to assembly ID described in the Assemblies.xml file.name Name of the C# class, for example: CxBaseEntity


13/41

Entities.xml

Entities Attributes:group_name Name of the group for all entities described in the file. It is used to

group entities in security setup.

Entity Attributes:id Unique ID of the entity.plural_caption Caption to describe multiple entities (entity list)

single_caption Caption to describe single entity instanceoperations Web:

Combination of i, u, d, v, f letters.Each letter means entity command:i New, u Edit, d Delete, v View, f FindWindows:Combination of o, i, d, t, c, p, f letters.Each letter means entity command:o Open, i New, d Delete, t Cut, c Copy, p

Paste, f Filterentity_class_id Reference to ID of the C# class described in

Classes.xmldb_object Name of main DB table or view used to generate

insert/update/delete SQL statements.


14/41

db_object_1 Name of the additional DB table or view togenerate insert/update/delete SQL statements. The

primary key of the additional DB object should beexactly the same as the main DB object primarykey. Entity attributes that belong to the additionalDB object are marked with the

db_object_index=n property.db_object_2

db_object_9

self_reference_attr_id For self-reference hierarchical entities. This is thename (id) of field (attribute) that contains self-reference value.

hint_find Hint displayed at top of the find form.hint_grid Hint displayed at the top of the grid.hint_new Hint displayed at the top of create new entity form.hint_edit Hint displayed at the top of modify entity form.hint_view Hint displayed at the top of view entity form.post_create_command_id ID of the entity command that should be

performed after new entity created. (Notimplemented for Windows)

post_update_command_id ID of the entity command that should beperformed after entity is modified.(Notimplemented for Windows)

in_security True if entity metadata should be in the securitypermissions list (true by default).

file_lib_category_entity_usage_id For file/image library entity only. Returns ID of

entity usage that is used as a category table. (Notimplemented for Windows)

file_lib_category_reference_attribute_id For file/image library entity only. Returns ID ofattribute that is a reference to image librarycategory entity. (Not implemented for Windows)

file_lib_category_code_attribute_id For file/image library category entity only. ReturnsID of attribute that contains category code. (Notimplemented for Windows)

file_lib_hide_upload_file_section If true, then 'Upload File' section will be notavailable

grid_row_variable_height If true, grid row height is variable, not fixed. (false

by default)auto_generate_filter_condition If true, filter condition will be auto generated by

the filter elements. (true by default)record_count_limit Can contain true or integer value. Defines record

count limit to read from DB (top X clause isadded).

cached If true, entity will be cached on the applicationlevel (if cache is enabled in Web.Config orApp.config)

security_entity_usage_id Reference to entity usage ID to take security

access rights from.current_workspace_filter If false, entity data will be not filtered by currentselected workspace even if WorkspaceId column


15/41

presents in the entity attributes. (true by default).available_workspace_filter If false, entity data will be not filtered by available

for current user workspace range even ifWorkspaceId column presents in the entityattributes. (true by default).

insert_on_update If true, INSERT SQL statement will be executed

instead of UPDATE statement when entity isupdated. False by default.

primary_key_update If false, primary key fields will be not updated onentity update. True by default.

read_only If true, entity or entity usage is read-only in UI.(Not implemented for Web)

read_only_attributes If true, all attributes of the entity usage are read-only in UI. (Not implemented for Web)

connection_id ID of entity database connection described in theconfiguration files, etc. If empty, the defaultdatabase connection is used to read this entity.(Not implemented for Windows)

grid_cell_merging Indicates whether the cells in grid with the samecontent and verging each other should be merged(displayed as a sole cell). So far, works just forWindows.

Entity Web Attributes:web_find_control Name of ASCX control used as a web part to

display entity list (with or without find form).web_edit_control Name of ASCX control used as a web part to

create/modify or view entity. (New, Edit, Viewcommands).filter_enabled It is used to switch off find feature on the entity list

web part. (true by default)web_page_size Page size for the web grid. (0 or -1 disables

paging)grid_row_css_class Additional CSS class for grid rows.grid_word_wrap If true, word-wrap is switched on for all grid cells.

(false by default)web_filter_on_start If true, filter form is displayed before displaying

grid with entity list. If false, grid with entity list is

displayed first. True by default.

Entity Windows Attributes:frame_class_id ID of the class metadata used to display list of

entities.editable_in_grid True if entities should be editable in grid. True by

default.auto_width_in_grid True if width for all grid columns should be set

automatically depending on the column content.image_id ID of the image metadata used to display

navigation tree node related to the given entity.win_edit_form_id ID of the windows form layout metadata(described in the WinForms.xml file) used to


16/41

create, view or edit the entity.display_grid_layout_in_tree Indicates that user-defined grid layouts for the

entity list can be displayed in the navigation tree.False by default.

edit_controller_class_id ID of the class metadata used as an edit controllerclass. The class must inherit from

CxEditController.customizable True if entity or entity usage should be displayed

on a setup columns (entity customize) form. Falseby default.

customize_caption Caption to display on a setup columns (entitycustomize) form.

refresh_depends_on_entity_usages Comma-separated list of entity usage IDs refreshof this entity usage depends on. (For now, inwindows framework, the refresh will be performed

just if the refresh_list property is set to true.)grid_view_customizable True if grid view can be customized by entity

customization form. True by default.edit_form_customizable True if edit form can be customized by entity

customization form. True by default.filter_form_customizable True if filter form can be customized by entity

customization form. True by default.query_customizable True if query can be customized using entity

customization form.disable_bookmarks_and_recent_items If true, reference to entity is not added to

Bookmarks and Recent Items lists. False bydefault.

select_only_when_filter_enabled If true, when the entity is shown in list (grid), theactual select will be performed just when the filtercriteria are defined.

paging_enabled Specifies if the paging feature should be usedwhere its possible while displaying entitys data.

reload_entity_after_update Indicates whether the updated entity should bereloaded after update.

Entity Unused Attributes:colors_in_grid not usedmay_disappear_after_update not used

edit_class_id not used


17/41

Entity Child Tags:sql_select SQL statement used to get list of entities from database.sql_select_single_ro

wOverrides SQL statement used to get single entity record from thedatabase. If is not defined, sql_select is used. This statement shouldnot contain WHERE clause, where-condition is generatedautomatically by primary key attribute definition or is taken from

primary_key_clause.sql_insert SQL statement used to insert new entity into the database (auto-

generated if not defined).sql_update SQL statement used to modify entity in the database (auto-generated if

not defined).sql_delete SQL statement used to delete entity from the database (auto-generated

if not defined).primary_key_clause SQL WHERE clause used to get entity from the database by the

primary key value (auto-generated if not defined).parent_entities Declares list of entities that can be found using this entity values.hint_find Hint displayed at top of the find form.hint_grid Hint displayed at the top of the grid.hint_new Hint displayed at the top of create new entity form.hint_edit Hint displayed at the top of modify entity form.hint_view Hint displayed at the top of view entity form.

Parent_Entity Attributes:id Reference to Entity ID that can be found by the described condition.entity_usage_id Reference to Entity Usage ID. Defines search priority. If entity with the

defined entity usage ID has to be found, condition described in thiselement is used.

Parent_Entity Child Tags:where_clause SQL WHERE clause used to find parent entity by this entity values.

EntityUsages.xml

Entity_Usage Attributes:id Unique ID of the entity usage.entity_id Reference to the base entity ID. (mandatory)inherited_entity_usage_id ID of the entity usage used as a source to copy properties,

attribute usage definitions and command definitions from.Strict dependency order must be kept in metadata definition.


18/41

DO NOT DEFINE CHILD METADATA BEFORE PARENT.Order must be kept in the following files: EntityUsages.xml,AttributeUsages.xml and EntityCommand.xml.

grid_grouping If true, grid grouping is enabled (true by default)grid_sorting If true, grid sorting is enabled (true by default)is_default True for default entity usage (each entity has one default entity

usage)command_entity_usage_id If specified, entity usage with the defined ID will be used for

all entity usage commands.join_condition_in_select True if SQL select clause already contains parent-child join

condition, and join_condition attribute is not needed for parent-child grid relation. (false by default)

Entity_Usage Web Attributes:always_expanded If true, and entity usage has child entity usages, all rows will be

initially expanded in hierarchical grid. (false by default)

Entity_Usage Windows Attributes:refresh_detail If true, detail grid will be refreshed after master record is

changed. False by default.refresh_list If true, current grid will be completely refreshed after the

record is changed (inserted, updated or deleted)refresh_master If true, parent record will be refreshed when child record is

changed (for master-detail grids).refresh_master_list If true, the whole parent (master) record list will be refreshed

when child record is changed (for master-detail grids).

Entity_Usage Unused Attributes:security_menu_item_id not usedbase_entity_usage_id not usedmain_menu_entity_usage_i

dnot used

hottable not usedrefresh_after_delete not used

Entity_Usage Child Tags:where_clause Additional SQL WHERE filter.join_condition For child entity usages only. Defines SQL WHERE condition to find

child records for the parent entity.child_entity_usages Entity usages that are children of the given entity usage. Children are

displayed in the hierarchical grid.entity_usages_to_edi

tnot used


19/41

Child_Entity_Usages Attributes:import_from ID of the entity usage to import child entity usages from

Child_Entity_Usage Attributes:id ID of the child entity usage.entity_usage_id Reference to entity usage ID. Referenced entity usage must have

join_condition tag.visible_in_hierarchy True if child grid should be visible as a level of the hierarchical grid.Is

not completely implemented.It is ignored by Web (child entity usage isalways displayed as a level of hierarchy), it is ignored by Windows

(hierarchical master-detail grid is not implemented yet).

Child_Entity_Usage Windows Attributes:visible_in_list True if child entity usage should be visible as a detail tab under

the master grid on main form. True by default.visible_in_view True if child entity usage should be visible as a detail tab on an

entity dialog form. True by default.win_view_placement ID of the panel to place child grid to. Panel ID references to the

panel defined in the WinForms.xml file, for the particular formmetadata used for layout.

change_notification_mode

Valid values: AllRecords, EachRecord. AllRecords is the defaultvalue. When AllRecords is specified, the notification about childentity (or entities) change is processed once for all changes (batchmode). When EachRecord is specified, the notification is

processed record-by-record.

Child_Entity_Usage Unused Attributes:

owned_by not used

Attributes.xml

Attribute Attributes:

id Unique ID of the attribute.type Field type

string character field


20/41

datetime datetime field

date datetime field containing no time

time datetime field containing no date

float numeric field

boolean boolean field

file file (BLOB) field

image image (BLOB) fieldicon c

framework metadata description

Documents