Подсказка по интерфейсам хранимых процедур компонентов

Таблица

Документация по таблицам

GetItems

SELECT 1 - данные в таблицу, color, rowLink, rowHeight, префиксы доп.столбцов: con, prev, prevcolor, color, backcolor, desc, hint, marker, prefix, suffix, barPercent, barClass, badge, sub, modal, wight, align, fontsize, dropdown, colTitle, hiddenDevice, showHover, editable

SELECT 2 - число строк

SELECT 3 - Title, TitleTooltip, Subtitle, ToolbarAdditional, GroupOperationsToolbar,EmptyText, FastCreateLinkText, FastCreateDialogHeader, FastCreateDialogPlaceholder, FastCreateDialogDefaultValue, FastCreateSelectCol, FastCreateSearch, FastCreateTextarea, HideTitleCount, FontSize, ButtonSize, FilterMakeup, InstantFilter, Compact, Ultracompact, ZoomCells, EnableExcelExport, EnablePrint, EnableClipboard, EditableMode, DisableFrozenHeader, FrozenLeftCol, DisableCellTitle, ViewType, GanttScale, GanttNavigate, GanttItemForm, GanttItemFormTitle, KanbanItemForm, KanbanItemFormTitle, MapShowUserLocation, MapUserImageUrl, MapShowAllRegions, MapShowLocationInRange, CardGroupType,ChartType, ChartTitle, ChartWidth, ChartHeight, ChartLineCommaLabels, ChartOptions, Collapse, HeaderTag, DisableSaveState, Theme, ShowChecksCol, ShowNumsCol, RemoveConfirmText, HideHeader, RowMakeup, LayoutMakeup, FastCreate, Remove, Comments, Sortable, ManageCols, ProccessOptions, Hide, tableHeaderOptions

SELECT 4 - Вывод столбцов подвала таблицы и дополнительных строк в шапке

SELECT 5 - Настройки предустановленных фильтров

SELECT 6 - вызов внешних действий

UpdateItemField

SELECT 1 - Msg, Result, Icon, RefreshContainer

SELECT 2 - вызов внешних действий

SELECT 3 - задает другие поля для обновления. Key - код поля, Value - новое значение для него. Для изменения полей в подвале таблицы напротив соответствующего
столбца в качестве Key указывается footer-{code}

DeleteItem

SELECT 1 - Msg, Result, Icon, RefreshContainer
SELECT 2 - вызов внешних действий

FastCreate

SELECT 1 - Msg, Result, Icon, RefreshContainer, RedirectUrl
SELECT 2 - вызов внешних действий

crud_{tableCode}_{colCode}_dict

SELECT 1 - Value, Text, Color

Форма

Документация по формам

GetItem

SELECT 1 - данные формы (колонки), метаданные: type_, class_, edt_, disabled_, example_, disableXSS_, options_
SELECT 2 - Title, TitleTooltip, Subtitle, EnablePrint, BackGround, ButtonText, EditableSuccessMessage, ChangeTriggerFieldOnLoad, DisabledFocusOnLoad, DisableAntiXSS, LineLabel, HeaderTag, DisableSaveStateCheking, CopyClipboard, DisableCheckField, Hide, NoForm
SELECT 3 - дополнительные табличные данные (произвольные колонки) для вывода через jsRender разметку
SELECT 4 - вызов внешних действий

CheckItem

SELECT 1 - Msg, Result

SaveItem

SELECT 1 - Msg, Result, ItemID, SuccessUrl, HideFormAfterSubmit, RefreshContainer, EnableSaveAlert, Icon, AlertDelay, Type, Confirm
SELECT 2 - вызов внешних действий

SaveField

SELECT 1 - Msg, Result, Icon, Type, HideContainer, ShowContainer, RefreshContainer, ReplaceContainer, ReplaceContainerHtml
SELECT 2 - вызов внешних действий

CheckItemField

SELECT 1 - Msg, Result, HideContainer, ShowContainer, RefreshContainer, ReplaceContainer, ReplaceContainerHtml
SELECT 2 - вызов внешних действий

Progress

SELECT 1 - Result, Msg
SELECT 2 - Text, Value (от 0 до 100), Title

