#1542 Актуализировать информацию по событиям ПМ

https://git.skbkontur.ru/Diadoc1C/DiadocModules/-/issues/1542
diadoc · Dec 8, 2021 · de19993 · de19993
1 parent 7a5dde2
commit de19993
Show file tree

Hide file tree

Showing 46 changed files with 786 additions and 311 deletions.
diff --git a/docs/source/Functions_PM.rst b/docs/source/Functions_PM.rst
@@ -9,14 +9,14 @@
   :name: Исходящие документы
   :maxdepth: 1
 
-  ПодготовитьПакет <func/pm/Podgotovit'Paket>
-  ПодготовитьЭлектронныйДокумент <func/pm/Podgotovit'ElektronnyyDokument>
-  ПолучитьТаблицуИспользуемыхВидовДокументов <func/pm/Poluchit'TablitsuIspol'zuyemykhVidovDokumentov>
   ПолучитьТаблицуИспользуемыхПакетов <func/pm/Poluchit'TablitsuIspol'zuyemykhPaketov>
+  ПолучитьТаблицуИспользуемыхВидовДокументов <func/pm/Poluchit'TablitsuIspol'zuyemykhVidovDokumentov>
   ПолучитьТекстЗапросаДляСпискаПакетовНаОтправкуПоМассивуВидовПакетов <func/pm/Poluchit'TekstZaprosaDlyaSpiskaPaketovNaOtpravkuPoMassivuVidovPaketov>
-  ПослеОтправкиПакета <func/pm/Posle_Otpravki_Paketa>
-  ПослеПодготовкиПакета <func/pm/PoslePodgotovkiPaketa>
+  ПодготовитьПакет <func/pm/Podgotovit'Paket>
+  ПодготовитьЭлектронныйДокумент <func/pm/Podgotovit'ElektronnyyDokument>
   ПодготовитьЭлектронныйДокументПоВнешнейПечатнойФорме <func/pm/ПодготовитьЭлектронныйДокументПоВнешнейПечатнойФорме>
+  ПослеПодготовкиПакета <func/pm/PoslePodgotovkiPaketa>
+  ПослеОтправкиПакета <func/pm/Posle_Otpravki_Paketa>
   ЗаполнитьРеквизитыДокумента <func/pm/ЗаполнитьРеквизитыДокумента>
 
 
@@ -27,16 +27,17 @@
   :name: Входящие документы
   :maxdepth: 0
 
-  ВыполнитьТребуемоеДействие <func/pm/Vypolnit'_Trebuyemoye_Deystviye>
   НайтиСопоставлениеДокумента <func/pm/Nayti_Sopostavleniye_Dokumenta>
   СписокТиповДокументовДляСоздания <func/pm/СписокТиповДокументовДляСоздания>
   ПолучитьЗаполненныйОбъектДокумента1С <func/pm/Poluchit'_Zapolnennyy_Obyekt_Dokumenta_1S>
+  ПрочитатьСопоставлениеНоменклатуры <func/pm/Prochitat'_Sopostavlenie_Nomenklatury>
+  СопоставитьНоменклатуруПоставщика <func/pm/Sopostavit'_Nomenklaturu_Postavshchika>
+  ПровестиАнализДокумента <func/pm/Provesti_Analiz_Dokumenta>
   ПослеАнализаПакета <func/pm/Posle_Analiza_Paketa>
+  ВыполнитьТребуемоеДействие <func/pm/Vypolnit'_Trebuyemoye_Deystviye>
   ПравилаСопоставленияДокумента <func/pm/Pravila_Sopostavleniya_Dokumenta>
-  ПровестиАнализДокумента <func/pm/Provesti_Analiz_Dokumenta>
-  СопоставитьНоменклатуруПоставщика <func/pm/Sopostavit'_Nomenklaturu_Postavshchika>
   ОтборСопоставленияНоменклатуры <func/pm/Otbor_Sopostavleniya_Nomenklatury>
-
+  ЗаполнитьТаблицуСопоставленияНоменклатуры <func/pm/Zapolnit'_Tabliycu_Sopostavlenia_Nomenklatury>
 
 Дополнение формы модуля
 -----------------------
