Сегменты сервер

ДобавитьПартнераВСегмент

Описание, пример вызова

// Добавляет партнера в сегмент партнеров.
//
// Параметры:
//  Сегмент  - СправочникСсылка.СегментыПартнеров - сегмент, в который добавляется партнер.
//  Партнер  - СправочникСсылка.Партнеры - добавляемый в сегмент партнер.
//
Процедура ДобавитьПартнераВСегмент(Сегмент,Партнер) Экспорт

Пример вызова

СегментыСервер.ДобавитьПартнераВСегмент(Сегмент, Партнер)

ДобавитьНоменклатуруВСегмент

Описание, пример вызова

// Добавляет пару номенклатура\характеристика  в сегмент номенклатуры.
//
// Параметры:
//  Сегмент        - СправочникСсылка.СегментыНоменклатуры - сегмент, в который добавляется номенклатуры.
//  Номенклатура   - СправочникСсылка.Номенклатура - добавляемая в сегмент номенклатура.
//  Характеристика - СправочникСсылка.ХарактеристикиНоменклатуры - добавляемая в сегмент характеристика номенклатуры.
//
Процедура ДобавитьНоменклатуруВСегмент(Сегмент, Номенклатура, Характеристика = Неопределено) Экспорт

Пример вызова

СегментыСервер.ДобавитьНоменклатуруВСегмент(Сегмент, Номенклатура, Характеристика);

УдалитьНоменклатуруИзСегмента

Описание, пример вызова

// Удаляет пару номенклатура\характеристика из сегмента номенклатуры.
//
// Параметры:
//  Сегмент        - СправочникСсылка.СегментыНоменклатуры - сегмент, из которого удаляется номенклатуры.
//  Номенклатура   - СправочникСсылка.Номенклатура - удаляемая из сегмента номенклатура.
//  Характеристика - СправочникСсылка.ХарактеристикиНоменклатуры - удаляемая из сегмента номенклатуры.
//
Процедура УдалитьНоменклатуруИзСегмента(Сегмент, Номенклатура, Характеристика = Неопределено) Экспорт

Пример вызова

СегментыСервер.УдалитьНоменклатуруИзСегмента(Сегмент, Номенклатура, Характеристика);

УдалитьПартнераИзСегмента

Описание, пример вызова

// Удаляет партнера из сегмента партнеров.
//
// Параметры:
//  Сегмент  - СправочникСсылка.СегментыПартнеров - сегмент, из которого удаляется партнер.
//  Партнер  - СправочникСсылка.Партнеры - удаляемый из сегмента партнер.
//
Процедура УдалитьПартнераИзСегмента(Сегмент, Партнер) Экспорт

Пример вызова

СегментыСервер.УдалитьПартнераИзСегмента(Сегмент, Партнер)

ЗаписьЖурнала

Описание, пример вызова

