Flexberry PLATFORM Documentation

https://flexberry.github.io
Admin
Technical documentation for the Flexberry PLATFORM, a suite of tools and frameworks for developing...
Tokens:14,333,825
Snippets:65,638
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Gulp and npm Commands

Source: https://flexberry.github.io/en/tds_module2-check-list

Provides examples of common build and task runner commands used in the project, such as Gulp tasks for linting, testing, and building, and npm commands for package installation and running scripts.

```Shell
gulp lint
gulp test
gulp build
```

```Shell
npm install
```

```Shell
npm run lint
```

--------------------------------

### Flexberry Business Server Example

Source: https://flexberry.github.io/ru/fo_reading-portion

A practical example demonstrating the usage and implementation of the Business Server in a Flexberry application.

```APIDOC
Topic: Example of Business Server Usage
URL: https://flexberry.github.io/ru/fo_bs-example.html
Description: Provides a concrete example of how to implement and utilize the Business Server in Flexberry.
Related: Business Server, Business Logic.
```

--------------------------------

### Flexberry Views Examples

Source: https://flexberry.github.io/ru/fo_func-in

Provides examples and guidance on working with views in Flexberry, including basic and advanced usage scenarios. These examples demonstrate how to define and interact with data views within the framework.

```APIDOC
Example Work with Views:
  Description: Demonstrates basic usage of views in Flexberry.
  Link: https://flexberry.github.io/ru/fo_work-with-views-example.html

Advanced Work with Views:
  Description: Covers more complex scenarios and advanced techniques for working with views in Flexberry.
  Link: https://flexberry.github.io/ru/fo_advanced-working-with-views.html
```

--------------------------------

### Enable and Start Apache (SysV)

Source: https://flexberry.github.io/ru/gbt_deployment_linux

Настраивает службу httpd2 для автоматического запуска на указанных уровнях выполнения и запускает службу Apache с использованием скриптов SysV init.

```bash
# chkconfig --add httpd2
# chkconfig --level 2345 httpd2 on
# service apache2 start
```

--------------------------------

### Get Guid by Object

Source: https://flexberry.github.io/NewPlatform.Flexberry.ORM/autodoc/develop/class_i_c_s_soft_1_1_s_t_o_r_m_n_e_t_1_1_p_k_helper

Extracts a Guid from an object, which can be a Guid, KeyGuid, DataObject, or string. Returns the object's Guid.

```APIDOC
ICSSoft.STORMNET.PKHelper.GetGuidByObject(object _obj_)
  - Extracts Guid from an object (Guid, KeyGuid, DataObject, or string).
  - Parameters:
    - _obj_: The object to convert.
  - Returns: The Guid of the object.
```

--------------------------------

### Enable and Start Apache (Systemd)

Source: https://flexberry.github.io/ru/gbt_deployment_linux

Включает службу apache2 для автоматического запуска при загрузке системы и запускает службу Apache с помощью команд systemd.

```bash
# systemctl enable apache2
# systemctl start apache2
```

--------------------------------

### Install and Run Pentaho PowerShell Script

Source: https://flexberry.github.io/en/fan_pentaho-installation

This PowerShell script automates the setup of Pentaho by downloading necessary configuration files and scripts from a GitHub repository. It creates a directory for Pentaho in the user's documents, downloads .env, pull.cmd, docker-compose.yml, and various start/stop scripts, preparing the environment for Pentaho execution.

```PowerShell
$documentsPath=[Environment]::GetFolderPath('MyDocuments')$folderName='Pentaho'cd$documentsPathNew-Item-ErrorActionIgnore-Path$folderName-ItemType'directory'cd$folderName$client=new-objectSystem.Net.WebClient$downloadPath='https://raw.githubusercontent.com/Flexberry/NewPlatform.Flexberry.Analytics/master/pentaho'$client.DownloadFile("$downloadPath/.env","$pwd\.env")$client.DownloadFile("$downloadPath/pull.sh","$pwd\pull.cmd")$client.DownloadFile("$downloadPath/docker-compose.yml","$pwd\docker-compose.yml")$client.DownloadFile("$downloadPath/composeStart.sh","$pwd\composeStart.cmd")$client.DownloadFile("$downloadPath/composeStop.sh","$pwd\composeStop.cmd")$client.DownloadFile("$downloadPath/swarmStart.sh","$pwd\swarmStart.cmd")$client.DownloadFile("$downloadPath/swarmStop.sh","$pwd\swarmStop.cmd")
```

--------------------------------

### FunctionBuilder Examples

Source: https://flexberry.github.io/en/fo_standard-data-services

Practical examples demonstrating the usage of the FunctionBuilder for creating various query constraints and functions in Flexberry.

```APIDOC
https://flexberry.github.io/en/fo_function-builder-examples.html
```

--------------------------------

### Flexberry Legacy Security Configuration Example

Source: https://flexberry.github.io/en/fs_legacy-security-install

Illustrates essential configuration settings for Flexberry Legacy Security, including application name, security service registration, and membership provider setup within an ASP.NET application's configuration file.

```APIDOC
<configuration>
   ...
   <appSettings>
      ...
      <!-- Here it is necessary to register the name of the application -->
      <add key="applicationName" value="WebApp" />
      ...
   </appSettings>
   <container>
      ...
      <!-- System configuration authority. -->
      <register type="ISecurityService" mapTo="CheckingInSessionMode">
        <lifetime type="singleton"/>
        <constructor>
          <!-- Here it is necessary to register the name of the application -->
          <param name="imprisone" type="System.String" value="WebApp"/>
        </constructor>
      </register>
      ...
   </container>
   ...
   <system.web>
      <membership defaultProvider="CaseberryMembershipProvider">
        <providers>
          <clear />
          <!-- Here it is necessary to register the name of the application -->
          <add name="CaseberryMembershipProvider" type="CheckingLibrary.Web.CaseberryDomainMembershipProvider" applicationName="WebApp" />
        </providers>
      </membership>
   </system.web>
</configuration>
```

--------------------------------

### Flexberry Product and Guide Links

Source: https://flexberry.github.io/en/fa_wolv-empty-control

This snippet aggregates links to various Flexberry products and development guides, offering a broad overview of the platform's capabilities and learning resources.

```APIDOC
Flexberry Products:

Flexberry PLATFORM:
  - Link: https://flexberry.github.io/en/fp_landing_page.html

Flexberry Designer Desktop:
  - Link: https://flexberry.github.io/en/fd_flexberry-designer.html

Flexberry Designer Online:
  - Link: https://flexberry.github.io/en/fdo_landing_page.html

Flexberry Ember:
  - Link: https://flexberry.github.io/en/ef3_landing_page.html

Flexberry ASP.NET:
  - Link: https://flexberry.github.io/en/fa_landing_page.html

Flexberry Winforms:
  - Link: https://flexberry.github.io/en/fw_landing_page.html

Flexberry Base:
  - Link: https://flexberry.github.io/en/fb_landing_page.html

Flexberry GIS:
  - Link: https://flexberry.github.io/en/fg_landing_page.html

Flexberry Service Bus:
  - Link: https://flexberry.github.io/en/fsb_landing_page.html

Flexberry Analytics:
  - Link: https://flexberry.github.io/en/fan_landing_page.html

Flexberry BPM:
  - Link: https://flexberry.github.io/en/fbpm_landing_page.html

Flexberry Portal:
  - Link: https://flexberry.github.io/en/fprt_landing_page.html

Flexberry ORM:
  - Link: https://flexberry.github.io/en/fo_landing_page.html

Flexberry Security:
  - Link: https://flexberry.github.io/en/fs_landing_page.html

Flexberry Audit:
  - Link: https://flexberry.github.io/en/fau_landing_page.html

Flexberry Guides:

Base tech:
  - Link: https://flexberry.github.io/en/gbt_landing-page.html

Create mobile app:
  - Link: https://flexberry.github.io/en/gma_landing-page.html

Create BPM app:
  - Link: https://flexberry.github.io/en/gbpm_landing-page.html

Create BigData app:
  - Link: https://flexberry.github.io/en/gbd_landing-page.html

Tasks:
  - Link: https://flexberry.github.io/en/gt_landing-page.html

Practical guides:
  - Link: https://flexberry.github.io/en/gpg_landing-page.html

UI UX Guideline:
  - Link: https://flexberry.github.io/en/uiuxg_landing-page.ru.html

OKR Guideline:
  - Link: https://flexberry.github.io/en/okrg_landing-page.html

Training courses:

Developers school:
  - Link: https://flexberry.github.io/en/tds_landing-page.html
```

--------------------------------

### Flexberry BaseApiController Initialization

Source: https://flexberry.github.io/NewPlatform.Flexberry.ORM.ODataService/autodoc/develop/class_new_platform_1_1_flexberry_1_1_o_r_m_1_1_o_data_service_1_1_web_api_1_1_controllers_1_1_file_controller-members

Handles the initialization of the base API controller, setting up the controller context.

```APIDOC
BaseApiController:
  Initialize(controllerContext)
    - Initializes the controller with the provided HTTP controller context.
    - Parameters:
      - controllerContext: The context for the HTTP controller.
```

--------------------------------

### Flexberry Legacy Security Installation Guide

Source: https://flexberry.github.io/en/fs_legacy-security-install

Provides an overview and installation steps for the legacy security module within the Flexberry platform. This section details the process and necessary configurations.

```APIDOC
Installing Legacy Security:
  Overview:
    - Provides a general understanding of the legacy security features and their purpose within the Flexberry ecosystem.
  Installation:
    - Detailed steps and prerequisites for installing the legacy security module.
    - May include configuration parameters or dependencies.

Related Sections:
  - Flexberry Security Overview: https://flexberry.github.io/en/fs_landing_page.html
  - Flexberry Security Update: https://flexberry.github.io/en/fs_flexberry_security_update.html
  - Permissions Structure: https://flexberry.github.io/en/fs_permissions_structure.html
  - Permissions Database Tables: https://flexberry.github.io/en/fs_permissions_tables.html
```

--------------------------------

### Loading and Altering Objects Example

Source: https://flexberry.github.io/ru/fo_business-logic

Provides an example demonstrating how to load and modify objects in Flexberry ORM. This is a practical guide for common data manipulation tasks.

```APIDOC
Documentation Link:
https://flexberry.github.io/ru/fo_load-alter-objects.html
```

--------------------------------

### Prototyping Example: Load, Prototype, Update

Source: https://flexberry.github.io/ru/fo_prototyping-example

This snippet demonstrates the process of loading a data object, creating a prototype of it, and then updating the prototyped object in the data service. It also includes timing for each operation (loading, prototyping, persistence).

```csharp
Console.WriteLine("7. Prototyping.");
IDataService dataService = DataServiceProvider.DataService;
OrmSample ormSample = new OrmSample(dataService);
object primaryKey = ormSample.GetSomeObjectPrimaryKey(typeof(D0));

D0 aggregator = new D0();
aggregator.SetExistObjectPrimaryKey(primaryKey);

Stopwatch stopwatch = new Stopwatch();
stopwatch.Start();

dataService.LoadObject(D0.Views.D0_E, aggregator);

stopwatch.Stop();
long loadObjectTime = stopwatch.ElapsedMilliseconds;
stopwatch.Restart();

// Этот метод делает каждый объект в иерархии новым (листинг приведен ниже).
aggregator.Prototype(true);

stopwatch.Stop();
long prototypingTime = stopwatch.ElapsedMilliseconds;
stopwatch.Restart();

dataService.UpdateObject(aggregator);

stopwatch.Stop();
long updateTime = stopwatch.ElapsedMilliseconds;

Console.WriteLine("Time taken for loading: {1} ms{0}prototyping: {2} ms{0}persistence: {3} ms.", Environment.NewLine, loadObjectTime, prototypingTime, updateTime);

```

--------------------------------

### Technological Forms Customization Example

Source: https://flexberry.github.io/ru/fa_global-limit-editor-settings

An example demonstrating how to customize technological forms in Flexberry applications. This guide helps developers tailor system forms to specific project needs.

```APIDOC
Technological Forms Customization Example:
  - Practical guide for modifying default technological forms.
  - Illustrates techniques for adapting system forms.
  - Useful for advanced configuration and feature implementation.
```

--------------------------------

### Install net-tools

Source: https://flexberry.github.io/ru/gbt_deployment_linux

Устанавливает пакет net-tools, который включает утилиту netstat, если она отсутствует в системе.

```bash
# apt-get install net-tools
```

--------------------------------

### Prototyping Object Example

Source: https://flexberry.github.io/ru/fo_func-sql

Shows how to create a new data object instance (prototype) and set its initial properties before saving.

```csharp
// Example of prototyping and saving a new object

// Create a new instance of a data object
var newObject = new MyDataObject();

// Set initial field values
newObject.Name = "New Item";
newObject.Value = 100;

// Save the new object
dataService.CreateObject(newObject);
```

--------------------------------

### C# Example: Restricting Object Key (GUID)

Source: https://flexberry.github.io/en/fo_function-list

Demonstrates filtering data based on an object's primary key, typically represented as a GUID. It uses the funcEQ operator with a GuidType VariableDef to match a specific identifier.

```C#
using ICSSoft.STORMNET.Windows.Forms;

var langdef = ExternalLangDef.LanguageDef;
var lcs = LoadingCustomizationStruct.GetSimpleStruct(typeof (Кредит), Кредит.Views.КредитE);
lcs.LimitFunction = langdef.GetFunction(langdef.funcEQ,
	            new VariableDef(langdef.GuidType, Information.ExtractPropertyPath<Кредит>(x => x.Личность)), "64F45BC3-339B-4FBA-A036-C5E9FE9EAE53");
var кредиты = DataServiceProvider.DataService.LoadObjects(lcs);

```

--------------------------------

### Flexberry Development Guides

Source: https://flexberry.github.io/en/gbt_dotnet_crossplatform

Provides access to various guides covering fundamental aspects of software development relevant to the Flexberry platform. Topics include base technologies, system design, frontend, and backend development.

```APIDOC
Guides:
  Base Tech:
    - Base technologies: https://flexberry.github.io/en/gbt_landing-page.html
    - Create mobile app: https://flexberry.github.io/en/gma_landing-page.html
    - Create BPM app: https://flexberry.github.io/en/gbpm_landing-page.html
    - Create BigData app: https://flexberry.github.io/en/gbd_landing-page.html
    - Tasks: https://flexberry.github.io/en/gt_landing-page.html
    - Practical guides: https://flexberry.github.io/en/gpg_landing-page.html
    - UI UX Guideline: https://flexberry.github.io/en/uiuxg_landing-page.ru.html
    - OKR Guideline: https://flexberry.github.io/en/okrg_landing-page.html
  System Design:
    - System design fundamentals: https://flexberry.github.io/en/gbt_information-system-design.html
    - OOP: https://flexberry.github.io/en/gbt_ood.html
    - UML: https://flexberry.github.io/en/gbt_uml.html
    - Design Patterns: https://flexberry.github.io/en/gbt_design-patterns.html
  Frontend:
    - Frontend fundamentals: https://flexberry.github.io/en/gbt_frontend.html
    - HTML: https://flexberry.github.io/en/gbt_html.html
    - CSS: https://flexberry.github.io/en/gbt_css.html
    - JavaScript: https://flexberry.github.io/en/gbt_javascript.html
    - JQuery: https://flexberry.github.io/en/gbt_jquery.html
    - Layout: https://flexberry.github.io/en/gbt_layout.html
    - Ember.js: https://flexberry.github.io/en/gbt_emberjs.html
  Backend:
    - Backend fundamentals: https://flexberry.github.io/en/gbt_backend.html
    - Microsoft .NET Framework: https://flexberry.github.io/en/gbt_dotnet.html
    - ASP.NET: https://flexberry.github.io/en/gbt_aspnet.html
    - C#: https://flexberry.github.io/en/gbt_csharp.html
    - Mono: https://flexberry.github.io/en/gbt_mono.html
```

--------------------------------

### KeyGuid.GetHashCode Method

Source: https://flexberry.github.io/NewPlatform.Flexberry.ORM/autodoc/develop/class_i_c_s_soft_1_1_s_t_o_r_m_n_e_t_1_1_key_gen_1_1_key_guid

Gets the hash code for this instance. The hash code is directly dependent on the underlying Guid value.

```APIDOC
override int ICSSoft.STORMNET.KeyGen.KeyGuid.GetHashCode()
- Gets the hash code value.
- Returns: The hash code value, dependent on the Guid.
```

--------------------------------

### Flexberry Products Overview

Source: https://flexberry.github.io/en/gbt_dotnet_crossplatform

Lists the various products offered by Flexberry, ranging from the core platform to specialized solutions like GIS and BPM. Each product links to its dedicated landing page for more details.

```APIDOC
Products:
  - Flexberry PLATFORM: https://flexberry.github.io/en/fp_landing_page.html
  - Flexberry Designer Desktop: https://flexberry.github.io/en/fd_flexberry-designer.html
  - Flexberry Designer Online: https://flexberry.github.io/en/fdo_landing_page.html
  - Flexberry Ember: https://flexberry.github.io/en/ef3_landing_page.html
  - Flexberry ASP.NET: https://flexberry.github.io/en/fa_landing_page.html
  - Flexberry Winforms: https://flexberry.github.io/en/fw_landing_page.html
  - Flexberry Base: https://flexberry.github.io/en/fb_landing_page.html
  - Flexberry GIS: https://flexberry.github.io/en/fg_landing_page.html
  - Flexberry Service Bus: https://flexberry.github.io/en/fsb_landing_page.html
  - Flexberry Analytics: https://flexberry.github.io/en/fan_landing_page.html
  - Flexberry BPM: https://flexberry.github.io/en/fbpm_landing_page.html
  - Flexberry Portal: https://flexberry.github.io/en/fprt_landing_page.html
  - Flexberry ORM: https://flexberry.github.io/en/fo_landing_page.html
  - Flexberry Security: https://flexberry.github.io/en/fs_landing_page.html
  - Flexberry Audit: https://flexberry.github.io/en/fau_landing_page.html
```

--------------------------------

### Transferring Filter Parameters via GET Request

Source: https://flexberry.github.io/en/fa_wolv-filters

Details how to pass filter parameters to a Flexberry application using a GET request. It specifies the URL format, parameter encoding, column numbering, and provides an example for filtering a list of apartments.

```APIDOC
GET Request Filter Parameter Transfer:

- Format: `?WOLF_WebObjectListView1=<Numerology>:<Filter>`
- `<Numerology>`: Represents the column number (0-indexed, excluding button columns).
- `<Filter>`: The filter value for the specified column.
- Separator: Use '|' to merge multiple filter parameters, applying an 'AND' logic.
- Note: All columns are considered, not just those displayed on the current page.

Example:
To filter a list of apartments to show only those with 'Apartment No. 1' and 'Standard finishing' (assuming 'Apartment No.' is column 0 and 'Finishing type' is column 10):

`?WOLF_WebObjectListView1=0:1|10:Стандартная`
```

--------------------------------

### GetKeyType for DataObject

Source: https://flexberry.github.io/NewPlatform.Flexberry.ORM/autodoc/master/class_i_c_s_soft_1_1_s_t_o_r_m_n_e_t_1_1_key_gen_1_1_key_generator

Returns the data type of the key generated for a given DataObject. For example, for GUIDGenerator, it returns typeof(Guid).

```C#
static Type ICSSoft.STORMNET.KeyGen.KeyGenerator.KeyType(DataObject _dataobject)
```

--------------------------------

### Initialize Project with npm

Source: https://flexberry.github.io/en/tds_module3-tasks

Initializes a new Node.js project using npm, generating a package.json file. It requires filling in project title and description, and setting the license to MIT.

```bash
npm init
# Follow prompts to fill in project title, description, license (MIT), etc.
```

--------------------------------

### Get SQL Function

Source: https://flexberry.github.io/ru/fo_function-builder-examples

Demonstrates obtaining a SQL function representation. The first example uses LangDef.GetFunction, while the second uses FunctionBuilder.BuildSQL to achieve the same.

```C#
Function lf = LangDef.GetFunction(LangDef.funcSQL, "sql");
```

```C#
Function lf = FunctionBuilder.BuildSQL("sql");
```

--------------------------------

### Mono Debugging Setup with Docker

Source: https://flexberry.github.io/en/gbt_debugging

Steps to set up and run a Mono development environment using Docker for debugging applications in Monodevelop on Windows. Includes pulling the Docker image, configuring XServer, running the container, and launching MonoDevelop.

```shell
docker pull flexberry/monodevelop:latest
```

```shell
docker run-dti --network host -e "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/root/projects/scripts" -e "DISPLAY=XX.XX.XX.XX:0.0" -v d:/projects:/root/projects flexberry/monodevelop:latest /usr/bin/mate-terminal --disable-factory
```

```shell
monodevelop&
```

--------------------------------

### Get KeyGuid by Object

Source: https://flexberry.github.io/NewPlatform.Flexberry.ORM/autodoc/develop/class_i_c_s_soft_1_1_s_t_o_r_m_n_e_t_1_1_p_k_helper

Extracts a KeyGuid from an object, which can be a Guid, KeyGuid, DataObject, or string. Returns the object's KeyGuid, or null if conversion is not possible.

```APIDOC
ICSSoft.STORMNET.PKHelper.GetKeyByObject(object _obj_)
  - Extracts KeyGuid from an object (Guid, KeyGuid, DataObject, or string).
  - Parameters:
    - _obj_: The object to convert.
  - Returns: The KeyGuid of the object, or null if it cannot be converted.
```

--------------------------------

### Configure Apache2 Startup (SysV)

Source: https://flexberry.github.io/en/gbt_deployment_linux

Instructions for configuring the Apache2 service to start automatically on boot for systems using the SysV init system. This involves adding the service, setting runlevels, and starting the service.

```shell
# chkconfig --add httpd2
# chkconfig --level 2345 httpd2 on
# service apache2 start
```

--------------------------------

### Advanced Working with Views Example

Source: https://flexberry.github.io/ru/fo_func-to-char

Details advanced techniques and scenarios for working with views in Flexberry. This guide explores more complex configurations and optimizations for data presentation.

```APIDOC
Example Usage:
https://flexberry.github.io/ru/fo_advanced-working-with-views.html
```

--------------------------------

### Working with Views in Flexberry

Source: https://flexberry.github.io/en/fo_xml-schema-generator

Documentation on how to work with views in the Flexberry platform, including basic and advanced examples. These topics guide users on manipulating data representations.

```APIDOC
Flexberry Views Documentation:

- Basic Views Example: Demonstrates fundamental operations with views.
  URL: https://flexberry.github.io/en/fo_work-with-views-example.html

- Advanced Views Example: Covers more complex scenarios and techniques for working with views.
  URL: https://flexberry.github.io/en/fo_advanced-working-with-views.html
```

--------------------------------

### ASP.NET Site Map Configuration Examples

Source: https://flexberry.github.io/en/fa_add-page-web-desktop

Examples of the `web.sitemap` file structure for configuring navigation in a Flexberry ASP.NET desktop application. These snippets illustrate how to add menu items and define their properties.

```xml
<?xml version="1.0" encoding="utf-8"?>
<!-- FlexberryAutogenerated="True" -->
<siteMap xmlns="http://schemas.microsoft.com/AspNet/SiteMap-File-1.0">
  <siteMapNode title=Desktop description="Desktop application" url="~/Default.aspx" roles="*">
    <siteMapNode title=Administration roles="admin" xmlns="">
      <siteMapNode title=Users url="~/forms/Security/User/UserL.aspx" />
      <siteMapNode title=Roles url="~/forms/Security/Role/RoleL.aspx" />
      <siteMapNode title=Classes url="~/forms/Security/Class/ClassL.aspx" />
    </siteMapNode>
    <siteMapNode title="The accounting system of credits" roles="*" xmlns="">
      <siteMapNode title="Loan officer" description="" url="~/forms/KreditnyjInspektor/KreditnyjInspektorL.aspx" />
      <siteMapNode title="Credit" description="" url="~/forms/Kredit/KreditL.aspx" />
      <siteMapNode title="Client" description="" url="~/forms/Klient/KlientL.aspx" />
    </siteMapNode>
  </siteMapNode>
</siteMap>
```

```xml
<?xml version="1.0" encoding="utf-8"?>
<!-- FlexberryAutogenerated="False" -->
<siteMap xmlns="http://schemas.microsoft.com/AspNet/SiteMap-File-1.0">
  <siteMapNode title=Desktop description="Desktop application" url="~/Default.aspx" roles="*">
    <siteMapNode title=Administration roles="admin" xmlns="">
      <siteMapNode title=Users url="~/forms/Security/User/UserL.aspx" />
      <siteMapNode title=Roles url="~/forms/Security/Role/RoleL.aspx" />
      <siteMapNode title=Classes url="~/forms/Security/Class/ClassL.aspx" />
    </siteMapNode>
    <siteMapNode title="The accounting system of credits" roles="*" xmlns="">
      <siteMapNode title="Loan officer" description="" url="~/forms/KreditnyjInspektor/KreditnyjInspektorL.aspx" />
      <siteMapNode title="Credit" description="" url="~/forms/Kredit/KreditL.aspx" />
      <siteMapNode title="Client" description="" url="~/forms/Klient/KlientL.aspx" />
      <siteMapNode title=Google description="" url="http://www.google.com" roles="*" />
    </siteMapNode>
    <siteMapNode title=Reports roles="*">
      <siteMapNode title=Reports description="" url="~/forms/Otcheti/Otcheti.aspx" />
    </siteMapNode>
  </siteMapNode>
</siteMap>
```

--------------------------------

### Flexberry ORM DataObjectCache Usage Example

Source: https://flexberry.github.io/en/fo_context-sensitive-cache

Demonstrates how to use the DataObjectCache class in Flexberry ORM to cache and retrieve data objects. It shows starting and stopping caching contexts, adding objects, and retrieving them by .Net type and primary key. This example highlights the basic workflow for managing cached data objects.

```C#
class Class1
{
	[STAThread]
	static void Main(string[] args)
	{
        var doc = new DataObjectCache();
		doc.StartCaching(false);
		object pkey = prv_CreateDataObject();
		SimpleDataObject sdo = (SimpleDataObject) doc.GetLivingDataObject(typeof(SimpleDataObject), pkey);
		doc.StopCaching();
		Console.WriteLine(String.Format("Getted from cache dataobject name = {0}",sdo.Name));
		Console.Read();
	}
	private static object prv_CreateDataObject()
	{
        var doc = new DataObjectCache();
		SimpleDataObject sdo = new SimpleDataObject();		
		sdo.Name="The data object";
		Console.WriteLine(String.Format("Created dataobject name = {0}",sdo.Name));
		doc.AddDataObject(sdo);
		return sdo.__PrimaryKey;
	}
}
```

--------------------------------

### Activate Virtual Hosts and Restart Apache

Source: https://flexberry.github.io/ru/gbt_deployment_linux

Активирует конфигурацию виртуального хоста ('vhosts') и перезапускает службу Apache для применения изменений.

```bash
# a2ensite vhosts
# service apache2 restart
```

--------------------------------

### Install Mono/.NET Packages on Ubuntu

Source: https://flexberry.github.io/en/gbt_deployment_linux

Installs the necessary Apache module for Mono and the Mono runtime on Ubuntu systems using apt-get. This prepares the system for running Mono/.NET applications.

```shell
# apt-get update
# apt-get install apache2-mod_mono mono4-full
```

--------------------------------

### DatePicker JavaScript API Usage

Source: https://flexberry.github.io/ru/fa_date-picker

Demonstrates how to interact with the DatePicker component on the client-side using its jQuery plugin. Includes examples for getting, setting, and clearing the date value.

```javascript
$(document).ready(function () {
    $('#getValBtn').bind('click', function () {
        // получить значение
        var vl = $('#<%=ctrlДеньРождения.ClientID%>').icsDatePicker('val');
        alert(vl);
    });
    $('#setValBtn').bind('click', function () {
        // установить значение
        $('#<%=ctrlДеньРождения.ClientID%>').icsDatePicker('val', '01.01.2010');
    });
    $('#clearValBtn').bind('click', function () {
        // очистить значение
        $('#<%=ctrlДеньРождения.ClientID%>').icsDatePicker('val', '');
    });

});
```

--------------------------------

### Custom Type String Representation Delegate Example

Source: https://flexberry.github.io/en/fw_aliases-system-and-user-types

Demonstrates assigning a static delegate `TypeToString` to `EditAdvansedFilter1` to convert .Net types into custom string representations for display in Flexberry applications. The example includes a `Main` method setup and a custom handler `MyStringViewForSpecificType` that maps specific .Net types to their desired string outputs.

```csharp
static void Main()
{
  ...
  EditAdvansedFilter1.TypeToString = MyStringViewForSpecificType;
  ...
}

private static string MyStringViewForSpecificType(Type type)
{
  if (type == typeof(string))
    return "string";

  if (type == typeof(Планета))
    return "Planetamazon";
             
  return null;
}
```

--------------------------------

### Create Cordova Project

Source: https://flexberry.github.io/en/ef2_cordova

Creates a new Apache Cordova project. This command initializes a basic Cordova application structure.

```bash
cordova create hello com.example.hello HelloWorld
```

--------------------------------

### Flexberry ORM Data Object Prototyping Example

Source: https://flexberry.github.io/en/fo_prototyping-example

Demonstrates loading a Flexberry ORM data object, prototyping it using the `Prototype` method, and updating it, while measuring the time taken for each operation. This example uses C# and highlights the performance impact of loading, prototyping, and persistence.

```cs
Console.WriteLine("7. Prototyping.");
IDataService dataService = DataServiceProvider.DataService;
OrmSample ormSample = new OrmSample(dataService);
object primaryKey = ormSample.GetSomeObjectPrimaryKey(typeof(D0));

D0 aggregator = new D0();
aggregator.SetExistObjectPrimaryKey(primaryKey);

Stopwatch stopwatch = new Stopwatch();
stopwatch.Start();

dataService.LoadObject(D0.Views.D0_E, aggregator);

stopwatch.Stop();
long loadObjectTime = stopwatch.ElapsedMilliseconds;
stopwatch.Restart();

// This method makes each object in the hierarchy of new (see listing below).
aggregator.Prototype(true);

stopwatch.Stop();
long prototypingTime = stopwatch.ElapsedMilliseconds;
stopwatch.Restart();

dataService.UpdateObject(aggregator);

stopwatch.Stop();
long updateTime = stopwatch.ElapsedMilliseconds;

Console.WriteLine("Time taken for loading: {1} ms{0}prototyping: {2} ms{0}persistence: {3} ms.", Environment.NewLine, loadObjectTime, prototypingTime, updateTime);
```

--------------------------------

### Flexberry Analytics Docker Image

Source: https://flexberry.github.io/en/fan_pentaho-installation

Information about the Docker image for Flexberry Analytics, which includes the Pentaho server. This image is available on Docker Hub.

```APIDOC
Docker Image:
  Name: flexberry/pentaho
  Description: Provides the Pentaho server for Flexberry Analytics.
  Availability: https://hub.docker.com/r/flexberry/pentaho/

Prerequisites:
  - Docker must be installed on the host machine.
  - For Windows users, Docker for Windows is recommended.

Installation Requirement:
  - To run the Pentaho image, Docker must be installed.
```

--------------------------------

### Run Docker Container

Source: https://flexberry.github.io/en/gbt_deployment_docker

Starts a new container from a Docker image. This example shows running an Apache2 container in detached mode, mapping host and container ports, and assigning a name.

```shell
# docker run -d -p 80:80 --name=apache2 kafnevod/altlinux.p8-apache2

```

--------------------------------

### Build and Launch Application (Winforms)

Source: https://flexberry.github.io/en/fd_using-quick-prototyping

Instructions for building and launching a Windows application generated by Flexberry. This involves selecting a specific menu item, after which Flexberry generates and compiles the system, then prompts for launch.

```text
Windows application: select the menu item “Winforms/C#/Generate and kapeliovich”. Flexberry will generate a - compile system and then prompts you to launch the app:

Click “OK”, the application will start:
```

--------------------------------

### Unity Configuration for Limit Editor View Generator

Source: https://flexberry.github.io/ru/fa_details-limit-editor

Example Unity configuration to register the LimitEditorViewGenerator for dynamic view generation in the advanced restrictions editor. This setup is relevant for versions after 14.01.2015.

```xml
<unity xmlns="http://schemas.microsoft.com/practices/2010/unity">
  <container>
    <register type="ICSSoft.STORMNET.Windows.Forms.IViewGenerator, ExternalLangDef" mapTo="NewPlatform.Flexberry.Web.Page.LimitEditorViewGenerator, NewPlatform.Flexberry.Web.LimitEditor" />
  </container>
</unity>
```

--------------------------------

### YAML Sidebar Configuration Example

Source: https://flexberry.github.io/ru/fp_documentation-writing-guidelines

Defines navigation links for a product's sidebar. Each entry includes a title (for different languages), a URL, and output formats.

```yaml
# ...
    - title: Documentation writing guidelines
      title_ru: Рекомендации по написанию документации
      url: /fp_documentation-writing-guidelines.html
      output: web, pdf
# ...
```

--------------------------------

### Клиент Class Documentation

Source: https://flexberry.github.io/NewPlatform.Flexberry.ORM/autodoc/master/namespace_new_platform_1_1_flexberry_1_1_o_r_m_1_1_tests

Provides detailed API documentation for the Клиент class. This entry links to the specific documentation page for the class, which would typically include its methods, properties, and usage examples.

```APIDOC
Class: Клиент
Description: Detailed API documentation for the Клиент class.
Link: https://flexberry.github.io/NewPlatform.Flexberry.ORM/autodoc/master/class_new_platform_1_1_flexberry_1_1_o_r_m_1_1_tests_1_1_xD0_x9A_xD0_xBB_xD0_xB8_xD0_xB5_xD0_xBD_xD1_x82.html
```

--------------------------------

### KeyGuid Convert to String

Source: https://flexberry.github.io/en/fo_key-guid

Demonstrates how to convert a KeyGuid object to its string representation. The examples show obtaining the GUID value with and without curly braces using the ToString method with specific format specifiers.

```C#
string stringKeyGuid = keyGuid.Guid.ToString("D");
//5ed31914-6827-485d-b34d-df1f65a08f47 

string stringKeyGuid3 = keyGuid.Guid.ToString("B");
//{5ed31914-6827-485d-b34d-df1f65a08f47} 
```

--------------------------------

### C# Hello World Example

Source: https://flexberry.github.io/ru/gbt_csharp

A basic 'Hello World!' program written in C#. This snippet demonstrates the fundamental structure of a C# console application, including the `Main` method and `Console.WriteLine` for output. It also includes code to keep the console window open.

```csharp
// A Hello World! program in C#.
namespace HelloWorld
{
    class Hello 
    {
        static void Main() 
        {
            Console.WriteLine("Hello World!");

            // Keep the console window open in debug mode.
            Console.WriteLine("Press any key to exit.");
            Console.ReadKey();
        }
    }
}
```

--------------------------------

### Optimize Flexberry Generation Speed with Archive

Source: https://flexberry.github.io/en/ef2_generator

Provides steps to create an archive of the node_modules folder to speed up subsequent generation processes. This involves initial setup, installing dependencies, and archiving the node_modules directory.

```shell
ember initember install ember-flexberry
npm install
bower install
npm uninstall ember-flexberry
7z a -r node_modules.7z node_modules
```

--------------------------------

### Build Application (Web)

Source: https://flexberry.github.io/en/fd_using-quick-prototyping

Guidance on building a web application within the Flexberry framework. It refers to a specific article for details on the ASP.NET generation plugin.

```text
Web application: article [generation Plugin Flexberry ASP.NET](https://flexberry.github.io/en/fa_asp-net-generator.html)
```

--------------------------------

### Unity Configuration for Config Resolver

Source: https://flexberry.github.io/en/fs_legacy-security-install

Registers the IConfigResolver interface within the Unity DI container, mapping it to the ConfigResolver implementation. This is a standard setup for configuration resolution in the application.

```xml
<register type="ICSSoft.STORMNET.Business.IConfigResolver, ICSSoft.STORMNET.Business" mapTo="ICSSoft.STORMNET.Business.ConfigResolver, ICSSoft.STORMNET.Business">
            <lifetime type="singleton" />
            <constructor />
         </register>
```

--------------------------------

### AGE JavaScript Example: Get Row Count

Source: https://flexberry.github.io/en/fa_ajax-group-edit

Illustrates how to retrieve and display the number of rows currently present in the AJAX Group Edit component using the `getDataRows` method. It iterates through the returned rows to display their content.

```javascript
<script type="text/javascript">
    function getRows() {
        var data = $('#<%=ctrlПодзадача.ClientID%>').ajaxgroupedit('getDataRows');
        if (data.length != 0) {
            var result = '';
            $.each(data, function(index, value) {
                result += value.innerHTML;
            });
            alert('Записей в списке: ' + data.length + '\n' + result);
        } else {
            alert('В списке нет записей.');
        }
    };
</script>

```

--------------------------------

### Клиент Class Documentation

Source: https://flexberry.github.io/NewPlatform.Flexberry.ORM/autodoc/master/class_new_platform_1_1_flexberry_1_1_o_r_m_1_1_tests_1_1_xD0_x98_xD1_x81_xD1_x82_xD0_xBE_xD1_x872830694dbccfa3bcde4eee364346b940

Link to the API documentation for the Клиент class in Flexberry ORM.

```APIDOC
Class: Клиент
URL: https://flexberry.github.io/NewPlatform.Flexberry.ORM/autodoc/master/class_new_platform_1_1_flexberry_1_1_o_r_m_1_1_tests_1_1_xD0_x9A_xD0_xBB_xD0_xB8_xD0_xB5_xD0_xBD_xD1_x82.html
```

--------------------------------

### Клиент Class Documentation

Source: https://flexberry.github.io/NewPlatform.Flexberry.ORM/autodoc/master/class_new_platform_1_1_flexberry_1_1_o_r_m_1_1_tests_1_1_xD0_x98_xD1_x81_xD1_x82_xD0_xBE_xD1_x876e813ffa83acf53c09545c40e58f6b7b

Link to the API documentation for the Клиент class in Flexberry ORM.

```APIDOC
Class: Клиент
URL: https://flexberry.github.io/NewPlatform.Flexberry.ORM/autodoc/master/class_new_platform_1_1_flexberry_1_1_o_r_m_1_1_tests_1_1_xD0_x9A_xD0_xBB_xD0_xB8_xD0_xB5_xD0_xBD_xD1_x82.html
```

--------------------------------

### Flexberry ORM: Get Primary Key Storage Name

Source: https://flexberry.github.io/NewPlatform.Flexberry.ORM/autodoc/master/class_i_c_s_soft_1_1_s_t_o_r_m_n_e_t_1_1_information

Retrieves the storage name for the primary key of a data object's type. This name is defined by the [PrimaryKeyStorageAttribute] and specifies how the primary key is stored, for example, in a relational database.

```APIDOC
static string ICSSoft.STORMNET.Information.GetPrimaryKeyStorageName(System.Type _type)
  - Получить имя хранения первичного ключа, установленное атрибутом [PrimaryKeyStorageAttribute].
  - Аргументы:
    - type: .Net-тип класса объекта данных
  - Возвращает: имя хранения первичного ключа
```

--------------------------------

### Flexberry UI/UX Group Edit Guide

Source: https://flexberry.github.io/en/uiuxg_group_edit

Details on editing groups of elements within a list, including button-group actions and examples across different devices. This section focuses on the visual presentation and interaction design for group editing features.

```APIDOC
Edit group
  Description: Edit groups of elements in the list.

  Section: Button-group actions
    Description: The 'add' button can be accented or plain. A group of actions to better focus the separator.
    Example:
      !Button [add](https://flexberry.github.io/images/pages/guides/ui-ux-guideline/uiuxg_group_edit/1.png)

  Section: The example in list
    Description: Demonstrates group editing examples in a list view.

    Subsection: Desktop
      Description: Layout and interaction for group editing on desktop devices.

    Subsection: Tablet
      Description: Layout and interaction for group editing on tablet devices.

    Subsection: Mobile
      Description: Layout and interaction for group editing on mobile devices.
```

--------------------------------

### Install Apache2 on ALT Linux

Source: https://flexberry.github.io/ru/gbt_deployment_linux

Устанавливает веб-сервер apache2 и его зависимости с помощью пакетного менеджера apt-get. Запрашивает подтверждение установки зависимых пакетов.

```bash
# apt-get update
# apt-get install apache2
```

--------------------------------

### Global.asax Application Start (C#)

Source: https://flexberry.github.io/en/fo_orm-odata-service

Initializes the Unity container and configures the ODataService during the application startup. This code ensures that the OData service is properly set up and ready to handle requests.

```C#
namespace ODataServiceTemplate
{
    using System;
    using System.Web;
    using System.Web.Http;

    using Microsoft.Practices.Unity;
    using Microsoft.Practices.Unity.Configuration;

    public class Global : HttpApplication
    {
        protected void Application_Start(object sender, EventArgs e)
        {
            IUnityContainer container = new UnityContainer();
            container.LoadConfiguration();

            GlobalConfiguration.Configure(configuration => ODataConfig.Configure(configuration, container, GlobalConfiguration.DefaultServer));
        }
    }
}
```

--------------------------------

### Flexberry Ember 2.x: Ember CLI via Docker

Source: https://flexberry.github.io/en/efd2_offline

Details on how to use Ember-CLI with a Docker image for Flexberry Ember 2.x projects. This guide likely covers setup, configuration, and usage within a containerized environment.

```APIDOC
Flexberry Ember 2.x:
  Ember-CLI via Docker Image
    - Description: Guide on utilizing Docker for Ember-CLI development within Flexberry Ember 2.x projects.
    - Purpose: Streamline development environment setup and ensure consistency.
    - Topics Covered: Docker image setup, running Ember CLI commands within Docker, environment configuration.
```

--------------------------------

### Working with Views Example

Source: https://flexberry.github.io/en/fo_copying-data-objects

Provides an example of how to work with views in the Flexberry platform. Details on basic view operations and usage patterns.

```APIDOC
Documentation Link:
https://flexberry.github.io/en/fo_work-with-views-example.html
```

--------------------------------

### Flexberry Object List View - Second Multi User List Configuration

Source: https://flexberry.github.io/ru/efd3_editform

Shows an alternative configuration for a multi-user list using flexberry-objectlistview. This example highlights similar list management features as the first user list, emphasizing flexibility in component setup.

```Handlebars
{{#with multiListSettings.MultiUserList2OnEdit as |settings|}}
  {{flexberry-objectlistview
    modelName=settings.modelName
    modelProjection=settings.modelProjection
    editFormRoute=settings.editFormRoute
    content=settings.model
    createNewButton=true
    refreshButton=true
    sorting=settings.computedSorting
    orderable=true
    sortByColumn=(action "sortByColumn")
    addColumnToSorting=(action "addColumnToSorting")
    beforeDeleteAllRecords=(action "beforeDeleteAllRecords")
    pages=settings.pages
    perPageValue=settings.perPageValue
    perPageValues=settings.perPageValues
    recordsTotalCount=settings.recordsTotalCount
    hasPreviousPage=settings.hasPreviousPage
    hasNextPage=settings.hasNextPage
    previousPage=(action "previousPage")
    gotoPage=(action "gotoPage")
    nextPage=(action "nextPage")
    componentName=settings.componentName
  }}
{{/with}}
```

--------------------------------

### Project Structure Overview

Source: https://flexberry.github.io/ru/tds_module3-tasks

Illustrates the typical directory and file structure for the Flexberry SPA project, highlighting the purpose of each component.

```text
Project Root:
  models/          - Data model classes
  styles/          - LESS stylesheets for the application
  templates/       - Route templates using Handlebars
  utils/           - Utility functions and helper classes
  views/           - View classes
  store.js         - Local storage/cache for server models
  app-container.js - Global application component container (factory manager)
  router.js        - Application routing module
  app.js           - Application entry point (Composition Root)
  index.html       - Main HTML page, includes layout and script/style links
  dist/assets/     - Compiled assets (JS, CSS) including dynamically imported modules
```

--------------------------------

### Get visible rows using getDataRows in AjaxGroupEdit

Source: https://flexberry.github.io/en/fa_age-events

Illustrates retrieving visible data rows from an AjaxGroupEdit component using the `getDataRows` method. This method returns an array of elements representing the rows currently displayed. The example shows how to iterate through these rows and display their content.

```asp.net
<asp:Content ID="Content2" ContentPlaceHolderID="TestContentPlaceHolder" runat="server">
    ... 
    <div style="clear: left">
	<ac:AjaxGroupEdit ID="ctrlПодзадача" runat="server" ReadOnly="false" />
    </div>
        <button id="getDataRows" onclick="getRows(); return false;">getDataRows</button>
    ...
</asp:Content>

<asp:Content ContentPlaceHolderID="TestScriptsPlaceHolder" runat="server" >
    <script type="text/javascript">
        function getRows() {
            var data = $('#<%=ctrlПодзадача.ClientID%>').ajaxgroupedit('getDataRows');
            if (data.length != 0) {
                var result = '';
                $.each(data, function(index, value) {
                    result += value.innerHTML;
                });
                alert('Записей в списке: ' + data.length + '\n' + result);
            } else {
                alert('В списке нет записей.');
            }
        };
    </script>
</asp:Content>
```
Tokens:
Raw