@@ -62,10 +63,24 @@
   :maxdepth: 0
 
   ВыполнитьРегламентныеДействия <func/pm/Vypolnit'_Reglamentnyye_Deystviya>
+  ПослеУстановкиСтатусаДокумента <func/pm/Posle_Ustanovki_Statusa_Dokumenta>
   ОбработатьСобытие <func/pm/Obrabotat'Sobytiye>
   ОпределитьТипЗначенияОбъекта <func/pm/Opredelit'_Tip_Znacheniya_Obyekta>
   ПолучитьКоличествоДокументовЗаПериод <func/pm/Poluchit'_Kolichestvo_Dokumentov_Za_Period>
   ПослеОбработкиЛентыСобытий <func/pm/Posle_Obrabotki_Lenty_Sobytiy>
-  ПослеУстановкиСтатусаДокумента <func/pm/Posle_Ustanovki_Statusa_Dokumenta>
   ПечатнаяФормаДокумента <func/pm/PechatnayaFormaDocumenta>
   ОбновитьКомментарийДокументаУчета <func/pm/ОбновитьКомментарийДокументаУчета>
+
+
+Криптография
+--------------
+
+.. toctree::
+  :name: Криптография
+  :maxdepth: 0
+
+  ЗашифроватьДанные <func/pm/Zahifrovat'_Dannye>
+  РасшифроватьДанные <func/pm/Rashifrovat'_Dannye>
+  ПолучитьСертификатыДляШифрования <func/pm/Polychit'_Sertifikaty_Dly_Shifrovania>
+  ПодписатьДанные <func/pm/Podpisat'_Dannye>
+  ПроверитьПодпись <func/pm/Proverit'_Podpis'>
diff --git a/docs/source/func/pm/Nayti_Sopostavleniye_Dokumenta.rst b/docs/source/func/pm/Nayti_Sopostavleniye_Dokumenta.rst
@@ -4,21 +4,28 @@
 
 **Синтаксис:**
 
-    НайтиСопоставлениеДокумента(<Параметры>)
+НайтиСопоставлениеДокумента(Параметры)
 
-**Возвращает:**
+**Описание:**
 
-    Неопределено / Массив ссылок на документ 1С
+Функция ищет ссылки на документы в 1С. Параметры поиска задаются согласно реквизитам электронного документа.
 
-**Описание:**
+**Входные параметры:**
 
-Функция ищет ссылку на объект в 1С. Параметры поиска задаются согласно реквизитам электронного документа.
+**Параметры** (тип Структура)
 
-**Параметры:**
+      **Элементы структуры:**
+
+      * **Документ** (тип Структура) — электронный :doc:`документ <../../objects/Документ>`, для которого выполняется сопоставление.
+      * **ДокументДД** (тип СправочникСсылка.Диадок_Документы) — содержит описание электронного документа, для которого выполняется сопоставление.
+      * **Контент** (тип Структура) — содержит описание контента, титул покупателя и т.п. Используется внутри модуля.
+      * **ПакетДД** (тип СправочникСсылка.Диадок_ПакетыДокументов) — содержит описание пакета, к которому относится электронный документ.
+
+**Возвращает:**
 
-Элементы структуры **Параметры**:
+Массив ссылок на документы 1С или Неопределено
 
-* **ДокументДД** - электронный документ, для которого выполняется сопоставление (СправочникСсылка.Диадок_Документы).
-* **ПакетДД** - пакет документов, в состав которого входит ДокументДД (СправочникСсылка.Диадок_ПакетыДокументов).
+      * **Документы 1С** (тип Массив) — содержит ссылки на найденные документы 1С.
+      * **Неопределено** (тип Неопределенно) — если не найден ни один подходящий документ.
 
 Пример использования: :doc:`Как обработать входящий пакет документов <../../proc/pm/Obrabotka_Vkhodyashchikh_Paketov>`
diff --git a/docs/source/func/pm/Nazhatiye_Dopolnitel'noy_Knopki.rst b/docs/source/func/pm/Nazhatiye_Dopolnitel'noy_Knopki.rst
@@ -4,25 +4,35 @@
 
 **Синтаксис:**
 
