Страница записи

PDF
Основы

Страница записи — элемент интерфейса, который хранит информацию о бизнес-объектах приложения в виде полей, вкладок, деталей и дашбордов. Имя страницы записи соответствует имени объекта системы (например, страница контрагента, страница контакта и т. д.). Назначение страницы записи — работа с записями реестра раздела. Каждый раздел приложения содержит одну или несколько страниц записей.

Каждая страница записи представлена схемой клиентского модуля. Например, страница контакта сконфигурирована в схеме ContactPageV2 пакета UIv2. Функциональность базовой страницы записи реализована в схеме BasePageV2 пакета NUI. Все схемы страниц записи должны наследовать схему BasePageV2.

Виды страницы записи:

  • Страница добавления записи — используется для создания записи реестра раздела.
  • Страница редактирования записи — используется для редактирования существующей записи реестра раздела.

Контейнеры страницы записи 

Элементы пользовательского интерфейса приложения, которые относятся к странице записи, размещены в соответствующих контейнерах. Контейнеры конфигурируются в базовой схеме страницы записи или схеме замещающей страницы записи. Не зависят от вида страницы записи.

На заметку. В приложении используются мета-имена html-контейнеров. На основании мета-имен приложение формирует фактические идентификаторы соответствующих html-элементов страницы записи.

Основные контейнеры страницы записи представлены на рисунке ниже.

  • Контейнер кнопок действий (ActionButtonsContainer) — содержит кнопки действий страницы записи.
  • Контейнер левой части страницы записи (LeftModulesContainer) — содержит основные поля ввода и редактирования данных.
  • Контейнер панели действий (ActionDashboardContainer) — содержит панель действий и полосу стадий.
  • Контейнер вкладок (TabsContainer) — содержит вкладки с полями ввода и редактирования, которые сгруппированы по признаку, например, месту работы.

Создать страницу записи 

  1. Перейдите в раздел Конфигурация (Configuration) и выберите пользовательский пакет, в который будет добавлена схема.
  2. На панели инструментов реестра раздела нажмите Добавить —> и выберите вид схемы модели представления.

    • Для создания новой страницы записи выберите Модель представления страницы (Page view model).

    • Для замещения существующей страницы записи выберите Замещающая модель представления (Replacing view model).

  3. Заполните свойства схемы.

    • Код (Code) — название схемы (обязательное свойство). Должно содержать префикс (по умолчанию Usr), указанный в системной настройке Префикс названия объекта (код SchemaNamePrefix).
    • Заголовок (Title) — локализуемый заголовок схемы (обязательное свойство).
    • Родительский объект (Parent object) — выберите схему страницы записи, функциональность которой необходимо наследовать.

      • Для создания новой страницы записи выберите "BasePageV2".
      • Для замещения существующей страницы записи выберите схему страницы записи, которую планируется заместить. Например, чтобы в приложении отображалась пользовательская страница контрагента, выберите схему AccountPageV2 пакета UIv2.
  4. Реализуйте логику страницы записи.
  5. На панели инструментов дизайнера модуля нажмите Сохранить (Save).

Настроить страницу записи 

Настройка страницы записи выполняется с помощью элементов управления.

Действия для настройки страницы записи, которые позволяет выполнять приложение:

  • Добавлять стандартные элементы управления страницы.
  • Изменять стандартные элементы управления страницы.
  • Добавлять пользовательские элементы управления страницы.

Основные элементы управления страницы:

  • Панель действий. Настройка панели действий страницы записи описана в статье Панель действий.
  • Поле. Настройка полей страницы записи описана в статье Поле.
  • Кнопка. Настройка кнопок страницы записи описана в статье Кнопка.

Добавить пользовательское действие на страницу записи 

Creatio предоставляет возможность добавления пользовательского действия в выпадающее меню Действия (Actions) страницы записи, которое реализовано в схеме BasePageV2 базовой страницы записи.

Чтобы добавить пользовательское действие на страницу записи:

  1. Создайте страницу записи или замещающую страницу записи. Для создания страницы записи выполните шаги 1-3 инструкции по созданию страницы записи.
  2. Переопределите защищенный виртуальный метод getActions(), который возвращает перечень действий страницы. Перечень действий страницы является экземпляром класса Terrasoft.BaseViewModelCollection. Каждое действие — это модель представления.
  3. В метод addItem() в качестве параметра передайте сallback-метод getButtonMenuItem(). Метод addItem() добавляет в коллекцию пользовательское действие.
  4. В callback-метод getButtonMenuItem() в качестве параметра передайте конфигурационный объект. Метод getButtonMenuItem() создает экземпляр модели представления действия.
  5. Реализуйте конфигурационный объект действия, который позволяет явно задать свойства модели представления действий или использовать базовый механизм привязки.

Важно. При замещении базовой страницы записи в методе getActions() схемы замещающей модели представления вызовите метод this.callParent(arguments), который возвращает коллекцию действий родительской страницы записи.

Шаблон добавления пользовательского действия на страницу записи приведен ниже.

Шаблон добавления пользовательского действия на страницу записи
/**
* Возвращает коллекцию действий страницы записи.
* @protected
* @virtual
* @return {Terrasoft.BaseViewModelCollection} Возвращает коллекцию действий страницы записи.
*/
getActions: function() {
	/* Список действий — экземпляр Terrasoft.BaseViewModelCollection. */
	var actionMenuItems = this.Ext.create("Terrasoft.BaseViewModelCollection");
	/* Добавление действия в коллекцию. В качестве callback-метода передается метод, который инстанцирует экземпляр модели действия по переданному конфигурационному объекту. */
	actionMenuItems.addItem(this.getButtonMenuItem({ 
		/* Конфигурационный объект настройки действия. */
		...
	}));
	/* Возвращает новую коллекцию действий. */
	return actionMenuItems;
}
Добавить действие на страницу записи
Средний

Пример реализован для продуктов линейки Sales Creatio.

Пример. На страницу заказа добавить действие Показать дату выполнения (Show execution date), которое в информационном окне отображает планируемую дату выполнения заказа. Действие активно для заказов, которые находятся на стадии Исполнение (In progress).

1. Создать схему замещающей модели представления страницы заказа 

  1. Перейдите в раздел Конфигурация (Configuration) и выберите пользовательский пакет, в который будет добавлена схема.
  2. На панели инструментов реестра раздела нажмите Добавить —> Замещающая модель представления (Add —> Replacing view model).

  3. Заполните свойства схемы.

    • Код (Code) — "OrderPageV2".
    • Заголовок (Title) — "Страница редактирования заказа" ("Order edit page").
    • Родительский объект (Parent object) — выберите "OrderPageV2".
  4. Добавьте локализуемую строку с текстом пункта меню, который планируется добавить.

    1. В контекстном меню узла Локализуемые строки (Localizable strings) нажмите кнопку scr_add_button.png.
    2. Заполните свойства локализуемой строки.

      • Код (Code) — "InfoActionCaption".
      • Значение (Value) — "Показать дату выполнения" ("Show execution date").
    3. Для добавления локализуемой строки нажмите Добавить (Add).
  5. Реализуйте логику работы пункта меню.

    Для этого в свойстве methods реализуйте методы:

    • isRunning() — проверяет находится ли заказ на стадии Исполнение (In progress) и определяет доступность добавленного пункта.
    • showOrderInfo() — метод-обработчик действия. В информационном окне отображает планируемую дату завершения заказа. Действие страницы записи применяется к конкретному объекту, который открыт на странице. Для доступа к значениям полей объекта страницы записи в методе-обработчике действия необходимо использовать методы модели представления get() (получить значение) и set() (установить значение).
    • getActions() — переопределенный базовый метод. Возвращает коллекцию действий замещающей страницы.

    Исходный код схемы замещающей модели представления страницы заказа представлен ниже.

    OrderPageV2
    define("OrderPageV2", ["OrderConfigurationConstants"], function(OrderConfigurationConstants) {
        return {
            /* Название схемы объекта страницы записи. */
            entitySchemaName: "Order",
            /* Методы модели представления страницы записи. */
            methods: {
                /* Проверяет стадию заказа для определения доступности пункта меню. */
                isRunning: function() {
                    /* Метод возвращает true, если статус заказа [Исполнение], иначе возвращает false. */
                    if (this.get("Status")) {
                        return this.get("Status").value === OrderConfigurationConstants.Order.OrderStatus.Running;
                    }
                    return false;
                },
                /* Метод-обработчик действия. В информационном окне отображает дату выполнения заказа. */
                showOrderInfo: function() {
                    /* Получает дату выполнения заказа. */
                    var dueDate = this.get("DueDate");
                    /* Отображает информационное окно. */
                    this.showInformationDialog(dueDate);
                },
                /* Переопределяет базовый виртуальный метод, который возвращает коллекцию действий страницы записи. */
                getActions: function() {
                    /* Вызывается родительская реализация метода для получения коллекции проинициализированных действий базовой страницы. */
                    var actionMenuItems = this.callParent(arguments);
                    /* Добавляет линию-разделитель. */
                    actionMenuItems.addItem(this.getButtonMenuItem({
                        Type: "Terrasoft.MenuSeparator",
                        Caption: ""
                    }));
                    /* Добавляет пункт меню в список действий страницы записи. */
                    actionMenuItems.addItem(this.getButtonMenuItem({
                        /* Привязывает заголовок пункта меню к локализуемой строке схемы. */
                        "Caption": {bindTo: "Resources.Strings.InfoActionCaption"},
                        /* Привязывает метод-обработчик действия. */
                        "Tag": "showOrderInfo",
                        /* Привязывает свойство доступности пункта меню к значению, которое возвращает метод isRunning(). */
                        "Enabled": {bindTo: "isRunning"}
                    }));
                    return actionMenuItems;
                }
            }
        };
    });
    
  6. На панели инструментов дизайнера нажмите Сохранить (Save).

В результате на страницу заказа, который находится на стадии Исполнение (In progress), добавлено действие Показать дату выполнения (Show execution date).

В режиме вертикального представления реестра пользовательское действие страницы не отображается.

Для корректного отображения действия страницы в схему замещающей модели представления раздела необходимо добавить:

  • Локализуемую строку, которая содержит текст пункта меню.
  • Метод, который определяет доступность пункта меню.

2. Создать схему замещающей модели представления раздела 

  1. Перейдите в раздел Конфигурация (Configuration) и выберите пользовательский пакет, в который будет добавлена схема.
  2. На панели инструментов реестра раздела нажмите Добавить —> Замещающая модель представления (Add —> Replacing view model).

  3. Заполните свойства схемы.

    • Код (Code) — "OrderSectionV2".
    • Заголовок (Title) — "Раздел заказа" ("Order section").
    • Родительский объект (Parent object) — выберите "OrderSectionV2".
  4. Добавьте локализуемую строку с текстом пункта меню, который планируется добавить. Для этого выполните шаг 4 алгоритма создания схемы замещающей модели представления страницы заказа.
  5. Реализуйте логику работы пункта меню. Для этого в свойстве methods реализуйте метод isRunning(), который проверяет находится ли заказ на стадии Исполнение (In progress) и определяет доступность добавленного пункта.

    Исходный код схемы замещающей модели представления страницы раздела представлен ниже.

    OrderSectionV2
    define("OrderSectionV2", ["OrderConfigurationConstants"], function(OrderConfigurationConstants) {
        return {
            /* Название схемы страницы раздела. */
            entitySchemaName: "Order",
            /* Методы модели представления страницы раздела. */
            methods: {
                /* Проверяет стадию заказа для определения доступности пункта меню. */
                isRunning: function(activeRowId) {
                    activeRowId = this.get("ActiveRow");
                    /* Получает коллекцию данных списочного представления реестра раздела. */
                    var gridData = this.get("GridData");
                    /* Получает модель выбранного заказа по заданному значению первичной колонки. */
                    var selectedOrder = gridData.get(activeRowId);
                    /* Получает свойства модели — статуса выбранного заказа. */
                    var selectedOrderStatus = selectedOrder.get("Status");
                    /* Метод возвращает true, если статус заказа [Исполнение], иначе возвращает false. */
                    return selectedOrderStatus.value === OrderConfigurationConstants.Order.OrderStatus.Running;
                }
            }
        };
    });
    
  6. На панели инструментов дизайнера нажмите Сохранить (Save).

Результат выполнения примера 

Чтобы посмотреть результат выполнения примера:

  1. Очистите кэш браузера.
  2. Обновите страницу раздела Заказы (Orders).

В результате выполнения примера на страницу заказа добавлено действие Показать дату выполнения (Show execution date).

Если заказ находится на стадии Исполнение (In progress), то действие Показать дату выполнения (Show execution date) активно.

В результате выбора действия Показать дату выполнения (Show execution date), в информационном окне отображается планируемая дата выполнения заказа.

Если заказ не находится на стадии Исполнение (In progress), то действие Показать дату выполнения (Show execution date) неактивно.

Схема BasePageV2
Средний

BasePageV2 — базовая схема карточки. Реализована в пакете NUI. Схема является схемой модели представления. Описание свойств схемы содержится в статье Клиентская схема.

Сообщения 