fm_{formCode}_{colCode}_dict

SELECT 1 - Value, Text, Selected, Disabled, OptGroup, Color

Страницы

Документация по работе со страницами

pg_crumbs_{code}

SELECT 1 - Title, Link, Tooltip, Right, CustomLink, DropdownMakeup
SELECT 2 - Title, Description, KeyWords, TitleTooltip, RedirectUrl, ExclusiveAccess, BodyBottomSection, HeadSection, IntroRunBtnText, IntroInstantRun, EnableIntroOnMobile
SELECT 3 - Дополнительные параметры отдельным запросом, которые можно вывести на странице через {sp-par1}, где par1 - название параметра в SQL. Также здесь передается разметка для списковых данных (list1Makeup, list2Makeup… list5Makeup)
SELECT 4-8 - списковые данные в формате p1... p6, они используются в разметке listXMakeup
SELECT 9 - Selector, Event, Description, Shape, ScrollAnimationSpeed, Radius, Margin, NextText, SkipText
SELECT 10 - Selector, Event, Text, Type, ShowType

Каталоги List

Документация по List

list_{code}_search

SELECT 1 - ID, Name, ShortDesc, Price, SupplierCount, Url, Img
SELECT 2 - EmptyText, OneToOneProduct, Title, Text, BannerImage, BannerText, Sort, Page, PageSize, total, MetaTitle, MetaDescription, MetaKeywords, HeadSection, BodyBottomSection, CustomMakeup, ListItemMakeup, ListPanelItemMakeup, AttrTemplateMakeup, DefaultView, FilterStateEnabled, RightDreadcrumb, RightBreadcrumbDrowndropMakeup, RedirectUrl, RedirectStatusCode, itemsClass, itemClass
SELECT 3 - ProductId, AttrID, AttrCode, Title, Value, TypeCode, DataType, Category, CategoryOrd, SqlGetValues, CacheMinutes
SELECT 4 - Key, Value
SELECT 5 - FilterCode, Value, Count

list_{code}_getItem

SELECT 1 - Result, Msg, EmptyText, Title, Text, Sort, Page, PageSize, Total, SeoTitle, SeoDescription, SeoKeywords, HeadSection, BodyBottomSection, BreadcrumbRootTitle, PreBreadcrumbs, RightBreadcrumb, RightBreadcrumbDropdownMakeup, RedirectUrl, RedirectStatusCode, LandMakeup
SELECT 2 - фильтры (ID, Code, Title, Tooltip, TypeCode, DefValue, ShowCount, CommaValues, CommaSelected)
SELECT 3 - Дерево категорий, показывающих текущее положение в каталоге (ID, Code, Name, Level, URL, ParentID, Count)
SELECT 4 - Вложенные категории (ID, Code, Name, Level, URL, ParentID, Count)
SELECT 5 - Элементы каталога (ID, Name, Desc, Price, Url, ImgUrl)
SELECT 6 - Параметры элементов каталога (ID, Code, Name, Value, ItemID)
SELECT 7 - Дополнительные атрибуты для вывода на странице поиска (ID, Code, Name, Value)
SELECT 8 - Варианты сортировок (Key, Value)
SELECT 9 Начальное меню категорий (может выводиться наверху перед поиском, например, в самом корне каталога) ID, Name, Code, URL, Image, IconClass, ParentID, Count

Дашборд

Документация по дашбордам

GetCounters

SELECT 1 - Title, Tooltip, Icon, Number, AdditionalNumber, DownTitle, DownLink, AnimateDuration, Color, MakeUp
SELECT 2 - возвращает названия панелей (если их надо сделать динамическими)
SELECT 3 - title, subtitle, filterType, makeup
SELECT 4 -возвращает значения фильтра (text,value). Фильтр выводится справа вверху

GetPanelTable

SELECT 1 - На выходе любая таблица с полями (выведется как таблица на панели)

GetPanelChart (bar и похожие типы)

SELECT 1 - type, title, wight, height
SELECT 2 - title, value, color

GetPanelChart (для line)

SELECT 1 - type, title, wight, height, commaLabels
SELECT 2 - title, value, color

Progress