-    НажатиеДополнительнойКнопки(<Параметры>)
+НажатиеДополнительнойКнопки(Параметры)
 
 **Описание:**
 
 Обработчики нажатия дополнительных кнопок, которые задали в :doc:`ЗаполнитьСписокДополнительныхКнопок <../../func/pm/Zapolnit'_Spisok_Dopolnitel'nykh_Knopok>`.
 
-**Параметры:**
+Событие доступно как на клиенте, так и на сервере.
 
-Элементы структуры **Параметры**:
+**Входные параметры:**
 
-* **РежимОтображенияДокументов** - текущий режим отображения документов;
-* **ВыделенныеСтроки** - массив выделенных строк списка документов;
-* **ИмяКнопки** - внутреннее наименование кнопки, нажатие которой выполнено.
+**Параметры** (тип Структура)
 
-**Режим отображения документов** принимает значения:
+      **Элементы структуры:**
 
-* ОтправкаПакетов,
-* ОтправленныеДокументы,
-* ПолученныеДокументы,
-* ПолученныеПакеты.
+      * **ВыделенныеСтроки** (тип Массив) — содержит выделенные строки списка документов.
+      * **ДополнительныеПараметры** (тип Произвольный) — содержит результат выполнения клиентской части события. Доступно только в серверном событии.
+      * **ИмяКнопки** (тип Строка) — внутреннее наименование кнопки, нажатие которой выполнено.
+      * **ИмяФормы** (тип Строка) — внутреннее название формы, в которой выполнено нажатие кнопки.
+      * **РежимОтображенияДокументов** (тип Строка) — текущий режим отображения документов.  
+
+            Возможные значения **Режим отображения документов**:
+
+            * ОтправкаПакетов,
+            * ОтправленныеДокументы,
+            * ПолученныеДокументы,
+            * ПолученныеПакеты.
+
+**Возвращает:**
+
+Значение (Истина)
 
 Пример использования: :doc:`Как добавить кнопки в действия <../../proc/pm/Dobavleniye_Knopok>`
diff --git a/docs/source/func/pm/Obrabotat'Sobytiye.rst b/docs/source/func/pm/Obrabotat'Sobytiye.rst
@@ -4,17 +4,17 @@
 
 **Синтаксис:**
 
-    ОбработатьСобытие(<ИмяСобытия>, <Параметры>)
+ОбработатьСобытие(ИмяСобытия, Параметры)
 
-**Возвращает:**
+**Описание:**
 
-    Значение вызываемой функции
+Определяет, какую функцию вызвать в зависимости от имени события.
 
-**Описание:**
+**Входные параметры:**
 
-Опреляется, какую функцию вызвать в зависимости от имени события.
+* **ИмяСобытия** (тип Строка) — название события, которое требуется обработать.
+* **Параметры** (тип Структура) — структура, элементы которой зависят от имени вызываемого события.
 
-**Параметры:**
+**Возвращает:**
 
-* **ИмяСобытия** (тип Строка) - название события, которое требуется обработать.
-* **Параметры** (тип Структура) - структура, элементы которой будут использоваться в функции-обработчике конкретного события.
+Значение вызываемой функции
diff --git a/docs/source/func/pm/Opredelit'_Tip_Znacheniya_Obyekta.rst b/docs/source/func/pm/Opredelit'_Tip_Znacheniya_Obyekta.rst
@@ -4,20 +4,22 @@
 
 **Синтаксис:**
 
-    ОпределитьТипЗначенияОбъекта(<Параметры>)
-
-**Возвращает:**
-
-    Строку с названием ссылочного типа
+ОпределитьТипЗначенияОбъекта(Параметры)
 
 **Описание:**
 
 Позволяет определить тип используемых справочников Организации и Контрагенты.
 
-**Параметры:**
+**Входные параметры:**
+
+**Параметры** (тип Структура)
 
-Элементы структуры **Параметры**:
+      **Элементы структуры:**
+
+      * **Синоним** (тип Строка) — текстовое значение: "Организации" или "Контрагенты".
+
+**Возвращает:**
 
-* **Синоним** - текстовое значение: "Организации" или "Контрагенты".
+Строка с названием ссылочного типа
 
 Пример использования: :doc:`Дополнительные возможности <../../proc/pm/Dopolnitel'nyye_Vozmozhnosti>`