// Создает запись в журнале регистрации и сообщениях пользователю,
//  Поддерживает до 4х параметров в комментарии при помощи функции
//    СтроковыеФункцииКлиентСервер.ПодставитьПараметрыВСтроку
//  Поддерживает передачу информации об ошибке, подробное представление
//    ошибки добавляется в комментарий записи в журнал регистрации.
//
// Параметры:
//   ПараметрыЖурнала  - Структура - Параметры записи в журнал регистрации:
//    * Префикс    - Строка           - Префикс для имени события журнала регистрации.
//    * Метаданные - ОбъектМетаданных - Метаданные для записи в журнал регистрации.
//    * Данные     - Произвольный     - Данные для записи в журнал регистрации.
//   УровеньЖурнала - Число - Соответствует уровням журнала регистрации.
//   ИмяСобытия     - Строка - Суффикс для имени события журнала регистрации.
//   КомментарийСПараметрами -Строка - Комментарий, возможно с параметрами %1 .. %4.
//   ИнформацияОбОшибке - ИнформацияОбОшибке, Строка - Информация об ошибке, которую так же необходимо
//                                                     задокументировать в комментарии журнала регистрации.
//
Процедура ЗаписьЖурнала(ПараметрыЖурнала, УровеньЖурнала , ИмяСобытия, Экспорт

Пример вызова

СегментыСервер.ЗаписьЖурнала(ПараметрыЖурнала, УровеньЖурнала, ИмяСобытия, );

ВыполнитьПлановуюОчистку

Описание, пример вызова

// Выполняет очистку не динамических сегментов по запланированным датам
//
Процедура ВыполнитьПлановуюОчистку() Экспорт

Пример вызова

СегментыСервер.ВыполнитьПлановуюОчистку()

ВыполнитьПериодическоеФормирование

Описание, пример вызова

// Запускает формирование сегмента и контролирует результат
//
// Параметры:
//   Сегмент - СправочникСсылка.СегментыПартнеров, СправочникСсылка.СегментыНоменклатуры - сегмент, который должен быть сформирован.
//
Процедура ВыполнитьПериодическоеФормирование(Сегмент) Экспорт

Пример вызова

СегментыСервер.ВыполнитьПериодическоеФормирование(Сегмент)

ПолучитьXML

Описание, пример вызова

// Выполняет сериализацию объекта в XML
//
// Параметры:
//  Значение  - Произвольный - объект, который необходимо сериализовать в XML.
//
// Возвращаемое значение:
//   Строка   - объект, сериализованный в XML.
//
Функция ПолучитьXML(Значение) Экспорт

Пример вызова

Результат = СегментыСервер.ПолучитьXML(Значение)

ПолучитьОписаниеИСхемуКомпоновкиДанныхПоИмениМакета

Описание, пример вызова

// Получает описание, СКД и настройки для сегмента
//
// Параметры:
//  Ссылка     - СправочникСсылка.СегментыНоменклатуры, СправочникСсылка.СегментыПартнеров - сегмент, чьи СКД и
//                                                                                           настройки получаются.
//  ИмяШаблона - Строка - имя шаблона сегмента.
//
// Возвращаемое значение:
//   Структура - состоит из следующих полей:
//      * Описание                  - Строка - описание сегмента
//      * СхемаКомпоновкиДанных     - СхемаКомпоновкиДанных, Неопределено - СКД шаблона.
//      * НастройкиКомпоновкиДанных - НастройкиКомпоновкиДанных, Неопределено -настройки СКД шаблона.
//
Функция ПолучитьОписаниеИСхемуКомпоновкиДанныхПоИмениМакета(Ссылка, ИмяШаблона) Экспорт

Пример вызова

Результат = СегментыСервер.ПолучитьОписаниеИСхемуКомпоновкиДанныхПоИмениМакета(Ссылка, ИмяШаблона)

СписокЭлементовСКД

Описание, пример вызова

// Возвращает таблицу значений, содержащую ссылки на элементы,
// входящие в сегмент, по настройкам СКД.
//
// Параметры:
//   СегментСсылка - СправочникСсылка.СегментыПартнеров, СправочникСсылка.СегментыНоменклатуры - сегмент, элементы
//       входящие в который получаются.
//
// Возвращаемое значение:
//   СписокЗначений - список элементов, входящих в сегмент.
//
Функция СписокЭлементовСКД(СегментСсылка) Экспорт

Пример вызова

Результат = СегментыСервер.СписокЭлементовСКД(СегментСсылка)

ПриСозданииНаСервере

Описание, пример вызова

// Вызывается из обработчиков события "При создании на сервере" форм элемента сегментов партнеров и номенклатуры.
//
// Параметры:
//  Форма   - ФормаКлиентскогоПриложения - создаваемая форма элемента сегмента партнеров или номенклатуры, содержит:
//    * Объект - СправочникОбъект.СегментыНоменклатуры - сегмент для
//  Отказ   - Булево - признак отказа от записи сегмента.
//
Процедура ПриСозданииНаСервере(Форма) Экспорт

Пример вызова

СегментыСервер.ПриСозданииНаСервере(Форма)

ПередЗаписьюНаСервере

Описание, пример вызова

Процедура ПередЗаписьюНаСервере(Форма,ТекущийОбъект) Экспорт

Пример вызова

СегментыСервер.ПередЗаписьюНаСервере(Форма, ТекущийОбъект)

СегментОбъектПередЗаписью

Описание, пример вызова

// Вызывается из обработчиков события "Перед записью" сегментов партнеров и номенклатуры.
//
// Параметры:
//  Объект  - СправочникОбъект.СегментыПартнеров, СправочникОбъект.СегментыНоменклатуры - записываемый объект.
//  Отказ   - Булево - признак отказа от записи сегмента.
//
Процедура СегментОбъектПередЗаписью(Объект, Отказ) Экспорт

Пример вызова

СегментыСервер.СегментОбъектПередЗаписью(Объект, Отказ)

СегментПередУдалением

Описание, пример вызова

// Вызывается из обработчиков события "Перед удаление" сегментов партнеров и номенклатуры.
//
// Параметры:
//  Объект  - СправочникОбъект.СегментыПартнеров, СправочникОбъект.СегментыНоменклатуры - помечаемый на удаление объект.
//  Отказ   - Булево - признак отказа от пометки на удаление сегмента.
//
Процедура СегментПередУдалением(Объект, Отказ) Экспорт

Пример вызова

СегментыСервер.СегментПередУдалением(Объект, Отказ)

СегментОбработкаЗаполнения

Описание, пример вызова

// Вызывается из обработчиков события "Обработка заполнения" сегментов партнеров и номенклатуры.
//
// Параметры:
//  Объект           - СправочникОбъект.СегментыПартнеров, СправочникОбъект.СегментыНоменклатуры - копируемый объект.
//  ДанныеЗаполнения - Произвольный - Значение, которое используется как основание для заполнения.
//
Процедура СегментОбработкаЗаполнения(Объект, ДанныеЗаполнения = Неопределено) Экспорт

Пример вызова

СегментыСервер.СегментОбработкаЗаполнения(Объект, ДанныеЗаполнения);

СегментПриКопировании

Описание, пример вызова

// Вызывается из обработчиков события "При копировании" сегментов партнеров и номенклатуры.
//
// Параметры:
//  Объект  - СправочникОбъект.СегментыПартнеров, СправочникОбъект.СегментыНоменклатуры - копируемый объект.
//
Процедура СегментПриКопировании(Объект) Экспорт

Пример вызова

СегментыСервер.СегментПриКопировании(Объект)

СегментПриЗаписи

Описание, пример вызова

// Вызывается из обработчиков события "При записи" сегментов партнеров и номенклатуры.
//
// Параметры:
//  Объект  - СправочникОбъект.СегментыПартнеров, СправочникОбъект.СегментыНоменклатуры - записываемый объект.
//  Отказ   - Булево - признак отказа от записи сегмента.
//
Процедура СегментПриЗаписи(Объект, Отказ) Экспорт

Пример вызова

СегментыСервер.СегментПриЗаписи(Объект, Отказ)

ТаблицаЗначений

Описание, пример вызова

// Возвращает таблицу значений, содержащую элементы, входящие в сегмент,
// с учетом способа формирования сегмента.
//
// Параметры:
//   СегментСсылка - СправочникСсылка.СегментыПартнеров, СправочникСсылка.СегментыНоменклатуры - сегмент, элементы
//       входящие в который получаются.
//
// Возвращаемое значение:
//   ТаблицаЗначений - таблица значений, содержащая элементы, входящие в сегмент.
//
Функция ТаблицаЗначений(СегментСсылка) Экспорт

Пример вызова

Результат = СегментыСервер.ТаблицаЗначений(СегментСсылка)

МассивЭлементов

Описание, пример вызова

// Возвращает массив элементов, входящих в сегмент,
// с учетом способа формирования сегмента.
//
// Параметры:
//   СегментСсылка - СправочникСсылка.СегментыПартнеров, СправочникСсылка.СегментыНоменклатуры - сегмент, элементы
//       входящие в который получаются.
//
// Возвращаемое значение:
//   Массив - массив элементов, входящих в сегмент.
//
Функция МассивЭлементов(СегментСсылка) Экспорт

Пример вызова

Результат = СегментыСервер.МассивЭлементов(СегментСсылка)

ЕстьПравоИзмененияСоставаСегментов

Описание, пример вызова

// Проверяет право изменения сегментов, в зависимости от типа сегмента.
//
// Параметры:
//  ТипСегмента  - Строка - указывает на то, какого типа сегмент.
//
// Возвращаемое значение:
//   Булево   - Истина, если право изменения есть.
//
Функция ЕстьПравоИзмененияСоставаСегментов(ТипСегмента) Экспорт

Пример вызова

Результат = СегментыСервер.ЕстьПравоИзмененияСоставаСегментов(ТипСегмента)

ПолучитьХарактеристикиНоменклатурыВходящиеВСегмент

Описание, пример вызова

// Определяет, какие характеристики номенклатуры входят в сегмент.
//
// Параметры:
//  Номенклатура  - СправочникСсылка.Номенклатура - номенклатура, характеристики которой получаются.
//  Сегмент       - СправочникСсылка.СегментыНоменклатуры - сегмент, в которых входя характеристики номенклатуры.
//
// Возвращаемое значение:
//   ТаблицаЗначений   - таблица, содержащая колонки Номенклатура и Характеристика.
//
Функция ПолучитьХарактеристикиНоменклатурыВходящиеВСегмент(Номенклатура, Сегмент) Экспорт

Пример вызова

Результат = СегментыСервер.ПолучитьХарактеристикиНоменклатурыВходящиеВСегмент(Номенклатура, Сегмент)

ВходитВСегмент

Описание, пример вызова

// Возвращает флаг вхождения объекта в сегмент
//
// Параметры:
//  ОбъектСсылка   - Произвольный - ссылка на анализируемый объект - партнера или номенклатуру,
//  СегментСсылка  - СправочникСсылка.СегментыНоменклатуры, СправочникСсылка.СегментыПартнеров - ссылка на сегмент
//      партнеров или номенклатуры.,
//  Характеристика - СправочникСсылка.ХарактеристикиНоменклатуры - характеристика номенклатуры.
//  Динамический   - Булево - Истина, если способ формирования сегмента - ФормироватьДинамически.
//
// Возвращаемое значение:
//   Булево - истина, если входит.
//
Функция ВходитВСегмент(ОбъектСсылка, СегментСсылка, Характеристика = Неопределено, Динамический = Истина) Экспорт

Пример вызова

Результат = СегментыСервер.ВходитВСегмент(ОбъектСсылка, СегментСсылка, Характеристика, Динамический);

ПроверитьВхождениеПартнераВСегментыПриСоздании

Описание, пример вызова

// Проверяет вхождение партнера в сегменты с типом "периодически обновлять" после создания нового партнера.
//
// Параметры:
//  Партнер  - СправочникСсылка.Партнеры - проверяемый партнер.
//
Процедура ПроверитьВхождениеПартнераВСегментыПриСоздании(Партнер) Экспорт

Пример вызова

СегментыСервер.ПроверитьВхождениеПартнераВСегментыПриСоздании(Партнер)

УстановитьОтборПоСегменту

Описание, пример вызова

// Устанавливает значение и использование параметра, определяющего отбор по партнерам
// по значению и использованию параметра - сегмента.
//
// Параметры:
//  ПараметрСегмент   - ПараметрСхемыКомпоновкиДанных  - параметр, содержащий отбор по сегменту.
//  ПараметрПартнеры  - ПараметрСхемыКомпоновкиДанных  - параметр, содержащий отбор по партнеру.
//
Процедура УстановитьОтборПоСегменту(ПараметрСегмент, ПараметрПартнеры) Экспорт

Пример вызова

СегментыСервер.УстановитьОтборПоСегменту(ПараметрСегмент, ПараметрПартнеры)

ВключитьОтборПоНеСегментуНоменклатурыВСКД

Описание, пример вызова

// Если в настройках СКД включено использование отбора по не сегменту номенклатуры,
// то процедура устанавливает служебный параметр использования отбора по не сегменту номенклатуры.
//
// Параметры:
//  ОбъектНастройки - КомпоновщикНастроекКомпоновкиДанных, НастройкиВложенногоОбъектаКомпоновкиДанных - откуда брать настройки.
//  ИспользоватьТолькоНастройки - Булево - признак того, что будут использованы настройки по умолчанию.
//
// Возвращаемое значение:
//   Булево - признак использования отбора по сегменту.
//
Функция ВключитьОтборПоНеСегментуНоменклатурыВСКД(ОбъектНастройки, ИспользоватьТолькоНастройки = Ложь) Экспорт

Пример вызова

Результат = СегментыСервер.ВключитьОтборПоНеСегментуНоменклатурыВСКД(ОбъектНастройки, ИспользоватьТолькоНастройки);

ВключитьОтборПоСегментуНоменклатурыВСКД

Описание, пример вызова

// Если в настройках СКД включено использование отбора по сегменту номенклатуры,
// то процедура устанавливает служебный параметр использования отбора по сегменту номенклатуры.
//
// Параметры:
//  ОбъектНастройки - КомпоновщикНастроекКомпоновкиДанных, НастройкиВложенногоОбъектаКомпоновкиДанных - откуда брать настройки.
//  ИспользоватьТолькоНастройки - Булево - признак того, что будут использованы настройки по умолчанию.
//
// Возвращаемое значение:
//   Булево - признак использования отбора по сегменту.
//
Функция ВключитьОтборПоСегментуНоменклатурыВСКД(ОбъектНастройки, ИспользоватьТолькоНастройки = Ложь) Экспорт

Пример вызова

Результат = СегментыСервер.ВключитьОтборПоСегментуНоменклатурыВСКД(ОбъектНастройки, ИспользоватьТолькоНастройки);

ВключитьОтборПоСегментуПартнеровВСКД

Описание, пример вызова

// Если в настройках СКД включено использование отбора по сегменту партнеров,
// то процедура устанавливает служебный параметр использования отбора по сегменту партнеров.
//
// Параметры:
// ОбъектНастройки - КомпоновщикНастроекКомпоновкиДанных, НастройкиВложенногоОбъектаКомпоновкиДанных - откуда брать настройки.
//
// Возвращаемое значение:
//   Булево - признак использования отбора по сегменту.
//
Функция ВключитьОтборПоСегментуПартнеровВСКД(ОбъектНастройки) Экспорт

Пример вызова

Результат = СегментыСервер.ВключитьОтборПоСегментуПартнеровВСКД(ОбъектНастройки)

ПартнерВходитВСегментыЗапретаОтгрузки

Описание, пример вызова

// Проверяет, что партнер входит в сегменты запрета отгрузки
//
// Параметры:
//  Партнер   - СправочникСсылка.Партнеры - Проверяемый партнер.
//
// Возвращаемое значение:
//  Булево - признак вхождения партнера.
//
Функция ПартнерВходитВСегментыЗапретаОтгрузки(Партнер) Экспорт

Пример вызова

Результат = СегментыСервер.ПартнерВходитВСегментыЗапретаОтгрузки(Партнер)

УстановитьВидимостьЗапретаОтгрузкиПартнеру

Описание, пример вызова

// Устанавливает видимость запрета отгрузки партнеру на форме
//
// Параметры:
//  Партнер   - СправочникСсылка.Партнеры - Проверяемый партнер
//  ЭлементыФормы   - ЭлементыФормы - элементы изменяемой формы.
//
Процедура УстановитьВидимостьЗапретаОтгрузкиПартнеру(Партнер, ЭлементыФормы) Экспорт

Пример вызова

СегментыСервер.УстановитьВидимостьЗапретаОтгрузкиПартнеру(Партнер, ЭлементыФормы)

КоличествоСегментовЗапретаОтгрузки

Описание, пример вызова

// Возвращает количество сегментов запрета отгрузки
//
// Возвращаемое значение:
//  Число - количество сегментов.
//
Функция КоличествоСегментовЗапретаОтгрузки() Экспорт

Пример вызова

Результат = СегментыСервер.КоличествоСегментовЗапретаОтгрузки()