SELECT 1 - Title, Value

API

Документация по API

api_{entityCode}_{code} (входящий API)

SELECT 1 - результат операции (Result), код результата (errorCode), и onlyData - если 1, то для JSON и XML вывода данные будут формироваться чисто из данных из SELECT 2
SELECT 2 - произвольные данные, которые передаются вовне.
SELECT 3 - Вызов внешних действий (уведомление на почту, телеграм и др.)

request - подготовка запроса исходящего API

SELECT 1 - Msg, Result, URL, ContentType
SELECT 2 - параметры которые будут передаваться вовне - name, value, type

response - обработка ответа при исходящем API

SELECT 1 - Msg, Result и Response (может быть дополнительная обработка и выдача ответа вовне).
SELECT 2 - Вызов внешних действий (Внешние запросы API и т.д.)

Ресурсы

Документация по ресурсам

rs_{entityCode}_{action}_callback

SELECT 1 - Result, Msg

rs_{entityCode}_hasAccess

SELECT 1 - Result, Msg

Импорт-экспорт через Excel

Документация по импорту-экспорту через Excel файлы

settings

SELECT 1 - Msg, Result, ExcelListName, ExportFileName, ImportDirectory, HeaderColName, DisableImport, LogImport, HideImportSummary, HideImportDetails, Roles
SELECT 2 - name, title, value, wight, ord

export

SELECT 1 - Msg, Result, ExcelListName, ExportFileName, ImportDirectory, HeaderColName, DisableImport, LogImport, HideImportSummary, HideImportDetails, Roles
SELECT 2 - name, title, value, wight, ord

import

SELECT 1 - Msg, Result
SELECT 2 - внешние действия

afterImport

SELECT 1 - Msg, Result

Выгрузка документов

Документация по выгрузкам документов в Word и Excel

getData

SELECT 1 - TableWight, TableFontSize, ColWights, TableHeaderBackColor, FileName, ShowTableHeader
SELECT 2 - name, title, value, wight, ord

Комментарии

Документация по комментариям

getOptions

SELECT 1 - commentType, enableCheck, enableFiles
SELECT 2 - возвращает теги, привязанные к типу комментариев

hasRight

SELECT 1 - Msg, Result

afterAdd

SELECT 1 - Msg, Result
SELECT 2 - вызов внешних действий

Чат
AfterSendMessage
SELECT 1 - LinkUrl, LinkTitle, DisablePush
SELECT 2 - вызов внешних действий

Дерево

Документация по компоненту Дерево

GetItems

SELECT 1 - Result, Msg, CanRename, CanAdd, canDelete, PlusIcon, MinusIcon, ShowIcon, ShowTags, ParentIDRootValue, EmptyIcon, NodeIcon
SELECT 2 - id, title, parentID, ord, icon, type, value, expanded, selected, selectedIcon, color, backColor, selectable, info

Rename

SELECT 1: Result, Msg

Delete

SELECT 1: Result, Msg

Create

SELECT 1 - Msg, Result, newID

Каталог

Документация по каталогу

cat_search

SELECT 1 - ID, Name, ShortDesc, Price, SupplierCount, Url, Img
SELECT 2 - EmptyText, OneToOneProduct, Title, Text, BannerImage, BannerText, Sort, Page, PageSize, total, MetaTitle, MetaDescription, MetaKeywords, HeadSection, BodyBottomSection, CustomMakeup, ListItemMakeup, ListPanelItemMakeup, AttrTemplateMakeup, DefaultView, FilterStateEnabled, RightDreadcrumb, RightBreadcrumbDrowndropMakeup, RedirectUrl, RedirectStatusCode, itemsClass, itemClass
SELECT 3 - ProductId, AttrID, AttrCode, Title, Value, TypeCode, DataType, Category, CategoryOrd, SqlGetValues, CacheMinutes
SELECT 4 - Key, Value
SELECT 5 - FilterCode, Value, Count

cat_search_getSeoParameters

нет выходных select

cat_getItem