Сообщения базовой карточки
Название Режим Направление Описание
UpdatePageHeaderCaption Адресное Публикация Обновляет заголовок страницы.
GridRowChanged Адресное Подписка Получает идентификатор выбранной в реестре записи при ее изменении.
UpdateCardProperty Адресное Подписка Изменяет значение параметра модели.
UpdateCardHeader Адресное Подписка Обновляет заголовок карточки.
CloseCard Адресное Публикация Закрывает карточку.
OpenCard Адресное Подписка Открывает карточку.
OpenCardInChain Адресное Публикация Открывает цепочку карточек.
GetCardState Адресное Подписка Возвращает состояние карточки.
IsCardChanged Адресное Публикация Сообщает об изменении карточки.
GetActiveViewName Адресное Публикация Получает имя активного представления.
GetMiniPageMasterEntityInfo Адресное Подписка Возвращает информацию об основной сущности мини-карточки.
GetPageTips Адресное Подписка Возвращает подсказки страницы.
GetColumnInfo Адресное Подписка Возвращает информацию колонки.
GetEntityColumnChanges Широковещательное Публикация Отправляет информацию колонки сущности при ее изменении.
ReloadSectionRow Адресное Публикация Перезагружает строку раздела в соответствии со значением основного столбца.
ValidateCard Адресное Подписка Запускает проверку валидности карточки.
ReInitializeActionsDashboard Адресное Публикация Запускает повторную инициализацию панели действий.
ReInitializeActionsDashboard Адресное Подписка Обновляет конфиг панели действий.
ReloadDashboardItems Широковещательное Публикация Перезагружает элементы дашбордов.
ReloadDashboardItemsPTP Адресное Публикация Перезагружает элементы дашбордов для текущей страницы.
CanChangeHistoryState Широковещательное Подписка Разрешает или запрещает изменение текущего состояния истории.
IsEntityChanged Адресное Подписка Возвращает измененную сущность.
IsDcmFilterColumnChanged Адресное Подписка Возвращает true, если изменены отфильтрованные колонки.
UpdateParentLookupDisplayValue Широковещательное Двунаправленное Обновляет значение родительской записи справочника по конфигу.
UpdateParentLookupDisplayValue Широковещательное Двунаправленное Указывает на необходимость перезагрузки данных при следующем запуске.

Режимы сообщений представлены перечислением Terrasoft.core.enums.MessageMode, а направления сообщений — перечислением Terrasoft.core.enums.MessageDirectionType. Перечисление MessageMode описано в Библиотеке JS классов. Перечисление MessageDirectionType описано в Библиотеке JS классов.

Атрибуты 

IsLeftModulesContainerVisible BOOLEAN

Признак видимости контейнера LeftModulesContainer.

IsActionDashboardContainerVisible BOOLEAN

Признак видимости контейнера ActionDashboardContainer.

HasActiveDcm BOOLEAN

Признак видимости контейнера DcmActionsDashboardContainer.

ActionsDashboardAttributes CUSTOM_OBJECT

Пользовательские атрибуты контейнера DcmActionsDashboardContainer.

IsPageHeaderVisible BOOLEAN

Флаг видимости заголовка страницы.

ActiveTabName TEXT

Сохранить имя активной вкладки.

GridDataViewName TEXT

Имя представления GridData.

AnalyticsDataViewName TEXT

Имя представления AnalyticsData.

IsCardOpenedAttribute STRING

Атрибут тела карточки, когда карточки отображена или скрыта.

IsMainHeaderVisibleAttribute STRING

Атрибут тела карточки, когда основной заголовок отображен или скрыт.

PageHeaderColumnNames CUSTOM_OBJECT

Массив имен колонок заголовка страницы.

IsNotAvailable BOOLEAN

Признак недоступности страницы.

CanCustomize BOOLEAN

Признак возможности кастомизации страницы.

Operation ENUM

Операции карточки.

EntityReloadScheduled BOOLEAN

Признак необходимости перезагрузки сущности при следующем запуске.

Типы данных атрибутов представлены перечислением Terrasoft.core.enums.DataValueType. Перечисление DataValueType описано в Библиотеке JS классов.

Методы 

onDiscardChangesClick(callback, scope)

Обрабатывает нажатие кнопки Отменить (Discard).

Параметры
{String} [callback] Функция обратного вызова.
{Terrasoft.BaseViewModel} [scope] Контекст выполнения метода.
addChangeDataViewOptions(viewOptions)

Добавляет представления точек переключения в выпадающий список кнопки Вид (View).

Параметры
{Terrasoft.BaseViewModelCollection} viewOptions Пункты выпадающего списка кнопки Вид (View).
addSectionDesignerViewOptions(viewOptions)

Добавляет пункт Открыть мастер раздела (Open section wizard) в выпадающий список кнопки Вид (View).

Параметры
{Terrasoft.BaseViewModelCollection} viewOptions Пункты выпадающего списка кнопки Вид (View).
getReportFilters()

Возвращает коллекцию фильтров для запроса.

initPageHeaderColumnNames()

Инициализировать имена колонок заголовка страницы.