diff --git a/docs/source/func/pm/Otbor_Sopostavleniya_Nomenklatury.rst b/docs/source/func/pm/Otbor_Sopostavleniya_Nomenklatury.rst
@@ -1,28 +1,44 @@
 
-ОтборСопоставленияНоменклатуры (начиная с версии 4.1)
+ОтборСопоставленияНоменклатуры
 =====================================================
 
 **Синтаксис:**
 
-	ОтборСопоставленияНоменклатуры(<Параметры>)
-
-**Возвращает:**
-
-	Структуру, которая содержит массив, состоящий из ссылок на номенклатуру.
+ОтборСопоставленияНоменклатуры(Параметры)
 
 **Описание:**
 
 Функция устанавливает отбор в форме сопоставления номенклатуры.
 
-**Параметры:**
+**Входные параметры:**
+
+**Параметры** (тип Структура)
+
+      **Элементы структуры:**
+
+      * **ИмяКолонки** (тип Строка) — внутреннее имя колонки, в которой осуществляется открытие формы выбора.
+      * **ДанныеСопоставления** (тип Структура) — содержит данные документа ЭДО и 1С.
 
-Элементы структуры **Параметры:**
+            Элементы структуры **"ДанныеСопоставления"**:
+
+            * **Артикул** (тип Строка) — артикул позиции номенклатуры.
+            * **ДетальнаяЗапись** (тип Булево) — служебный параметр, не подлежащий изменению.
+            * **Код** (тип Строка) — код позиции номенклатуры.
+            * **Контрагент** (тип СправочникСсылка.Контрагенты) — ссылка на запись из справочника контрагентов.
+            * **Наименование** (тип Строка) — наименование позиции номенклатуры.
+            * **Номенклатура** (тип СправочникСсылка.Номенклатура) — ссылка на запись из справочника номенклатуры.
+            * **НоменклатураКонтрагента** (тип Структура) — данные номенклатуры из ЭДО.
+
+**Возвращает:**
+
+Структура, которая содержит параметры отбора для формы выбора справочника номенклатуры, где
+
+      * **Ключ** (тип Строка) — имя реквизита,
+      * **Значение** (тип Произвольный) — значение отбора по реквизиту.
+
+
+Пример использования: :doc:`Как обработать входящий пакет документов <../../proc/pm/Obrabotka_Vkhodyashchikh_Paketov>`
 
-* **Артикул** (тип Строка) - артикул позиции номенклатуры.
-* **ДетальнаяЗапись** (тип Булево) - служебный параметр, не подлежащий изменению.
-* **Код** (тип Строка) - код позиции номенклатуры.
-* **Контрагент** (тип Ссылка) - ссылка на запись из справочника контрагентов.
-* **Наименование** (тип Строка) - наименование позиции номенклатуры.
-* **Номенклатура** (тип Ссылка) - ссылка на запись из справочника номенклатуры.
+.. note::
 
-Пример использования: :doc:`Как обработать входящий пакет документов <../../proc/pm/Obrabotka_Vkhodyashchikh_Paketov>`
+  Доступно для версии модуля 4.1 и выше
diff --git a/docs/source/func/pm/PechatnayaFormaDocumenta.rst b/docs/source/func/pm/PechatnayaFormaDocumenta.rst
@@ -1,20 +1,26 @@
 
-ПечатнаяФормаДокумента
-===================================
+ПечатнаяФормаДокумента не существует?
+======================================
 
 **Синтаксис:**
 
-    ПечатнаяФормаДокумента(<Параметры>)
+ПечатнаяФормаДокумента(Параметры)
 
 **Описание:**
 
 Позволяет вернуть нестандартную печатную форму для документа.
 
-**Параметры:**
+**Входные параметры:**
 
-Элементы структуры **Параметры**:
+**Параметры** (тип Структура)
 
-* **Документ** - структура с описанием документа. Здесь может быть как уже отправленный или полученный документ, так и новый, готовый к отправке.
+      **Элементы структуры:**
+
+      * **Документ** (тип Структура) — :doc:`структура документа <../../objects/Документ>`. Здесь может быть как уже отправленный или полученный документ, так и новый, готовый к отправке.
+
+**Возвращает:**
+
+ТабличныйДокумент
 
 Пример использования: