Framework Metadata Description

Framework Metadata Description
Common Metadata Object Attributes......................................................................11

id............................................................................................................................................11
text.........................................................................................................................................11
group_name...........................................................................................................................11
security_entity_usage_id.......................................................................................................11
visible.....................................................................................................................................11
hidden_for_user.....................................................................................................................11
Config.xml..............................................................................................................11
Config Attributes:....................................................................................................................11
application_code....................................................................................................................11
application_scope..................................................................................................................11
child_entity_usage_visible_in_hierarchy..............................................................................11
plugins...................................................................................................................................12
Assemblies.xml.......................................................................................................12
Assembly Attributes:...............................................................................................................12
id............................................................................................................................................12
namespace..............................................................................................................................12
file_name...............................................................................................................................12
Classes.xml.............................................................................................................12
Class Attributes:......................................................................................................................12
id............................................................................................................................................12
assembly_id...........................................................................................................................12
name.......................................................................................................................................12
Entities.xml............................................................................................................12
Entities Attributes:..................................................................................................................13
group_name...........................................................................................................................13
Entity Attributes:.....................................................................................................................13
id............................................................................................................................................13
plural_caption........................................................................................................................13
single_caption........................................................................................................................13
operations...............................................................................................................................13
entity_class_id.......................................................................................................................13
db_object...............................................................................................................................13
db_object_1...........................................................................................................................13
db_object_2...........................................................................................................................13
…...........................................................................................................................................13
db_object_9...........................................................................................................................13
self_reference_attr_id............................................................................................................13
hint_find.................................................................................................................................13
hint_grid.................................................................................................................................14
hint_new................................................................................................................................14
hint_edit.................................................................................................................................14
hint_view...............................................................................................................................14
post_create_command_id......................................................................................................14
post_update_command_id.....................................................................................................14
in_security.............................................................................................................................14
file_lib_category_entity_usage_id.........................................................................................14
file_lib_category_reference_attribute_id...............................................................................14
file_lib_category_code_attribute_id......................................................................................14
grid_row_variable_height......................................................................................................14
auto_generate_filter_condition..............................................................................................14
record_count_limit.................................................................................................................14
cached....................................................................................................................................14
security_entity_usage_id.......................................................................................................14
current_workspace_filter.......................................................................................................14
available_workspace_filter....................................................................................................14
insert_on_update....................................................................................................................14
primary_key_update..............................................................................................................14
read_only...............................................................................................................................14
read_only_attributes..............................................................................................................14
connection_id.........................................................................................................................14
Entity Web Attributes:............................................................................................................15
web_find_control...................................................................................................................15
web_edit_control...................................................................................................................15
filter_enabled.........................................................................................................................15
web_page_size.......................................................................................................................15
grid_row_css_class................................................................................................................15
grid_word_wrap.....................................................................................................................15
web_filter_on_start................................................................................................................15
Entity Windows Attributes:....................................................................................................15
frame_class_id.......................................................................................................................15
editable_in_grid.....................................................................................................................15
auto_width_in_grid................................................................................................................15
image_id................................................................................................................................15
win_edit_form_id..................................................................................................................15
display_grid_layout_in_tree..................................................................................................15
edit_controller_class_id.........................................................................................................15
customizable..........................................................................................................................15
customize_caption.................................................................................................................15
refresh_depends_on_entity_usages.......................................................................................15
grid_view_customizable........................................................................................................15
edit_form_customizable........................................................................................................15
filter_form_customizable.......................................................................................................15
disable_bookmarks_and_recent_items..................................................................................16
Entity Unused Attributes:.......................................................................................................16
colors_in_grid........................................................................................................................16
may_disappear_after_update.................................................................................................16
edit_class_id..........................................................................................................................16
Entity Child Tags:...................................................................................................................16
sql_select...............................................................................................................................16
sql_select_single_row............................................................................................................16
sql_insert................................................................................................................................16
sql_update..............................................................................................................................16
sql_delete...............................................................................................................................16
primary_key_clause...............................................................................................................16
parent_entities........................................................................................................................16
hint_find.................................................................................................................................16
hint_grid.................................................................................................................................16
hint_new................................................................................................................................16
hint_edit.................................................................................................................................16
hint_view...............................................................................................................................16
Parent_Entity Attributes:.......................................................................................................16
id............................................................................................................................................16
entity_usage_id......................................................................................................................16
Parent_Entity Child Tags:......................................................................................................16
where_clause.........................................................................................................................16
EntityUsages.xml...................................................................................................16
Entity_Usage Attributes:........................................................................................................17
id............................................................................................................................................17
entity_id.................................................................................................................................17
inherited_entity_usage_id......................................................................................................17
grid_grouping........................................................................................................................17
grid_sorting............................................................................................................................17
is_default...............................................................................................................................17
command_entity_usage_id....................................................................................................17
join_condition_in_select........................................................................................................17
Entity_Usage Web Attributes:...............................................................................................17
always_expanded...................................................................................................................17
Entity_Usage Windows Attributes:.......................................................................................17
refresh_detail.........................................................................................................................17
refresh_list.............................................................................................................................17
refresh_master.......................................................................................................................17
refresh_master_list.................................................................................................................17
Entity_Usage Unused Attributes:...........................................................................................17
security_menu_item_id.........................................................................................................17
base_entity_usage_id.............................................................................................................17
main_menu_entity_usage_id.................................................................................................17
hottable..................................................................................................................................17
refresh_after_delete...............................................................................................................17
Entity_Usage Child Tags:.......................................................................................................17
where_clause.........................................................................................................................17
join_condition........................................................................................................................17
child_entity_usages...............................................................................................................17
entity_usages_to_edit............................................................................................................17
Child_Entity_Usages Attributes:...........................................................................................18
import_from...........................................................................................................................18
Child_Entity_Usage Attributes:.............................................................................................18
id............................................................................................................................................18
entity_usage_id......................................................................................................................18
visible_in_hierarchy..............................................................................................................18
Child_Entity_Usage Windows Attributes:............................................................................18
visible_in_list.........................................................................................................................18
visible_in_view......................................................................................................................18
win_view_placement.............................................................................................................18
change_notification_mode.....................................................................................................18
Child_Entity_Usage Unused Attributes:...............................................................................18
owned_by...............................................................................................................................18
Attributes.xml........................................................................................................18
Attribute Attributes:...............................................................................................................18
id............................................................................................................................................18
type........................................................................................................................................18
caption...................................................................................................................................19
form_caption..........................................................................................................................19
default....................................................................................................................................19
control_width.........................................................................................................................19
control_height........................................................................................................................19
control_modifiers...................................................................................................................20
row_source_id.......................................................................................................................20
row_source_filter...................................................................................................................20
row_source_constant_filter...................................................................................................20
row_source_or_filter.............................................................................................................20
row_source_constant_or_filter..............................................................................................20
sorting....................................................................................................................................20
sort_order...............................................................................................................................20
max_length............................................................................................................................20
scale.......................................................................................................................................20
grid_width..............................................................................................................................20
min_value..............................................................................................................................20
max_value..............................................................................................................................20
primary_key...........................................................................................................................20
alternative_key.......................................................................................................................20
alternative_key_index............................................................................................................20
nullable..................................................................................................................................20
storable...................................................................................................................................20
visible.....................................................................................................................................20
editable...................................................................................................................................20
filterable.................................................................................................................................20
read_only...............................................................................................................................20
read_only_for_update............................................................................................................20
enabled...................................................................................................................................20
display_name.........................................................................................................................20
grid_summary........................................................................................................................20
local_expression....................................................................................................................21
on_save_expression...............................................................................................................21
incomparable.........................................................................................................................21
filter_default..........................................................................................................................21
filter_default_1......................................................................................................................21
filter_default_2......................................................................................................................21
filter_operation......................................................................................................................21
filter_condition......................................................................................................................21
enabled_filter_operations......................................................................................................21
filter_mandatory....................................................................................................................22
filter_search_field..................................................................................................................22
filter_search_object...............................................................................................................22
filter_search_object_join.......................................................................................................22
filter_myself...........................................................................................................................22
alignment...............................................................................................................................22
file_lib_entity_usage_id........................................................................................................22
file_lib_reference_attribute_id..............................................................................................22
file_content_attribute_id........................................................................................................22
file_lib_category_code..........................................................................................................22
file_lib_category_code_attribute_id......................................................................................22
image_small_thumbnail_size................................................................................................22
image_large_thumbnail_size.................................................................................................22
new_line.................................................................................................................................22
new_line_filter.......................................................................................................................22
visibility_condition................................................................................................................22
read_only_condition..............................................................................................................22
hyperlink_command_id.........................................................................................................22
hyperlink_entity_usage_id.....................................................................................................22
hyperlink_entity_usage_attr_id.............................................................................................22
hyperlink_ignore_null...........................................................................................................22
is_calculated..........................................................................................................................22
min_year_value.....................................................................................................................22
max_year_value.....................................................................................................................22
mandatory_condition.............................................................................................................23
default_value_calculation_order............................................................................................23
text_attr_id.............................................................................................................................23
db_object_index.....................................................................................................................23
init_with_row_source_default_value....................................................................................23
display_seconds.....................................................................................................................23
sort_by_attr_id.......................................................................................................................23
Attribute Web Attributes:......................................................................................................23
web_control...........................................................................................................................23
web_control_placement.........................................................................................................24
web_filter_control.................................................................................................................24
web_filter_control_placement...............................................................................................24
grid_word_wrap.....................................................................................................................24
hyperlink_web_command_id................................................................................................24
hyperlink_show_in_popup....................................................................................................24
hyperlink_show_get_url........................................................................................................24
hyperlink_show_get_url_only...............................................................................................24
scrambler_class_cd................................................................................................................24
scrambler_method.................................................................................................................24
Attribute Windows Attributes:..............................................................................................24
win_control............................................................................................................................24
win_control_placement.........................................................................................................26
win_filter_control..................................................................................................................26
win_filter_control_placement................................................................................................26
filter_advanced......................................................................................................................26
refresh_on_popup..................................................................................................................26
grid_width_fixed...................................................................................................................26
paste_default..........................................................................................................................26
read_only_in_grid..................................................................................................................26
hyperlink_windows_command_id.........................................................................................26
button_command_id..............................................................................................................26
button_command_entity_usage_id........................................................................................26
button_image_id....................................................................................................................26
button_visible........................................................................................................................26
button_hidden_for_update.....................................................................................................26
button_ellipsis........................................................................................................................26
button_edit_text_editable......................................................................................................26
lookup_width.........................................................................................................................26
only_one_selected.................................................................................................................27
increment_on_create..............................................................................................................27
select_form_class_id.............................................................................................................27
hyperlink_auto_refresh..........................................................................................................27
customizable..........................................................................................................................27
Attribute Unused Attributes:.................................................................................................27
attributes_to_get_from_lookup.............................................................................................27
value_attribute_id..................................................................................................................27
user_id...................................................................................................................................27
custom....................................................................................................................................27
manual...................................................................................................................................27
grid_filtered...........................................................................................................................27
definition_attribute_id...........................................................................................................27
definition_class_id.................................................................................................................27
definition_dialog_class_id.....................................................................................................27
grid_color...............................................................................................................................27
Attribute Child Tags:..............................................................................................................27
filter_condition......................................................................................................................27
read_only_condition..............................................................................................................27
mandatory_condition.............................................................................................................27
AttributeUsages.xml..............................................................................................28
Attribute_Usage Attributes:...................................................................................................28
id............................................................................................................................................28
Attribute_Usage Tags:............................................................................................................28
grid_order..............................................................................................................................28
grid_visible_order..................................................................................................................28
edit_order...............................................................................................................................28
filter_order.............................................................................................................................28
Commands.xml......................................................................................................28
Command Attributes:.............................................................................................................29
id............................................................................................................................................29
text.........................................................................................................................................29
operation_code.......................................................................................................................29
parent_command_id..............................................................................................................29
is_entity_instance_required...................................................................................................29
entity_usage_id......................................................................................................................29
parent_entity_usage_id..........................................................................................................29
confirmation_text...................................................................................................................29
command_type.......................................................................................................................29
is_default...............................................................................................................................29
target_command_id...............................................................................................................29
sql_command.........................................................................................................................29
instance_method....................................................................................................................29
static_class_id........................................................................................................................29
static_method.........................................................................................................................29
refresh_page...........................................................................................................................29
refresh_part............................................................................................................................29
dynamic_entity_usage_attr_id...............................................................................................29
dynamic_command_attr_id...................................................................................................29
convert_entity_usage_attr_id.................................................................................................29
multiple..................................................................................................................................29
Command Web Attributes:....................................................................................................30
target_portal_id......................................................................................................................30
target_tree_item_id................................................................................................................30
target_page_id.......................................................................................................................30
target_tab_id..........................................................................................................................30
Command Windows Attributes:............................................................................................30
unique_id...............................................................................................................................30
menu_category.......................................................................................................................30
image_id................................................................................................................................30
windows_handler_class_id....................................................................................................30
windows_handler_batch........................................................................................................30
display_order.........................................................................................................................30
visible_in_main_menu...........................................................................................................30
visible_in_toolbar..................................................................................................................30
visible_in_popup_menu.........................................................................................................30
toolbar_display......................................................................................................................30
begin_group...........................................................................................................................30
shortcut..................................................................................................................................30
split_by_entity_usages...........................................................................................................30
publish_global.......................................................................................................................30
publish_local..........................................................................................................................30
hidden_when_disabled..........................................................................................................30
copy_entity_image.................................................................................................................30
ellipsis_mark..........................................................................................................................30
entity_save.............................................................................................................................30
command_category_caption..................................................................................................31
image_entity_usage_id..........................................................................................................31
split_entity_usages.................................................................................................................31
Command Unused Attributes:...............................................................................................31
web_request...........................................................................................................................31
web_display_mode................................................................................................................31
Command Child Tags:............................................................................................................31
sql_command.........................................................................................................................31
disable_conditions.................................................................................................................31
Condition Attributes:..............................................................................................................31
expression..............................................................................................................................31
error_text...............................................................................................................................31
error_text_expression............................................................................................................31
entity_usage_id......................................................................................................................31
entity_id.................................................................................................................................31
Condition Child Tags:.............................................................................................................31
expression..............................................................................................................................31
error_text_expression............................................................................................................31
EntityCommands.xml...........................................................................................31
Command Attributes:.............................................................................................................32
id............................................................................................................................................32
EntityCommands Tags:..........................................................................................................32
command_order.....................................................................................................................32
command_groups...................................................................................................................32
Command_Group Attributes:................................................................................................32
id............................................................................................................................................32
command_type.......................................................................................................................32
excluded_commands.............................................................................................................32
included_commands..............................................................................................................32
RowSources.xml....................................................................................................32
Row_Source Attributes:..........................................................................................................32
id............................................................................................................................................32
entity_usage_id......................................................................................................................33
hierarchical............................................................................................................................33
hierarchy_orphan_visible......................................................................................................33
localizable..............................................................................................................................33
huge.......................................................................................................................................33
cached....................................................................................................................................33
key_type.................................................................................................................................33
Row_Source Web Attributes:.................................................................................................33
Row_Source Windows Attributes:.........................................................................................33
image_attr_id.........................................................................................................................33
rgb_color_attr_id...................................................................................................................33
RowSource Child Tags:...........................................................................................................33
rows.......................................................................................................................................33
Row Attributes:........................................................................................................................33
key.........................................................................................................................................33
value.......................................................................................................................................33
image_id................................................................................................................................33
Constraints.xml......................................................................................................33
Constraint Attributes:.............................................................................................................33
id............................................................................................................................................33
Constraint Child Tags:............................................................................................................33
message..................................................................................................................................33
Images.xml.............................................................................................................34
Image_Folder Attributes:.......................................................................................................34
id............................................................................................................................................34
path........................................................................................................................................34
Image Attributes:.....................................................................................................................34
id............................................................................................................................................34
Image Web Attributes:............................................................................................................34
folder_id.................................................................................................................................34
file_name...............................................................................................................................34
Image Windows Attributes:....................................................................................................34
provider_class_id...................................................................................................................34
image_provider_class_id.......................................................................................................34
index......................................................................................................................................34
image_index...........................................................................................................................34
WebParts.xml........................................................................................................34
Web_Part Attributes:..............................................................................................................34
id............................................................................................................................................34
text.........................................................................................................................................34
entity_usage_id......................................................................................................................34
position..................................................................................................................................34
content_control......................................................................................................................35
content_class_id.....................................................................................................................35
template_control....................................................................................................................35
min_width..............................................................................................................................35
min_height.............................................................................................................................35
fixed_width............................................................................................................................35
fixed_height...........................................................................................................................35
fit_to_width...........................................................................................................................35
fit_to_height...........................................................................................................................35
hidden_commands.................................................................................................................35
content_type...........................................................................................................................35
title_visible............................................................................................................................35
menu_visible..........................................................................................................................35
filter_enabled.........................................................................................................................35
hint.........................................................................................................................................35
hint_expression......................................................................................................................35
hint_expression_entity_usage_id...........................................................................................35
redirect_after_insert...............................................................................................................35
redirect_after_update.............................................................................................................35
visibility_condition_entity_usage_id.....................................................................................35
ok_button_redirect_page_id..................................................................................................35
ok_button_redirect_tab_id.....................................................................................................35
ok_button_redirect_entity_usage_id.....................................................................................35
ok_button_text.......................................................................................................................35
grid_row_selection................................................................................................................35
grid_row_selection_entity_usage_id.....................................................................................36
grid_row_selection_by_parent..............................................................................................36
form_column_count...............................................................................................................36
form_control_width...............................................................................................................36
form_label_width...................................................................................................................36
query_value_provider_entity_usage_id.................................................................................36
Web_Part Child Tags:.............................................................................................................36
disable_conditions.................................................................................................................36
hint.........................................................................................................................................36
hint_expression......................................................................................................................36
Pages.xml................................................................................................................36
Page Attributes:.......................................................................................................................36
id............................................................................................................................................36
text.........................................................................................................................................36
clear_history..........................................................................................................................36
save_history...........................................................................................................................36
is_default...............................................................................................................................36
is_secured..............................................................................................................................36
set_focus_on_load.................................................................................................................36
portal_template_control.........................................................................................................37
is_scrollable...........................................................................................................................37
Tab Attributes:........................................................................................................................37
id............................................................................................................................................37
text.........................................................................................................................................37
visibility_condition_entity_usage_id.....................................................................................37
set_focus_on_load.................................................................................................................37
is_scrollable...........................................................................................................................37
Tab Child Tags:.......................................................................................................................37
Web_Part Attributes:..............................................................................................................37
id............................................................................................................................................37
Portals.xml.............................................................................................................37
Portal Attributes:.....................................................................................................................37
id............................................................................................................................................37
text.........................................................................................................................................37
skin_id...................................................................................................................................37
is_default...............................................................................................................................37
title.........................................................................................................................................37
hidden_for_user.....................................................................................................................37
visible.....................................................................................................................................37
Tree_Item Attributes:.............................................................................................................37
id............................................................................................................................................37
text.........................................................................................................................................37
page_id...................................................................................................................................37
entity_usage_id......................................................................................................................37
PortalSkins.xml......................................................................................................38
Skin Attributes:........................................................................................................................38
id............................................................................................................................................38
is_default...............................................................................................................................38
template_folder......................................................................................................................38
portal_template......................................................................................................................38
popup_template.....................................................................................................................38
web_part_template.................................................................................................................38
login_template.......................................................................................................................38
images_folder........................................................................................................................38
Skin Child Tags:......................................................................................................................38
stylesheets..............................................................................................................................38
Stylesheets Attributes:.............................................................................................................38
folder......................................................................................................................................38
Stylesheet Attributes:..............................................................................................................38
name.......................................................................................................................................38
WinSections.xml....................................................................................................38
Section Attributes:...................................................................................................................38
id............................................................................................................................................38
text.........................................................................................................................................38
is_default...............................................................................................................................38
hidden_for_user.....................................................................................................................38
visible.....................................................................................................................................38
Tree_Item Attributes:.............................................................................................................39
id............................................................................................................................................39
text.........................................................................................................................................39
entity_usage_id......................................................................................................................39
frame_class_id.......................................................................................................................39
image_id................................................................................................................................39
item_provider_class_id..........................................................................................................39
item_provider_parameters.....................................................................................................39
item_provider_replacement...................................................................................................39
depends_on_entity_usage_ids...............................................................................................39
WinForms.xml.......................................................................................................39
Form Attributes:......................................................................................................................39
id............................................................................................................................................39
Tab Attributes:........................................................................................................................39
id............................................................................................................................................39
text.........................................................................................................................................39
Panel Attributes:......................................................................................................................39
id............................................................................................................................................39
text.........................................................................................................................................39
Common Metadata Object Attributes

Common attributes can be defined for any metadata object, but actually they are used for
particular 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_i Reference to entity usage ID to take security access rights from.
d
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.
<config>
<plugins></plugins>
</config>
Config Attributes:
application_code Code of the application to identify current
application in framework tables. Should
correspond to ApplicationCd field value in the
Framework_Applications table.
application_scope Scope of the application: Windows or Web. Some
metadata elements can be filtered by the
application scope. For example, if
application_scope=”Web” is specified for
command metadata, the command will be
available and visible only for web application, not
for windows application.
child_entity_usage_visible_in_hierarch Default visibility of child entity usages in the
y hierarchical grids. This setting is taken when
visible_in_hierarchy property of the child entity
usage is not specified.
plugins Plugins XML tag contains comma-separated list of
metadata plugin DLL names. '.dll' extension is
automatically added to the name, the namespace of
the assembly must equal to the dll name (w/o
extension). Example: Custom.Metadata name
means Custom.Metadata.dll file, and
Custom.Metadata namespace.
Assemblies.xml
<assemblies>
<assembly />
</assemblies>
Assembly Attributes:
id Unique ID of the assembly.
namespace C# namespace, for example: Mesh.BackOffice
file_name Assembly DLL name, for example Mesh.BackOffice.dll
application_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
<classes>
<class />
</classes>
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
Entities.xml
<entities>
<entity>
<sql_select>
</sql_select>
<sql_insert>
</sql_insert>
<sql_update>
</sql_update>
<sql_delete>
</sql_delete>
<primary_key_clause>
</primary_key_clause>
<sql_select_single_row>
</sql_select_single_row>
<parent_entities>
<parent_entity>
<where_clause>
</wnere_clause>
</parent_entity>
</parent_entities>
<hint_find></hint_find>
<hint_grid></hint_grid>
<hint_new></hint_new>
<hint_edit></hint_edit>
<hint_view></hint_view>
</entity>
</entities>
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 instance
operations Web:
Combination of i, u, d, v, f letters.
Each letter means entity command:
i – New, u – Edit, d – Delete, v – View, f – Find
Windows:
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 – Filter
entity_class_id Reference to ID of the C# class described in
Classes.xml
db_object Name of main DB table or view used to generate
insert/update/delete SQL statements.
db_object_1 Name of the additional DB table or view to
generate insert/update/delete SQL statements. The
primary key of the additional DB object should be
exactly the same as the main DB object primary
key. Entity attributes that belong to the additional
DB 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 the
name (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. (Not
implemented for Windows)
post_update_command_id ID of the entity command that should be
performed after entity is modified. (Not
in_security True if entity metadata should be in the security
permissions 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. (Not
file_lib_category_reference_attribute_id For file/image library entity only. Returns ID of
attribute that is a reference to image library
category entity. (Not implemented for Windows)
file_lib_category_code_attribute_id For file/image library category entity only. Returns
ID of attribute that contains category code. (Not
file_lib_hide_upload_file_section If true, then 'Upload File' section will be not
available
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 is
added).
cached If true, entity will be cached on the application
level (if cache is enabled in Web.Config or
App.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 current
selected workspace even if WorkspaceId column
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 if
WorkspaceId column presents in the entity
attributes. (true by default).
insert_on_update If true, INSERT SQL statement will be executed
instead of UPDATE statement when entity is
updated. False by default.
primary_key_update If false, primary key fields will be not updated on
entity 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 the
configuration files, etc. If empty, the default
database connection is used to read this entity.
(Not implemented for Windows)
grid_cell_merging Indicates whether the cells in grid with the same
content and verging each other should be merged
(displayed as a sole cell). So far, works just for
Windows.
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, View
commands).
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
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 controller
class. The class must inherit from
CxEditController.
customizable True if entity or entity usage should be displayed
on a setup columns (entity customize) form. False
by default.
customize_caption Caption to display on a setup columns (entity
customize) form.
refresh_depends_on_entity_usages Comma-separated list of entity usage IDs refresh
of this entity usage depends on. (For now, in
windows 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
filter_form_customizable True if filter form can be customized by entity
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 by
default.
select_only_when_filter_enabled If true, when the entity is shown in list (grid), the
actual select will be performed just when the filter
criteria are defined.
paging_enabled Specifies if the paging feature should be used
where it’s possible while displaying entity’s data.
reload_entity_after_update Indicates whether the updated entity should be
reloaded after update.
Entity Unused Attributes:

colors_in_grid not used
may_disappear_after_update not used
edit_class_id not used
Entity Child Tags:

sql_select SQL statement used to get list of entities from database.
sql_select_single_ro Overrides SQL statement used to get single entity record from the
w database. If is not defined, sql_select is used. This statement should
not contain WHERE clause, where-condition is generated
automatically 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 this
element is used.
Parent_Entity Child Tags:

where_clause SQL WHERE clause used to find parent entity by this entity values.
EntityUsages.xml
<entity_usages>
<entity_usage>
<where_clause>
</where_clause>
<join_condition>
</join_condition>
<child_entity_usages>
<child_entity_usage />
</child_entity_usages>
<entity_usage/>
</entity_usages>
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.
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 used
base_entity_usage_id not used
main_menu_entity_usage_i not used
d
hottable not used
refresh_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 not used
t
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 is
always 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 form
metadata used for layout.
change_notification_mod Valid values: AllRecords, EachRecord. AllRecords is the default
e value. When AllRecords is specified, the notification about child
entity (or entities) change is processed once for all changes (batch
mode). When EachRecord is specified, the notification is
processed record-by-record.
Child_Entity_Usage Unused Attributes:

owned_by not used
Attributes.xml
<entities>
<entity id=”ENTITY_ID”>
<attributes>
<attribute>
<filter_condition>
</filter_condition>
<visibility_condition>
</visibility_condition>
<read_only_condition>
</read_only_condition>
</attribute>
</attributes>
</entity>
</entities>
Attribute Attributes:
id Unique ID of the attribute.
type Field type
string character field
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) field
icon character field containing reference to
icon image
hyperlink character field with linked command
caption Caption displayed for user.
Caption_grid Caption displayed in grid column header only. (Just for
Windows, so far)
Caption_edit Caption displayed in edit/view form only. (Just for
Windows, so far)
Caption_filter Caption displayed in filter dialog only. (Just for
Windows, so far)
Caption_query Caption displayed in query interface only. (Just for
Windows, so far)
form_caption Caption displayed on a Edit/View form.(obsolete)
default Default value for the field (is used on a New form only,
when creating new entity).
Syntax:
- If value does not start with ‘=’ it is treated as a
constant value.
- If value starts with ‘=PARENT.’ it should be in
format =PARENT.<EntityId>.<AttributeId>
where <EntityId> is the ID of the entity
metadata or entity usage metadata to take parent
value from; <AttributeId> is the ID of parent
entity attribute (field) to take value from.
- If value starts with ‘=SQL.’, the expression
following the ‘=SQL.’ prefix is calculated via
the call to the database. SQL statement is
executed and scalar result is returned.
Parameters can be used in the SQL statement.
Parameter name should start with colon ‘:’,
parameter value can be a field value from the
current entity.
- If value starts with ‘=Application$’, the
following application variables can be obtained:
Application$UserId, Application$UserName,
Application$UserEmail,
Application$ApplicationCode,
Application$FrameworkUserId,
Application$CurrentWorkspaceId,
Application$WorkspaceAvailableForUserTable
, Application$LanguageCode,
Application$LocalizationApplicationCode.
- If value starts with ‘=@TODAY’, current date
is substituted.
- If value starts with ‘=@NOW’, current date and
time is substituted.
- If value starts with ‘=@SEQUENCE’, next
sequence value obtained from the
Framework_Sequence table is substituted.
control_width Relative width of the control on a New/Edit/View
form. For example, 2 means double width.
control_height Height of the control on a New/Edit/View form. Height
is specified in rows. It is available for memo and html
controls only.
control_modifiers List of control options encoded into letters.
U text is converted to upper case
L text is converted to lower case
P password text input (Not implemented for
Web)
row_source_id Reference to row source ID to get list of values for
drop-down lists.
row_source_filter SQL WHERE clause to apply to list of values.
row_source_constant_filter Constant SQL WHERE clause to apply to list of
values. Constant means that clause does not contain
references to the fields of current entity.
row_source_or_filter SQL WHERE clause added with ‘OR’ operator to the
row_source_filter clause.
row_source_constant_or_filter Constant SQL WHERE clause added with ‘OR’
operator to the row_source_filter clause.
sorting If specified, entity list will be sorted by this attribute.
Possible values are: asc or desc.
sort_order It is used in combination with sorting. Defines sort
order if sorting is performed by multiple fields.
max_length Maximum length of field value.
scale Scale of float field (number of characters after decimal
point)
grid_width Width of the column in grid (in pixels)
min_value Minimum value of a numeric field.
max_value Maximum value of a numeric field.
primary_key True if field is a part of table primary key.
alternative_key True if field is a part of table alternative (unique) key.
Alternative key can be logical only (DB constraint is
optional). Alternative key is used for the following
main purposes: 1) Inserted record reload from database
if primary key value is absent; 2) Record search in the
memory data table if primary key is absent; 3) Correct
unique values handling on record copy and paste.
alternative_key_index Index of the alternative key. Is used in a combination
with the alternative_key attribute to define more than
one alternative key for the entity.
nullable False if field does not allow nulls.
storable False if field should not be updated in DB.
visible False if field should be not visible.
editable False if field should be not visible on New/Edit/View
form.
filterable False if field should be not visible on a find form.
read_only True is field should be read-only on New/Edit/View
form.
read_only_for_update True is field should be read-only on Edit form.
enabled False is field should be read-only on New/Edit/View
form. (Obsolete, Not implemented for Windows)
display_name True if value of the field should be a part of entity
instance display name.
grid_summary Defines aggregate expression to calculate in grid.
Syntax: <expression>;<format> where <expression> is
one of the list: Count, Sum, Min, Max, Average;
<format> is the expression can be used as a
String.Format placeholder.
local_expression Field value expression to calculate on a New/ Edit
form.
Syntax:
- If does not start with ‘SQL.’, is interpreted as
the expression calculated via the .NET
DataTable class built-in functionality (see
DataColumn.Expression topic of MSDN).
- If starts with ‘SQL.’, is calculated via the
database call. SQL statement is executed and
scalar result is returned.
Parameters can be used in the expression. Parameter
should start with the colon ‘:’. Any current entity field
can be used as an expression parameter.
on_save_expression Field value expression calculated on a New/Edit form
before write entity to DB. (See local_expression for
syntax)
incomparable True if this attribute should not participate in entity
comparisons
filter_default Default value for find (filter) form.
filter_default_1 First default value for find (filter) form.
filter_default_2 Second default value for find (filter) form.
filter_operation Default filter operation selected on a find (filter) form.
Available values:
- Equal
- NotEqual
- Less
- Greater
- LessEqual
- GreaterEqual
- Between
- Like
- NotLike
- StartsWith
- IsNull
- IsNotNull
- Today
- ThisWeek
- ThisMonth
- Yesterday
- PrevWeek
- PrevMonth
- NotExists
filter_condition Condition to be substituted into SQL WHERE clause to
filter query data by parameters specified on a find
form.
enabled_filter_operations Comma-separated list of available filter operations for
a find form (see filter_operation for list of available
filter operation values)
filter_mandatory True if value of the field should be mandatory (not
empty) for a find form.
filter_search_field Is used to override the name of field in the database
object (table or view) to compare with the filter value.
filter_search_object Is used to override the database object (table or view)
to apply filter condition to.
filter_search_object_join Is used in combination with filter_search_object to
specify condition for search object join.
filter_myself Can be used to filter by current user ID. Is applicable
when filtering by user ID. If true, ‘Myself’ filter
operation is displayed in the filter operations drop-
down list.
alignment Alignment in a grid (left, center, right). (Not
file_lib_entity_usage_id ID of entity usage that is used as file/image library.
file_lib_reference_attribute_id ID of attribute that contains a foreign key reference to
file/image library. (Not implemented for Windows)
file_content_attribute_id ID of attribute that contains file/image binary data.
file_lib_category_code For file/image. Group ID to open default file library
group (category). (Not implemented for Windows)
file_lib_category_code_attribute_id For file/image. ID of attribute that contains group ID to
open default file library group (category). (Not
image_small_thumbnail_size For image type. Size of image thumbnail.
image_large_thumbnail_size For image type. Size of image thumbnail.
new_line True if control should be placed on the new line of the
edit form.
new_line_filter True if control should be placed on the new line of the
filter form.
visibility_condition Condition to make control visible/invisible on
New/Edit/View form.
read_only_condition Condition to make control read-only on
New/Edit/View form.
hyperlink_command_id Command ID to perform when hyperlink control is
clicked (only for hyperlink type).
hyperlink_entity_usage_id Entity usage ID to perform hyperlink command on. The
specified entity usage should be available to find by the
parent_entity conditions.
hyperlink_entity_usage_attr_id ID of the attribute where stored dynamic entity usage
ID to perform hyperlink command on. The specified
entity usage should be available to find by the
parent_entity conditions.
hyperlink_ignore_null Indicates is hyperlink displayed when attribute value is
null.
is_calculated If true, entity field value will be always calculated by
the local_expression (on entity load).
min_year_value Minimum relative year value for date drop-down list
control.
max_year_value Maximum relative year value for date drop-down list
control.
mandatory_condition Condition to make control mandatory (not null) on
New/Edit form. Set nullable=”false” to use this
property.
default_value_calculation_order Defines order in which expression specified in the
‘default’ property is calculated within entity fields.
First all attributes with specified calculation order are
sorted by the order, then attributes without order are
appended to the end of the sorted list in order of
appearance (definition).
text_attr_id For attributes with row_source_id specified only. A
reference to the attribute containing text description for
the lookup value. Is used for optimization and
windows-web compatibility. It is recommended to
specify this attribute if SQL select contains read-only
text description for the lookup value.
db_object_index For multiple database object entities only. Indicates the
index of DB object used to store this attribute (field)
value.
init_with_row_source_default_valu True if attribute value should be initialized with the
e default (first) row source value on new entity creation
if attribute is mandatory. True by default.
display_seconds For date-time fields only. If true, seconds are displayed,
if false, seconds are not displayed. True by default.
sort_by_attr_id ID of the attribute to sort dataset when sorting is
applied to the current attribute
Attribute Web Attributes:

web_control Control to edit/view field on a web form.
text text box
checkbox check box
int text box with validation
number text box with validation
date date selection control (popup)
datetime date/time selection control
(popup)
time time selection control (not
implemented yet)
month two drop-down lists to select year
and month
future_month two drop-down lists to select year
and month from future time range
date_dropdown three drop-down lists to select
day, month, year
memo multiline text box
html HTML editor
dropdown drop-down list
lookup not used
password password text box
file special control to
download/upload files
image special control to view and upload
images
icon displays icon image referenced
from the field content
icon_text displays icon image referenced
from the field content and field
text
hyperlink displays hyperlink to linked
command
scrambled_text displays text scrambled by some
algorithm determined by
scrambled_class_cd and
scrambler_method properties. By
default if these properties are
empty, text is replaced with
asterisks.
web_control_placement Name of parent ASP.NET panel to place control to.
web_filter_control Control to use on a find form.
web_filter_control_placement Name of parent ASP.NET panel to place control on a
find form.
grid_word_wrap If true, column content will be wrapped in the grid cell.
hyperlink_web_command_id Command ID to perform when hyperlink control is
clicked. Web only.
hyperlink_show_in_popup True if hyperlink should contain small icon URL
redirecting by GET request to the command target page
opening in a separate popup window to avoid extra
postback.
hyperlink_show_get_url True if hyperlink should contain small icon URL
redirecting by GET request to the command target page
to avoid extra postback.
hyperlink_show_get_url_only True if hyperlink URL redirects by GET request to the
command target page to avoid extra postback.
scrambler_class_cd For attributes with web_control=’scrambled_text’.
Scrambler class code.
scrambler_method For attributes with web_control=’scrambled_text’.
Static scrambler method which belongs to the scrambler
class. Method takes one string parameter and returns
scrambled string.
Attribute Windows Attributes:

win_control Control to edit/view field on a windows form or in a
windows grid.
text text box
checkbox check box
spin spin editor with up-down
arrows for integer or float
values
calc text box with calculator pop-
up for integer or float values
date date selection control
(popup)
memo multi-line text box
memopopup pop-up multi-line text box
html HTML editor (text with
formatting)
comboedit text box with list of values
(user can select text value or
enter any text)
dropdown drop-down list of values
(taken from row source)
dropdown_image drop-down list of values and
images (taken from row
source)
dropdown_imageonly drop-down list of images
(taken from row source)
lookup drop-down lookup grid
(defined by row source)
lookup_multi drop-down lookup grid with
multiple selection (defined
by row source)
lookup_select lookup value selection
dialog invoked with the
ellipsis button. (defined by
row source)
time time edit box
hyperlink hyperlink to linked
command
hyperlinkedit editable hyper link, user can
enter URL or file name and
then clicking on hyper link
opens URL with explorer or
file with associated program.
hyperlinkeditfile The same as hyperlinkedit
but with file-associated icon
display.
email Editable hyperlink text box
for email input.
image image editor
imagepopup image pop-up editor (Not
implemented yet)
buttonedit Text box with button, button
command is determined by
the button_command_id.
Text editor is disabled,
button can be pressed only.
buttontextedit Text box with button, button
command is determined by
the button_command_id.
Text editor is enabled.
color Color selection drop-down.
Color must be stored in the
DB as a comma-separated
R,G,B string.
color_notext The same as ‘color’, but
does not display RGB color
text, displays color rectangle
only.
file Server (database) file upload
and download control. The
control should be used with
BLOB binary fields
containing CxBlobFile
object. Allows file upload to
server and file download
from server (download and
open).
percent Percent value from 1 to 100,
displayed with the ‘%’
symbol.
win_control_placement ID of the panel to place control to. Panel ID references
to the panel defined in the WinForms.xml file, for the
particular form metadata used for layout.
win_filter_control Control to use on a find (filter) form.
win_filter_control_placement ID of the panel to place control on the filter form. (Not
implemented yet)
filter_advanced True to place filter control on a special ‘Advanced’
panel of the filter form.
refresh_on_popup If true, and given attribute is dynamic lookup, list of
values is refreshed each time lookup popup is activated.
grid_width_fixed True if grid column with should be fixed and column
cannot be resized by user. False by default.
paste_default Value (or expression) applied to the attribute on entity
paste. See default for syntax.
read_only_in_grid True if field should be read-only in grid.
hyperlink_windows_command_id Command ID to perform when hyperlink control is
clicked. Windows only.
button_command_id ID of the command to execute on additional editor
button click.
button_command_entity_usage_id ID of the entity usage to apply command to on
additional editor button click.
button_image_id ID of the image to display on the additional editor
button (12x12 pixels).
button_visible False to hide additional editor button.
button_hidden_for_update True to hide additional editor button in edit (not new)
mode. I.e., button is available for new records only.
button_ellipsis True if command button should be ellipsis instead of
glyph.
button_edit_text_editable True if text should be editable for the button edit. False
by default.
lookup_width The width (in pixels) of the lookup (grid lookup or tree
list lookup) drop-down popup window.
only_one_selected Client-side processing of check-box fields. If child
entity has only_one_selected Boolean field, the check-
mark will be correctly kept in a child grid of entity
dialog. The logic of checking-unchecking must be
implemented on the server-side, client-side logic is just
for displaying purposes.
increment_on_create Client-side processing of automatic numeration.
If true, fills field of the new created entity with
incremented max value. Max value is calculated among
currently present in memory child entities, then max
value incremented and assigned to the entity field.
Works for Windows only. Is used for an entity dialog
child grids.
select_form_class_id ID of class metadata used as lookup select form
(lookup_select Windows control type).
hyperlink_auto_refresh If true, record containing foreign key hyperlink
reference to the changed record will be automatically
refreshed.
customizable Returns true if attribute should present on the entity
customization form. The customization form allows
hiding/showing attributes in entities from user interface
by application user. Currently implemented for
Windows only. True by default.
column_header_image_id Id of the image to be displayed in the column header.
No image is displayed if empty.
Attribute Unused Attributes:
attributes_to_get_from_lookup not used
value_attribute_id not used
user_id not used
custom not used
manual not used
grid_filtered not used
definition_attribute_id not used
definition_class_id not used
definition_dialog_class_id not used
grid_color Name of the color to show attribute grid column with.
(Not implemented yet)
Attribute Child Tags:

filter_condition Condition to be substituted into SQL WHERE clause to filter
query data by parameters specified on a find form. (Also can be
specified as an XML attribute).
visibility_condition Condition to make control visible/invisible on New/Edit/View
form. (Also can be specified as an XML attribute).
read_only_condition Condition to make control read-only on New/Edit/View form.
(Also can be specified as an XML attribute).
mandatory_condition Condition to make control mandatory (not null) on New/Edit
form. Set nullable=”false” to use this property. (Also can be
specified as an XML attribute).
AttributeUsages.xml
<entity_usages>
<entity_usage id=”ENTITY_USAGE_ID”>
<grid_order>
</grid_order>
<grid_visible_order>
</grid_visible_order>
<edit_order>
</edit_order>
<filter_order>
</filter_order>
<attribute_usages>
<attribute_usage>
<filter_condition>
</filter_condition>
<read_only_condition>
</read_only_condition>
</attribute_usage>
</attribute_usages>
</entity_usage>
</entity_usages>
Attribute_Usage Attributes:
id Unique ID of the attribute.
See Attribute Attributes table for the list of available Attribute
Usage attributes.
Attribute_Usage Tags:
grid_order Comma separated list of entity attribute names. The list defines
available entity attributes.
grid_visible_order Comma separated list of entity attribute names. The list defines
attributes visible in a grid.
edit_order Comma separated list of entity attribute names. The list defines
attributes visible on a New/Edit/View form.
filter_order Comma separated list of entity attribute names. The list defines
attributes visible on a find form.
Commands.xml
<commands>
<command>
<sql_command>
</sql_command>
<disable_conditions>
<condition>
<expression>
</expression>
<error_text_expression>
</error_text_expression>
</condition>
</disable_conditions>
</command>
</commands>
Command Attributes:
id Unique ID of the command.
text Command caption displayed to user.
operation_code Letter to link command to entity operation attribute value.
parent_command_id Reference to parent command ID to build hierarchical menus.
is_entity_instance_required True if command requires selected entity instance to be
executed for.
entity_usage_id Entity usage ID to be executed for.
parent_entity_usage_id Parent entity usage ID for commands that do not require
entity instance.
confirmation_text Confirmation text to be displayed before command execution.
command_type Available values: View or Edit. It is used for security setup
purposes.
is_default True if command is default for the entity or entity usage.
(Executed by double-click in a grid). (Not implemented for
Windows, ‘Open’ command is always used as default)
target_command_id Performs redirection to another command.
sql_command SQL block to execute.
instance_method Returns the name of the C# method in the entity instance to
execute by the command.
static_class_id Reference to C# class ID defined in Classes.xml containing
static method to execute by the command. (Not implemented
for Windows)
static_method Returns the name of C# static method to execute by the
command. Method should be present in a class referenced by
static_class_id. (Not implemented for Windows)
refresh_page True if the whole web page (or windows form) should be
refreshed after command is executed.
refresh_part True if web part (or windows form) should be refreshed after
command is executed.
dynamic_entity_usage_attr_i ID of the attribute containing entity usage ID for
d command execution. Attribute value is taken from the current
entity related to the command.
dynamic_command_attr_id ID of the attribute containing command ID for command
execution. Attribute value is taken from the current entity
related to the command.
convert_entity_usage_attr_id Returns the name of the attribute containing entity usage ID
for command execution. Attribute value is taken from the
current entity related to the command. Current (this) entity is
converted to the given entity usage.
multiple True if command can be applied to multiple entities selected
in a grid.
application_scope Windows or Web. Command is available if the application
scope is empty or equals to the application scope value from
the Config.xml.
Command Web Attributes:

target_portal_id Portal part of the redirection URL.
target_tree_item_id Tree item part of the redirection URL.
target_page_id Page part of the redirection URL.
target_tab_id Tab part of the redirection URL.
Command Windows Attributes:

unique_id Mandatory property for Windows command. Unique integer
value assigned to any Windows command in metadata.
menu_category Mandatory property for Windows command. Valid values
are: File, Edit, View, Entity.
image_id ID of the image metadata used to display command item on a
toolbar or menu.
windows_handler_class_id ID of the C# class implementing IxCommandHandler
interface used to perform the command.
windows_handler_batch True for batch commands (single windows handler method is
called for all selected entities). Can be used in a combination
with windows_handler_class_id only.
display_order Determines the display order of the command within menu
category when displaying in menus and toolbars.
visible_in_main_menu True to display command in main menu. True by default.
visible_in_toolbar True to display command in main toolbar. True by default.
visible_in_popup_menu True to display command in context (popup) menu. True by
default.
toolbar_display Valid values: Default, ImageAndText and Text.
begin_group True to draw menu divider line before command. False by
default.
shortcut Shortcut key combination. Valid value is a text can be
converted to the .NET System.Windows.Forms.Shortcut
enumeration.
split_by_entity_usages For commands that do not require entity instance. True to
generate a set of menu items like ‘New Entity 1’, ‘New Entity
2’, etc.
publish_global For commands that do not require entity instance. True if
menu item should be always published in the main application
menu. Is used for the non-instance commands in a
combination with a particular entity usage to put New
Something commands to the main application menu.
publish_local For commands that do not require entity instance. True if
menu item should be always published in the view/edit form
menu. Is used for the non-instance commands in a
combination with a particular entity usage to put New
Something commands to the view/edit form menu.
hidden_when_disabled True if command should be hidden (not just disabled only) if
it is not available for the current entity or entity usage.
copy_entity_image True if current entity image should be assigned to the
command.
ellipsis_mark True if command text should be followed with ellipsis (...).
entity_save Entity save mode. Valid values: Before or After. Indicates
than command target entity should be automatically saved
before command execution or after command execution.
command_category_caption Category caption to display in the main menu for commands
specific for the current entity (or entity usage).
image_entity_usage_id ID of the entity usage to take image from.
split_entity_usages Comma-separated list of entity usage IDs to split non-instance
command. A menu item will be added for each specified
entity usage, for example, if we have command New and
split_entity_usages=”Appointment, Task”, two menu items
will be added: ‘New Appointment’ and ‘New Task’.
Command Unused Attributes:

web_request not used
web_display_mode not used
Command Child Tags:

sql_command SQL block to execute.
disable_conditions Command disable conditions.
Condition Attributes:
expression Local or SQL boolean expression to check. If expression result is
calculated to true, command is not executed, error message is
displayed.
error_text Error text to display.
error_text_expression Local or SQL string expression calculates error text to display.
entity_usage_id Reference to entity usage ID to calculate expression for.
entity_id Reference to entity ID to calculate expression for.
Condition Child Tags:

expression Local or SQL boolean expression to check. If expression result is
calculated to true, command is not executed, error message is
displayed.
error_text_expression Local or SQL string expression calculates error text to display.
EntityCommands.xml
<entity_commands>
<entity id=”ENTITY_ID”>
<commands>
</commands>
<command_order>
</command_order>
<command_groups>
<command_group>
<condition>
<expression>
</expression>
</condition>
</command_group>
</command_groups>
</entity>
<entity_usage id=”ENTITY_USAGE_ID”>
<commands>
</commands>
<command_order>
</command_order>
<command_groups>
<command_group>
<condition>
<expression>
</expression>
</condition>
</command_group>
</command_groups>
</entity_usage>
</entity_commands>
Command Attributes:
id Reference to ID of the command defined in Commands.xml.
See Command Attributes table below for the list of command
attributes that can be overridden for the command.
EntityCommands Tags:
command_order Comma-separated list of command IDs defined for entity or entity
usage. It is used to remove some commands or change command
visible order.
command_groups Defines groups of commands with the same disable conditions.
Command_Group Attributes:
id Unique ID of the command group
command_type Type of commands included into the group.
excluded_commands Comma-separated list of command IDs excluded from the group.
included_commands Comma-separated list of command IDs included into the group.
RowSources.xml
<row_sources>
<row_source>
<rows>
<row/>
</rows>
</row_source>
</row_sources>
Row_Source Attributes:
id Unique ID of the row source.
entity_usage_id Reference to the entity usage to take row source data from.
hierarchical True if drop-down list should be hierarchical. Can be used with
self-reference entity usage only.
hierarchy_orphan_visibl If true, and row source is hierarchical, orphan records (that have
e invalid parent) are also visible.
localizable For static row sources only (when rows are specified in XML). If
true, rows will be localized by the Multilanguage system (if
Multilanguage is enabled). True by default.
huge True if row source entity usage contains huge amount of data and
should be handled in a special way. (Not implemented for Web).
cached True if row source data should be cached in the application.
key_type Defines type of the key value for the static (hard-coded) row
sources. Valid types: string (default), int or boolean.
Row_Source Web Attributes:

Row_Source Windows Attributes:
image_attr_id ID of the row source entity usage attribute containing valid image
metadata ID. Image is displayed before text in the drop-down.
rgb_color_attr_id ID of the row source entity usage attribute containing valid RGB
color description in the comma-separated R,G,B format. The color
is used to display filled rectangle before text in the drop-down.
RowSource Child Tags:

rows Defines static rows for the row source. (If present, this row source
is always static).
Row Attributes:
key Value used as row key (will be used as target field value).
value Value used to display to user in a drop-down list.
image_id ID of the image metadata corresponding to the row. (Not
implemented for Web).
Constraints.xml
<constraints>
<constraint>
<message>
</message>
</constraint>
</constraints>
Constraint Attributes:
id Unique ID of the constraint. This text will be searched in DB error
message.
Constraint Child Tags:

message Error message to display to user.
Images.xml
<images>
<image_folder />
<image />
</images>
Image_Folder Attributes:
id Unique ID of the image folder.
path Relative URL path
Image_folder elements are used for Web only.
Image Attributes:
id Unique ID of the image.
Image Web Attributes:

folder_id Reference to folder ID defined as image_folder element.
file_name Image file name.
Image Windows Attributes:

provider_class_id ID of the C# class containing image list. (IxImageProvider
interface)
image_provider_class_i Synonym to the provider_class_id.
d
index Index of the image in the image list.
image_index Synonym to the index.
WebParts.xml
<web_parts>
<web_part>
<condition>
<expression>
</expression>
</condition>
<hint_expression>
</hint_expression>
</web_part>
</web_parts>
Web_Part Attributes:
id Unique ID of the web part.
text Web part caption displayed to user.
entity_usage_id Defines entity usage to display on the web part.
position Position on the page: left, right, top, bottom.
content_control Name of the ASCX control to render web part
content.
content_class_id Reference to C# class ID for web part content
rendering
template_control Name of the ASCX control to render web part
template.
min_width Minimum web part width (in pixels).
min_height Minimum web part height (in pixels).
fixed_width Web part width (in pixels).
fixed_height Web part height (in pixels).
fit_to_width True if web part should be fitted to all available
width.
fit_to_height True if web part should be fitted to all available
height.
hidden_commands Comma-separated list of command IDs to hide on
the web part.
content_type Can be: Custom, New, Edit, View, Find.
title_visible If false, web part title is not visible.
menu_visible If false, web part menu is not visible.
filter_enabled For entity list web part only. If false, find form is
not visible.
hint Web part hint text displayed at the top of the web
part.
hint_expression Local or SQL string expression to calculate dynamic
web part hint text.
hint_expression_entity_usage_id ID of the entity usage used as a value provider for
hint expression.
redirect_after_insert For entity edit web parts. If true, redirect to previous
page is performed after entity insert. True is a
default setting.
redirect_after_update For entity edit web parts. If true, redirect to previous
page is performed after entity update. True is a
default setting.
visibility_condition Local or SQL boolean expression. Web part is
visible, if expression calculates to true.
visibility_condition_entity_usage_id Reference to entity usage ID to calculate visibility
condition for.
ok_button_redirect_page_id For entity edit web parts: page ID to redirect after
OK button clicked.
ok_button_redirect_tab_id For entity edit web parts: tab ID to redirect after OK
button clicked.
ok_button_redirect_entity_usage_id For entity edit web parts: used only with
'ok_button_redirect_page_id' property. Defines
context entity usage ID to pass to redirection page
after OK button clicked.
ok_button_text For entity edit web parts: caption to display on OK
button.
grid_row_selection For entity list web parts determines automatic row
selection mode. (OnLoad (web part load only),
Always (web part load and postback)). Tries to
select current entity row in the grid.
grid_row_selection_entity_usage_id For entity list web parts with automatic row
selection mode specifies entity usage ID to select
row.
grid_row_selection_by_parent True if navigator parent entity should be used for
grid row selection. False by default.
form_column_count For New/Edit/View (entity edit) web parts: control
column count on the form.
form_control_width For New/Edit/View (entity edit) web parts: standard
control width on the form (in pixels).
form_label_width For New/Edit/View (entity edit) web parts: standard
label width on the form (in pixels).
query_value_provider_entity_usage_i ID of the entity usage required as a parameter value
d provider for select statement used for grid
(Default_List web part).
Web_Part Child Tags:

disable_conditions Web part disable conditions (see command disable conditions for
syntax).
visibility_condition Local or SQL boolean expression. Web part is visible, if expression
calculates to true.
hint Web part hint text displayed at the top of the web part.
hint_expression Local or SQL string expression to calculate dynamic web part hint
text.
Pages.xml
<pages>
<page>
<web_part id=”WEB_PART_ID”>
</web_part>
</page>
<page>
<tab>
<web_part id=”WEB_PART_ID”>
</web_part>
</tab>
</page>
</pages>
Page Attributes:
id Unique ID of the page.
text Page caption displayed to user.
clear_history True if page state 'back' stack should be cleared before page
displaying.
save_history True if page should be stored in page state ‘back’ stack (true by
default).
is_default True if the page is a default application startup page.
is_secured True if page is secured, i.e. SSL is required.
set_focus_on_load True if page focus should be set on load.
portal_template_control Name of the portal template ASCX control that should be used as a
page template. Can be used to override default portal template for
some pages.
is_scrollable True if page is scrollable.
Tab Attributes:
id Unique ID of the tab.
text Tab caption displayed to user.
visibility_condition Local or SQL boolean expression. Tab is visible, if
expression calculates to true.
visibility_condition_entity_usage_i Reference to entity usage ID to calculate visibility
d condition for.
set_focus_on_load True if page focus should be set on load.
is_scrollable True if page is scrollable when this tab is selected.
Tab Child Tags:

visibility_condition Local or SQL boolean expression. Tab is visible, if expression
calculates to true.
Web_Part Attributes:
id Reference to web part ID defined in WebParts.xml
All web part attributes can be overridden on the page (see
Web_Part attributes table).
Portals.xml
<portals>
<tree_item>
<tree_item>
....
</tree_item>
</tree_item>
</portals>
Portal Attributes:
id Unique ID of the portal.
text Portal caption displayed to user.
skin_id ID of the portal skin defined in PortalSkins.xml.
is_default True if the portal is a default portal for the application.
title Application title for the portal displayed as a page title in browser.
hidden_for_user True if portal should be visible in development mode only.
visible False if portal should be hidden.
Tree_Item Attributes:
id Unique ID of the tree item.
text Tree item caption displayed to user.
page_id Reference to page ID defined in Pages.xml. Defines page to
display.
entity_usage_id Reference to entity usage ID defined in EntityUsages.xml. Defines
entity usage context for the tree item.
PortalSkins.xml
<skins>
<skin>
<stylesheets>
<stylesheet />
<stylesheets>
</skin>
</skins>
Skin Attributes:
id Unique ID of the portal skin.
is_default If true, the skin is used by default for all portals. (If skin is not
specified for portal directly).
template_folder Root path for all template user controls (ASCX).
portal_template The name (and path) of portal main page template user control
(ASCX).
popup_template The name (and path) of portal popup page template user control
(ASCX).
web_part_template The name (and path) of web part template user control (ASCX).
login_template The name (and path) of portal login page template user control
(ASCX).
images_folder Folder that is default for skin images.
Skin Child Tags:

stylesheets List of stylesheets (CSS files) used for the portal skin.
Stylesheets Attributes:
folder Default folder for all child style sheets.
Stylesheet Attributes:
name Name of the CSS file.
WinSections.xml
<sections>
<section>
<tree_item>
<tree_item>
....
</tree_item>
</tree_item>
</section>
</sections>
Section Attributes:
id Unique ID of the section.
text Section caption displayed to user.
is_default True if the section is a default section for the application.
hidden_for_user True if section should be visible in development mode only.
visible False if section should be hidden.
Tree_Item Attributes:
id Unique ID of the tree item.
text Tree item caption displayed to user.
entity_usage_id Reference to entity usage ID defined in EntityUsages.xml.
Defines entity usage context for the tree item.
frame_class_id ID of the C# class used to display tree item content. Is not
required if entity_usage_id is specified.
image_id ID of the image used to display in the tree. Is not required if
entity_usage_id is specified and image_id for the
entity_usage is specified.
item_provider_class_id ID of the C# tree item provider class to get child or neighbor
items.
item_provider_parameters String containing parameters specific for each item provider
class.
item_provider_replacement If true, items returned by the item provider should replace
this item. Otherwise, items returned by item provider are
added as child items.
depends_on_entity_usage_id For dynamic tree items created by item provider indicates
s that these dynamic items should be refreshed when some
listed entity usage is changed. List is comma-separated.
WinForms.xml
<forms>
<form>
<tab>
<panel></panel>
</tab>
</form>
</forms>
Form Attributes:
id Unique ID of the form layout.
Tab Attributes:
id Unique ID of the form tab. Form should have default tab with the
id=”tpDefault”. Tab IDs should be prefixed with “tp”. Default tab
should have default panel with the id=”pnDefault”. Panel IDs
should be prefixed with “pn”.
text Tab caption to display to user.
Panel Attributes:
id Unique ID of the form panel.
text Panel caption to display to user. Optional. If empty, panel does not
have caption.

Framework Metadata Description

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

Framework Metadata Description

Caricato da

Copyright:

Formati disponibili

Framework Metadata Description

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

Common Metadata Object Attributes

Entity Web Attributes:

Entity Windows Attributes:

Entity Unused Attributes:

Entity Child Tags:

Parent_Entity Child Tags:

Entity_Usage Web Attributes:

Entity_Usage Windows Attributes:

Entity_Usage Unused Attributes:

Entity_Usage Child Tags:

Child_Entity_Usage Windows Attributes:

Child_Entity_Usage Unused Attributes:

Attribute Web Attributes:

Attribute Windows Attributes:

Attribute Child Tags:

Command Web Attributes:

Command Windows Attributes:

Command Unused Attributes:

Command Child Tags:

Condition Child Tags:

Row_Source Web Attributes:

RowSource Child Tags:

Constraint Child Tags:

Image Web Attributes:

Image Windows Attributes:

Web_Part Child Tags:

Tab Child Tags:

Skin Child Tags:

Potrebbero piacerti anche