getParameters(parameters)

Возвращает значения параметров ViewModel.

Параметры
{Array} parameters Имена параметров.
setParameters(parameters)

Задает параметры ViewModel.

Параметры
{Object} parameters Значения параметров.
getLookupModuleId()

Возвращает идентификатор модуля страницы справочника.

onReloadCard(defaultValues)

Обработчик сообщения ReloadCard. Перезагружает данные сущности карточки.

Параметры
{Object[]} defaultValues Массив значений по умолчанию.
onGetColumnInfo(columnName)

Возвращает информацию колонки.

Параметры
{String} columnName Имя колонки.
getTabsContainerVisible()

Возвращает статус видимости вкладок контейнера.

getPrintMenuItemVisible(reportId)

Возвращает статус видимости пунктов выпадающего списка (т. е. отчетов) кнопки Печать (Print).

Параметры
{String} reportId Идентификатор отчета.
getDataViews()

Получает представление раздела.

runProcess(tag)

Запустить бизнес-процесс с помощью кнопки запуска глобальных бизнес-процессов.

Параметры
{Object} tag Идентификатор схемы бизнес-процесса.
runProcessWithParameters(config)

Запустить бизнес-процесс с параметрами.

Параметры
{Object} config Конфигурационный объект.
onCanBeDestroyed(cacheKey)

Проверяет наличие несохраненных данных. Измените config.result из кэша, если данные изменены, но не сохранены.

Параметры
{String} cacheKey Ключ конфигурационного объекта в кэше.
onValidateCard()

Отображается сообщение о некорректности, если карточка невалидна.

Схема BaseEntityPage
Основы

BaseEntityPage — базовая схема страницы записи. Реализована в пакете NUI. Схема является схемой модели представления. Описание свойств схемы содержится в статье Клиентская схема. Все схемы страниц записей должны наследовать схему BaseEntityPage.

Сообщения 

Сообщения базовой страницы записи
Название Режим Направление Описание
UpdateDetail Адресное Публикация Сообщает детали изменения карточки.
CardModuleResponse Адресное Двунаправленное Сообщает об изменении страницы записи.
CardRendered Широковещательное Двунаправленное Сообщает об обработке страницы записи.
EntityInitialized Широковещательное Двунаправленное Сообщает о выполнении инициализации объекта и отправляет информацию об объекте.
ShowProcessPage Адресное Публикация Отображает страницу процесса.

Режимы сообщений представлены перечислением Terrasoft.core.enums.MessageMode, а направления сообщений — перечислением Terrasoft.core.enums.MessageDirectionType. Перечисление MessageMode описано в Библиотеке JS классов. Перечисление MessageDirectionType описано в Библиотеке JS классов.

Атрибуты 

IsEntityInitialized BOOLEAN

Используется для подготовки сущности.

DefaultValues ARRAY

Массив значений по умолчанию для объекта.

IsModelItemsEnabled BOOLEAN

Признак доступности элементов модели.

DetailsConfig CUSTOM_OBJECT

Детали конфигурации.

Типы данных атрибутов представлены перечислением Terrasoft.core.enums.DataValueType. Перечисление DataValueType описано в Библиотеке JS классов.

Миксины 

EntityResponseValidationMixin Terrasoft.EntityResponseValidationMixin

Проверяет ответ сервера. Если false, то генерирует сообщение об ошибке и запускает диалог.

Методы 

init(callback, scope)

Инициализирует страницу записи.

Параметры
{Function} callback Функция обратного вызова.
{Object} scope Контекст выполнения метода.
saveDetailsInChain(next)

Сохраняет детали в цепочку.

Параметры
{Function} next Функция обратного вызова.
getDetailId(detailName)

Возвращает идентификатор детали.

Параметры
{String} detailName Имя детали.
loadDetail(config)

Загружает деталь. Если деталь загружена, то повторно ее отображает.

Параметры
{Object} config Конфигурация детали.
saveCheckCanEditRight(callback, scope)

Проверяет наличие прав пользователя на редактирование.

Параметры
{Function} callback Функция обратного вызова.
{Object} scope Контекст выполнения метода.
getLookupDisplayValueQuery(config)

Формирует поисковый запрос для отображаемого значения.

Параметры
{Object} config Конфигурация детали.
loadLookupDisplayValue(name, value, callback, scope)

Заполняет справочные поля.

Параметры
{String} name Имя схемы объекта.
{String} value Значение объекта.
{Function} callback Функция обратного вызова.
{Object} scope Контекст выполнения метода.
canAutoCleanDependentColumns()

Возвращает true, если бизнес-правило может очищать колонку объекта.