Академический Документы
Профессиональный Документы
Культура Документы
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
implemented for Windows)
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
implemented for Windows)
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
implemented for Windows)
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.
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)
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).
<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
implemented for Windows)
file_lib_entity_usage_id ID of entity usage that is used as file/image library.
(Not implemented for Windows)
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.
(Not implemented for Windows)
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
implemented for Windows)
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
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>
<visibility_condition>
</visibility_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.
(Not implemented for Windows)
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.
EntityCommands.xml
<entity_commands>
<entity id=”ENTITY_ID”>
<commands>
</commands>
<command_order>
</command_order>
<command_groups>
<command_group>
<disable_conditions>
<condition>
<expression>
</expression>
<error_text_expression>
</error_text_expression>
</condition>
</disable_conditions>
</command_group>
</command_groups>
</entity>
<entity_usage id=”ENTITY_USAGE_ID”>
<commands>
</commands>
<command_order>
</command_order>
<command_groups>
<command_group>
<disable_conditions>
<condition>
<expression>
</expression>
<error_text_expression>
</error_text_expression>
</condition>
</disable_conditions>
</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 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.
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.
WebParts.xml
<web_parts>
<web_part>
<disable_conditions>
<condition>
<expression>
</expression>
<error_text_expression>
</error_text_expression>
</condition>
</disable_conditions>
<visibility_condition>
</visibility_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).
Pages.xml
<pages>
<page>
<web_part id=”WEB_PART_ID”>
</web_part>
</page>
<page>
<tab>
<web_part id=”WEB_PART_ID”>
</web_part>
<visibility_condition>
</visibility_condition>
</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.
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.
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.