SELECT 1 - OneToOneProduct, AttrTemplateMakeup, ID, Name, ShortDesc, Price, Rating, ValutaSigh, CustomMakeup, MetaTitle, MetaDescription, MetaKeywords, HeadSection, BodyBottomSection, PreBreadcrumbs, RightDreadcrumb, RightBreadcrumbDrowndropMakeup, RedirectUrl, RedirectStatusCode
SELECT 2 - ID, Code, Name, Level, Url, Icon
SELECT 3 - AttrID, Title, Value, TypeCode, DataType, Category, CategoryOrd
SELECT 4 - SupplierProductID, Price, SupplierName, SupplierLink

cat_getItem_getSeoParameters

нет выходных select

cat_new_panel

SELECT 1 - Title, Link, BottomHtml, CacheMinutes, ItemMakeup, Msg, Result
SELECT 2 - Name, Link, Img, Price, Desc

Глобальный поиск на сайте

Документация по поиску

falcon_search

SELECT 1 - элементы поиска. Обязательные столбцы: id, type, text, desc. Необязательные: date, p1, p2, p3, p4, p5 (могут быть использованы при кастомной разметке)
SELECT 2 - Result, Msg, Makeup

Настройки системы

Про настройку системы

GetLayoutInfo

SELECT 1 - topNavbarText, topPageText, brabd, logoIcon, leftFooterText, footer, mobileFooter, customHeader, userProfileLink, enableLang, defaultLang, enableAnimation, enableGeoLocation, geolocationKey, saveGeoposition, leftSidebar, hideLeftCol, favicon, BalanceSum, BalanceLink, BalanceText, BalanceIcon, theme, horisontalMenuOnTop, TopSubMenuText, TopSubMenuTitle, breadcrumbOnTop, showSearch, helpChatKey, dateFormat, phoneFormat, fixWigth, disableCart, cartCode, bodyClass, schemaTypeBody, userPic, userPicLabel, alertIcon, TopMakeup и TopMakeupMobile, linkPrefix, customMetaTags
SELECT 2 - id, name, Title, Url, CssClass, isActive, parentID
SELECT 3 - type, Title, Code, ItemId, Icon, btnText, bigModal, slideOut, floatPanel (type = form)
SELECT 3 - type, Code, ItemId (type = formcont)
SELECT 3 - type, Title, Code, Icon, bigModal, slideOut (type = table)
SELECT 3 - type, code (link)
SELECT 3 - type, code, ItemID, btnText (sp)
SELECT 4 - class, Title, Icon, Url, Ord
SELECT 5 - Url, Icon, Value, Type, Title
SELECT 6 - вызов внешних действий

Периодические события

Про периодические события на сайте

falcon_nt_sync_start

SELECT 1 - Msg, Result
SELECT 2 - 10 - вызовы внешних действий (почта, смс, уведомление и т.д.). См. вызов внешних действий. Эти SELECT могут вызываться где-то внутри периодических процедур (min, hour и т.д.). И важно - эти процедуры не должны возвращать в общий поток вывода ничего кроме подобных запросов!

Телеграм бот

Документация по телеграм боту

telegram_bot_action

SELECT 1 - Msg, Result
SELECT 2 - набор команд для telegram (актуально если SELECT1.Result=1). Type, Text, ChatID, replyMessageID, DisableNotification, Channel, ButtonsJSON, parseMode
SELECT 3 - внешние действия, которые могут быть вызваны по команде от телеграм бота.

Список актуален на 28.09.2022. Для уточнения информации смотрите описание соответствующего компонента. 

Falcon Space - функциональная веб-платформа разработки на узком стеке MS SQL/Bootstrap. Вводная по Falcon Space
Насколько полезной была статья?

Google поиск по нашей документации

Выгода от использования Falcon Space

В 2-3 раза экономнее и быстрее, чем заказная разработка
Более гибкая, чем коробочные решения и облачные сервисы
Используйте готовые решения и изменяйте под свои потребности
Нужна бесплатная консультация?
Получить оценку проекта
Создайте концепцию проекта на основе нашего шаблона и получите оценку проекта в виде КП.
Демо-сайт решений
Базисные решения, которые можно гибко адаптировать под себя: менять внешний вид, бизнес-логику и даже структуру базы данных.
Сайт использует Cookie. Правила конфиденциальности OK